Back to Eslint

Command Line Interface Reference

docs/src/use/command-line-interface.md

10.3.034.5 KB
Original Source

{%- from 'components/npm_tabs.macro.html' import npm_tabs with context %} {%- from 'components/npx_tabs.macro.html' import npx_tabs %}

The ESLint Command Line Interface (CLI) lets you execute linting from the terminal. The CLI has a variety of options that you can pass to configure ESLint.

Run the CLI

ESLint requires Node.js for installation. Follow the instructions in the Getting Started Guide to install ESLint.

Most users use npx to run ESLint on the command line like this:

{{ npx_tabs ({ package: "eslint", args: ["[options]", "[file|dir|glob]*"] }) }}

Such as:

{{ npx_tabs ({ package: "eslint", args: ["file1.js", "file2.js"], comment: "Run on two files" }) }}

or

{{ npx_tabs ({ package: "eslint", args: ["lib/**"], comment: "Run on multiple files" }) }}

Please note that when passing a glob as a parameter, it is expanded by your shell. The results of the expansion can vary depending on your shell, and its configuration. If you want to use node glob syntax, you have to quote your parameter (using double quotes if you need it to run in Windows), as follows:

{{ npx_tabs ({ package: "eslint", args: [""lib/**""] }) }}

You can also omit the file arguments and ESLint will use .. For instance, these two lines perform the same operation:

{{ npx_tabs ({ package: "eslint", args: ["."] }) }}

{{ npx_tabs ({ package: "eslint", args: [] }) }}

Note: You can also use alternative package managers such as Yarn or pnpm to run ESLint. For pnpm use pnpm dlx eslint and for Yarn use yarn dlx eslint.

Pass Multiple Values to an Option

Options that accept multiple values can be specified by repeating the option or with a comma-delimited list (other than --ignore-pattern, which does not allow the second style).

Examples of options that accept multiple values:

{{ npx_tabs ({ package: "eslint", args: ["--global", "describe", "--global", "it", "tests/"] }) }}

OR

{{ npx_tabs ({ package: "eslint", args: ["--global", "describe,it", "tests/"] }) }}

Options

You can view all the CLI options by running npx eslint -h.

txt
eslint [options] file.js [file.js] [dir]

Basic configuration:
  --no-config-lookup               Disable look up for eslint.config.js
  -c, --config path::String        Use this configuration instead of eslint.config.js, eslint.config.mjs, or eslint.config.cjs
  --inspect-config                 Open the config inspector with the current configuration
  --ext [String]                   Specify additional file extensions to lint
  --global [String]                Define global variables
  --parser String                  Specify the parser to be used
  --parser-options Object          Specify parser options

Specify Rules and Plugins:
  --plugin [String]                Specify plugins
  --rule Object                    Specify rules

Fix Problems:
  --fix                            Automatically fix problems
  --fix-dry-run                    Automatically fix problems without saving the changes to the file system
  --fix-type Array                 Specify the types of fixes to apply (directive, problem, suggestion, layout)

Ignore Files:
  --no-ignore                      Disable use of ignore files and patterns
  --ignore-pattern [String]        Patterns of files to ignore

Use stdin:
  --stdin                          Lint code provided on <STDIN> - default: false
  --stdin-filename String          Specify filename to process STDIN as

Handle Warnings:
  --quiet                          Report errors only - default: false
  --max-warnings Int               Number of warnings to trigger nonzero exit code - default: -1

Output:
  -o, --output-file path::String   Specify file to write report to
  -f, --format String              Use a specific output format - default: stylish
  --color, --no-color              Force enabling/disabling of color

Inline configuration comments:
  --no-inline-config               Prevent comments from changing config or rules
  --report-unused-disable-directives  Adds reported errors for unused eslint-disable and eslint-enable directives
  --report-unused-disable-directives-severity String  Chooses severity level for reporting unused eslint-disable and eslint-enable directives - either: off, warn, error, 0, 1, or 2
  --report-unused-inline-configs String  Adds reported errors for unused eslint inline config comments - either: off, warn, error, 0, 1, or 2

Caching:
  --cache                          Only check changed files - default: false
  --cache-file path::String        Path to the cache file. Deprecated: use --cache-location - default: .eslintcache
  --cache-location path::String    Path to the cache file or directory
  --cache-strategy String          Strategy to use for detecting changed files in the cache - either: metadata or content - default: metadata

Suppressing Violations:
  --suppress-all                   Suppress all violations - default: false
  --suppress-rule [String]         Suppress specific rules
  --suppressions-location path::String  Specify the location of the suppressions file
  --prune-suppressions             Prune unused suppressions - default: false
  --pass-on-unpruned-suppressions  Ignore unused suppressions - default: false

Miscellaneous:
  --init                           Run config initialization wizard - default: false
  --env-info                       Output execution environment information - default: false
  --no-error-on-unmatched-pattern  Prevent errors when pattern is unmatched
  --exit-on-fatal-error            Exit with exit code 2 in case of fatal error - default: false
  --no-warn-ignored                Suppress warnings when the file list includes ignored files
  --pass-on-no-patterns            Exit with exit code 0 in case no file patterns are passed
  --debug                          Output debugging information
  -h, --help                       Show help
  -v, --version                    Output the version number
  --print-config path::String      Print the configuration for the given file
  --stats                          Add statistics to the lint report - default: false
  --flag [String]                  Enable a feature flag
  --mcp                            Start the ESLint MCP server
  --concurrency Int|String         Number of linting threads, auto to choose automatically, off for no multithreading - default: off

Basic Configuration

--no-config-lookup

Disables use of configuration from files.

  • Argument Type: No argument.
--no-config-lookup example

{{ npx_tabs ({ package: "eslint", args: ["--no-config-lookup", "file.js"] }) }}

-c, --config

This option allows you to specify an additional configuration file for ESLint (see Configure ESLint for more).

  • Argument Type: String. Path to file.
  • Multiple Arguments: No
-c, --config example

{{ npx_tabs ({ package: "eslint", args: ["-c", "~/my.eslint.config.js", "file.js"] }) }}

This example uses the configuration file at ~/my.eslint.config.js, which is used instead of searching for an eslint.config.js file.

--inspect-config

This option runs npx @eslint/config-inspector@latest to start the config inspector. You can use the config inspector to better understand what your configuration is doing and which files it applies to. When you use this flag, the CLI does not perform linting.

  • Argument Type: No argument.
--inspect-config example

{{ npx_tabs ({ package: "eslint", args: ["--inspect-config"] }) }}

--ext

This option allows you to specify additional file extensions to lint.

  • Argument Type: String. File extension.
  • Multiple Arguments: Yes
  • Default Value: By default, ESLint lints files with extensions .js, .mjs, .cjs, and additional extensions specified in the configuration file.

This option is primarily intended for use in combination with the --no-config-lookup option, since in that case there is no configuration file in which the additional extensions would be specified.

--ext example

{{ npx_tabs ({ package: "eslint", args: [".", "--ext", ".ts"], comment: "Include .ts files" }) }}

{{ npx_tabs ({ package: "eslint", args: [".", "--ext", ".ts", "--ext", ".tsx"], comment: "Include .ts and .tsx files" }) }}

{{ npx_tabs ({ package: "eslint", args: [".", "--ext", ".ts,.tsx"], comment: "Also include .ts and .tsx files" }) }}

--global

This option defines global variables so that they are not flagged as undefined by the no-undef rule.

  • Argument Type: String. Name of the global variable. Any specified global variables are assumed to be read-only by default, but appending :true to a variable's name ensures that no-undef also allows writes.
  • Multiple Arguments: Yes
--global example

{{ npx_tabs ({ package: "eslint", args: ["--global", "require,exports:true", "file.js"] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--global", "require", "--global", "exports:true"] }) }}

--parser

This option allows you to specify a parser to be used by ESLint.

  • Argument Type: String. Parser to be used by ESLint.
  • Multiple Arguments: No
  • Default Value: espree
--parser example

{{ npx_tabs ({ package: "eslint", args: ["--parser", "@typescript-eslint/parser", "file.ts"], comment: "Use TypeScript ESLint parser" }) }}

--parser-options

This option allows you to specify parser options to be used by ESLint. The available parser options are determined by the parser being used.

  • Argument Type: Key/value pair separated by colon (:).
  • Multiple Arguments: Yes
--parser-options example

{{ npx_tabs ({ package: "eslint", args: ["--stdin", "--parser-options", "ecmaVersion:6"], comment: "fails with a parsing error", previousCommands: ["echo '3 ** 4'"] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--stdin", "--parser-options", "ecmaVersion:7"], comment: "succeeds, yay!", previousCommands: ["echo '3 ** 4'"] }) }}

Specify Rules and Plugins

--plugin

This option specifies a plugin to load.

  • Argument Type: String. Plugin name. You can optionally omit the prefix eslint-plugin- from the plugin name.
  • Multiple Arguments: Yes

Before using the plugin, you have to install it using npm.

--plugin example

{{ npx_tabs ({ package: "eslint", args: ["--plugin", "jquery", "file.js"] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--plugin", "eslint-plugin-mocha", "file.js"] }) }}

--rule

This option specifies the rules to be used.

  • Argument Type: Rules and their configuration specified with levn format.
  • Multiple Arguments: Yes

These rules are merged with any rules specified with configuration files. If the rule is defined in a plugin, you have to prefix the rule ID with the plugin name and a /.

To ignore rules in configuration files and only run rules specified in the command line, use the --rule flag in combination with the --no-config-lookup flag.

--rule example

{{ npx_tabs ({ package: "eslint", args: ["--rule", "'quotes: [error, double]'"], comment: "Apply single rule" }) }}

{{ npx_tabs ({ package: "eslint", args: ["--rule", "'guard-for-in: error'", "--rule", "'brace-style: [error, 1tbs]'"], comment: "Apply multiple rules" }) }}

{{ npx_tabs ({ package: "eslint", args: ["--rule", "'jquery/dollar-sign: error'"], comment: "Apply rule from jquery plugin" }) }}

{{ npx_tabs ({ package: "eslint", args: ["--rule", "'quotes: [error, double]'", "--no-config-lookup"], comment: "Only apply rule from the command line" }) }}

Fix Problems

--fix

This option instructs ESLint to try to fix as many issues as possible. The fixes are made to the actual files themselves and only the remaining unfixed issues are output.

  • Argument Type: No argument.

Not all problems are fixable using this option, and the option does not work in these situations:

  1. This option throws an error when code is piped to ESLint.
  2. This option has no effect on code that uses a processor, unless the processor opts into allowing autofixes.

If you want to fix code from stdin or otherwise want to get the fixes without actually writing them to the file, use the --fix-dry-run option.

--fix example

{{ npx_tabs ({ package: "eslint", args: ["--fix", "file.js"] }) }}

--fix-dry-run

This option has the same effect as --fix with the difference that the fixes are not saved to the file system. Because the default formatter does not output the fixed code, you'll have to use another formatter (e.g. --format json) to get the fixes.

  • Argument Type: No argument.

This makes it possible to fix code from stdin when used with the --stdin flag.

This flag can be useful for integrations (e.g. editor plugins) which need to autofix text from the command line without saving it to the filesystem.

--fix-dry-run example

{{ npx_tabs ({ package: "eslint", args: ["--stdin", "--fix-dry-run", "--format", "json"], previousCommands: ["getSomeText"] }) }}

--fix-type

This option allows you to specify the type of fixes to apply when using either --fix or --fix-dry-run.

  • Argument Type: String. One of the following fix types:
    1. problem - fix potential errors in the code
    2. suggestion - apply fixes to the code that improve it
    3. layout - apply fixes that do not change the program structure (AST)
    4. directive - apply fixes to inline directives such as // eslint-disable
  • Multiple Arguments: Yes

This option is helpful if you are using another program to format your code, but you would still like ESLint to apply other types of fixes.

--fix-type example

{{ npx_tabs ({ package: "eslint", args: ["--fix", "--fix-type", "suggestion", "."] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--fix", "--fix-type", "suggestion", "--fix-type", "problem", "."] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--fix", "--fix-type", "suggestion,layout", "."] }) }}

Ignore Files

--no-ignore

Disables excluding of files from --ignore-pattern flags and the ignores property in configuration.

  • Argument Type: No argument.
--no-ignore example

{{ npx_tabs ({ package: "eslint", args: ["--no-ignore", "file.js"] }) }}

--ignore-pattern

This option allows you to specify patterns of files to ignore.

  • Argument Type: String. The supported syntax is the same as for ignores patterns, which use minimatch syntax. You should quote your patterns in order to avoid shell interpretation of glob patterns.
  • Multiple Arguments: Yes
--ignore-pattern example

{{ npx_tabs ({ package: "eslint", args: ["--ignore-pattern", ""/lib/"", "--ignore-pattern", ""/src/vendor/*"", "."] }) }}

Use stdin

--stdin

This option tells ESLint to read and lint source code from STDIN instead of from files. You can use this to pipe code to ESLint.

  • Argument Type: No argument.
--stdin example

{{ npx_tabs ({ package: "eslint", args: ["--stdin"], previousCommands: ["cat myFile.js"] }) }}

--stdin-filename

This option allows you to specify a filename to process STDIN as.

  • Argument Type: String. Path to file.
  • Multiple Arguments: No

This is useful when processing files from STDIN and you have rules which depend on the filename.

--stdin-filename example

{{ npx_tabs ({ package: "eslint", args: ["--stdin", "--stdin-filename", "myfile.js"], previousCommands: ["cat myFile.js"] }) }}

Handle Warnings

--quiet

This option allows you to disable reporting on warnings and running of rules set to warn. If you enable this option, only errors are reported by ESLint and only rules set to error will be run.

  • Argument Type: No argument.
--quiet example

{{ npx_tabs ({ package: "eslint", args: ["--quiet", "file.js"] }) }}

--max-warnings

This option allows you to specify a warning threshold, which can be used to force ESLint to exit with an error status if there are too many warning-level rule violations in your project.

  • Argument Type: Integer. The maximum number of warnings to allow. To prevent this behavior, do not use this option or specify -1 as the argument.
  • Multiple Arguments: No

Normally, if ESLint runs and finds no errors (only warnings), it exits with a success exit status. However, if --max-warnings is specified and the total warning count is greater than the specified threshold, ESLint exits with an error status.

::: important When used alongside --quiet, this will cause rules marked as warn to still be run, but not reported. :::

--max-warnings example

{{ npx_tabs ({ package: "eslint", args: ["--max-warnings", "10", "file.js"] }) }}

Output

-o, --output-file

Write the output of linting results to a specified file.

  • Argument Type: String. Path to file.
  • Multiple Arguments: No
-o, --output-file example

{{ npx_tabs ({ package: "eslint", args: ["-o", "./test/test.html"] }) }}

-f, --format

This option specifies the output format for the console.

If you are using a custom formatter defined in a local file, you can specify the path to the custom formatter file.

An npm-installed formatter is resolved with or without eslint-formatter- prefix.

When specified, the given format is output to the console. If you'd like to save that output into a file, you can do so on the command line like so:

{{ npx_tabs ({ package: "eslint", args: ["-f", "json", "file.js", ">", "results.json"], comment: "Saves the output into the results.json file." }) }}

-f, --format example

Use the built-in json formatter:

{{ npx_tabs ({ package: "eslint", args: ["--format", "json", "file.js"] }) }}

Use a local custom formatter:

{{ npx_tabs ({ package: "eslint", args: ["-f", "./customformat.js", "file.js"] }) }}

Use an npm-installed formatter:

{{ npm_tabs({ command: "install", packages: ["eslint-formatter-pretty"], args: [] }) }}

Then run one of the following commands

{{ npx_tabs ({ package: "eslint", args: ["-f", "pretty", "file.js"] }) }}

or alternatively

{{ npx_tabs ({ package: "eslint", args: ["-f", "eslint-formatter-pretty", "file.js"] }) }}

--color and --no-color

These options force the enabling/disabling of colorized output.

  • Argument Type: No argument.

You can use these options to override the default behavior, which is to enable colorized output unless no TTY is detected, such as when piping eslint through cat or less.

::: warning

When neither --color nor --no-color is specified, the formatter may decide whether to colorize the output based on the runtime environment. For example, when using the default stylish formatter under Node.js, FORCE_COLOR, NO_COLOR, or NODE_DISABLE_COLORS environment variables may affect whether colors are used.

:::

--color and --no-color example

{{ npx_tabs ({ package: "eslint", args: ["--color", "file.js", "|", "cat"] }) }}

{{ npx_tabs ({ package: "eslint", args: ["--no-color", "file.js"] }) }}

Inline Configuration Comments

--no-inline-config

This option prevents inline comments like /*eslint-disable*/ or /*global foo*/ from having any effect.

  • Argument Type: No argument.

This allows you to set an ESLint config without files modifying it. All inline config comments are ignored, such as:

  • /*eslint-disable*/
  • /*eslint-enable*/
  • /*global*/
  • /*eslint*/
  • // eslint-disable-line
  • // eslint-disable-next-line
--no-inline-config example

{{ npx_tabs ({ package: "eslint", args: ["--no-inline-config", "file.js"] }) }}

--report-unused-disable-directives

This option causes ESLint to report directive comments like // eslint-disable-line when no errors would have been reported on that line anyway.

  • Argument Type: No argument.

This can be useful to prevent future errors from unexpectedly being suppressed, by cleaning up old eslint-disable and eslint-enable comments which are no longer applicable.

::: warning When using this option, it is possible that new errors start being reported whenever ESLint or custom rules are upgraded.

For example, suppose a rule has a bug that causes it to report a false positive, and an eslint-disable comment is added to suppress the incorrect report. If the bug is then fixed in a patch release of ESLint, the eslint-disable comment becomes unused since ESLint is no longer generating an incorrect report. This results in a new reported error for the unused directive if the --report-unused-disable-directives option is used. :::

--report-unused-disable-directives example

{{ npx_tabs ({ package: "eslint", args: ["--report-unused-disable-directives", "file.js"] }) }}

--report-unused-disable-directives-severity

Same as --report-unused-disable-directives, but allows you to specify the severity level (error, warn, off) of the reported errors. Only one of these two options can be used at a time.

  • Argument Type: String. One of the following values:
    1. off (or 0)
    2. warn (or 1)
    3. error (or 2)
  • Multiple Arguments: No
  • Default Value: By default, linterOptions.reportUnusedDisableDirectives configuration setting is used (which defaults to "warn").
--report-unused-disable-directives-severity example

{{ npx_tabs ({ package: "eslint", args: ["--report-unused-disable-directives-severity", "warn", "file.js"] }) }}

--report-unused-inline-configs

This option causes ESLint to report inline config comments like /* eslint rule-name: "error" */ whose rule severity and any options match what's already been configured.

  • Argument Type: String. One of the following values:
    1. off (or 0)
    2. warn (or 1)
    3. error (or 2)
  • Multiple Arguments: No
  • Default Value: By default, linterOptions.reportUnusedInlineConfigs configuration setting is used (which defaults to "off").

This can be useful to keep files clean and devoid of misleading clutter. Inline config comments are meant to change ESLint's behavior in some way: if they change nothing, there is no reason to leave them in.

--report-unused-inline-configs example
shell
npx eslint --report-unused-inline-configs error file.js

Caching

--cache

Store the info about processed files in order to only operate on the changed ones. Enabling this option can dramatically improve ESLint's run time performance by ensuring that only changed files are linted. The cache is stored in .eslintcache by default.

  • Argument Type: No argument.

If you run ESLint with --cache and then run ESLint without --cache, the .eslintcache file will be deleted. This is necessary because the results of the lint might change and make .eslintcache invalid. If you want to control when the cache file is deleted, then use --cache-location to specify an alternate location for the cache file.

Autofixed files are not placed in the cache. Subsequent linting that does not trigger an autofix will place it in the cache.

--cache example

{{ npx_tabs ({ package: "eslint", args: ["--cache", "file.js"] }) }}

--cache-file

Deprecated: Use --cache-location instead.

Path to the cache file. If none specified .eslintcache is used. The file is created in the directory where the eslint command is executed.

--cache-location

Specify the path to the cache location. Can be a file or a directory.

  • Argument Type: String. Path to file or directory. If a directory is specified, a cache file is created inside the specified folder. The name of the file is based on the hash of the current working directory, e.g.: .cache_hashOfCWD.
  • Multiple Arguments: No
  • Default Value: If no location is specified, .eslintcache is used. The file is created in the directory where the eslint command is executed.

If the directory for the cache does not exist make sure you add a trailing / on *nix systems or \ on Windows. Otherwise, the path is assumed to be a file.

--cache-location example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--cache", "--cache-location", ""/Users/user/.eslintcache/""] }) }}

--cache-strategy

Strategy for the cache to use for detecting changed files.

  • Argument Type: String. One of the following values:
    1. metadata
    2. content
  • Multiple Arguments: No
  • Default Value: metadata

The content strategy can be useful in cases where the modification time of your files changes even if their contents have not. For example, this can happen during git operations like git clone because git does not track file modification time.

--cache-strategy example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--cache", "--cache-strategy", "content"] }) }}

Suppress Violations

--suppress-all

Suppresses existing violations, so that they are not being reported in subsequent runs. It allows you to enable one or more lint rules and be notified only when new violations show up. The suppressions are stored in eslint-suppressions.json by default, unless otherwise specified by --suppressions-location. The file gets updated with the new suppressions.

  • Argument Type: No argument.
--suppress-all example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--suppress-all"] }) }}

--suppress-rule

Suppresses violations for specific rules, so that they are not being reported in subsequent runs. Similar to --suppress-all, the suppressions are stored in eslint-suppressions.json by default, unless otherwise specified by --suppressions-location. The file gets updated with the new suppressions.

  • Argument Type: String. Rule ID.
  • Multiple Arguments: Yes
--suppress-rule example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--suppress-rule", "no-console", "--suppress-rule", "indent"] }) }}

--suppressions-location

Specify the path to the suppressions location. Can be a file or a directory.

  • Argument Type: String. Path to file. If a directory is specified, a cache file is created inside the specified folder. The name of the file is based on the hash of the current working directory, e.g.: suppressions_hashOfCWD
  • Multiple Arguments: No
  • Default Value: If no location is specified, eslint-suppressions.json is used. The file is created in the directory where the eslint command is executed.
--suppressions-location example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--suppressions-location", "".eslint-suppressions-example.json""] }) }}

--prune-suppressions

Prune unused suppressions from the suppressions file. This option is useful when you addressed one or more of the suppressed violations.

  • Argument Type: No argument.
--prune-suppressions example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--prune-suppressions"] }) }}

--pass-on-unpruned-suppressions

Ignore unused suppressions. By default, ESLint exits with exit code 2 and displays an error message if there are unused suppressions in the suppressions file. When you use this flag, unused suppressions do not affect the exit code and ESLint doesn't output an error about unused suppressions.

  • Argument Type: No argument.
--pass-on-unpruned-suppressions example

{{ npx_tabs ({ package: "eslint", args: [""src/**/*.js"", "--pass-on-unpruned-suppressions"] }) }}

Miscellaneous

--init

This option runs npm init @eslint/config to start the config initialization wizard. It's designed to help new users quickly create an eslint.config.js file by answering a few questions. When you use this flag, the CLI does not perform linting.

  • Argument Type: No argument.

The resulting configuration file is created in the current directory.

--init example

{{ npx_tabs ({ package: "eslint", args: ["--init"] }) }}

--env-info

This option outputs information about the execution environment, including the version of Node.js, npm, and local and global installations of ESLint.

  • Argument Type: No argument.

The ESLint team may ask for this information to help solve bugs. When you use this flag, the CLI does not perform linting.

--env-info example

{{ npx_tabs ({ package: "eslint", args: ["--env-info"] }) }}

--no-error-on-unmatched-pattern

This option prevents errors when a quoted glob pattern is unmatched. This does not prevent errors when your shell can't match a glob.

  • Argument Type: No argument.
--no-error-on-unmatched-pattern example

{{ npx_tabs ({ package: "eslint", args: ["--no-error-on-unmatched-pattern", "--ext", ".ts", ""lib/*""] }) }}

--exit-on-fatal-error

This option causes ESLint to exit with exit code 2 if one or more fatal parsing errors occur. Without this option, ESLint reports fatal parsing errors as rule violations.

  • Argument Type: No argument.
--exit-on-fatal-error example

{{ npx_tabs ({ package: "eslint", args: ["--exit-on-fatal-error", "file.js"] }) }}

--no-warn-ignored

This option suppresses both File ignored by default and File ignored because of a matching ignore pattern warnings when an ignored filename is passed explicitly. It is useful when paired with --max-warnings 0 as it will prevent exit code 1 due to the aforementioned warning.

  • Argument Type: No argument.
--no-warn-ignored example

{{ npx_tabs ({ package: "eslint", args: ["--no-warn-ignored", "--max-warnings", "0", "ignored-file.js"] }) }}

--pass-on-no-patterns

This option allows ESLint to exit with code 0 when no file or directory patterns are passed. Without this option, ESLint assumes you want to use . as the pattern.

  • Argument Type: No argument.
--pass-on-no-patterns example

{{ npx_tabs ({ package: "eslint", args: ["--pass-on-no-patterns"] }) }}

--debug

This option outputs debugging information to the console. Add this flag to an ESLint command line invocation in order to get extra debugging information while the command runs.

  • Argument Type: No argument.

This information is useful when you're seeing a problem and having a hard time pinpointing it. The ESLint team may ask for this debugging information to help solve bugs.

--debug example

{{ npx_tabs ({ package: "eslint", args: ["--debug", "test.js"] }) }}

-h, --help

This option outputs the help menu, displaying all of the available options. All other options are ignored when this is present. When you use this flag, the CLI does not perform linting.

  • Argument Type: No argument.
-h, --help example

{{ npx_tabs ({ package: "eslint", args: ["--help"] }) }}

-v, --version

This option outputs the current ESLint version onto the console. All other options are ignored when this is present. When you use this flag, the CLI does not perform linting.

  • Argument Type: No argument.
-v, --version example

{{ npx_tabs ({ package: "eslint", args: ["--version"] }) }}

--print-config

This option outputs the configuration to be used for the file passed. When present, no linting is performed and only config-related options are valid. When you use this flag, the CLI does not perform linting.

  • Argument Type: String. Path to file.
  • Multiple Arguments: No
--print-config example

{{ npx_tabs ({ package: "eslint", args: ["--print-config", "file.js"] }) }}

--stats

This option adds a series of detailed performance statistics (see Stats type) such as the parse-, fix- and lint-times (time per rule) to result objects that are passed to the formatter (see Stats CLI usage).

  • Argument Type: No argument.

This option is intended for use with custom formatters that display statistics. It can also be used with the built-in json formatter.

--stats example

{{ npx_tabs ({ package: "eslint", args: ["--stats", "--format", "json", "file.js"] }) }}

--flag

This option enables one or more feature flags for ESLint.

  • Argument Type: String. A feature identifier.
  • Multiple Arguments: Yes
--flag example

{{ npx_tabs ({ package: "eslint", args: ["--flag", "x_feature", "file.js"] }) }}

--mcp

This option starts the ESLint MCP server for use with AI agents.

  • Argument Type: No argument.
  • Multiple Arguments: No
--mcp example

{{ npx_tabs ({ package: "eslint", args: ["--mcp"] }) }}

--concurrency

This option controls the number of worker threads used to lint files.

  • Argument Type: Int|String. A positive integer, auto or off.
  • Multiple Arguments: No
  • Default Value: off

The value off causes all files to be linted in the main thread. The value auto attempts to determine the best setting automatically.

--concurrency example

{{ npx_tabs ({ package: "eslint", args: ["--concurrency", "auto"] }) }}

Exit Codes

When linting files, ESLint exits with one of the following exit codes:

  • 0: Linting was successful and there are no linting errors. If the --max-warnings flag is set to n, the number of linting warnings is at most n.
  • 1: Linting was successful and there is at least one linting error, or there are more linting warnings than allowed by the --max-warnings option.
  • 2: Linting was unsuccessful due to a configuration problem or an internal error.