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

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

Getting Started

To begin, you'll need to installeslint-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 installeslint >= 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:[newESLintPlugin(options)],// ...};

Options

You can passESLint Node.js API options.

[!NOTE]

The config option you provide will be passed to theESLint class.This is a different set of options than what you'd specify inpackage.json oreslint.config.js (since ESLint v9.0.0, formerly.eslintrc).See theESlint docs for more details.

[!WARNING]

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

cache

• Type:

typecache=boolean;

• Default:true

The cache is enabled by default to decrease execution time.

cacheLocation

• Type:

typecacheLocation=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:

typeconfigType="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 itsown documentation.

context

• Type:

typecontext=string;

• Default:compiler.context

Base directory for linting.

eslintPath

• Type:

typeeslintPath=string;

• Default:eslint

Path toeslint instance that will be used for linting.

If theeslintPath is a folder like a official ESlint, or specify aformatter option, now you don't have to installeslint.

extensions

• Type:

typeextensions=string|string[];

• Default:'js'

Specify file extensions that should be checked.

exclude

• Type:

typeexclude=string|string[];

• Default:'node_modules'

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

resourceQueryExclude

• Type:

typeresourceQueryExclude= RegExp| RegExp[];

• Default:[]

Specify the resource query to exclude.

files

• Type:

typefiles=string|string[];

• Default:null

Specify directories, files, or globs. Must be relative tooptions.context.Directories are traversed recursively looking for files matchingoptions.extensions.File and glob patterns ignoreoptions.extensions.

fix

• Type:

typefix=boolean;

• Default:false

Will enableESLint autofix feature.

Be careful: this option will modify source files.

formatter

• Type:

typeformatter=|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 officialESlint formatters.

lintDirtyModulesOnly

• Type:

typelintDirtyModulesOnly=boolean;

• Default:false

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

threads

• Type:

typethreads=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 usingemitErrororemitWarning options:

emitError

• Type:

typeemitError=boolean;

• Default:true

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

emitWarning

• Type:

typeemitWarning=boolean;

• Default:true

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

failOnError

• Type:

typefailOnError=boolean;

• Default:true

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

failOnWarning

• Type:

typefailOnWarning=boolean;

• Default:false

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

quiet

• Type:

typequiet=boolean;

• Default:false

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

outputReport

• Type:

typeoutputReport=|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 differentformatter 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