Man page - eslint(1)

Packages contas this manual

Package: eslint
apt-get install eslint

Manuals in package:

eslint(1)

Documentations in package:

eslint

Manual

ESLINT(1)

User Commands

ESLINT(1)

NAME

eslint - JavaScript

DESCRIPTION

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

Basic configuration:

--no-eslintrc: Disable use of configuration from .eslintrc.*
-c, --config path::String: Use this configuration, overriding .eslintrc.* config options if present
--env [String]: Specify environments
--ext [String]: Specify JavaScript file extensions - default: .js
--global [String]: Define global variables
--parser String: Specify the parser to be used
--parser-options Object: Specify parser options
--resolve-plugins-relative-to path::String: A folder where plugins should be resolved from, CWD by default

Specifying rules and plugins:

--rulesdir [path::String]: Use additional rules from this directory
--plugin [String]: Specify plugins
--rule Object: Specify rules

Fixing 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 (problem, suggestion, layout)

Ignoring files:

--ignore-path path::String: Specify path of ignore file
--no-ignore: Disable use of ignore files and patterns
--ignore-pattern [String]: Pattern of files to ignore (in addition to those in .eslintignore)

Using stdin:

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

Handling 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 directives

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

Miscellaneous:

--init: Run config initialization wizard - default: false
--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

June 2024

eslint v6.4.0