# eslint-rspack-plugin > A ESLint plugin for Rspack Latest version **5.0.1** (published 2026-05-29) · MIT license · 0 weekly downloads ## Install ```sh npm install eslint-rspack-plugin pnpm add eslint-rspack-plugin yarn add eslint-rspack-plugin bun add eslint-rspack-plugin ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 5.0.1 | | Published | 2026-05-29 | | First published | 2023-04-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM | | Node | >= 20.19.0 | | Dependencies | 3 | | Unpacked size | 31 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 9 | | Author | Ricardo Gobbo de Souza | | Maintainers | chenjiahan, hardfist, harpsealjs | | Keywords | eslint, lint, linter, plugin, rspack | ## Links - npm: https://www.npmjs.com/package/eslint-rspack-plugin - Repository: https://github.com/rstackjs/eslint-rspack-plugin - Issues: https://github.com/rstackjs/eslint-rspack-plugin/issues - npm.io page: https://npm.io/package/eslint-rspack-plugin ## Dependencies (3) - [micromatch](https://npm.io/package/micromatch.md) ^4.0.8 - [tinyglobby](https://npm.io/package/tinyglobby.md) ^0.2.15 - [normalize-path](https://npm.io/package/normalize-path.md) ^3.0.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 5.0.1 (latest) — 2026-05-29 - 5.0.0-beta.1 (beta) — 2026-05-13 - 5.0.0 — 2026-05-13 - 5.0.0-beta.0 — 2026-05-11 - 4.4.1 — 2026-02-25 - 4.4.0 — 2026-02-25 - 4.3.0 — 2025-12-05 - 4.2.1 — 2024-09-30 - 4.2.0 — 2024-08-20 - 4.0.1-alpha — 2023-10-18 - 4.0.0-alpha — 2023-04-24 ## README # eslint-rspack-plugin

npm version license downloads

This plugin runs [ESLint](https://eslint.org/) during Rspack compilation to detect issues in your JavaScript code. In watch mode, it re-runs ESLint on files changed by Rspack. > 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. ## Versions - 5.x: Supports ESLint 9/10, see [v4 -> v5](https://github.com/rstackjs/eslint-rspack-plugin/blob/master/docs/migrate-v4-to-v5.md) for migration guide. - 4.x: Supports ESLint 8/9/10, see [4.x README](https://github.com/rstackjs/eslint-rspack-plugin/tree/v4.x#eslint-rspack-plugin) for usage guide. ## Getting Started To begin, you'll need to install `eslint-rspack-plugin`: ```bash # pnpm pnpm add -D eslint-rspack-plugin # npm npm install -D eslint-rspack-plugin # yarn yarn add -D eslint-rspack-plugin # bun bun add -D eslint-rspack-plugin ``` You also need to install `eslint >= 9`, if you haven't already: ```bash # pnpm pnpm add -D eslint # npm npm install -D eslint # yarn yarn add -D eslint # bun bun add -D eslint ``` Then add the plugin to your Rspack config. For example: ```js import ESLintPlugin from 'eslint-rspack-plugin'; export default { plugins: [new ESLintPlugin()], }; ``` ## Options You can pass [ESLint options](https://eslint.org/docs/latest/integrate/nodejs-api#-new-eslintoptions). > [!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`. > See the [ESLint docs](https://eslint.org/docs/latest/integrate/nodejs-api#-new-eslintoptions) for more details. ### `cache` - Type: ```ts type cache = boolean; ``` - Default: `true` The cache is enabled by default to decrease execution time. ### `cacheLocation` - Type: ```ts type cacheLocation = string; ``` - Default: `node_modules/.cache/eslint-rspack-plugin/.eslintcache` Specify the path to the cache location. Can be a file or a directory. ### `configType` - Type: ```ts type configType = 'flat' | 'eslintrc'; ``` - Default: `flat` 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. The flat configuration format is explained in its [own documentation](https://eslint.org/docs/latest/use/configure/configuration-files). ### `context` - Type: ```ts type context = string; ``` - Default: `compiler.context` A string indicating the root of your files. ### `eslintPath` - Type: ```ts 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: ```ts type extensions = string | Array; ``` - Default: `'js'` Specify extensions that should be checked. Only works when `configType` is `eslintrc`. For flat config, use `files` option instead. ### `exclude` - Type: ```ts type exclude = string | Array; ``` - Default: `'node_modules'` Specify the files and/or directories to exclude. Must be relative to `options.context`. ### `resourceQueryExclude` - Type: ```ts type resourceQueryExclude = string | RegExp | Array; ``` - Default: `[]` Exclude modules from linting when their resource query matches one of the provided patterns. The resource query is the part after `?` in an import, such as `raw` in `import './file.js?raw'`. String values are converted to `RegExp`. Use anchors when you need an exact match. ```js import ESLintPlugin from 'eslint-rspack-plugin'; export default { plugins: [ new ESLintPlugin({ resourceQueryExclude: 'raw', }), ], }; ``` You can also mix strings and `RegExp` values: ```js import ESLintPlugin from 'eslint-rspack-plugin'; export default { plugins: [ new ESLintPlugin({ resourceQueryExclude: [/media/, '^raw$'], }), ], }; ``` ### `files` - Type: ```ts type files = string | Array; ``` - 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: ```ts type fix = boolean; ``` - Default: `false` Will enable [ESLint autofix feature](https://eslint.org/docs/latest/integrate/nodejs-api#-eslintoutputfixesresults). **Be careful: this option will change source files.** ### `formatter` - Type: ```ts type formatter = string| ( results: Array, data?: import('eslint').ESLint.LintResultData | undefined ) => 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](https://eslint.org/docs/latest/use/formatters/). ### `lintDirtyModulesOnly` - Type: ```ts type lintDirtyModulesOnly = boolean; ``` - Default: `false` Lint only changed files, skip lint on start. ### `lintAllFiles` - Type: ```ts type lintAllFiles = boolean; ``` - Default: `false` Lint all files matching the `files` and `extensions` patterns, regardless of whether they are part of the compilation. > [!TIP] > 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. > > Enabling this option will run a single ESLint instance to check all files rather than running separate ESLint instances for each environment. ### `severity` - Type: ```ts type severity = { error?: 'error' | 'warning' | 'off'; warning?: 'error' | 'warning' | 'off'; }; ``` - Default: ```js { error: 'error', warning: 'warning', } ``` Controls how ESLint diagnostics are emitted to Rspack. Diagnostics emitted as `compilation.errors` are treated as build errors by Rspack and make the build fail. Diagnostics emitted as `compilation.warnings` are printed as warnings and do not fail the build. - `error: 'error'`: emit ESLint errors as `compilation.errors`. - `error: 'warning'`: emit ESLint errors as `compilation.warnings`. - `error: 'off'`: do not emit ESLint errors. - `warning: 'warning'`: emit ESLint warnings as `compilation.warnings`. - `warning: 'error'`: emit ESLint warnings as `compilation.errors`. - `warning: 'off'`: do not emit ESLint warnings. Examples: Use the default behavior: ```js new ESLintPlugin({ severity: { error: 'error', warning: 'warning', }, }); ``` Downgrade ESLint errors so they are still shown but do not fail the build: ```js new ESLintPlugin({ severity: { error: 'warning', }, }); ``` Treat ESLint warnings as build errors: ```js new ESLintPlugin({ severity: { warning: 'error', }, }); ``` Ignore ESLint warnings: ```js new ESLintPlugin({ severity: { warning: 'off', }, }); ``` Ignore ESLint errors: ```js new ESLintPlugin({ severity: { error: 'off', }, }); ``` #### `outputReport` - Type: ```ts type outputReport = | boolean | { filePath?: string | undefined; formatter?: | ( | string | (( results: Array, data?: import('eslint').ESLint.LintResultData | undefined, ) => string) ) | undefined; }; ``` - 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 Rspack 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. ## Credits 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. ## License [MIT](./LICENSE) [npm]: https://img.shields.io/npm/v/eslint-rspack-plugin.svg [npm-url]: https://npmjs.com/package/eslint-rspack-plugin [node]: https://img.shields.io/node/v/eslint-rspack-plugin.svg [node-url]: https://nodejs.org --- _Source: https://npm.io/package/eslint-rspack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._