-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(core): add warning if running on an outdated global install (#15443)
(cherry picked from commit 7740bb1)
- Loading branch information
1 parent
d863930
commit 91b7344
Showing
7 changed files
with
280 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Managing your Global Nx Installation | ||
|
||
Nx can be ran in a total of 3 ways: | ||
|
||
- Through your package manager (e.g. `npx nx`, `yarn nx`, or `pnpm exec nx`) | ||
- Through [./nx or ./nx.bat](/more-concepts/nx-and-the-wrapper) | ||
- Through a global Nx installation (e.g. `nx`) | ||
|
||
With a global Nx installation, Nx looks for the local copy of Nx in your repo and hands off the process execution to it. This means that whichever version of Nx is installed locally in your repo is still the version of Nx that runs your code. For the most part, this can eliminate any issues that may arise from the global install being outdated. | ||
|
||
## Installing Nx Globally | ||
|
||
Depending on your package manager of choice, you can install Nx with the following commands: | ||
|
||
{% tabs %} | ||
{% tab label="npm" %} | ||
|
||
```shell | ||
npm install --global nx@latest | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="yarn" %} | ||
|
||
```shell | ||
yarn global add nx@latest | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="pnpm" %} | ||
|
||
```shell | ||
pnpm install --global nx@latest | ||
``` | ||
|
||
{% /tab %} | ||
{% /tabs %} | ||
|
||
## Updating your global Nx installation | ||
|
||
There are some cases where an issue could arise when using an outdated global installation of Nx. If the structure of your Nx workspace no longer matches up with what the globally installed copy of Nx expects, it may fail to hand off to your local installation properly and instead error. This commonly results in errors such as: | ||
|
||
- Could not find Nx modules in this workspace. | ||
- The current directory isn't part of an Nx workspace. | ||
|
||
If you find yourself in this position, you will need to update your global install of Nx. | ||
|
||
In most cases, you can update a globally installed npm package by rerunning the command you used to install it, as described [above](#installing-nx-globally) | ||
|
||
If you cannot remember which package manager you installed Nx globally with or are still encountering issues, you can locate other installs of Nx with these commands: | ||
|
||
{% tabs %} | ||
{% tab label="npm" %} | ||
|
||
```shell | ||
npm list --global nx | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="yarn" %} | ||
|
||
```shell | ||
yarn global list nx | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="pnpm" %} | ||
|
||
```shell | ||
pnpm list --global nx | ||
``` | ||
|
||
{% /tab %} | ||
{% /tabs %} | ||
|
||
You can then remove the extra global installations by running the following commands for the duplicate installations: | ||
|
||
{% tabs %} | ||
{% tab label="npm" %} | ||
|
||
```shell | ||
npm rm --global nx | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="yarn" %} | ||
|
||
```shell | ||
yarn global remove nx | ||
``` | ||
|
||
{% /tab %} | ||
{% tab label="pnpm" %} | ||
|
||
```shell | ||
pnpm rm --global nx | ||
``` | ||
|
||
{% /tab %} | ||
{% /tabs %} | ||
|
||
Finally, to complete your global installation update, simply reinstall it as described [above](#installing-nx-globally). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -120,6 +120,9 @@ | |
}, | ||
{ | ||
"env": "NX_E2E_CI_CACHE_KEY" | ||
}, | ||
{ | ||
"env": "CI" | ||
} | ||
], | ||
"options": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters