summaryrefslogtreecommitdiff
path: root/packages/vscode-ide-companion/development.md
blob: 0fdc93f23a715b83919b0da62d294e3811640516 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
```