@cany748/eslint-config 3.0.3 → 3.0.4

package/dist/index.cjs

@@ -28,8 +28,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   GLOB_ALL_SRC: () => GLOB_ALL_SRC,
   GLOB_ASTRO: () => GLOB_ASTRO,
   GLOB_ASTRO_TS: () => GLOB_ASTRO_TS,
@@ -61,12 +61,14 @@ __export(src_exports, {
   GLOB_YAML: () => GLOB_YAML,
   combine: () => combine,
   comments: () => comments,
+  disables: () => disables,
   factoryConfig: () => factoryConfig,
   formatters: () => formatters,
   ignores: () => ignores,
   imports: () => imports,
   interopDefault: () => interopDefault,
   isInEditorEnv: () => isInEditorEnv,
+  isInGitHooksOrLintStaged: () => isInGitHooksOrLintStaged,
   javascript: () => javascript,
   jsonc: () => jsonc,
   node: () => node,
@@ -81,7 +83,7 @@ __export(src_exports, {
   unocss: () => unocss,
   vue: () => vue
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/configs/comments.ts
 var import_eslint_plugin_eslint_comments = __toESM(require("@eslint-community/eslint-plugin-eslint-comments"), 1);
@@ -100,10 +102,6 @@ function comments() {
   ];
 }
 
-// src/configs/formatters.ts
-var import_eslint_plugin_prettier = __toESM(require("eslint-plugin-prettier"), 1);
-var import_recommended = __toESM(require("eslint-plugin-prettier/recommended"), 1);
-
 // src/globs.ts
 var GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 var GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -189,6 +187,63 @@ var GLOB_EXCLUDE = [
   "**/components.d.ts"
 ];
 
+// src/configs/disables.ts
+function disables() {
+  return [
+    {
+      files: [`**/scripts/${GLOB_SRC}`],
+      name: "disables/scripts",
+      rules: {
+        "no-console": "off",
+        "@typescript-eslint/explicit-function-return-type": "off"
+      }
+    },
+    {
+      files: [`**/cli/${GLOB_SRC}`, `**/cli.${GLOB_SRC_EXT}`],
+      name: "disables/cli",
+      rules: {
+        "no-console": "off"
+      }
+    },
+    {
+      files: ["**/*.d.?([cm])ts"],
+      name: "disables/dts",
+      rules: {
+        "@eslint-community/eslint-comments/no-unlimited-disable": "off",
+        "import/no-duplicates": "off",
+        "no-restricted-syntax": "off",
+        "unused-imports/no-unused-vars": "off"
+      }
+    },
+    {
+      files: ["**/*.{test,spec}.([tj])s?(x)"],
+      name: "disables/test",
+      rules: {
+        "no-unused-expressions": "off"
+      }
+    },
+    {
+      files: ["**/*.js", "**/*.cjs"],
+      name: "disables/cjs",
+      rules: {
+        "@typescript-eslint/no-require-imports": "off"
+      }
+    },
+    {
+      files: [`**/*.config.${GLOB_SRC_EXT}`, `**/*.config.*.${GLOB_SRC_EXT}`],
+      name: "disables/config-files",
+      rules: {
+        "no-console": "off",
+        "@typescript-eslint/explicit-function-return-type": "off"
+      }
+    }
+  ];
+}
+
+// src/configs/formatters.ts
+var import_eslint_plugin_prettier = __toESM(require("eslint-plugin-prettier"), 1);
+var import_recommended = __toESM(require("eslint-plugin-prettier/recommended"), 1);
+
 // src/utils.ts
 var parserPlain = {
   meta: {
@@ -221,8 +276,14 @@ async function interopDefault(m) {
   const resolved = await m;
   return resolved.default || resolved;
 }
+function isInGitHooksOrLintStaged() {
+  return !!// eslint-disable-next-line no-constant-binary-expression
+  (process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged"));
+}
 function isInEditorEnv() {
-  return !!((process.env.VSCODE_PID || process.env.VSCODE_CWD || process.env.JETBRAINS_IDE || process.env.VIM || process.env.NVIM) && !process.env.CI);
+  if (process.env.CI) return false;
+  if (isInGitHooksOrLintStaged()) return false;
+  return !!(process.env.VSCODE_PID || process.env.VSCODE_CWD || process.env.JETBRAINS_IDE || process.env.VIM || process.env.NVIM);
 }
 
 // src/configs/formatters.ts
@@ -318,10 +379,10 @@ function formatters(options = true) {
 }
 
 // src/configs/ignores.ts
-function ignores() {
+function ignores(userIgnores = []) {
   return [
     {
-      ignores: GLOB_EXCLUDE
+      ignores: [...GLOB_EXCLUDE, ...userIgnores]
     }
   ];
 }
@@ -525,13 +586,7 @@ function javascript(options = {}) {
             allowUnboundThis: true
           }
         ],
-        "prefer-const": [
-          "error",
-          {
-            destructuring: "all",
-            ignoreReadBeforeAssign: true
-          }
-        ],
+        "prefer-const": isInEditor ? "warn" : ["error", { destructuring: "all", ignoreReadBeforeAssign: true }],
         "prefer-exponentiation-operator": "error",
         "prefer-promise-reject-errors": "error",
         "prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
@@ -552,7 +607,7 @@ function javascript(options = {}) {
         ],
         "symbol-description": "error",
         "unicode-bom": ["error", "never"],
-        "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
+        "unused-imports/no-unused-imports": isInEditor ? "warn" : "error",
         "unused-imports/no-unused-vars": [
           "error",
           {
@@ -569,20 +624,6 @@ function javascript(options = {}) {
         yoda: ["error", "never"],
         ...overrides
       }
-    },
-    {
-      files: [`scripts/${GLOB_SRC}`, `cli.${GLOB_SRC_EXT}`],
-      name: "javascript/disables/cli",
-      rules: {
-        "no-console": "off"
-      }
-    },
-    {
-      files: ["**/*.{test,spec}.js?(x)"],
-      name: "javascript/disables/test",
-      rules: {
-        "no-unused-expressions": "off"
-      }
     }
   ];
 }
@@ -640,6 +681,23 @@ function node() {
   ];
 }
 
+// src/configs/regexp.ts
+var import_eslint_plugin_regexp = require("eslint-plugin-regexp");
+function regexp(options = {}) {
+  const config = import_eslint_plugin_regexp.configs["flat/recommended"];
+  return [
+    {
+      ...config,
+      name: "regexp",
+      rules: {
+        ...config.rules,
+        "regexp/no-obscure-range": "off",
+        ...options.overrides
+      }
+    }
+  ];
+}
+
 // src/configs/sort.ts
 function sortPackageJson() {
   return [
@@ -886,9 +944,11 @@ async function test(options = {}) {
         "test/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
         "test/no-identical-title": "error",
         "test/no-import-node-test": "error",
-        "test/no-only-tests": isInEditor ? "off" : "error",
+        "test/no-only-tests": isInEditor ? "warn" : "error",
         "test/prefer-hooks-in-order": "error",
         "test/prefer-lowercase-title": "error",
+        "no-unused-expressions": "off",
+        "n/prefer-global/process": "off",
         "@typescript-eslint/explicit-function-return-type": "off",
         ...overrides
       }
@@ -968,7 +1028,7 @@ async function typescript(options = {}) {
         "no-invalid-this": "off",
         "@typescript-eslint/no-invalid-this": "error",
         "no-redeclare": "off",
-        "@typescript-eslint/no-redeclare": "error",
+        "@typescript-eslint/no-redeclare": ["error", { builtinGlobals: false }],
         "no-unused-expressions": "off",
         "@typescript-eslint/no-unused-expressions": ["error", { allowShortCircuit: true, allowTernary: true, allowTaggedTemplates: true }],
         "no-use-before-define": "off",
@@ -1006,32 +1066,7 @@ async function typescript(options = {}) {
           ...overridesTypeAware
         }
       }
-    ] : [],
-    {
-      files: ["**/*.d.?([cm])ts"],
-      name: "typescript/disables/dts",
-      rules: {
-        "eslint-comments/no-unlimited-disable": "off",
-        "import/no-duplicates": "off",
-        "no-restricted-syntax": "off",
-        "unused-imports/no-unused-vars": "off"
-      }
-    },
-    {
-      files: ["**/*.{test,spec}.ts?(x)"],
-      name: "typescript/disables/test",
-      rules: {
-        "no-unused-expressions": "off"
-      }
-    },
-    {
-      files: ["**/*.js", "**/*.cjs"],
-      name: "typescript/disables/cjs",
-      rules: {
-        "@typescript-eslint/no-require-imports": "off",
-        "@typescript-eslint/no-var-requires": "off"
-      }
-    }
+    ] : []
   ];
 }
 
@@ -1052,6 +1087,7 @@ function unicorn() {
         "unicorn/no-array-callback-reference": "off",
         "unicorn/no-null": "off",
         "unicorn/prefer-string-replace-all": "off",
+        "unicorn/prefer-structured-clone": "off",
         "unicorn/prefer-top-level-await": "off",
         "unicorn/prevent-abbreviations": "off"
       }
@@ -1150,35 +1186,18 @@ async function vue(options = {}) {
         "vue/prefer-template": "error",
         "vue/padding-line-between-blocks": ["error", "always"],
         "vue/component-tags-order": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
         ...overrides
       }
     }
   ];
 }
 
-// src/configs/regexp.ts
-var import_eslint_plugin_regexp = require("eslint-plugin-regexp");
-function regexp(options = {}) {
-  const config = import_eslint_plugin_regexp.configs["flat/recommended"];
-  return [
-    {
-      ...config,
-      name: "regexp",
-      rules: {
-        ...config.rules,
-        ...options.overrides
-      }
-    }
-  ];
-}
-
 // src/factory.ts
 var import_local_pkg = require("local-pkg");
 var import_eslint_flat_config_utils = require("eslint-flat-config-utils");
 var flatConfigProps = [
   "name",
-  "files",
-  "ignores",
   "languageOptions",
   "linterOptions",
   "processor",
@@ -1192,7 +1211,6 @@ var factoryConfig = function(options = {}, ...userConfigs) {
     componentExts = [],
     formatters: enableFormatters = true,
     gitignore: enableGitignore = true,
-    isInEditor = isInEditorEnv(),
     jsonc: enableJSONC = true,
     regexp: enableRegexp = true,
     test: enableTest = true,
@@ -1200,6 +1218,11 @@ var factoryConfig = function(options = {}, ...userConfigs) {
     unocss: enableUnoCSS = (0, import_local_pkg.isPackageExists)("unocss"),
     vue: enableVue = VuePackages.some((i) => (0, import_local_pkg.isPackageExists)(i))
   } = options;
+  let isInEditor = options.isInEditor;
+  if (isInEditor == null) {
+    isInEditor = isInEditorEnv();
+    if (isInEditor) console.log("[@cany748/eslint-config] Detected running in editor, some rules are disabled.");
+  }
   const configs2 = [];
   if (enableGitignore) {
     if (typeof enableGitignore === "boolean") {
@@ -1210,7 +1233,7 @@ var factoryConfig = function(options = {}, ...userConfigs) {
   }
   configs2.push(
     comments(),
-    ignores(),
+    ignores(options.ignores),
     imports(),
     javascript({
       isInEditor,
@@ -1259,6 +1282,12 @@ var factoryConfig = function(options = {}, ...userConfigs) {
   if (enableFormatters) {
     configs2.push(formatters(enableFormatters));
   }
+  configs2.push(disables());
+  if ("files" in options) {
+    throw new Error(
+      '[@cany748/eslint-config] The first argument should not contain the "files" property as the options are supposed to be global. Place it in the second or later config instead.'
+    );
+  }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
     if (key in options) acc[key] = options[key];
     return acc;
@@ -1301,12 +1330,14 @@ var factoryConfig = function(options = {}, ...userConfigs) {
   GLOB_YAML,
   combine,
   comments,
+  disables,
   factoryConfig,
   formatters,
   ignores,
   imports,
   interopDefault,
   isInEditorEnv,
+  isInGitHooksOrLintStaged,
   javascript,
   jsonc,
   node,