@rsbuild/plugin-eslint 1.0.0-alpha.2 → 1.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+Copyright (c) 2024 Rspack Contrib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,19 +1,124 @@
-<p align="center">
-  <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
+# @rsbuild/plugin-eslint
+
+An Rsbuild plugin to run ESLint checks during the compilation.
+
+The plugin has integrated [eslint-webpack-plugin](https://www.npmjs.com/package/eslint-webpack-plugin) internally.
+
+<p>
+  <a href="https://npmjs.com/package/@rsbuild/plugin-eslint">
+   <img src="https://img.shields.io/npm/v/@rsbuild/plugin-eslint?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  </a>
+  <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
 
-# Rsbuild
+## 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-webpack-plugin`, please refer to [eslint-webpack-plugin - README](https://github.com/webpack-contrib/eslint-webpack-plugin#readme) to learn about available options.
+
+- **Type:** [Options](https://github.com/webpack-contrib/eslint-webpack-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:
 
-The Rspack-based build tool. It's fast, out-of-the-box and extensible.
+```ts
+pluginEslint({
+  eslintPluginOptions: {
+    cwd: __dirname,
+    configType: "flat",
+  },
+});
+```
 
-## Documentation
+- For example, exclude some files using `exclude`:
 
-https://rsbuild.dev/
+```ts
+pluginEslint({
+  eslintPluginOptions: {
+    exclude: ["node_modules", "dist", "./src/foo.js"],
+  },
+});
+```
 
-## Contributing
+- Extend `extensions` to validate `.vue` or `.svelte` files:
 
-Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
+```ts
+pluginEslint({
+  eslintPluginOptions: {
+    extensions: ["js", "jsx", "mjs", "cjs", "ts", "tsx", "mts", "cts", "vue"],
+  },
+});
+```
 
 ## License
 
-Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
+[MIT](./LICENSE).

package/dist/index.cjs

@@ -34,7 +34,7 @@ __export(src_exports, {
   pluginEslint: () => pluginEslint
 });
 module.exports = __toCommonJS(src_exports);
-var import_node_path = __toESM(require("path"));
+var import_node_path = __toESM(require("path"), 1);
 var PLUGIN_ESLINT_NAME = "rsbuild:eslint";
 var pluginEslint = (options = {}) => ({
   name: PLUGIN_ESLINT_NAME,

package/dist/index.d.cts

@@ -0,0 +1,19 @@
+import { RsbuildPlugin } from '@rsbuild/core';
+import { Options } from 'eslint-webpack-plugin';
+
+type PluginEslintOptions = {
+    /**
+     * Whether to enable ESLint checking.
+     * @default true
+     */
+    enable?: boolean;
+    /**
+     * To modify the options of `eslint-webpack-plugin`.
+     * @see https://github.com/webpack-contrib/eslint-webpack-plugin
+     */
+    eslintPluginOptions?: Options;
+};
+declare const PLUGIN_ESLINT_NAME = "rsbuild:eslint";
+declare const pluginEslint: (options?: PluginEslintOptions) => RsbuildPlugin;
+
+export { PLUGIN_ESLINT_NAME, type PluginEslintOptions, pluginEslint };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-import type { Options } from 'eslint-webpack-plugin';
-export type PluginEslintOptions = {
+import { RsbuildPlugin } from '@rsbuild/core';
+import { Options } from 'eslint-webpack-plugin';
+
+type PluginEslintOptions = {
     /**
      * Whether to enable ESLint checking.
      * @default true
@@ -12,5 +13,7 @@ export type PluginEslintOptions = {
      */
     eslintPluginOptions?: Options;
 };
-export declare const PLUGIN_ESLINT_NAME = "rsbuild:eslint";
-export declare const pluginEslint: (options?: PluginEslintOptions) => RsbuildPlugin;
+declare const PLUGIN_ESLINT_NAME = "rsbuild:eslint";
+declare const pluginEslint: (options?: PluginEslintOptions) => RsbuildPlugin;
+
+export { PLUGIN_ESLINT_NAME, type PluginEslintOptions, pluginEslint };

package/dist/index.js

@@ -1,13 +1,5 @@
-import { createRequire } from 'module';
-var require = createRequire(import.meta['url']);
-
-
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.54.5_eslint@9.6.0_typescript@5.5.2/node_modules/@modern-js/module-tools/shims/esm.js
-import { fileURLToPath } from "url";
-import path from "path";
-
 // src/index.ts
-import path2 from "path";
+import path from "node:path";
 var PLUGIN_ESLINT_NAME = "rsbuild:eslint";
 var pluginEslint = (options = {}) => ({
   name: PLUGIN_ESLINT_NAME,
@@ -26,7 +18,7 @@ var pluginEslint = (options = {}) => ({
         extensions: ["js", "jsx", "mjs", "cjs", "ts", "tsx", "mts", "cts"],
         exclude: [
           "node_modules",
-          path2.relative(api.context.rootPath, distPath)
+          path.relative(api.context.rootPath, distPath)
         ]
       };
       chain.plugin(CHAIN_ID.PLUGIN.ESLINT).use(ESLintPlugin, [

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "@rsbuild/plugin-eslint",
-  "version": "1.0.0-alpha.2",
-  "description": "ESLint plugin for Rsbuild",
-  "homepage": "https://rsbuild.dev",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/web-infra-dev/rsbuild",
-    "directory": "packages/plugin-eslint"
-  },
+  "version": "1.0.0",
+  "repository": "https://github.com/rspack-contrib/rsbuild-plugin-eslint",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -17,32 +11,54 @@
       "require": "./dist/index.cjs"
     }
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "simple-git-hooks": {
+    "pre-commit": "npx nano-staged"
+  },
+  "nano-staged": {
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+      "biome check --write --no-errors-on-unmatched"
+    ]
+  },
   "dependencies": {
     "eslint-webpack-plugin": "^4.2.0",
     "webpack": "^5.92.1"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.8.3",
+    "@playwright/test": "^1.44.1",
+    "@rsbuild/core": "1.0.0-alpha.3",
+    "@types/node": "^20.14.1",
     "eslint": "^9.6.0",
-    "typescript": "^5.5.2",
-    "@rsbuild/core": "1.0.0-alpha.2",
-    "@scripts/test-helper": "1.0.0-alpha.2"
+    "nano-staged": "^0.8.0",
+    "playwright": "^1.44.1",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.0.2",
+    "typescript": "^5.5.2"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^1.0.0-alpha.2",
+    "@rsbuild/core": "1.x",
     "eslint": "^8.0.0 || ^9.0.0"
   },
+  "peerDependenciesMeta": {
+    "@rsbuild/core": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "access": "public",
-    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "modern build",
-    "dev": "modern build --watch"
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "biome check .",
+    "lint:write": "biome check . --write",
+    "test": "playwright test"
   }
 }