nx.json

The nx.json file configures the Nx CLI and project defaults. The full machine readable schema is available on GitHub.

The following is an expanded example showing all options. Your nx.json will likely be much shorter.

nx.json
{
  "plugins": [
    {
      "plugin": "@nx/eslint/plugin",
      "options": {
        "targetName": "lint"
      }
    }
  ],
  "parallel": 4,
  "cacheDirectory": "tmp/my-nx-cache",
  "defaultBase": "main",
  "namedInputs": {
    "default": ["{projectRoot}/**/*"],
    "production": ["!{projectRoot}/**/*.spec.tsx"]
  },
  "targetDefaults": {
    "@nx/js:tsc": {
      "inputs": ["production", "^production"],
      "dependsOn": ["^build"],
      "options": {
        "main": "{projectRoot}/src/index.ts"
      },
      "cache": true
    },
    "test": {
      "cache": true,
      "inputs": ["default", "^production", "{workspaceRoot}/jest.preset.js"],
      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
      "executor": "@nx/jest:jest"
    }
  },
  "release": {
    "version": {
      "generatorOptions": {
        "currentVersionResolver": "git-tag",
        "specifierSource": "conventional-commits"
      }
    },
    "changelog": {
      "git": {
        "commit": true,
        "tag": true
      },
      "workspaceChangelog": {
        "createRelease": "github"
      },
      "projectChangelogs": true
    }
  },
  "generators": {
    "@nx/js:library": {
      "buildable": true
    }
  },
  "extends": "nx/presets/npm.json"
}

Plugins

Nx plugins improve the experience of using different tools with Nx. One key feature of plugins is that they can automatically configure the way Nx runs tasks for a tool based on that tool's configuration. In order for a plugin to configure tasks for Nx, it needs to be registered in the plugins array. If a plugin has no options, it can be listed as a string. Otherwise, it should be listed as an object with a plugin property and an options property.

Every plugin behaves differently, so consult the plugin's own documentation for information about what it does. You can browse the plugin registry for available plugins.

To learn about creating your own plugin read about extending Nx.

nx.json
{
  "plugins": [
    "@my-org/graph-plugin",
    {
      "plugin": "@nx/eslint/plugin",
      "options": {
        "targetName": "lint"
      }
    }
  ]
}

Task Options

The following properties affect the way Nx runs tasks and can be set at the root of nx.json.

Property	Description
parallel	defines the max number of targets run in parallel
captureStderr	defines whether the cache captures stderr or just stdout
skipNxCache	defines whether the Nx Cache should be skipped (defaults to `false`)
cacheDirectory	defines where the local cache is stored (defaults to `.nx/cache`)
encryptionKey	(when using `"nx-cloud"` only) defines an encryption key to support end-to-end encryption of your cloud cache. You may also provide an environment variable with the key `NX_CLOUD_ENCRYPTION_KEY` that contains an encryption key as its value. The Nx Cloud task runner normalizes the key length, so any length of key is acceptable
selectivelyHashTsConfig	only hash the path mapping of the active project in the `tsconfig.base.json` (e.g., adding/removing projects doesn't affect the hash of existing projects) (defaults to `false`)

You can configure parallel in nx.json, but you can also set a --parallel flag in the terminal nx run-many -t test --parallel=5.

Multiple Tasks Runners

Tasks runners are invoked when you run nx test, nx build, nx run-many, nx affected, and so on.

There is a tasks runner created from the task options defined at the root of nx.json named default. You can register another tasks runner by adding it to nx.json like this:

nx.json
{
  "tasksRunnerOptions": {
    "another": {
      "runner": "nx/tasks-runners/default",
      "options": {}
    }
  }
}

Then you can run a task with the new runner using the --runner flag:

❯

nx run-many -t build --runner=another

The official types of runner supported by Nx are "nx/tasks-runners/default" and "nx-cloud".

Default Base

Tells Nx which base branch to use when calculating affected projects.

defaultBase defines the default base branch, defaults to main.

Target Defaults

Target defaults provide ways to set common options for a particular target in your workspace. When building your project's configuration, we merge it with up to 1 default from this map. For a given target, we look at its name and its executor. We then check target defaults looking for a configuration whose key matches any of the following:

`${executor}`
`${targetName}` (if the configuration specifies the executor, this needs to match the target's executor as well)

Target defaults matching the executor takes precedence over those matching the target name. If we find a target default for a given target, we use it as the base for that target's configuration.

Beware

When using a target name as the key of a target default, make sure all the targets with that name use the same executor or that the target defaults you're setting make sense to all targets regardless of the executor they use. Anything set in a target default will also override the configuration of tasks inferred by plugins.

Some common scenarios for this follow.

inputs & namedInputs

Named inputs defined in nx.json are merged with the named inputs defined in project level configuration. In other words, every project has a set of named inputs, and it's defined as: {...namedInputsFromNxJson, ...namedInputsFromProjectsProjectJson}.

Defining inputs for a given target would replace the set of inputs for that target name defined in nx.json. Using pseudocode inputs = projectJson.targets.build.inputs || nxJson.targetDefaults.build.inputs.

You can also define and redefine named inputs. This enables one key use case, where your nx.json can define things like this (which applies to every project):

nx.json
{
  "targetDefaults": {
    "test": {
      "inputs": ["default", "^production"]
    }
  }
}

And projects can define their production inputs, without having to redefine the inputs for the test target.

project.json
{
  "namedInputs": {
    "production": ["default", "!{projectRoot}/**/*.test.js"]
  }
}

In this case Nx will use the right production input for each project.

Inputs and Named Inputs Reference

Learn about all the possible settings for `inputs` and `namedInputs`

Configure Inputs for Task Caching

This recipes walks you through a few examples of how to configure `inputs` and `namedInputs`

Task Pipelines

Targets can depend on other targets. A common scenario is having to build dependencies of a project first before building the project. The dependsOn property in project.json can be used to define the list of dependencies of an individual target.

Often the same dependsOn configuration has to be defined for every project in the repo, and that's when defining targetDefaults in nx.json is helpful.

nx.json
{
  "targetDefaults": {
    "build": {
      "dependsOn": ["^build"]
    }
  }
}

The configuration above is identical to adding {"dependsOn": ["^build"]} to every build target of every project.

Project Configuration reference

For full documentation of the `dependsOn` property, see the project configuration reference

What is a Task Pipeline

This guide describes how to think about task pipelines

Outputs

Another target default you can configure is outputs:

nx.json
{
  "targetDefaults": {
    "build": {
      "outputs": ["{projectRoot}/custom-dist"]
    }
  }
}

When defining any options or configurations inside of a target default, you may use the {workspaceRoot} and {projectRoot} tokens. This is useful for defining options whose values are paths.

nx.json
{
  "targetDefaults": {
    "@nx/js:tsc": {
      "options": {
        "main": "{projectRoot}/src/index.ts"
      },
      "configurations": {
        "prod": {
          "tsconfig": "{projectRoot}/tsconfig.prod.json"
        }
      },
      "inputs": ["prod"],
      "outputs": ["{workspaceRoot}/{projectRoot}"]
    },
    "build": {
      "inputs": ["prod"],
      "outputs": ["{workspaceRoot}/{projectRoot}"],
      "cache": true
    }
  }
}

Target Default Priority

Note that the inputs and outputs are specified on both the @nx/js:tsc and build default configurations. This is required, as when reading target defaults Nx will only ever look at one key. If there is a default configuration based on the executor used, it will be read first. If not, Nx will fall back to looking at the configuration based on target name. For instance, running nx build project will read the options from targetDefaults[@nx/js:tsc] if the target configuration for build uses the @nx/js:tsc executor. It would not read any of the configuration from the build target default configuration unless the executor does not match.

Configure Outputs for Task Caching

This recipe walks you through how to set outputs

Cache

In Nx 17 and higher, caching is configured by specifying "cache": true in a target's configuration. This will tell Nx that it's ok to cache the results of a given target. For instance, if you have a target that runs tests, you can specify "cache": true in the target default configuration for test and Nx will cache the results of running tests.

nx.json
{
  "targetDefaults": {
    "test": {
      "cache": true
    }
  }
}

Per Project Caching + Distribution

If you are using distributed task execution and disable caching for a given target, you will not be able to use distributed task execution for that target. This is because distributed task execution requires caching to be enabled. This means that the target you have disabled caching for, and any targets which depend on that target will fail the pipeline if you try to run them with Nx Agents enabled.

Executor/command options

You can configure options specific to a target's executor. As an example, if your repo has projects using the @nx/js:tsc executor, you can provide some default options as follows:

nx.json
{
  "targetDefaults": {
    "@nx/js:tsc": {
      "options": {
        "generateExportsField": true
      }
    }
  }
}

You can also provide defaults for inferred targets or targets running a command using the nx:run-commands executor. As an example, if your repo has projects where all the build targets run the same vite build command, you can provide some default options as follows:

nx.json
{
  "targetDefaults": {
    "build": {
      "options": {
        "assetsInlineLimit": 2048,
        "assetsDir": "static/assets"
      }
    }
  }
}

Be careful

If multiple targets with the same name run different commands (or use different executors), do not set options in targetDefaults. Different commands would accept different options, and the target defaults will apply to all targets with the same name regardless of the command they run. If you were to provide options in targetDefaults for them, the commands that don't expect those options could throw an error.

For more details on how to pass args to the underlying command see the Pass Args to Commands recipe.

Release

The release property in nx.json configures the nx release command. It is an optional property, as nx release is capable of working with zero config, but when present it is used to configure the versioning, changelog, and publishing phases of the release process.

For more information on how nx release works, see manage releases.

The full list of configuration options available for "release" can be found here: https://github.com/nrwl/nx/blob/master/packages/nx/src/config/nx-json.ts under NxReleaseConfiguration.

Projects

If you want to limit the projects that nx release targets, you can use the projects property in nx.json to do so. This property is either a string, or an array of strings. The strings can be project names, glob patterns, directories, tag references or anything else that is supported by the --projects filter you may know from other commands such as nx run.

nx.json
{
  "release": {
    // Here we are configuring nx release to target all projects
    // except the one called "ignore-me"
    "projects": ["*", "!ignore-me"]
  }
}

Projects Relationship

The projectsRelationship property tells Nx whether to release projects independently or together. By default Nx will release all your projects together in lock step, which is an equivalent of "projectRelationships": "fixed". If you want to release projects independently, you can set "projectsRelationship": "independent".

nx.json
{
  "release": {
    // Here we are configuring nx release to release projects
    // independently, as opposed to the default of "fixed"
    "projectsRelationship": "independent"
  }
}

Release Tag Pattern

Optionally override the git/release tag pattern to use. This field is the source of truth for changelog generation and release tagging, as well as for conventional commits parsing.

It supports interpolating the version as {version} and (if releasing independently or forcing project level version control system releases) the project name as {projectName} within the string.

The default "releaseTagPattern" for fixed/unified releases is: v{version}

The default "releaseTagPattern" for independent releases at the project level is: {projectName}@{version}

nx.json
{
  "release": {
    // Here we are configuring nx release to use a custom release
    // tag pattern (we have dropped the v prefix from the default)
    "releaseTagPattern": "{version}"
  }
}

Version

The version property configures the versioning phase of the release process. It is used to determine the next version of your projects, and update any projects that depend on them to use the new version.

Behind the scenes, the version logic is powered by an Nx generator. Out of the box Nx wires up the most widely applicable generator implementation for you, which is @nx/js:release-version provided by the @nx/js plugin.

It is therefore a common requirement to be able to tweak the options given to that generator. This can be done by configuring the release.version.generatorOptions property in nx.json:

nx.json
{
  "release": {
    "version": {
      "generatorOptions": {
        // Here we are configuring the generator to use git tags as the
        // source of truth for a project's current version
        "currentVersionResolver": "git-tag",
        // Here we are configuring the generator to use conventional
        // commits as the source of truth for how to determine the
        // relevant version bump for the next version
        "specifierSource": "conventional-commits"
      }
    }
  }
}

For a full reference of the available options for the @nx/js:release-version generator, see the release version generator reference.

Changelog

The changelog property configures the changelog phase of the release process. It is used to generate a changelog for your projects, and commit it to your repository.

There are two types of possible changelog that can be generated:

Workspace Changelog: A changelog that contains all changes across all projects in your workspace. This is not applicable when releasing projects independently.
Project Changelogs: A changelog that contains all changes for a given project.

The changelog property is used to configure both of these changelogs.

Workspace Changelog

The changelog.workspaceChangelog property configures the workspace changelog. It is used to determine if and how the workspace changelog is generated.

nx.json
{
  "release": {
    "changelog": {
      // This disables the workspace changelog
      "workspaceChangelog": false
    }
  }
}

nx.json
{
  "release": {
    "changelog": {
      "workspaceChangelog": {
        // This will create a GitHub release containing the workspace
        // changelog contents
        "createRelease": "github",
        // This will disable creating a workspace CHANGELOG.md file
        "file": false
      }
    }
  }
}

Project Changelogs

The changelog.projectChangelogs property configures the project changelogs. It is used to determine if and how the project changelogs are generated.

nx.json
{
  "release": {
    "changelog": {
      // This enables project changelogs with the default options
      "projectChangelogs": true
    }
  }
}

nx.json
{
  "release": {
    "changelog": {
      "projectChangelogs": {
        // This will create one GitHub release per project containing
        // the project changelog contents
        "createRelease": "github",
        // This will disable creating any project level CHANGELOG.md
        // files
        "file": false
      }
    }
  }
}

Git

The git property configures the automated git operations that take place as part of the release process.

nx.json
{
  "release": {
    "git": {
      // This will enable committing any changes (e.g. package.json
      // updates, CHANGELOG.md files) to git
      "commit": true,
      // This will enable create a git for the overall release, or
      // one tag per project for independent project releases
      "tag": false
    }
  }
}

Generators

Default generator options can be configured in nx.json. For instance, the following tells Nx to always pass --buildable=true when creating new libraries with the @nx/js plugin.

nx.json
{
  "generators": {
    "@nx/js:library": {
      "buildable": true
    }
  }
}

Extends

Some presets use the extends property to hide some default options in a separate json file. The json file specified in the extends property is located in your node_modules folder. The Nx preset files are specified in the nx package.

Nx Cloud

There are also options for Nx Cloud that are set in the nx.json file. For instance, you authenticate with the Nx Cloud service using an nxCloudAccessToken like this:

nx.json
{
  "nxCloudAccessToken": "SOMETOKEN"
}

For more details on configuring Nx Cloud, see the Nx Cloud Configuration Options page.