\n\n\n\n## Usage\n\nInstall:\n\n```bash\nnpm add @rsbuild/plugin-eslint -D\n```\n\nAdd plugin to your `rsbuild.config.ts`:\n\n```ts\n// rsbuild.config.ts\nimport { pluginEslint } from \"@rsbuild/plugin-eslint\";\n\nexport default {\n plugins: [pluginEslint()],\n};\n```\n\n## Example Projects\n\n- [React + ESLint project](https://github.com/rstackjs/rspack-examples/tree/main/rsbuild/react-eslint)\n- [Vue 3 + ESLint project](https://github.com/rstackjs/rspack-examples/tree/main/rsbuild/vue3-eslint)\n\n## Options\n\n### enable\n\nWhether to enable ESLint checking.\n\n- **Type:** `boolean`\n- **Default:** `true`\n- **Example:**\n\nDisable ESLint checking:\n\n```js\npluginEslint({\n enable: false,\n});\n```\n\nEnable ESLint checking only during production builds:\n\n```js\npluginEslint({\n enable: process.env.NODE_ENV === \"production\",\n});\n```\n\nEnable ESLint checking only during development builds:\n\n```js\npluginEslint({\n enable: process.env.NODE_ENV === \"development\",\n});\n```\n\n### environments\n\nControl which environments to run ESLint on when using [Rsbuild's multi-environment builds](https://rsbuild.rs/guide/advanced/environments).\n\n- **Type:** `'all' | boolean | string[]`\n- **Default:** `false`\n- **Example:**\n\nBy default, ESLint only runs on the first environment to avoid running multiple times:\n\n```js\npluginEslint({\n environments: false // (default)\n});\n```\n\nRun ESLint on all environments:\n\n```js\npluginEslint({\n environments: 'all',\n // or\n environments: true,\n});\n```\n\nRun ESLint on specific environments by name:\n\n```js\npluginEslint({\n environments: ['web', 'node'],\n});\n```\n\nThis is useful when different environments have different entry points and you want to ensure all files are linted. Note that when set to `'all'` or `true`, ESLint will run separately for each environment, which may increase build time.\n\n### eslintPluginOptions\n\nTo modify the options of `eslint-rspack-plugin`, please refer to [eslint-rspack-plugin - README](https://github.com/rstackjs/eslint-rspack-plugin#readme) to learn about available options.\n\n- **Type:** [Options](https://github.com/rstackjs/eslint-rspack-plugin/blob/master/types/options.d.ts)\n- **Default:**\n\n```ts\nconst defaultOptions = {\n extensions: [\"js\", \"jsx\", \"mjs\", \"cjs\", \"ts\", \"tsx\", \"mts\", \"cts\"],\n exclude: [\n \"node_modules\",\n \"dist\", // -> rsbuildConfig.output.distPath.root\n ],\n};\n```\n\nThe `eslintPluginOptions` object will be shallowly merged with the default configuration object.\n\n- For example, enable ESLint's flat config:\n\n```ts\npluginEslint({\n eslintPluginOptions: {\n cwd: __dirname,\n configType: \"flat\",\n },\n});\n```\n\n- For example, exclude some files using `exclude`:\n\n```ts\npluginEslint({\n eslintPluginOptions: {\n exclude: [\"node_modules\", \"dist\", \"./src/foo.js\"],\n },\n});\n```\n\n- Extend `extensions` to validate `.vue` or `.svelte` files:\n\n```ts\npluginEslint({\n eslintPluginOptions: {\n extensions: [\"js\", \"jsx\", \"mjs\", \"cjs\", \"ts\", \"tsx\", \"mts\", \"cts\", \"vue\"],\n },\n});\n```\n\n## License\n\n[MIT](./LICENSE).","users":{}}
![\"npm](\"https://img.shields.io/npm/v/@rsbuild/plugin-eslint?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/@rsbuild/plugin-eslint.svg?style=flat-square&colorA=564341&colorB=EDED91\")
\n