@agilebot/eslint-config 0.2.5 → 0.3.0

package/dist/cli.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.2.5
+ * @license @agilebot/eslint-config v0.3.0
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -48,7 +48,7 @@ var import_node_fs = __toESM(require("fs"));
 var import_node_path = __toESM(require("path"));
 var import_eslint_utils = require("@agilebot/eslint-utils");
 
-// src/cli/constants.ts
+// src/factory/constants.ts
 var defaultExtensions = [
   ".js",
   ".jsx",
@@ -60,6 +60,8 @@ var defaultExtensions = [
   ".mts",
   ".vue"
 ];
+
+// src/cli/constants.ts
 var isEslint = /^\.eslint.*/;
 
 // src/cli/index.ts
@@ -69,7 +71,8 @@ function cli() {
     ext: false,
     fix: false,
     config: false,
-    checkIntl: false
+    checkIntl: false,
+    progress: false
   };
   const pkg = require.resolve("eslint/package.json");
   const bin = import_node_path.default.join(pkg, "..", "bin", "eslint.js");
@@ -78,6 +81,7 @@ function cli() {
     has.fix = has.fix || arg === "--fix";
     has.config = has.config || arg === "-c" || arg === "--config";
     has.checkIntl = has.checkIntl || arg === "--check-intl";
+    has.progress = has.progress || arg === "--progress";
   });
   if (!has.fix) {
     process.argv.splice(2, 0, "--fix");
@@ -85,7 +89,7 @@ function cli() {
   if (!has.ext) {
     process.argv.splice(2, 0, "--ext", defaultExtensions.join(","));
   }
-  if (!(0, import_eslint_utils.isCI)()) {
+  if (has.progress && !(0, import_eslint_utils.isCI)()) {
     process.argv.splice(
       2,
       0,

package/dist/index.d.ts

@@ -1,14 +1,32 @@
 import { Linter } from 'eslint';
 
 interface FactoryOptions {
+    /** ESLint configuration (default: undefined) */
+    config?: Pick<Linter.Config, 'rules' | 'settings'>;
+    /** List of development dependencies (default: undefined) */
     devDependencies?: string[];
+    /** List of core modules (default: undefined) */
+    coreModules?: string[];
+    /** List of words to include in cspell (default: undefined) */
     cspellWords?: string[];
+    /** Monorepo scope (default: undefined) */
     monorepoScope?: string;
-    config?: Linter.Config;
-    react?: boolean;
+    /** Flag indicating whether to enable React configurations (default: undefined) */
+    react?: boolean | number;
+    /** Version of Vue.js (optional) (default: undefined) */
     vue?: number;
+    /** Flag indicating whether ES modules are used (default: undefined) */
     module?: boolean;
+    /** Flag indicating whether to enable GoDaddy configurations (default: undefined) */
     godaddy?: boolean;
+    /** Flag indicating whether to enable JSDoc configurations (default: true) */
+    jsdoc?: boolean;
+    /** Flag indicating whether to enable Prettier configurations (default: true) */
+    prettier?: boolean;
+    /** Flag indicating whether to enable Lodash configurations (default: true) */
+    lodash?: boolean;
+    /** Flag indicating whether to enable CSpell configurations (default: true) */
+    cspell?: boolean;
 }
 declare function factory(root: string, options?: FactoryOptions): Linter.BaseConfig;
 

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.2.5
+ * @license @agilebot/eslint-config v0.3.0
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -10,7 +10,9 @@
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __getProtoOf = Object.getPrototypeOf;
@@ -28,6 +30,7 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -57,10 +60,9 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/factory.ts
+// src/factory/index.ts
 var import_node_assert = __toESM(require("assert"));
-var import_eslint_utils2 = require("@agilebot/eslint-utils");
-var import_fast_glob = require("fast-glob");
+var import_eslint_utils3 = require("@agilebot/eslint-utils");
 
 // src/configs/env.ts
 function env() {
@@ -77,17 +79,20 @@ function env() {
 }
 
 // src/configs/standard.ts
+var import_eslint_config_love = __toESM(require("eslint-config-love"));
 function standard() {
+  const standardRules = {};
+  Object.entries(import_eslint_config_love.default.rules).forEach(([key, value]) => {
+    if (key.startsWith("import/")) {
+      standardRules[`import-x/${key.slice(7)}`] = value;
+    } else {
+      standardRules[key] = value;
+    }
+  });
   return {
-    extends: ["love"],
-    rules: {
+    plugins: ["@typescript-eslint", "import-x", "n", "promise"],
+    rules: __spreadProps(__spreadValues({}, standardRules), {
       "no-alert": "error",
-      // 避免使用同步方法
-      "n/no-sync": "error",
-      // 尽量使用fs.promises而不是fs
-      "n/prefer-promises/fs": "error",
-      "arrow-body-style": "off",
-      curly: "error",
       // 找出TODO注释，以便后期修复
       "no-warning-comments": [
         "warn",
@@ -95,16 +100,48 @@ function standard() {
           terms: ["todo", "fixme"]
         }
       ],
+      // 避免使用同步方法
+      "n/no-sync": "error",
+      // 尽量使用fs.promises而不是fs
+      "n/prefer-promises/fs": "error",
       // 路径拼接使用path.join，而不是直接使用加号
-      "n/no-path-concat": "error"
-    }
+      "n/no-path-concat": "error",
+      "promise/no-return-wrap": "error",
+      "promise/no-nesting": "error",
+      "promise/no-promise-in-callback": "error",
+      "promise/no-callback-in-promise": "error",
+      "promise/param-names": "error",
+      "promise/valid-params": "error",
+      "promise/no-multiple-resolved": "error",
+      "promise/no-return-in-finally": "error",
+      "promise/prefer-await-to-then": "warn",
+      // 覆盖standard中的规则
+      "@typescript-eslint/no-confusing-void-expression": "off",
+      "@typescript-eslint/space-before-function-paren": "off",
+      "@typescript-eslint/unbound-method": "off",
+      "@typescript-eslint/no-extraneous-class": "off",
+      "@typescript-eslint/consistent-type-assertions": "off",
+      "@typescript-eslint/method-signature-style": "off",
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/strict-boolean-expressions": "off",
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+      "@typescript-eslint/explicit-member-accessibility": "off",
+      "@typescript-eslint/no-unsafe-argument": "off"
+    })
   };
 }
 
 // src/configs/ts.ts
+var import_eslint_utils = require("@agilebot/eslint-utils");
 function ts() {
   return {
-    plugins: ["@typescript-eslint", "@stylistic", "prefer-arrow-functions"],
+    plugins: [
+      "@typescript-eslint",
+      "@stylistic",
+      "prefer-arrow-functions",
+      "unused-imports"
+    ],
     rules: {
       // 如果没用模板字符串，避免使用反引号
       "@stylistic/quotes": ["error", "single", { avoidEscape: true }],
@@ -118,7 +155,21 @@ function ts() {
           singleReturnOnly: false
         }
       ],
-      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-unused-vars": "off",
+      "unused-imports/no-unused-imports": (0, import_eslint_utils.isInEditor)() ? "off" : "error",
+      "unused-imports/no-unused-vars": [
+        "warn",
+        {
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          vars: "all",
+          varsIgnorePattern: "^_",
+          caughtErrors: "none",
+          caughtErrorsIgnorePattern: "^_",
+          destructuredArrayIgnorePattern: "^_",
+          ignoreRestSiblings: true
+        }
+      ],
       // 优先使用interface而不是type
       "@typescript-eslint/consistent-type-definitions": "error",
       // The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings.
@@ -179,33 +230,7 @@ function ts() {
         {
           checksVoidReturn: false
         }
-      ],
-      // 以下是关闭的规则
-      "@typescript-eslint/strict-boolean-expressions": "off",
-      "@typescript-eslint/explicit-function-return-type": "off",
-      "@typescript-eslint/restrict-template-expressions": "off",
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "@typescript-eslint/method-signature-style": "off",
-      "@typescript-eslint/consistent-type-assertions": "off",
-      "@typescript-eslint/no-extraneous-class": "off",
-      "@typescript-eslint/no-confusing-void-expression": "off",
-      "@typescript-eslint/explicit-member-accessibility": "off",
-      "@typescript-eslint/unbound-method": "off",
-      "@typescript-eslint/no-unsafe-argument": "off"
-    }
-  };
-}
-
-// src/configs/promise.ts
-function promise() {
-  return {
-    plugins: ["promise"],
-    rules: {
-      "promise/no-nesting": "error",
-      "promise/no-promise-in-callback": "error",
-      "promise/param-names": "error",
-      "promise/no-multiple-resolved": "error",
-      "promise/no-return-in-finally": "error"
+      ]
     }
   };
 }
@@ -213,10 +238,10 @@ function promise() {
 // src/configs/import.ts
 var import_node_path = __toESM(require("path"));
 var import_node_fs = __toESM(require("fs"));
-var import_eslint_utils = require("@agilebot/eslint-utils");
+var import_eslint_utils2 = require("@agilebot/eslint-utils");
 function eslintImport(opts) {
-  var _a;
-  const rootDir = (0, import_eslint_utils.findRootDir)(__dirname);
+  var _a, _b;
+  const rootDir = (0, import_eslint_utils2.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}`);
@@ -228,8 +253,8 @@ function eslintImport(opts) {
       [pkg.name]: "*"
     }
   };
-  const tmpPkgSafeName = tmpPkg.name.replaceAll("/", "__");
-  const cacheDir = (0, import_eslint_utils.findCacheDir)(rootDir);
+  const tmpPkgSafeName = tmpPkg.name.replace(/\//g, "__");
+  const cacheDir = (0, import_eslint_utils2.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 });
@@ -237,30 +262,30 @@ function eslintImport(opts) {
   const tmpPkgJson = JSON.stringify(tmpPkg, null, 2);
   import_node_fs.default.writeFileSync(import_node_path.default.join(tmpPkgDir, "package.json"), tmpPkgJson);
   return {
-    plugins: ["import", "no-relative-import-paths"],
-    extends: ["plugin:import/recommended", "plugin:import/typescript"],
+    plugins: ["import-x", "no-relative-import-paths"],
+    extends: ["plugin:import-x/recommended", "plugin:import-x/typescript"],
     rules: {
-      "import/no-unresolved": "error",
-      "import/no-named-as-default-member": "off",
-      "import/no-named-as-default": "off",
-      "import/no-useless-path-segments": [
+      "import-x/no-unresolved": "error",
+      "import-x/no-named-as-default-member": "off",
+      "import-x/no-named-as-default": "off",
+      "import-x/no-useless-path-segments": [
         "error",
         {
           noUselessIndex: true
         }
       ],
-      "import/no-cycle": "error",
-      "import/newline-after-import": "error",
-      "import/first": "error",
-      "import/no-import-module-exports": "error",
-      "import/no-anonymous-default-export": [
+      "import-x/no-cycle": "error",
+      "import-x/newline-after-import": "error",
+      "import-x/first": "error",
+      "import-x/no-import-module-exports": "error",
+      "import-x/no-anonymous-default-export": [
         "error",
         {
           allowArray: true,
           allowObject: true
         }
       ],
-      "import/no-extraneous-dependencies": [
+      "import-x/no-extraneous-dependencies": [
         "error",
         {
           packageDir: [opts.packageDir, tmpPkgDir, rootDir],
@@ -278,7 +303,7 @@ function eslintImport(opts) {
           includeInternal: true
         }
       ],
-      "import/order": [
+      "import-x/order": [
         "error",
         {
           groups: [
@@ -307,15 +332,16 @@ function eslintImport(opts) {
       ]
     },
     settings: {
-      "import/parsers": {
+      "import-x/parsers": {
         "@typescript-eslint/parser": [".ts", ".tsx"]
       },
-      "import/resolver": {
+      "import-x/resolver": {
         typescript: {
           alwaysTryTypes: true
         }
       },
-      "import/internal-regex": opts.monorepoScope ? `^${opts.monorepoScope.replaceAll("/", "")}/` : void 0
+      "import-x/internal-regex": opts.monorepoScope ? `^${opts.monorepoScope.replace(/\//g, "")}/` : void 0,
+      "import-x/core-modules": (_b = opts.coreModules) != null ? _b : void 0
     }
   };
 }
@@ -359,7 +385,7 @@ function unicorn(opts) {
 }
 
 // src/configs/react.ts
-function react() {
+function react(opts) {
   return {
     plugins: ["react", "react-hooks", "jsx-a11y"],
     extends: [
@@ -416,7 +442,7 @@ function react() {
     },
     settings: {
       react: {
-        version: "detect"
+        version: typeof opts.version === "number" ? opts.version : "detect"
       }
     }
   };
@@ -432,10 +458,12 @@ function vue(opts) {
 }
 
 // src/configs/jsdoc.ts
-function jsdoc() {
+function jsdoc(opt) {
   return {
     plugins: ["jsdoc"],
-    extends: ["plugin:jsdoc/recommended-typescript-error"],
+    extends: [
+      opt.ts ? "plugin:jsdoc/recommended-typescript-error" : "plugin:jsdoc/recommended-error"
+    ],
     rules: {
       // 禁止有空行
       "jsdoc/no-blank-block-descriptions": "error",
@@ -457,8 +485,8 @@ function lodash() {
   };
 }
 
-// src/configs/eslint.ts
-function eslint() {
+// src/configs/comments.ts
+function comments() {
   return {
     plugins: ["eslint-comments"],
     rules: {
@@ -540,27 +568,28 @@ function agilebot(opts) {
     },
     settings: {
       "agilebot/project-root": opts.root,
-      "agilebot/monorepo-scope": opts.monorepoScope ? (
-        // eslint-disable-next-line unicorn/prefer-string-replace-all -- not supported in Node.js 12
-        opts.monorepoScope.replace(/\//g, "")
-      ) : void 0
+      "agilebot/monorepo-scope": opts.monorepoScope ? opts.monorepoScope.replace(/\//g, "") : void 0
     }
   };
 }
 
 // src/configs/prettier.ts
+var import_recommended = __toESM(require("eslint-plugin-prettier/recommended"));
 function prettier() {
   return {
     plugins: ["prettier"],
-    extends: ["plugin:prettier/recommended"],
-    rules: {
+    // Do not extends
+    // extends: ['plugin:prettier/recommended'],
+    rules: __spreadProps(__spreadValues({}, import_recommended.default.rules), {
+      curly: "error",
+      "arrow-body-style": "off",
       "prettier/prettier": [
         "error",
         {
           endOfLine: "auto"
         }
       ]
-    }
+    })
   };
 }
 
@@ -590,64 +619,91 @@ function godaddy() {
   };
 }
 
-// src/factory.ts
+// src/factory/constants.ts
+var defaultExtensions = [
+  ".js",
+  ".jsx",
+  ".ts",
+  ".tsx",
+  ".cjs",
+  ".mjs",
+  ".cts",
+  ".mts",
+  ".vue"
+];
+var jsExtensions = [".js", ".jsx", ".cjs", ".mjs"];
+var tsExtensions = [".ts", ".tsx", ".cts", ".mts"];
+var dtsExtensions = [".d.ts", ".d.cts", ".d.mts"];
+
+// src/factory/index.ts
 function factory(root, options) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e;
   import_node_assert.default.ok(root, "root option is required");
+  const defaultOptions = {
+    jsdoc: true,
+    prettier: true,
+    lodash: true,
+    cspell: true
+  };
+  options = __spreadValues(__spreadValues({}, defaultOptions), options);
+  if (options == null ? void 0 : options.config) {
+    import_node_assert.default.ok(
+      Object.keys(options.config).every(
+        (key) => key === "rules" || key === "settings"
+      ),
+      "config option must only contain rules and settings"
+    );
+  }
   const commonConfigs = [
     unicorn({
       module: (_a = options == null ? void 0 : options.module) != null ? _a : false
     }),
-    eslint(),
+    comments(),
     eslintImport({
       packageDir: root,
       devDependencies: options == null ? void 0 : options.devDependencies,
-      monorepoScope: options == null ? void 0 : options.monorepoScope
+      monorepoScope: options == null ? void 0 : options.monorepoScope,
+      coreModules: options == null ? void 0 : options.coreModules
     }),
-    prettier()
+    options.prettier ? prettier() : {}
   ];
   if (options == null ? void 0 : options.godaddy) {
-    return (0, import_eslint_utils2.mergeESLintConfig)(
+    return (0, import_eslint_utils3.mergeESLintConfig)(
       godaddy(),
       ...commonConfigs,
       (_b = options == null ? void 0 : options.config) != null ? _b : {}
     );
   }
+  const tsconfigFiles = (0, import_eslint_utils3.findTsconfigFiles)(root, {
+    absolute: true
+  });
   const config = {
     overrides: [
       __spreadValues({
-        files: [
-          "*.ts",
-          "*.tsx",
-          "*.cts",
-          "*.mts",
-          "*.js",
-          "*.jsx",
-          "*.cjs",
-          "*.mjs",
-          "*.vue"
-        ],
+        files: defaultExtensions.map((ext) => `*${ext}`),
         parser: !(options == null ? void 0 : options.vue) ? "@typescript-eslint/parser" : "vue-eslint-parser",
         parserOptions: {
           parser: "@typescript-eslint/parser",
           tsconfigRootDir: root,
           extraFileExtensions: !(options == null ? void 0 : options.vue) ? void 0 : [".vue"]
         }
-      }, (0, import_eslint_utils2.mergeESLintConfig)(
+      }, (0, import_eslint_utils3.mergeESLintConfig)(
         env(),
         standard(),
+        // standard必须在ts之前
         ts(),
-        promise(),
-        (options == null ? void 0 : options.react) ? react() : {},
+        (options == null ? void 0 : options.react) ? react({ version: options.react }) : {},
         (options == null ? void 0 : options.vue) ? vue({
           version: options.vue
         }) : {},
-        jsdoc(),
-        lodash(),
+        (options == null ? void 0 : options.jsdoc) ? jsdoc({
+          ts: true
+        }) : {},
+        (options == null ? void 0 : options.lodash) ? lodash() : {},
         deprecation(),
-        cspell({
+        (options == null ? void 0 : options.cspell) ? cspell({
           words: (_c = options == null ? void 0 : options.cspellWords) != null ? _c : []
-        }),
+        }) : {},
         ...commonConfigs,
         agilebot({
           root,
@@ -655,14 +711,26 @@ function factory(root, options) {
         }),
         (_d = options == null ? void 0 : options.config) != null ? _d : {}
       )),
+      __spreadValues({
+        files: jsExtensions.map((ext) => `*${ext}`)
+      }, (0, import_eslint_utils3.mergeESLintConfig)(
+        {
+          rules: {
+            "@typescript-eslint/no-var-requires": "off"
+          }
+        },
+        (options == null ? void 0 : options.jsdoc) ? jsdoc({
+          ts: false
+        }) : {}
+      )),
       {
-        files: ["*.ts", "*.tsx"],
+        files: tsExtensions.map((ext) => `*${ext}`),
         rules: {
           "@typescript-eslint/explicit-member-accessibility": "error"
         }
       },
       {
-        files: ["*.d.ts", "*.cts", "*.mts"],
+        files: dtsExtensions.map((ext) => `*${ext}`),
         rules: {
           // .d.ts中支持导入ts文件中的类型
           "@typescript-eslint/consistent-type-imports": "off",
@@ -671,24 +739,11 @@ function factory(root, options) {
           // .d.ts中忽略三斜线引用
           "@typescript-eslint/triple-slash-reference": "off"
         }
-      },
-      {
-        files: ["*.js", "*.jsx", "*.cjs"],
-        rules: {
-          "@typescript-eslint/no-var-requires": "off"
-        }
       }
     ]
   };
-  const tsconfigFiles = (0, import_fast_glob.globSync)("tsconfig*.json", {
-    cwd: root
-  });
-  if (config.parserOptions) {
-    if (tsconfigFiles.length > 0) {
-      config.parserOptions.project = tsconfigFiles;
-    } else {
-      config.parserOptions.project = true;
-    }
+  if ((_e = config.overrides) == null ? void 0 : _e[0].parserOptions) {
+    config.overrides[0].parserOptions.project = tsconfigFiles.length > 0 ? tsconfigFiles : true;
   }
   return config;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-config",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Agilebot's ESLint config",
   "bin": {
     "eslint-agilebot": "bin/eslint-agilebot"
@@ -20,8 +20,8 @@
   "dependencies": {
     "@cspell/eslint-plugin": "^8.7.0",
     "@stylistic/eslint-plugin": "^1.7.0",
-    "@typescript-eslint/eslint-plugin": "^7.6.0",
-    "@typescript-eslint/parser": "^7.6.0",
+    "@typescript-eslint/eslint-plugin": "~7.7.0",
+    "@typescript-eslint/parser": "~7.7.0",
     "eslint-config-godaddy": "^6.0.0",
     "eslint-config-love": "^47.0.0",
     "eslint-config-prettier": "^9.1.0",
@@ -29,7 +29,7 @@
     "eslint-plugin-deprecation": "^2.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-file-progress": "^1.3.0",
-    "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
+    "eslint-plugin-import-x": "^0.5.0",
     "eslint-plugin-jsdoc": "^48.2.1",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-n": "^17.2.0",
@@ -41,14 +41,15 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-prefer-function-component": "^3.3.0",
     "eslint-plugin-unicorn": "^52.0.0",
+    "eslint-plugin-unused-imports": "^3.2.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.5"
+    "vue-eslint-parser": "^9.4.2",
+    "@agilebot/eslint-utils": "0.3.0"
   },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0",
-    "@agilebot/eslint-plugin": "0.2.5"
+    "@agilebot/eslint-plugin": "0.3.0"
   },
   "files": [
     "bin",