miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): update troubleshoot installation docs (#16446)

Browse Source
This commit is contained in:
Jonathan Cammisuli 2023-04-21 20:12:49 -04:00 committed by GitHub
parent 0e68441265
commit b3a8ac3cb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/shared/installation/troubleshoot-installation.md
View File

@ -12,8 +12,11 @@ Some npm users are experiencing errors like the following:
NX Cannot find module '@nrwl/nx-linux-x64-gnu'
```
This happens because the package-lock.json file was not correctly updated by npm, and missed optional dependencies used by Nx.
You can read more about this [issue on the npm repository.](https://github.com/npm/cli/issues/4828)
There are two reasons why this could potentially happen:
1. Running your install command with `--no-optional` (or the relative flag in yarn, pnpm, etc)
2. The package-lock.json file was not correctly updated by npm, and missed optional dependencies used by Nx.
You can read more about this [issue on the npm repository.](https://github.com/npm/cli/issues/4828)
{% callout type="note" title="Updating Nx" %}
When updating Nx that is already on 15.8, the package-lock.json should continue to be updated properly with all the proper optional dependencies.
@ -21,7 +24,8 @@ When updating Nx that is already on 15.8, the package-lock.json should continue
### How to fix
Deleting your node_modules and `package-lock.json` and re-running `npm i` should make sure that everything is created properly in the newly generated `package-lock.json`.
1. If you are running your install command with `--no-optional`, try again without the flag.
2. Delete your node_modules and `package-lock.json` and re-run `npm i`. This should have the `package-lock.json` file updated properly.
### Supported native module platforms