@agilebot/eslint-config 0.2.0 → 0.2.2

package/README.md

@@ -1,17 +1,16 @@
-# @agilebot/eslint-config
-
-### Usage
-
-```bash
-npm install --save-dev eslint \
-  @agilebot/eslint-config \
-  @agilebot/eslint-plugin \
-  @agilebot/eslint-utils
-```
-
-```js
-// .eslintrc.js
-const { agilebot } = require('@agilebot/eslint-utils');
-
-module.exports = agilebot(__dirname);
-```
+# @agilebot/eslint-config
+
+### Usage
+
+```bash
+npm install --save-dev eslint \
+  @agilebot/eslint-config \
+  @agilebot/eslint-plugin
+```
+
+```js
+// .eslintrc.js
+const { agilebot } = require('@agilebot/eslint-config');
+
+module.exports = agilebot(__dirname);
+```

package/dist/index.d.ts

@@ -5,6 +5,8 @@ interface FactoryOptions {
     cspellWords?: string[];
     config?: Linter.Config;
     react?: boolean;
+    vue?: number;
+    module?: boolean;
     godaddy?: boolean;
 }
 declare function factory(root: string, options?: FactoryOptions): Linter.BaseConfig;

package/dist/index.js

@@ -180,11 +180,14 @@ function promise() {
 // src/configs/import.ts
 var import_node_path = __toESM(require("path"));
 var import_node_fs = __toESM(require("fs"));
-var import_find_root = require("@manypkg/find-root");
 var import_eslint_utils = require("@agilebot/eslint-utils");
-function eslintImport(packageDir, devDependencies) {
-  const { rootDir } = (0, import_find_root.findRootSync)(__dirname);
-  const pkg = require(import_node_path.default.join(packageDir, "package.json"));
+function eslintImport(opts) {
+  const rootDir = (0, import_eslint_utils.findRootDir)(__dirname);
+  const pkgPath = import_node_path.default.join(opts.packageDir, "package.json");
+  if (!import_node_fs.default.existsSync(pkgPath)) {
+    throw new Error(`package.json not found in ${opts.packageDir}`);
+  }
+  const pkg = JSON.parse(import_node_fs.default.readFileSync(pkgPath, "utf8"));
   const tmpPkg = {
     name: `${pkg.name}/tmp`,
     dependencies: {
@@ -192,7 +195,7 @@ function eslintImport(packageDir, devDependencies) {
     }
   };
   const tmpPkgSafeName = tmpPkg.name.replaceAll("/", "__");
-  const cacheDir = (0, import_eslint_utils.getCacheDir)(rootDir);
+  const cacheDir = (0, import_eslint_utils.findCacheDir)(rootDir);
   const tmpPkgDir = import_node_path.default.join(cacheDir, "tmp-pkg", tmpPkgSafeName);
   if (!import_node_fs.default.existsSync(tmpPkgDir)) {
     import_node_fs.default.mkdirSync(tmpPkgDir, { recursive: true });
@@ -226,7 +229,7 @@ function eslintImport(packageDir, devDependencies) {
       "import/no-extraneous-dependencies": [
         "error",
         {
-          packageDir: [packageDir, tmpPkgDir, rootDir],
+          packageDir: [opts.packageDir, tmpPkgDir, rootDir],
           devDependencies: [
             "test/**/*",
             "tests/**/*",
@@ -236,7 +239,7 @@ function eslintImport(packageDir, devDependencies) {
             "**/.storybook/**",
             "**/*.stories.{ts,tsx}",
             "**/scripts/*.{ts,mts}",
-            ...devDependencies ?? []
+            ...opts.devDependencies ?? []
           ],
           includeInternal: true
         }
@@ -283,21 +286,20 @@ function eslintImport(packageDir, devDependencies) {
 }
 
 // src/configs/unicorn.ts
-function unicorn() {
+function unicorn(opts) {
   return {
     plugins: ["unicorn"],
     extends: ["plugin:unicorn/recommended"],
     rules: {
-      // unicorn默认规则太严格，屏蔽以下
+      "unicorn/prefer-module": opts.module ? "error" : "off",
+      "unicorn/prefer-top-level-await": opts.module ? "error" : "off",
       "unicorn/filename-case": "off",
       "unicorn/import-style": "off",
       "unicorn/prefer-at": "off",
       "unicorn/prevent-abbreviations": "off",
       "unicorn/prefer-date-now": "off",
       "unicorn/no-process-exit": "off",
-      "unicorn/prefer-module": "off",
       "unicorn/no-null": "off",
-      "unicorn/prefer-top-level-await": "off",
       "unicorn/consistent-function-scoping": "off",
       "unicorn/numeric-separators-style": "off",
       "unicorn/prefer-optional-catch-binding": "off",
@@ -385,6 +387,15 @@ function react() {
   };
 }
 
+// src/configs/vue.ts
+function vue(opts) {
+  return {
+    extends: [
+      opts.version === 3 ? "plugin:vue/vue3-recommended" : "plugin:vue/recommended"
+    ]
+  };
+}
+
 // src/configs/jsdoc.ts
 function jsdoc() {
   return {
@@ -449,7 +460,7 @@ function deprecation() {
 }
 
 // src/configs/cspell.ts
-function cspell(words) {
+function cspell(opts) {
   return {
     plugins: ["@cspell"],
     rules: {
@@ -459,7 +470,7 @@ function cspell(words) {
           checkComments: false,
           autoFix: false,
           cspell: {
-            words
+            words: opts.words
           }
         }
       ]
@@ -470,7 +481,30 @@ function cspell(words) {
 // src/configs/agilebot.ts
 function agilebot() {
   return {
-    extends: ["plugin:@agilebot/recommended"]
+    extends: ["plugin:@agilebot/recommended"],
+    plugins: ["react-hooks"],
+    rules: {
+      "react-hooks/exhaustive-deps": "off",
+      "@agilebot/react/better-exhaustive-deps": [
+        "warn",
+        {
+          checkMemoizedVariableIsStatic: true,
+          staticHooks: {
+            "useIpc.*": {
+              value: true,
+              regexp: true
+            },
+            useDialog: true,
+            useSnackbar: true,
+            useForm: true,
+            "use.*Store": {
+              value: true,
+              regexp: true
+            }
+          }
+        }
+      ]
+    }
   };
 }
 
@@ -515,13 +549,21 @@ function godaddy() {
 // src/factory.ts
 function factory(root, options) {
   import_node_assert.default.ok(root, "root option is required");
+  const commonConfigs = [
+    unicorn({
+      module: options?.module ?? false
+    }),
+    eslint(),
+    eslintImport({
+      packageDir: root,
+      devDependencies: options?.devDependencies
+    }),
+    prettier()
+  ];
   if (options?.godaddy) {
     return (0, import_eslint_utils3.mergeESLintConfig)(
       godaddy(),
-      prettier(),
-      unicorn(),
-      eslint(),
-      eslintImport(root, options?.devDependencies),
+      ...commonConfigs,
       options?.config ?? {}
     );
   }
@@ -536,10 +578,12 @@ function factory(root, options) {
           "*.js",
           "*.jsx",
           "*.cjs",
-          "*.mjs"
+          "*.mjs",
+          "*.vue"
         ],
-        parser: "@typescript-eslint/parser",
+        parser: !options?.vue ? "@typescript-eslint/parser" : "vue-eslint-parser",
         parserOptions: {
+          parser: "@typescript-eslint/parser",
           tsconfigRootDir: root
         },
         ...(0, import_eslint_utils3.mergeESLintConfig)(
@@ -547,16 +591,18 @@ function factory(root, options) {
           standard(),
           ts(),
           promise(),
-          eslintImport(root, options?.devDependencies),
-          unicorn(),
           options?.react ? react() : {},
+          options?.vue ? vue({
+            version: options.vue
+          }) : {},
           jsdoc(),
           lodash(),
-          eslint(),
           deprecation(),
-          cspell(options?.cspellWords ?? []),
+          cspell({
+            words: options?.cspellWords ?? []
+          }),
+          ...commonConfigs,
           agilebot(),
-          prettier(),
           options?.config ?? {}
         )
       },
@@ -567,7 +613,7 @@ function factory(root, options) {
         }
       },
       {
-        files: ["*.d.ts"],
+        files: ["*.d.ts", "*.cts", "*.mts"],
         rules: {
           // .d.ts中支持导入ts文件中的类型
           "@typescript-eslint/consistent-type-imports": "off",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-config",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Agilebot's ESLint config",
   "main": "dist",
   "types": "dist/index.d.ts",
@@ -16,7 +16,6 @@
   "homepage": "https://github.com/sh-agilebot/frontend-toolkit/tree/master/packages/eslint-config#readme",
   "dependencies": {
     "@cspell/eslint-plugin": "^8.7.0",
-    "@manypkg/find-root": "^2.2.1",
     "@stylistic/eslint-plugin": "^1.7.0",
     "@typescript-eslint/eslint-plugin": "^7.6.0",
     "@typescript-eslint/parser": "^7.6.0",
@@ -38,9 +37,10 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-prefer-function-component": "^3.3.0",
     "eslint-plugin-unicorn": "^52.0.0",
+    "eslint-plugin-vue": "^9.25.0",
     "eslint-plugin-you-dont-need-lodash-underscore": "^6.13.0",
     "fast-glob": "^3.3.2",
-    "@agilebot/eslint-utils": "0.2.0"
+    "@agilebot/eslint-utils": "0.2.2"
   },
   "peerDependencies": {
     "@agilebot/eslint-plugin": "*",