Skip to content

Commit cd72da8

Browse files
committed
Use the same Node version as VSCode
As recommended here #1369 (comment), we want to stay in sync with the current node version shipped with VSCode (v16.13.0): https://github.com/microsoft/vscode/blob/32d40cf44e893e87ac33ac4f08de1e5f7fe077fc/remote/.yarnrc#L2 For this we can add a `.nvmrc` file to alert nvm to switch to the preferred version automatically. It will also help prevent builds from failing when setting up the project for the first time, as building the extension currently fails in Node v18: #1373 We're also updating the docs to mention using `nvm` to manage node versions and point to the right place to check for current supported versions.
1 parent 475d7cc commit cd72da8

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ Here are a few things you can do that will increase the likelihood of your pull
2929

3030
## Setting up a local build
3131

32-
Make sure you have installed recent versions of vscode (>= v1.52), node (>=12.16), and npm (>= 7.5.2). Earlier versions will probably work, but we no longer test against them.
32+
Make sure you have installed recent versions of vscode, node, and npm. Check the `engines` block in [`package.json`](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/package.json) file for compatible versions. Earlier versions may work, but we no longer test against them.
33+
34+
To automatically switch to the correct version of node, we recommend using [nvm](https://github.com/nvm-sh/nvm), which will pick-up the node version from `.nvmrc`.
3335

3436
### Installing all packages
3537

extensions/ql-vscode/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16.13.0

0 commit comments

Comments
 (0)