Skip to content

Commit d4aa325

Browse files
committed
Update development documentation for vendoring
This commit updates the development documentation to add the Language Server vendoring step when developing on the client. Without this, the extension fails to launch the server.
1 parent 0fb3e6f commit d4aa325

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,41 @@ Follow the instructions in the server documentation - [How to run the Language S
2323

2424
* Clone this repository
2525

26-
```
26+
```bash
2727
> git clone https://github.com/jpogran/puppet-vscode.git
2828

2929
> cd puppet-vscode
3030
> cd client
3131
```
3232

33-
* Install the node modules and start VS Code
33+
* Install the node modules
3434

35-
```
36-
> npm install
35+
```bash
36+
client > npm install
3737
...
3838

3939
> puppet-vscode@0.0.3 postinstall C:\Source\puppet-vscode\client
4040
> node ./node_modules/vscode/bin/install
41-
41+
...
4242
Detected VS Code engine version: ^1.10.0
4343
Found minimal version that qualifies engine range: 1.10.0
4444
Fetching vscode.d.ts from: https://raw.githubusercontent.com/Microsoft/vscode/1.10.0/src/vs/vscode.d.ts
4545
vscode.d.ts successfully installed!
46+
```
47+
48+
* Copy the Language Server for vendoring into the extensions
49+
50+
```bash
51+
client > node node_modules/gulp/bin/gulp.js copy_language_server
52+
[15:13:02] Using gulpfile client/gulpfile.js
53+
[15:13:02] Starting 'copy_language_server'...
54+
[15:13:02] Finished 'copy_language_server' after 193 ms
55+
```
56+
57+
* Start VS Code
4658

47-
> code .
59+
```bash
60+
client > code .
4861
```
4962

5063
* Once VS Code is running, press `F5` to start a build and a new VS Code development instance should start

0 commit comments

Comments
 (0)