The ESLint plugin integrates ESLint with Nx. It allows you to run ESLint through Nx with caching enabled. It also includes code generators to help you set up ESLint in your workspace.
Setting Up @nx/eslint
Installation
Make sure to install the @nx/eslint version that matches the version of nx in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
In any Nx workspace, you can install @nx/eslint by running the following command:
❯
nx add @nx/eslint
This will install the correct version of @nx/eslint.
How @nx/eslint Infers Tasks
The @nx/eslint plugin will create a task for any project that has an ESLint configuration file present and files to lint. Any of the following files will be recognized as an ESLint configuration file:
.eslintrc.eslintrc.js.eslintrc.cjs.eslintrc.yaml.eslintrc.yml.eslintrc.jsoneslint.config.js
Because ESLint applies configuration files to all subdirectories, the @nx/eslint plugin will also infer tasks for projects in subdirectories. So, if there is an ESLint configuration file in the root of the repository, every project will have an inferred ESLint task.
Even if a project has an ESLint configuration file, it will only have an inferred ESLint task if there are files to lint. Otherwise, the task will not be created. Therefore, if you don't want an ESLint task to be inferred for a particular project, make sure the project files are properly excluded from ESLint.
View Inferred Tasks
To view inferred tasks for a project, open the project details view in Nx Console or run nx show project my-project --web in the command line.
@nx/eslint Configuration
The @nx/eslint/plugin is configured in the plugins array in nx.json.
1{
2 "plugins": [
3 {
4 "plugin": "@nx/eslint/plugin",
5 "options": {
6 "targetName": "lint"
7 }
8 }
9 ]
10}
11- The
targetNameoption controls the name of the inferred ESLint tasks. The default name islint.
Lint
You can lint an application or a library with the following command:
❯
nx lint my-project
Utils
- convert-to-flat-config - Converts the workspace's ESLint configs to the new Flat Config
ESLint plugin
Read about our dedicated ESLint plugin - eslint-plugin-nx.