Inputs and Named Inputs
When Nx computes the hash for a given operation, it takes into account the inputs of the target. The inputs are a list of file sets, runtime inputs and environment variables that affect the output of the target. If any of the inputs change, the cache is invalidated and the target is re-run.
Types of Inputs
Nx can consider the following types of Inputs when computing the hash for a given operation.
Project Configuration
Nx always considers the configuration of the project of a task and its dependencies when calculating the hash of a task.
Command Arguments
Passing different arguments to an Nx command will often change the behavior of a task. Nx will filter out arguments which are for Nx itself and do not have any effect on running of tasks such as --parallel or --projects.
For example, running nx build myreactapp --prod will not reuse the cached output of running nx build myreactapp.
Source Files
Changing source code will often change the behavior of a task. Nx can consider the contents of files matching a pattern when calculating the computation hash. Source file inputs are defined like this:
1"inputs": {
2 "{projectRoot}/**/*", // All files in a project
3 "{workspaceRoot}/.gitignore", // A specific file in the workspace
4 "{projectRoot}/**/*.ts", // A glob pattern for files
5 "!{projectRoot}/**/*.spec.ts", // Excluding files matching a glob pattern
6}
7Source file inputs must be prefixed with either {projectRoot} or {workspaceRoot} to distinguish where the paths should be resolved from.
Prefixing a source file input with ! will exclude the files matching the pattern from the set of files used to calculate the hash. Prefixing a source file input with ^ means this entry applies to the project dependencies of the project, not the project itself.
By default, Nx will use all files in a project as well as all files in the project's dependencies when computing a hash for tasks belonging to the project. This may cause Nx to rerun some tasks even when files irrelevant to the task have changed but it ensures that by default, Nx always re-runs the task when it should.
See the Common Input Sets section to see some common examples of source file inputs
Environment Variables
Tools and scripts will often use some environment variables to change their behavior. Nx can consider the value of environment variables when calculating the computation hash in order to invalidate the cache if the environment variable value changes. Environment variable inputs are defined like this:
1"inputs": [
2 { "env": "API_KEY" } // this will include the value of $API_KEY in the cache hash
3]
4Runtime Inputs
You can use a Runtime input to provide a script which will output the information you want to include in the computation hash. Runtime inputs are defined like this:
1"inputs": [
2 { "runtime": "node --version" }
3]
4This kind of input is often used to include versions of tools used to run the task. You should ensure that these scripts work on any platform where the workspace is used. Avoid using .sh or .bat files as these will not work across Windows and *nix operating systems.
External Dependencies
Source code often imports from external dependencies installed through package managers. For example, a React application will likely import react. It is not needed to configure those externalDependencies directly. Nx will always consider external dependencies depended upon by any source code within the project.
External dependencies can also be tools used to run tasks. Updating the versions of those tools will change the behavior of those tasks. External dependencies inputs are defined like this:
1"inputs": [
2 { "externalDependencies": ["jest"] }
3]
4By default, if no external dependencies inputs are specified, Nx will include the hash of all external dependencies of the workspace in the computation hash. For many targets, Nx does not know which external dependencies are used and which are not. By considering all external dependencies, Nx will always re-run tasks when necessary even though in some cases, it might have been able to restore from cache.
For example, when defining a target to run eslint ., Nx does not know which ESLint plugins are used by the eslint config. To be safe, it will consider all external dependencies, including all ESLint plugins, to ensure that the lint task is re-run when any of the plugins have been updated. The drawback of this assumption is that Nx will re-run the lint task even when external dependencies not used by ESLint are updated.
1"targets": {
2 "lint": {
3 "command": "eslint ."
4 }
5}
6This default behavior can be overridden by adding any external dependency inputs and enables Nx to use cached results more often.
1"targets": {
2 "lint": {
3 "command": "eslint .",
4 "inputs": [
5 "default",
6 { "externalDependencies": ["eslint", "eslint-config-airbnb"] }
7 ]
8 }
9}
10Targets which use an executor from a Nx Plugin maintained by the Nx Team will have the correct set of external dependencies considered when calculating the hash.
Outputs of Dependent Tasks
When a task depends on another task, it is possible that the outputs of the dependent task will affect the behavior of the task. The Nx caching mechanism can consider the contents of files produced by dependent tasks that match a pattern. Use outputs of dependent tasks as inputs like this:
1"inputs": [
2 { "dependentTasksOutputFiles": "**/*.d.ts" },
3 { "dependentTasksOutputFiles": "**/*.d.ts", "transitive": true }
4]
5The pattern will be matched with outputs of tasks which this task depends on. Setting transitive to true will also include outputs of all task dependencies of this task in the task pipeline.
A subset of the root tsconfig.json or tsconfig.base.json
When a root tsconfig.json or tsconfig.base.json is present, Nx will always consider parts of the file which apply to the project of a task being run. This includes the full compilerOptions section and particular path mappings in the compilerOptions.paths property. This allows Nx to to not invalidate every single task when a path mapping is added or removed from the root tsconfig.json file
Named Inputs
Many tasks will utilize the same sets of inputs with minor differences. Nx allows you to define these sets in the namedInputs section of the nx.json file.
These sets of inputs can then be referenced and reused in the inputs array of targets. You can think of these as variables which can be used in the inputs array.
Named Inputs can be defined for the entire workspace in nx.json or for a specific project in project.json/package.json.
Workspace Level Named Inputs
Named inputs defined in nx.json can be used by any project in the workspace in the inputs array. The following example shows how to define named inputs for the entire workspace in nx.json.
1{
2 "namedInputs": {
3 "default": ["{projectRoot}/**/*"] // Default Inputs
4 }
5}
6Project Level Named Inputs
Named inputs defined in package.json or project.json define the value of the named input for tasks belonging to that specific project.
Naming a set of inputs with the same name as a set of inputs defined for the workspace in nx.json will override the meaning of that set for the project.
1{
2 "namedInputs": {
3 "default": ["{projectRoot}/**/*", "sharedGlobals"], // Default Inputs
4 "production": ["default", "!{projectRoot}/jest.config.ts"], // Production Inputs
5 "sharedGlobals": [] // Shared Global Inputs
6 },
7 "targets": { ... }
8}
9Named Input Conventions
By default, Nx Workspaces are generated with the following named inputs:
1{
2 "namedInputs": {
3 "default": ["{projectRoot}/**/*", "sharedGlobals"], // Default Inputs
4 "production": ["default", "!{projectRoot}/jest.config.ts"], // Production Inputs
5 "sharedGlobals": [] // Shared Global Inputs
6 },
7 "targetDefaults": {
8 "inputs": ["default", "^default"]
9 }
10}
11The above inputs follow a convention that Nx recommends for named inputs. Nx generates these by default but you can also introduce your own conventions.
Default Inputs
The default inputs include all files in a project as well as any shared global inputs which should be considered for all tasks. Defaulting to the set of everything that matters ensures that Nx will always re-run tasks when necessary by default.
Shared Global Inputs
The sharedGlobal inputs include things that Nx should always look at when determining computation hashes. For instance, this could be the OS where the command is being run or the version of Node.
Production Inputs
The production inputs only include the set of files in a project which will affect behavior of the project in production. For instance, the main.ts of an application will be compiled as the main application logic and will affect the end user experience while files such as .eslintrc.json only affect the tools used by the developers and have no direct impact on the end user experience. In general, it is best to define the production inputs as the default inputs (everything) excluding the specific files which are known not to affect end user experience. This makes it so that by default, all files are considered to affect end user behavior unless excluded from the production fileset.
Using Named Inputs on Project Dependencies
It is common for most tasks to consider a set of inputs for the project it belongs to and a set of inputs for dependencies of the project. For instance, running the tests of a project should consider all files of the project being tested but only production files of its dependencies. The following inputs configuration uses named inputs in two different ways:
1{
2 "name": "myreactapp",
3 "targets": {
4 "test": {
5 "inputs": ["default", "^production", "{projectRoot}/jest.config.js"]
6 }
7 }
8}
9defaulttells Nx to consider all files within the project root ofmyreactappwhen running thetesttask.^productionis prefixed with^and applies the to projects whichmyreactappdepends on.- You can add other modifications to the inputs set directly without defining them as named inputs.
All of the above inputs are taken into consideration when the following command is run:
❯
nx test myreactapp