eslint-webpack-plugin

This version of eslint-webpack-plugin only works with webpack 5. For the webpack 4, see the 2.x branch.

This plugin uses eslint to find and fix problems in your JavaScript code

Getting Started

To begin, you'll need to install eslint-webpack-plugin:

1npm install eslint-webpack-plugin --save-dev

or

1yarn add -D eslint-webpack-plugin

or

1pnpm add -D eslint-webpack-plugin

[!NOTE]

You also need to install eslint >= 8 from npm, if you haven't already:

1npm install eslint --save-dev

or

1yarn add -D eslint

or

1pnpm add -D eslint

Then add the plugin to your webpack config. For example:

1const ESLintPlugin = require('eslint-webpack-plugin');
2
3module.exports = {
4  // ...
5  plugins: [new ESLintPlugin(options)],
6  // ...
7};

Options

You can pass eslint options.

[!NOTE]

The config option you provide will be passed to the ESLint class. This is a different set of options than what you'd specify in package.json or .eslintrc. See the eslint docs for more details.

[!WARNING]

In eslint-webpack-plugin version 1 the options were passed to the now deprecated CLIEngine.

cache

• Type:

1type cache = boolean;

• Default: true

The cache is enabled by default to decrease execution time.

cacheLocation

• Type:

1type cacheLocation = string;

• Default: node_modules/.cache/eslint-webpack-plugin/.eslintcache

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

configType

• Type:

1type configType = 'flat' | 'eslintrc';

• Default: eslintrc

Specify the type of configuration to use with ESLint.

• eslintrc is the classic configuration format available in most ESLint versions.
• flat is the new format introduced in ESLint 8.21.0.

The new configuration format is explained in its own documentation.

This configuration format being considered as experimental, it is not exported in the main ESLint module in ESLint 8. You need to set your eslintPath to eslint/use-at-your-own-risk for this config format to work.

context

• Type:

1type context = string;

• Default: compiler.context

A string indicating the root of your files.

eslintPath

• Type:

1type eslintPath = string;

• Default: eslint

Path to eslint instance that will be used for linting. If the eslintPath is a folder like a official eslint, or specify a formatter option. now you don't have to install eslint.

extensions

• Type:

1type extensions = string | Array<string>;

• Default: 'js'

Specify extensions that should be checked.

exclude

• Type:

1type exclude = string | Array<string>;

• Default: 'node_modules'

Specify the files and/or directories to exclude. Must be relative to options.context.

resourceQueryExclude

• Type:

1type resourceQueryExclude = RegExp | Array<RegExp>;

• Default: []

Specify the resource query to exclude.

files

• Type:

1type files = string | Array<string>;

• Default: null

Specify directories, files, or globs. Must be relative to options.context. Directories are traversed recursively looking for files matching options.extensions. File and glob patterns ignore options.extensions.

fix

• Type:

1type fix = boolean;

• Default: false

Will enable ESLint autofix feature.

Be careful: this option will change source files.

formatter

• Type:

1type formatter = string| (
2  results:  Array<import('eslint').ESLint.LintResult>,
3  data?: import('eslint').ESLint.LintResultData | undefined
4) => string

• Default: 'stylish'

Accepts a function that will have one argument: an array of eslint messages (object). The function must return the output as a string. You can use official eslint formatters.

lintDirtyModulesOnly

• Type:

1type lintDirtyModulesOnly = boolean;

• Default: false

Lint only changed files, skip lint on start.

threads

• Type:

1type threads = boolean | number;

• Default: false

Will run lint tasks across a thread pool. The pool size is automatic unless you specify a number.

Errors and Warning

By default the plugin will auto adjust error reporting depending on eslint errors/warnings counts. You can still force this behavior by using emitError or emitWarning options:

emitError

• Type:

1type emitError = boolean;

• Default: true

The errors found will always be emitted, to disable set to false.

emitWarning

• Type:

1type emitWarning = boolean;

• Default: true

The warnings found will always be emitted, to disable set to false.

failOnError

• Type:

1type failOnError = boolean;

• Default: true

Will cause the module build to fail if there are any errors, to disable set to false.

failOnWarning

• Type:

1type failOnWarning = boolean;

• Default: false

Will cause the module build to fail if there are any warnings, if set to true.

quiet

• Type:

1type quiet = boolean;

• Default: false

Will process and report errors only and ignore warnings, if set to true.

outputReport

• Type:

1type outputReport =
2  | boolean
3  | {
4      filePath?: string | undefined;
5      formatter?:
6        | (
7            | string
8            | ((
9                results: Array<import('eslint').ESLint.LintResult>,
10                data?: import('eslint').ESLint.LintResultData | undefined,
11              ) => string)
12          )
13        | undefined;
14    };

• Default: false

Write the output of the errors to a file, for example a checkstyle xml file for use for reporting on Jenkins CI.

The filePath is an absolute path or relative to the webpack config: output.path. You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.

Changelog

Changelog

License

MIT