Skip to content

Commit 4513a13

Browse files
refine the DevREADME.md for more cleaner setup and compile steps (#65)
##### Objective I want to make the devREADME.md has more cleaner steps for new developers. ##### Abstractions Now for new developer it should only do two things: 1. git pull to get the codes 2. run` python pack.py` to compile the codes Other details information like `npm install` or copy the correct file to correct location is hidden in the pack.py file. And I also added one section how to setup the environment in Autodesk domain to work around the NPM local setting limitation. ##### Tests performed ##### Screen shot No applicable for this PR.
1 parent 58f6e56 commit 4513a13

File tree

1 file changed

+12
-29
lines changed

1 file changed

+12
-29
lines changed

DevREADME.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,17 @@
22

33
AutoCAD Lisp Extension is a vscode extension for debug AutoCAD AutoLISP. The Extension plays the roles of both debug adapter and language server which could enable you debug lisp with AutoCAD. The following description is for developers.
44

5-
## How to setup the Dev Env
6-
npm install -g yarn (if it's not installed yet)
5+
## How to setup the Dev env and compile the code
76

8-
Then you could setup the develop environment by:
7+
You could do all the steps in the script pack.py, it is python2; or run it directly:
98
```
109
cd AutoLispExt
11-
npm install --global gulp-cli
12-
npm install
13-
```
14-
__NOTE:__ You may see a warning `"The engine "vscode" appears to be invalid"` while running `yarn install`. This is a known problem. Please refer to the [VSCode issue](https://github.com/microsoft/vscode/issues/91009).
15-
## How to compile the code
16-
You could compile the code by:
17-
```
18-
cd AutoLispExt
19-
gulp build
20-
copy utils\acadProcessFinder\bin\acadProcessFinder.exe extension\out\process
10+
python pack.py
2111
```
22-
If you only want to build the ts file and debug it via F5, you can run:
12+
### How to compile the codes
13+
The script pack.py will copy some utility files to correct location for making package. After run that script and then change some TS codes, you can also use the follow command to compile codes simply:
2314
```
24-
=> Windows: winCompile.bat
25-
=> Otherwise: ./macCompile.sh
15+
npm run compile
2616
```
2717

2818
## How to debug the extension
@@ -32,36 +22,29 @@ If you only want to build the ts file and debug it via F5, you can run:
3222
3. hit F5 and select "Extension Client", then it will start another vscode instance with running the extension.
3323
4. Do some operations to invoke the codes which are added breakpoints, vscode will stop in the first instance.
3424

35-
3625
## How to package the extension
3726

3827
You could package the extension by:
3928
```
40-
cd AutoLispExt
41-
gulp package
42-
```
43-
Note that don't run "publish" command otherwise you make sure you want to do.
44-
For the publish command it will release current version extension to vscode market.
45-
46-
## The Script pack.py
47-
48-
You could do all above steps by the script pack.py, it is python2
49-
```
50-
cd AutoLispExt
5129
python pack.py
5230
```
31+
It will create the package in the current folder.
5332

5433
## Run tests
5534

5635
You have two ways to run the tests:
5736
- Run inside the VS Code and begin debugging by choosing "Extension Tests"
5837
- Run on terminal outside of VS Code and make sure no VS code is running (VS Code terminal will not work due to VS Code limitation)
5938
```
60-
yarn test
39+
npm run test
6140
```
6241

6342
### The following steps require access to Autodesk network resources and therefore can only be done by Autodesk employees
6443

44+
## NPM settings
45+
Because the mandatory local NPM setting in Autodesk, for Autodesk developer you can simply replace all the ocurrences in pacake-lock.json like:
46+
replace https://registry.npmjs.org/ with https://art-bobcat.autodesk.com:443/artifactory/api/npm/autodesk-npm-virtual/
47+
6548
## Build status
6649

6750
[![Build Status](https://master-2.jenkins.autodesk.com/buildStatus/icon?=job/AutoCAD/job/AutoLispExt/master)](https://master-2.jenkins.autodesk.com/buildStatus/icon?=job/AutoCAD/job/AutoLispExt/master/)

0 commit comments

Comments
 (0)