Skip to content

Commit

Permalink
Update CONTRIBUTING.md with instruction to run Bicep VSCode extension…
Browse files Browse the repository at this point in the history
… when using WSL2
  • Loading branch information
miqm committed Nov 22, 2020
1 parent fa6e2c5 commit 9806502
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -364,3 +364,4 @@ FodyWeavers.xsd

# Language Server bits
bicepLanguageServer/
src/vscode-bicep/bicepLanguageServer
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The Bicep solution is comprised of the following main components:
* On the first run, you'll need to ensure you have installed all the npm packages required by the Bicep VSCode extension with the following:
* `cd src/vscode-bicep`
* `npm i`
* In the [VSCode Run View](https://code.visualstudio.com/Docs/editor/debugging), select the "Bicep VSCode Extension" task, and press the "Start" button. This will launch a new VSCode window with the Bicep extension and LanguageServer containing your changes. When running on WSL, set the `BICEP_LANGUAGE_SERVER_PATH` environment variable found in `launch.json` manually following [WSL environment setup scripts](https://code.visualstudio.com/docs/remote/wsl#_advanced-environment-setup-script).
* In the [VSCode Run View](https://code.visualstudio.com/Docs/editor/debugging), select the "Bicep VSCode Extension" task, and press the "Start" button. This will launch a new VSCode window with the Bicep extension and LanguageServer containing your changes. When running on WSL, create a symbolic link in `src/vscode-bicep` named `bicepLanguageServer` to `../Bicep.LangServer/bin/Debug/net5.0`.
* If you want the ability to put breakpoints and step through the C# code, you can also use the "Attach" run configuration once the extension host has launched, and select the Bicep LanguageServer process by searching for "bicep".

### Running the Bicep CLI
Expand Down

0 comments on commit 9806502

Please sign in to comment.