\n\n> This plugin was forked from the excellent [eslint-webpack-plugin](https://github.com/webpack/eslint-webpack-plugin/). Many thanks to the original authors for their great work.\n\nThis plugin uses [ESLint](https://eslint.org/) to find and fix problems in your JavaScript code.\n\n> You may find it more efficient to avoid using the `eslint-rspack-plugin`, as running ESLint during the build can lead to longer build times. A separate lint command usually offers a better workflow.\n\n## Getting Started\n\nTo begin, you'll need to install `eslint-rspack-plugin`:\n\n```bash\nnpm install eslint-rspack-plugin --save-dev\n```\n\nor\n\n```bash\nyarn add -D eslint-rspack-plugin\n```\n\nor\n\n```bash\npnpm add -D eslint-rspack-plugin\n```\n\n> [!NOTE]\n>\n> You also need to install `eslint >= 8` from npm, if you haven't already:\n\n```bash\nnpm install eslint --save-dev\n```\n\nor\n\n```bash\nyarn add -D eslint\n```\n\nor\n\n```bash\npnpm add -D eslint\n```\n\nThen add the plugin to your Rspack config. For example:\n\n```js\nimport ESLintPlugin from 'eslint-rspack-plugin';\n\nexport default {\n plugins: [new ESLintPlugin()],\n};\n```\n\n## Options\n\nYou can pass [ESLint options](https://eslint.org/docs/developer-guide/nodejs-api#-new-eslintoptions).\n\n> [!NOTE]\n>\n> The config option you provide will be passed to the `ESLint` class.\n> This is a different set of options than what you'd specify in `package.json` or `.eslintrc`.\n> See the [ESLint docs](https://eslint.org/docs/developer-guide/nodejs-api#-new-eslintoptions) for more details.\n\n### `cache`\n\n- Type:\n\n```ts\ntype cache = boolean;\n```\n\n- Default: `true`\n\nThe cache is enabled by default to decrease execution time.\n\n### `cacheLocation`\n\n- Type:\n\n```ts\ntype cacheLocation = string;\n```\n\n- Default: `node_modules/.cache/eslint-rspack-plugin/.eslintcache`\n\nSpecify the path to the cache location. Can be a file or a directory.\n\n### `configType`\n\n- Type:\n\n```ts\ntype configType = 'flat' | 'eslintrc';\n```\n\n- Default:\n - For ESLint < 10.0.0: `eslintrc`\n - For ESLint >= 10.0.0: `flat`\n\nSpecify the type of configuration to use with ESLint.\n\n- `eslintrc` is the classic configuration format available in most ESLint versions.\n- `flat` is the new format introduced in ESLint 8.21.0.\n\nThe flat configuration format is explained in its [own documentation](https://eslint.org/docs/latest/use/configure/configuration-files).\n\n### `context`\n\n- Type:\n\n```ts\ntype context = string;\n```\n\n- Default: `compiler.context`\n\nA string indicating the root of your files.\n\n### `eslintPath`\n\n- Type:\n\n```ts\ntype eslintPath = string;\n```\n\n- Default: `eslint`\n\nPath 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`.\n\n### `extensions`\n\n- Type:\n\n```ts\ntype extensions = string | Array;\n```\n\n- Default: `'js'`\n\nSpecify extensions that should be checked.\n\nOnly works when `configType` is `eslintrc`. For flat config, use `files` option instead.\n\n### `exclude`\n\n- Type:\n\n```ts\ntype exclude = string | Array;\n```\n\n- Default: `'node_modules'`\n\nSpecify the files and/or directories to exclude. Must be relative to `options.context`.\n\n### `resourceQueryExclude`\n\n- Type:\n\n```ts\ntype resourceQueryExclude = RegExp | Array;\n```\n\n- Default: `[]`\n\nSpecify the resource query to exclude.\n\n### `files`\n\n- Type:\n\n```ts\ntype files = string | Array;\n```\n\n- Default: `null`\n\nSpecify directories, files, or globs. Must be relative to `options.context`.\nDirectories are traversed recursively looking for files matching `options.extensions`.\nFile and glob patterns ignore `options.extensions`.\n\n### `fix`\n\n- Type:\n\n```ts\ntype fix = boolean;\n```\n\n- Default: `false`\n\nWill enable [ESLint autofix feature](https://eslint.org/docs/developer-guide/nodejs-api#-eslintoutputfixesresults).\n\n**Be careful: this option will change source files.**\n\n### `formatter`\n\n- Type:\n\n```ts\ntype formatter = string| (\n results: Array,\n data?: import('eslint').ESLint.LintResultData | undefined\n) => string\n```\n\n- Default: `'stylish'`\n\nAccepts 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](https://eslint.org/docs/user-guide/formatters/).\n\n### `lintDirtyModulesOnly`\n\n- Type:\n\n```ts\ntype lintDirtyModulesOnly = boolean;\n```\n\n- Default: `false`\n\nLint only changed files, skip lint on start.\n\n### `lintAllFiles`\n\n- Type:\n\n```ts\ntype lintAllFiles = boolean;\n```\n\n- Default: `false`\n\nLint all files matching the `files` and `extensions` patterns, regardless of whether they are part of the compilation.\n\n> [!TIP]\n> This option is particularly useful for multi-environment builds (e.g., Rsbuild/Rspack with separate client and server environments) where you want to ensure all files in your codebase are linted, not just the ones included in each environment's dependency graph.\n>\n> Enabling this option will run a single ESLint instance to check all files rather than running separate ESLint instances for each environment.\n\n### `threads`\n\n- Type:\n\n```ts\ntype threads = boolean | number;\n```\n\n- Default: `false`\n\nWill run lint tasks across a thread pool. The pool size is automatic unless you specify a number.\n\n### Errors and Warning\n\n**By default the plugin will auto adjust error reporting depending on eslint errors/warnings counts.**\nYou can still force this behavior by using `emitError` **or** `emitWarning` options:\n\n#### `emitError`\n\n- Type:\n\n```ts\ntype emitError = boolean;\n```\n\n- Default: `true`\n\nThe errors found will always be emitted, to disable set to `false`.\n\n#### `emitWarning`\n\n- Type:\n\n```ts\ntype emitWarning = boolean;\n```\n\n- Default: `true`\n\nThe warnings found will always be emitted, to disable set to `false`.\n\n#### `failOnError`\n\n- Type:\n\n```ts\ntype failOnError = boolean;\n```\n\n- Default: `true`\n\nWill cause the module build to fail if there are any errors, to disable set to `false`.\n\n#### `failOnWarning`\n\n- Type:\n\n```ts\ntype failOnWarning = boolean;\n```\n\n- Default: `false`\n\nWill cause the module build to fail if there are any warnings, if set to `true`.\n\n#### `quiet`\n\n- Type:\n\n```ts\ntype quiet = boolean;\n```\n\n- Default: `false`\n\nWill process and report errors only and ignore warnings, if set to `true`.\n\n#### `outputReport`\n\n- Type:\n\n```ts\ntype outputReport =\n | boolean\n | {\n filePath?: string | undefined;\n formatter?:\n | (\n | string\n | ((\n results: Array,\n data?: import('eslint').ESLint.LintResultData | undefined,\n ) => string)\n )\n | undefined;\n };\n```\n\n- Default: `false`\n\nWrite the output of the errors to a file, for example a checkstyle xml file for use for reporting on Jenkins CI.\n\nThe `filePath` is an absolute path or relative to the Rspack config: `output.path`.\nYou can pass in a different `formatter` for the output file,\nif none is passed in the default/configured formatter will be used.\n\n## Changelog\n\n[Changelog](CHANGELOG.md)\n\n## License\n\n[MIT](./LICENSE)\n\n[npm]: https://img.shields.io/npm/v/eslint-rspack-plugin.svg\n[npm-url]: https://npmjs.com/package/eslint-rspack-plugin\n[node]: https://img.shields.io/node/v/eslint-rspack-plugin.svg\n[node-url]: https://nodejs.org","users":{}}
![\"npm](\"https://img.shields.io/npm/v/eslint-rspack-plugin?style=flat-square&colorA=564341&colorB=EDED91\")
\n \n ![\"license\"](\"https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91\"){kind=icon}
\n ![\"downloads\"](\"https://img.shields.io/npm/dm/eslint-rspack-plugin.svg?style=flat-square&colorA=564341&colorB=EDED91\")
\n