@nx/eslint:lint

ESLint Lint Target.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

Linter can be configured in multiple ways. The basic way is to provide only lintFilePatterns, which is a mandatory property. This tells us where to look for files to lint.

project.json:

"lint": {
  "executor": "@nx/eslint:lint",
  "options": {
    "lintFilePatterns": ["apps/frontend/**/*.ts"]
  }
}

Examples

Linter provides an automated way of fixing known issues. To ensure that those changes are properly cached, we need to add an outputs property to the lint target. Omitting the outputs property would produce an invalid cache record. Both of these properties are set by default when scaffolding a new project.

"lint": {
  "executor": "@nx/eslint:lint",
  "outputs": ["{options.outputFile}"],
  "options": {
    "lintFilePatterns": ["apps/frontend/**/*.ts"]
  }
}

With these settings, we can run the command with a --fix flag:

nx run frontend:lint --fix

We can also set this flag via project configuration to always fix files when running lint:

"lint": {
  "executor": "@nx/eslint:lint",
  "outputs": ["{options.outputFile}"],
  "options": {
    "lintFilePatterns": ["apps/frontend/**/*.ts"],
    "fix": true
  }
}

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Options

eslintConfig

string

The name of the ESLint configuration file.

format

anyOf [string, string]

Default: stylish

ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).

fix

boolean

Default: false

Fixes linting errors (may overwrite linted files).

quiet

boolean

Default: false

Report errors only - default: false.

cache

boolean

Default: false

Only check changed files.

cacheLocation

string

Path to the cache file or directory.

cacheStrategy

string

Default: metadata

Accepted values: metadata, content

Strategy to use for detecting changed files in the cache.

errorOnUnmatchedPattern

boolean

Default: true

When set to false, equivalent of the --no-error-on-unmatched-pattern flag on the ESLint CLI.

force

boolean

Default: false

Succeeds even if there was linting errors.

hasTypeAwareRules

boolean

When set to true, the linter will invalidate its cache when any of its dependencies changes.

ignorePath

string

The path of the .eslintignore file. Not supported for Flat Config.

lintFilePatterns

Array<string>

Default: [{projectRoot}]

One or more files/dirs/globs to pass directly to ESLint's lintFiles() method.

maxWarnings

number

Default: -1

Number of warnings to trigger nonzero exit code - default: -1.

noEslintrc

boolean

Default: false

The equivalent of the --no-eslintrc flag on the ESLint CLI, it is false by default.

outputFile

string

File to write report to.

printConfig

string

The equivalent of the --print-config flag on the ESLint CLI.

rulesdir

Array<string>

Default: []

The equivalent of the --rulesdir flag on the ESLint CLI.

resolvePluginsRelativeTo

string

The equivalent of the --resolve-plugins-relative-to flag on the ESLint CLI. Not supported for Flat Config.

reportUnusedDisableDirectives

string

Accepted values: off, warn, error

The equivalent of the --report-unused-disable-directives flag on the ESLint CLI.

silent

boolean

Default: false

Hide output text.