Skip to content

Commit 09fab3f

Browse files
committed
docs: update build-install.md
1 parent 8a87a31 commit 09fab3f

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

docs/development/build-install.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Build and install
22

3-
Build the extension using Node and then install it in your IDE, using the latest code in the repo.
4-
5-
This is ideal for testing out local changes you've made in the extension, without creating a tag yet.
3+
Build the extension using Node and then install it in your IDE, using the latest code in the repo. This is ideal for testing out local changes you've made in the extension, without creating a tag yet.
64

75
Navigate to the repo root and then run this:
86

@@ -13,16 +11,30 @@ $ make ext
1311
That will do the following:
1412

1513
1. Run **lint** checks.
16-
2. **Build** the extension `.vsix` archive to the `build` directory using the current code. Performing all necessary checks.
17-
3. It will **install** the extension globally in VS Code.
14+
1. **Build** the extension using the current codebase and output as an `.vsix` archive file to the `build` directory. Performs all necessary code quality checks.
15+
1. **Install** the extension globally in VS Code.
1816

1917
You should then **restart** VS Code.
2018

2119
You can find the extension in the _Extension_ tab.
2220

23-
### Notes
21+
## Issues installing using WSL
22+
23+
If using WSL, then after the build is complete you might get an error:
24+
25+
```
26+
ERROR: UtilConnectToInteropServer
27+
```
28+
29+
In that case, you'll need to install from the `.vsix` file yourself:
30+
31+
1. Open the VS Code _Command Palette_ under _View_.
32+
1. Select the option _Extension: Install from VSIX..._.
33+
1. Enter the path to the file e.g. `/home/my-user/repos/auto-commit-msg/build/auto-commit-msg-0.25.1.vsix`.
34+
35+
## Notes
2436

25-
About the `ext` command in [package.json](/package.json).
37+
About the `ext` command in [package.json](/package.json):
2638

2739
- We use the `--force` flag to allow **downgrade** to an older version, according to the CLI output help.
2840
- The command sorts by _time_ to find the latest version. Since sorting by name is _not_ reliable, such as when the version is `0.9.0` and `0.10.0` and the latter is meant to be higher but appears like a lower version)

0 commit comments

Comments
 (0)