1.3 KiB
The ESLint plugin contains executors, generator, plugin and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.
Setting Up ESLint
Installation
{% callout type="note" title="Keep Nx Package Versions In Sync" %}
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.
{% /callout %}
In any Nx workspace, you can install @nx/eslint by running the following command:
{% tabs %} {%tab label="npm"%}
npm i -D @nx/eslint
{% /tab %} {%tab label="yarn"%}
yarn add -D @nx/eslint
{% /tab %} {%tab label="pnpm"%}
pnpm add -D @nx/eslint
{% /tab %} {% /tabs %}
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.