@nx/eslint

The ESLint plugin contains executors, generator, plugin and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.

Setting Up ESLint

Installation

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.

In any Nx workspace, you can install @nx/eslint by running the following commands if @nx/eslint package is not installed:

npm i --save-dev @nx/eslint

Nx 15 and lower use @nrwl/ instead of @nx/

yarn add --dev @nx/eslint

Nx 15 and lower use @nrwl/ instead of @nx/

Lint

You can lint an application or a library with the following command:

nx lint my-app

nx lint my-lib

Utils

ESLint plugin

Read about our dedicated ESLint plugin - eslint-plugin-nx.

Package reference

Here is a list of all the executors and generators available from this package.

Guides

Executors

  • lint

    Run ESLint on a project.

Generators