diff options
Diffstat (limited to 'packages/vscode-ide-companion/development.md')
| -rw-r--r-- | packages/vscode-ide-companion/development.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/packages/vscode-ide-companion/development.md b/packages/vscode-ide-companion/development.md new file mode 100644 index 00000000..0fdc93f2 --- /dev/null +++ b/packages/vscode-ide-companion/development.md @@ -0,0 +1,30 @@ +# Local Development + +## Running the Extension + +To run the extension locally for development: + +1. From the root of the repository, install dependencies: + ```bash + npm install + ``` +2. Open this directory (`packages/vscode-ide-companion`) in VS Code. +3. Compile the extension: + ```bash + npm run compile + ``` +4. Press `F5` (fn+f5 on mac) to open a new Extension Development Host window with the extension running. + +To watch for changes and have the extension rebuild automatically, run: + +```bash +npm run watch +``` + +## Running Tests + +To run the automated tests, run: + +```bash +npm run test +``` |
