Skip to content

Commit 770f1f2

Browse files
committed
docs: update sandbox.md
1 parent bca22f3 commit 770f1f2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/development/advanced/sandbox.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,25 @@ If you prefer not use this approach, you can just compile and install the extens
99

1010
## Start sandbox
1111

12+
These are configured in the `.vscode` directory of the repo.
13+
1214
Follow these steps:
1315

1416
1. Open VS Code at this repo if you haven't already.
15-
2. Go to the _Debug_ tab.
16-
3. Select one of two tasks:
17+
1. Go to the _Debug_ tab.
18+
1. Select one of two tasks:
1719
- _Run Extension_ task.
1820
- This will start in a default directory such as your user's home directory.
1921
- You might want to use File / Open to change the sandbox window to a repo what has more content to play with. This will be remembered on later runs. Unfortunately if you changed your VS Code settings to open in a new window on Open, then the extension setup will be undone.
20-
- Start in Sandbox repo_ task.
22+
- _Start in Sandbox repo_ task.
2123
- For more reliable and consistent behavior.
22-
- This will run against `sandbox` directory in the project, which is a git repo where you can make files and commits as you like. Y
23-
- NB. You'll need to run `npm run sb` first to ensure this directory exists and then run the debug action. Run that NPM command again to clear the space and start over.
24-
4. Click the play arrow.
24+
- This will run against `sandbox` directory in the project, which is a Git repo where you can make files and commits as you like.
25+
- NB. You'll must run `npm run sb` **first** to ensure this directory exists and then run the debug action. Run that NPM command again whenever you want to clear the space and start over.
26+
1. Click the run button.
27+
28+
That will start a new sandboxed VS Code session which has the extension built using the local code and _enabled_, and all other extensions _disabled_. At a lower level, it runs `npm compile` and `npm watch`.
2529

26-
That will start a new sandboxed VS Code session which has the extension active and all others inactive. At a lower level, it runs `npm compile` and `npm watch`.
30+
What is especially useful about this is that whenever an extension action is performed in the sandboxed VS Code window, if there are any logs for that then those will appear in the Debug Console of the _original_ VS Code window.
2731

2832
The code for the extension is in [src](/src/).
2933

0 commit comments

Comments
 (0)