Skip to content

Commit 23ce467

Browse files
authored
update dev workflow doc to reflect VSCode extension setup (#284)
1 parent 7b5447e commit 23ce467

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs-website/docs/development-workflow.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The node.js and pnpm versions used by Isograph are specified in fields `engines.
1616

1717
In order to ensure you are using the correct versions of these you should install `fnm` for your respective operating system by following [this](https://github.com/Schniz/fnm?tab=readme-ov-file#installation) guide. Optionally, configure fnm for your shell by following [this](https://github.com/Schniz/fnm?tab=readme-ov-file#shell-setup) guide.
1818

19-
Now, navigate to the root directory of your Isograph repository and run the following commands one by one:
19+
Now, navigate to the root directory of your Isograph repository and run the following commands:
2020

2121
```bash
2222
fnm install --resolve-engines
@@ -111,7 +111,7 @@ pnpm i
111111
### Build the Isograph JavaScript libraries for use in demos
112112

113113
```sh
114-
pnpm -r watch-libs
114+
pnpm watch-libs
115115
```
116116

117117
`watch-libs` will watch the source files for changes, and rebuild everything. If you only want to do it once, you can:
@@ -152,8 +152,29 @@ pnpm backend
152152

153153
### Starting
154154

155+
- If you haven't yet, build the Isograph javascript libraries for the demos by running the following from root:
156+
157+
```sh
158+
pnpm i
159+
pnpm watch-libs
160+
```
161+
162+
or
163+
164+
```sh
165+
pnpm i
166+
pnpm -r compile
167+
```
168+
155169
- Open VSCode in `isograph/vscode-extension`
156-
- Open the "run and debug" sidebar, and click `Run and Debug`. If given a choice, select something related to "Extension development host".
170+
- Run the following in `isograph/vscode-extension`:
171+
172+
```sh
173+
npm i
174+
npm run build-local
175+
```
176+
177+
- Open `src/extension.ts` in your editor, then open the "run and debug" sidebar and click `Run and Debug`. If given a choice, select something related to "Extension development host".
157178
- In this new window, open `isograph/demos/pet-demo`.
158179
- The VSCode extension should start when you open a JS, JSX, TS or TSX file.
159180

0 commit comments

Comments
 (0)