EslintWebpackPlugin

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

This plugin uses ESlint to find and fix problems in your JavaScript code during the Webpack build process.

Getting Started

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

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

or

yarn add -D eslint-webpack-plugin

or

pnpm add -D eslint-webpack-plugin

[!NOTE]

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

npm install eslint --save-dev

or

yarn add -D eslint

or

pnpm add -D eslint

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

const ESLintPlugin = require("eslint-webpack-plugin");

module.exports = {
  // ...
  plugins: [new ESLintPlugin(options)],
  // ...
};

Options

You can pass ESLint Node.js API 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 eslint.config.js (since ESLint v9.0.0, formerly .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:

type cache = boolean;

• Default: true

The cache is enabled by default to decrease execution time.

cacheLocation

• Type:

type 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:

type configType = "flat" | "eslintrc";

• Default: flat

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.

context

• Type:

type context = string;

• Default: compiler.context

Base directory for linting.

eslintPath

• Type:

type 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:

type extensions = string | string[];

• Default: 'js'

Specify file extensions that should be checked.

exclude

• Type:

type exclude = string | string[];

• Default: 'node_modules'

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

resourceQueryExclude

• Type:

type resourceQueryExclude = RegExp | RegExp[];

• Default: []

Specify the resource query to exclude.

files

• Type:

type files = string | 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:

type fix = boolean;

• Default: false

Will enable ESLint autofix feature.

Be careful: this option will modify source files.

formatter

• Type:

type formatter =
  | string
  | ((
      results: import("eslint").ESLint.LintResult[],
      data?: import("eslint").ESLint.LintResultData | undefined,
    ) => string);

• Default: 'stylish'

Accepts a function that receives an array of ESLint messages (object) as its argument and must return a string as output.

You can use official ESlint formatters.

lintDirtyModulesOnly

• Type:

type lintDirtyModulesOnly = boolean;

• Default: false

Lint only changed files, skipping initial lint on build start.

threads

• Type:

type 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:

type emitError = boolean;

• Default: true

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

emitWarning

• Type:

type emitWarning = boolean;

• Default: true

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

failOnError

• Type:

type failOnError = boolean;

• Default: true

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

failOnWarning

• Type:

type failOnWarning = boolean;

• Default: false

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

quiet

• Type:

type quiet = boolean;

• Default: false

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

outputReport

• Type:

type outputReport =
  | boolean
  | {
      filePath?: string | undefined;
      formatter?:
        | (
            | string
            | ((
                results: import("eslint").ESLint.LintResult[],
                data?: import("eslint").ESLint.LintResultData | undefined,
              ) => string)
          )
        | undefined;
    };

• Default: false

Write ESLint results to a file, for example a checkstyle xml file for use for reporting on Jenkins CI.

• filePath: Path to output report file (relative to output.path or absolute).
• formatter: 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

Contributing

We welcome all contributions!

If you're new here, please take a moment to review our contributing guidelines.

CONTRIBUTING

License

MIT