Skip to content

Commit

Permalink
docs: Add notes/disclaimers for upgrading the node-gyp npm uses
Browse files Browse the repository at this point in the history
Add notes on npm version compatibility for methods to update node-gyp.

Also mention that this is tested on npm 8, now that npm 8 exists.
(Npm 8 is the same as npm 7 for purposes of these instructions.)

Lastly, add a note that one of the methods is simpler/more durable,
if only functional for npm 6 and older.
  • Loading branch information
DeeDeeG committed Jan 6, 2022
1 parent 6e8f93b commit c450575
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/Force-npm-to-use-global-node-gyp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Force npm to use global installed node-gyp

**Note: These instructions only work with npm 6 or older. For a solution that works with npm 8 (or older), see [Updating-npm-bundled-node-gyp.md](https://github.com/nodejs/node-gyp/blob/master/docs/Updating-npm-bundled-node-gyp.md).**

[Many issues](https://github.com/nodejs/node-gyp/labels/ERR%21%20node-gyp%20-v%20%3C%3D%20v5.1.0) are opened by users who are
not running a [current version of node-gyp](https://github.com/nodejs/node-gyp/releases).

Expand Down
8 changes: 6 additions & 2 deletions docs/Updating-npm-bundled-node-gyp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Updating the npm-bundled version of node-gyp

**Note: These instructions are (only) tested and known to work with npm 8 and older.**

**Note: These instructions will be undone if you reinstall or upgrade npm or node! For a more permanent (and simpler) solution, see [Force-npm-to-use-global-node-gyp.md](https://github.com/nodejs/node-gyp/blob/master/docs/Force-npm-to-use-global-node-gyp.md). (npm 6 or older only!)**

[Many issues](https://github.com/nodejs/node-gyp/labels/ERR%21%20node-gyp%20-v%20%3C%3D%20v5.1.0) are opened by users who are
not running a [current version of node-gyp](https://github.com/nodejs/node-gyp/releases).

Expand All @@ -25,7 +29,7 @@ npm --version

Unix is easy. Just run the following command.

If your npm is version ___7___, do:
If your npm is version ___7 or 8___, do:
```bash
$ npm explore npm/node_modules/@npmcli/run-script -g -- npm_config_global=false npm install node-gyp@latest
```
Expand All @@ -52,7 +56,7 @@ Now `cd` to the directory that `node.exe` is contained in e.g.:
$ cd "C:\Program Files\nodejs"
```

If your npm version is ___7___, do:
If your npm version is ___7 or 8___, do:
```bash
cd node_modules\npm\node_modules\@npmcli\run-script
```
Expand Down

0 comments on commit c450575

Please sign in to comment.