nx/docs/shared/recipes/rescope.md
Jack Hsu 99543b5a01
docs(core): update rescope message from Nx 19 to 20 (#23349)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-05-13 12:55:21 -04:00

68 lines
3.0 KiB
Markdown

# Rescope Packages from @nrwl to @nx
As of version 16, all the official Nx plugins are moving from the `@nrwl` npm scope to `@nx`. The goal is for anyone looking through a list of dependencies to easily make the connection between the `nx` package and the `@nx` plugins that are associated with it.
`@nrwl/*` packages are still provided and reexport the `@nx/*` packages so any third-party plugins should continue to work. Any generators (e.g. `@nrwl/react:library`) and executors (e.g. `@nrwl/webpack:webpack`) will continue to work in the interim as well.
## What Do You Need To Do?
For new repos, run `npx create-nx-workspace` as usual. The correct packages will be added.
For existing repos, run `nx migrate` as you normally would. When migrating to version 16 or higher, the package names will be automatically updated for you. If you have a local script, update it to use `@nx/*` packages.
If you maintain a Nx plugin, please update it to use the `@nx/*` packages.
> If you come across Nrwl in blog posts, videos, or elsewhere, that content is likely referring to these packages. Depending on when the content was published, it is likely still relevant.
### Rename
The packages are being renamed as defined in the tables below:
The following packages were not simply rescoped `@nrwl` to `@nx`.
| Nx 15 and lower | Nx 16 and higher |
| ---------------------- | ----------------- |
| @nrwl/nx-cloud | nx-cloud |
| @nrwl/eslint-plugin-nx | @nx/eslint-plugin |
| @nrwl/nx-plugin | @nx/plugin |
| Nx 15 and lower | Nx 16 | Nx 17 |
| --------------- | ---------- | ---------- |
| @nrwl/linter | @nx/linter | @nx/eslint |
### Rescope Only
All other packages keep the same name, but change scope from `@nrwl` to `@nx`.
| Nx 15 and lower | Nx 16 |
| ------------------ | ---------------- |
| @nrwl/angular | @nx/angular |
| @nrwl/aws-lambda | @nx/aws-lambda |
| @nrwl/cypress | @nx/cypress |
| @nrwl/detox | @nx/detox |
| @nrwl/devkit | @nx/devkit |
| @nrwl/esbuild | @nx/esbuild |
| @nrwl/expo | @nx/expo |
| @nrwl/express | @nx/express |
| @nrwl/gatsby | @nx/gatsby |
| @nrwl/jest | @nx/jest |
| @nrwl/js | @nx/js |
| @nrwl/nest | @nx/nest |
| @nrwl/netlify | @nx/netlify |
| @nrwl/next | @nx/next |
| @nrwl/node | @nx/node |
| @nrwl/react | @nx/react |
| @nrwl/react-native | @nx/react-native |
| @nrwl/remix | @nx/remix |
| @nrwl/rollup | @nx/rollup |
| @nrwl/rspack | @nx/rspack |
| @nrwl/storybook | @nx/storybook |
| @nrwl/vite | @nx/vite |
| @nrwl/web | @nx/web |
| @nrwl/webpack | @nx/webpack |
| @nrwl/workspace | @nx/workspace |
## @nrwl Scope End of Life
Starting in version 20, the `@nrwl` scoped packages will no longer be published to npm. Only the `@nx` scoped packages will be available on the npm registry.