Skip to content package
eslint-webpack-plugin v5.0.2 A ESLint plugin for webpack
node >= 18.12.0 6 deps cjs types open source
overview readme
license MIT
deps 6
unpacked 46.9 kB
files 18
node >= 18.12.0 $ npm install eslint-webpack-plugin@5.0.2n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
eslint lint linter plugin webpack
install size Estimated unpacked size across 17 packages.
2.1 MB
Includes dependencies.
dependencies 4 direct dependencies.
versions Latest published Apr 3, 2026
maintainers Registry package owners.
sokra
tobias.koppers@googlemail.com
eslint-webpack-plugin
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 copy yarn add -D eslint-webpack-plugin copy pnpm add -D eslint-webpack-plugin copy
[!NOTE]
You also need to install eslint >= 9 from npm, if you haven't already:
npm install eslint --save-dev copy Then add the plugin to your webpack configuration. For example:
const ESLintPlugin = require ( "eslint-webpack-plugin" );
module . exports = {
// ...
plugins: [ new ESLintPlugin (options)],
// ...
}; copy
Options
[!NOTE]
The config option you provide will be passed to the ESLint class.
See the ESlint docs for more details.
cachetype cache = boolean ; copy The cache is enabled by default to decrease execution time.
cacheLocationtype cacheLocation = string ; copy
Default: node_modules/.cache/eslint-webpack-plugin/.eslintcache
Specify the path to the cache location. Can be a file or a directory.
configTypetype configType = "flat" | "eslintrc" ; copy Specify the type of configuration to use with ESLint.
flat is the current standard configuration format.
eslintrc is the legacy configuration format and has been officially deprecated.
contexttype context = string ; copy
Default: compiler.context
Base directory for linting.
eslintPathtype eslintPath = string ; copy 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.
extensionstype extensions = string | string []; copy Specify file extensions that should be checked.
excludetype exclude = string | string []; copy Specify the files/directories to exclude. Must be relative to options.context.
resourceQueryExcludetype resourceQueryExclude = RegExp | RegExp []; copy Specify the resource query to exclude.
filestype files = string | string []; copy 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.
fixBe careful: this option will modify source files.
type formatter =
| string
| ((
results : import ( "eslint" ). ESLint . LintResult [],
data ?: import ( "eslint" ). ESLint . LintResultData | undefined ,
) => string ); copy Accepts a function that receives an array of ESLint messages (object) as its argument and must return a string as output.
lintDirtyModulesOnlytype lintDirtyModulesOnly = boolean ; copy Lint only changed files, skipping initial lint on build start.
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:
emitErrortype emitError = boolean ; copy The errors found will always be emitted, to disable set to false.
emitWarningtype emitWarning = boolean ; copy The warnings found will always be emitted, to disable set to false.
failOnErrortype failOnError = boolean ; copy Will cause the module build to fail if any errors are found, to disable set to false.
failOnWarningtype failOnWarning = boolean ; copy Will cause the module build to fail if any warnings are found, if set to true.
quiettype quiet = boolean ; copy Will process and report errors only and ignore warnings, if set to true.
outputReporttype outputReport =
| boolean
| {
filePath ?: string | undefined ;
formatter ?:
| (
| string
| ((
results : import ( "eslint" ). ESLint . LintResult [],
data ?: import ( "eslint" ). ESLint . LintResultData | undefined ,
) => string )
)
| undefined ;
}; copy 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
Contributing We welcome all contributions!
If you're new here, please take a moment to review our contributing guidelines.
License