Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rspack-contrib/rsbuild-plugin-eslint
An Rsbuild plugin to run ESLint checks during the compilation.
https://github.com/rspack-contrib/rsbuild-plugin-eslint
rsbuild rsbuild-plugin rspack
Last synced: 16 days ago
JSON representation
An Rsbuild plugin to run ESLint checks during the compilation.
- Host: GitHub
- URL: https://github.com/rspack-contrib/rsbuild-plugin-eslint
- Owner: rspack-contrib
- License: mit
- Created: 2024-07-04T14:48:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-01T02:03:46.000Z (26 days ago)
- Last Synced: 2024-12-01T02:31:47.958Z (26 days ago)
- Topics: rsbuild, rsbuild-plugin, rspack
- Language: TypeScript
- Homepage:
- Size: 191 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rspack - @rsbuild/plugin-eslint
README
# @rsbuild/plugin-eslint
An Rsbuild plugin to run ESLint checks during the compilation.
The plugin has integrated [eslint-rspack-plugin](https://www.npmjs.com/package/eslint-rspack-plugin) internally.
## Usage
Install:
```bash
npm add @rsbuild/plugin-eslint -D
```
Add plugin to your `rsbuild.config.ts`:
```ts
// rsbuild.config.ts
import { pluginEslint } from "@rsbuild/plugin-eslint";
export default {
plugins: [pluginEslint()],
};
```
## Example Projects
- [React + ESLint project](https://github.com/rspack-contrib/rspack-examples/tree/main/rsbuild/react-eslint)
- [Vue 3 + ESLint project](https://github.com/rspack-contrib/rspack-examples/tree/main/rsbuild/vue3-eslint)
## Options
### enable
Whether to enable ESLint checking.
- **Type:** `boolean`
- **Default:** `true`
- **Example:**
Disable ESLint checking:
```js
pluginEslint({
enable: false,
});
```
Enable ESLint checking only during production builds:
```js
pluginEslint({
enable: process.env.NODE_ENV === "production",
});
```
Enable ESLint checking only during development builds:
```js
pluginEslint({
enable: process.env.NODE_ENV === "development",
});
```
### eslintPluginOptions
To modify the options of `eslint-rspack-plugin`, please refer to [eslint-rspack-plugin - README](https://github.com/rspack-contrib/eslint-rspack-plugin#readme) to learn about available options.
- **Type:** [Options](https://github.com/rspack-contrib/eslint-rspack-plugin/blob/master/types/options.d.ts)
- **Default:**
```ts
const defaultOptions = {
extensions: ["js", "jsx", "mjs", "cjs", "ts", "tsx", "mts", "cts"],
exclude: [
"node_modules",
"dist", // -> rsbuildConfig.output.distPath.root
],
};
```
The `eslintPluginOptions` object will be shallowly merged with the default configuration object.
- For example, enable ESLint v9's flat config:
```ts
pluginEslint({
eslintPluginOptions: {
cwd: __dirname,
configType: "flat",
},
});
```
- For example, exclude some files using `exclude`:
```ts
pluginEslint({
eslintPluginOptions: {
exclude: ["node_modules", "dist", "./src/foo.js"],
},
});
```
- Extend `extensions` to validate `.vue` or `.svelte` files:
```ts
pluginEslint({
eslintPluginOptions: {
extensions: ["js", "jsx", "mjs", "cjs", "ts", "tsx", "mts", "cts", "vue"],
},
});
```
## License
[MIT](./LICENSE).