Skip to content

Commit 53fccdf

Browse files
Create node-version.md
1 parent 315021e commit 53fccdf

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/node-version.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Node version
2+
3+
The CodeQL for VS Code extension defines the version of Node.js that it is intended to run with. This Node.js version is used when running most CI and unit tests.
4+
5+
When running in production (i.e. as an extension for a VS Code application) it will use the Node.js version provided by VS Code. This can mean a different Node.js version is used by different users with different versions of VS Code.
6+
We should make sure the CodeQL for VS Code extension works with the Node.js version supplied by all versions of VS Code that we support.
7+
8+
## Checking the version of Node.js supplied by VS Code
9+
10+
You can find this info by seleting "About Visual Studio Code" from the top menu.
11+
12+
![about-vscode](images/about-vscodeaba.png)
13+
14+
## Updating the Node.js version
15+
16+
The following files will need to be updated:
17+
- `.github/workflows/cli-test.yml` - the "node-version: '[VERSION]'" setting
18+
- `.github/workflows/main.yml` - all the "node-version: '[VERSION]'" settings
19+
- `.github/workflows/release.yml` - the "node-version: '[VERSION]'" setting
20+
- `extensions/ql-vscode/.nvmrc` - this will enable nvm to automatically switch to the correct node version when you're in the project folder
21+
- `extensions/ql-vscode/package-lock.json` - the "engines.node: '[VERSION]'" setting
22+
- `extensions/ql-vscode/package.json` - the "engines.node: '[VERSION]'" setting

0 commit comments

Comments
 (0)