nx-rescope v1.0.6
nx-rescope
The nx-rescope tool is designed to assist you in migrating your workspace to the new scope format introduced in Nx version 16. This update involved transitioning the @nrwl packages to the @nx scope. To learn more about this change, refer to the official documentation.
Usage
npx nx-rescopeWarning
Nx already has a built-in command to apply these migrations
nx migrate latest
npx nx migrate --run-migrations --create-commitsWhat does it do?
The nx-rescope tool will do the following:
- Update the
@nrwldependencies to@nx - Update the
@nrwldevDependencies to@nx - Update the
@nrwlpeerDependencies to@nx - Update the
@nrwloverrides to@nx(if the--update-overridesoption is enabled) - Install the new dependencies using your preferred package manager
You can check the current supported rescope/rename packages here.
What does it NOT do?
While the nx-rescope tool assists in migrating your workspace to the new scope format, it does not perform the following actions:
- Update the version of the
@nrwl/@nxpackages. It focuses on updating the scope format rather than upgrading the package versions (usenx migrate latestinstead). - Update the
package.jsonfiles of your individual projects. Only the workspace'spackage.jsonfile will be updated during the migration. - Modify other configuration files such as
tsconfig.json,jest.config.js, etc. The tool solely focuses on updating the workspace'spackage.jsonfile.
It's important to note that you may need to handle these aspects manually if necessary.
What is the recommended approach?
The recommended approach is to use the nx-rescope tool in conjunction with the nx migrate latest command. This will ensure that your workspace is up-to-date with the latest version of Nx and that the scope format is updated accordingly.
To make sure that your workspace is ready for the migration, you can run the following commands in sequence:
nx migrate latestThen use your package manager of choice to install the new dependencies, and to make sure you are using the latest version of Nx or at least the version 16.0.0:
npm install
# or
yarn install
# or
pnpm installFinally, run the nx-rescope tool to update the scope format:
npx nx-rescopeOptions
| Option | Description |
|---|---|
--help | Display a help message |
--dry-run | By using this option, the tool will perform a dry run, meaning it will simulate the changes without modifying the package.json file or installing new dependencies. |
--force | If you encounter any conditions that prevent the execution of the script, you can use the --force option to override these conditions and force the tool to proceed. |
--update-overrides | Enabling this option will update the overrides section of the package.json file, ensuring that it aligns with the new scope format. |
--skip-install | If you don't want the tool to automatically install the new dependencies, you can utilize the --skip-install option. This is useful if you prefer to handle the installation manually. |
Feel free to modify and enhance this readme file according to your specific project requirements.