@agilebot/eslint-config 0.2.1 → 0.2.2

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Agilebot, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2024 Agilebot, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.ts

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

package/dist/index.js

@@ -181,9 +181,13 @@ function promise() {
 var import_node_path = __toESM(require("path"));
 var import_node_fs = __toESM(require("fs"));
 var import_eslint_utils = require("@agilebot/eslint-utils");
-function eslintImport(packageDir, devDependencies) {
+function eslintImport(opts) {
   const rootDir = (0, import_eslint_utils.findRootDir)(__dirname);
-  const pkg = require(import_node_path.default.join(packageDir, "package.json"));
+  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: {
@@ -225,7 +229,7 @@ function eslintImport(packageDir, devDependencies) {
       "import/no-extraneous-dependencies": [
         "error",
         {
-          packageDir: [packageDir, tmpPkgDir, rootDir],
+          packageDir: [opts.packageDir, tmpPkgDir, rootDir],
           devDependencies: [
             "test/**/*",
             "tests/**/*",
@@ -235,7 +239,7 @@ function eslintImport(packageDir, devDependencies) {
             "**/.storybook/**",
             "**/*.stories.{ts,tsx}",
             "**/scripts/*.{ts,mts}",
-            ...devDependencies ?? []
+            ...opts.devDependencies ?? []
           ],
           includeInternal: true
         }
@@ -282,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,10 +388,10 @@ function react() {
 }
 
 // src/configs/vue.ts
-function vue(version) {
+function vue(opts) {
   return {
     extends: [
-      version === 3 ? "plugin:vue/vue3-recommended" : "plugin:vue/recommended"
+      opts.version === 3 ? "plugin:vue/vue3-recommended" : "plugin:vue/recommended"
     ]
   };
 }
@@ -457,7 +460,7 @@ function deprecation() {
 }
 
 // src/configs/cspell.ts
-function cspell(words) {
+function cspell(opts) {
   return {
     plugins: ["@cspell"],
     rules: {
@@ -467,7 +470,7 @@ function cspell(words) {
           checkComments: false,
           autoFix: false,
           cspell: {
-            words
+            words: opts.words
           }
         }
       ]
@@ -546,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 ?? {}
     );
   }
@@ -580,17 +591,18 @@ function factory(root, options) {
           standard(),
           ts(),
           promise(),
-          eslintImport(root, options?.devDependencies),
-          unicorn(),
           options?.react ? react() : {},
-          options?.vue ? vue(options.vue) : {},
+          options?.vue ? vue({
+            version: options.vue
+          }) : {},
           jsdoc(),
           lodash(),
-          eslint(),
           deprecation(),
-          cspell(options?.cspellWords ?? []),
+          cspell({
+            words: options?.cspellWords ?? []
+          }),
+          ...commonConfigs,
           agilebot(),
-          prettier(),
           options?.config ?? {}
         )
       },
@@ -601,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.1",
+  "version": "0.2.2",
   "description": "Agilebot's ESLint config",
   "main": "dist",
   "types": "dist/index.d.ts",
@@ -40,7 +40,7 @@
     "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.1"
+    "@agilebot/eslint-utils": "0.2.2"
   },
   "peerDependencies": {
     "@agilebot/eslint-plugin": "*",