Adding Nx to NPM/Yarn/PNPM Workspace

Migrating from Lerna?

Interested in migrating from Lerna in particular? In case you missed it, Lerna v6 is powering Nx underneath. As a result, Lerna gets all the modern features such as caching and task pipelines. Read more on https://lerna.js.org/upgrade.

Nx has first-class support for monorepos. As a result, if you have an existing NPM/Yarn or PNPM-based monorepo setup, you can easily add Nx to get

fast task scheduling
support for task pipelines
caching
remote caching with Nx Cloud
distributed task execution with Nx Cloud

This is a low-impact operation because all that needs to be done is to install the nx package at the root level and add an nx.json for configuring caching and task pipelines.

Installing Nx

Run the following command to automatically set up Nx:

❯

npx nx@latest init

This will set up Nx for you - updating the package.json file and creating a new nx.json file with Nx configuration based on your answers during the set up process. The set up process will suggest installing Nx plugins that might be useful based on your existing repository. The example below is using the @nx/eslint and @nx/next plugins to run ESLint and Next.js tasks with Nx:

nx.json
{
  "plugins": [
    {
      "plugin": "@nx/eslint/plugin",
      "options": {
        "targetName": "lint"
      }
    },
    {
      "plugin": "@nx/next/plugin",
      "options": {
        "buildTargetName": "build",
        "devTargetName": "dev",
        "startTargetName": "start"
      }
    }
  ]
}

When Nx updates your package.json scripts, it looks for scripts that can be replaced with an Nx command that has caching automatically enabled. The package.json defined above would be updated to look like this:

package.json
{
  "name": "my-workspace",
  ...
  "scripts": {
    "build": "nx build",
    "lint": "nx lint",
    "test": "node ./run-tests.js"
  },
  ...
  "nx": {
    "includedScripts": []
  }
}

The @nx/next plugin can run next build for you and set up caching correctly, so it replaces next build with nx build. Similarly, @nx/eslint can set up caching for eslint ./src. When you run npm run build or npm run lint multiple times, you'll see that caching is enabled. You can also call Nx directly from the terminal with nx build or nx lint.

The test script was not recognized by any Nx plugin, so it was left as is.

The includedScripts array allows you to specify package.json scripts that can be run with the nx build syntax.

Inferred Tasks

You may have noticed that @nx/next provides dev and start tasks in addition to the build task. Those tasks were created by the @nx/next plugin from your existing Next.js configuration. To view all available tasks, open the Project Details view with Nx Console or use the terminal to launch the project details in a browser window.

❯

nx show project my-workspace --web

Project Details View

my-workspace

Root: .

Type: Library

Targets

lint
eslint ./src
Cacheable
build
next build
Cacheable
dev
next dev
start
next start

The project detail view lists all available tasks, the configuration values for those tasks and where those configuration values are being set.

Configure an Existing Script to Run with Nx

If you want to run one of your existing scripts with Nx, you need to tell Nx about it.

Preface the script with nx exec -- to have npm run test invoke the command with Nx.
Add the script to includedScripts.
Define caching settings.

The nx exec command allows you to keep using npm test or npm run test (or other package manager's alternatives) as you're accustomed to. But still get the benefits of making those operations cacheable. Configuring the test script from the example above to run with Nx would look something like this:

package.json
{
  "name": "my-workspace",
  ...
  "scripts": {
    "build": "nx build",
    "lint": "nx lint",
    "test": "nx exec -- node ./run-tests.js"
  },
  ...
  "nx": {
    "includedScripts": ["test"],
    "targets": {
      "test": {
        "cache": "true",
        "inputs": ["default", "^default"],
        "outputs": []
      }
    }
  }
}

Now if you run npm run test or nx test twice, the results will be retrieved from the cache. The inputs used in this example are as cautious as possible, so you can significantly improve the value of the cache by customizing Nx Inputs for each task.

Incrementally Adopting Nx

All the features of Nx can be enabled independently of each other. Hence, Nx can easily be adopted incrementally by initially using Nx just for a subset of your scripts and then gradually adding more.

For example, use Nx to run your builds:

❯

npx nx run-many -t build

But instead keep using NPM/Yarn/PNPM workspace commands for your tests and other scripts. Here's an example of using PNPM commands to run tests across packages

❯

pnpm run -r test

This allows for incrementally adopting Nx in your existing workspace.

Learn More

Cache Task Results

Learn more about how caching works

Task Pipeline Configuration

Learn more about how to setup task dependencies

Nx Ignore

Learn about how to ignore certain projects using .nxignore

Nx and Turbo

Read about how Nx compares to Turborepo

Integrated Repos vs Package-Based Repos

Learn about two styles of monorepos.