@cany748/eslint-config 3.0.3 → 3.0.5

package/dist/index.js

@@ -15,10 +15,6 @@ function comments() {
   ];
 }
 
-// src/configs/formatters.ts
-import pluginPrettier from "eslint-plugin-prettier";
-import configPrettier from "eslint-plugin-prettier/recommended";
-
 // src/globs.ts
 var GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 var GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
@@ -104,6 +100,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
+import pluginPrettier from "eslint-plugin-prettier";
+import configPrettier from "eslint-plugin-prettier/recommended";
+
 // src/utils.ts
 var parserPlain = {
   meta: {
@@ -136,8 +189,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
@@ -233,10 +292,10 @@ function formatters(options = true) {
 }
 
 // src/configs/ignores.ts
-function ignores() {
+function ignores(userIgnores = []) {
   return [
     {
-      ignores: GLOB_EXCLUDE
+      ignores: [...GLOB_EXCLUDE, ...userIgnores]
     }
   ];
 }
@@ -440,13 +499,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 }],
@@ -467,7 +520,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",
           {
@@ -484,20 +537,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"
-      }
     }
   ];
 }
@@ -555,6 +594,23 @@ function node() {
   ];
 }
 
+// src/configs/regexp.ts
+import { configs } from "eslint-plugin-regexp";
+function regexp(options = {}) {
+  const config = configs["flat/recommended"];
+  return [
+    {
+      ...config,
+      name: "regexp",
+      rules: {
+        ...config.rules,
+        "regexp/no-obscure-range": "off",
+        ...options.overrides
+      }
+    }
+  ];
+}
+
 // src/configs/sort.ts
 function sortPackageJson() {
   return [
@@ -801,9 +857,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
       }
@@ -883,7 +941,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",
@@ -921,32 +979,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"
-      }
-    }
+    ] : []
   ];
 }
 
@@ -967,6 +1000,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"
       }
@@ -1065,35 +1099,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
-import { configs } from "eslint-plugin-regexp";
-function regexp(options = {}) {
-  const config = configs["flat/recommended"];
-  return [
-    {
-      ...config,
-      name: "regexp",
-      rules: {
-        ...config.rules,
-        ...options.overrides
-      }
-    }
-  ];
-}
-
 // src/factory.ts
 import { isPackageExists } from "local-pkg";
 import { FlatConfigComposer } from "eslint-flat-config-utils";
 var flatConfigProps = [
   "name",
-  "files",
-  "ignores",
   "languageOptions",
   "linterOptions",
   "processor",
@@ -1107,7 +1124,6 @@ var factoryConfig = function(options = {}, ...userConfigs) {
     componentExts = [],
     formatters: enableFormatters = true,
     gitignore: enableGitignore = true,
-    isInEditor = isInEditorEnv(),
     jsonc: enableJSONC = true,
     regexp: enableRegexp = true,
     test: enableTest = true,
@@ -1115,6 +1131,11 @@ var factoryConfig = function(options = {}, ...userConfigs) {
     unocss: enableUnoCSS = isPackageExists("unocss"),
     vue: enableVue = VuePackages.some((i) => 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") {
@@ -1125,7 +1146,7 @@ var factoryConfig = function(options = {}, ...userConfigs) {
   }
   configs2.push(
     comments(),
-    ignores(),
+    ignores(options.ignores),
     imports(),
     javascript({
       isInEditor,
@@ -1174,6 +1195,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;
@@ -1215,12 +1242,14 @@ export {
   GLOB_YAML,
   combine,
   comments,
+  disables,
   factoryConfig,
   formatters,
   ignores,
   imports,
   interopDefault,
   isInEditorEnv,
+  isInGitHooksOrLintStaged,
   javascript,
   jsonc,
   node,

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "@cany748/eslint-config",
   "type": "module",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
+    ".": "./dist/index.js"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,9 +11,9 @@
     "dist"
   ],
   "peerDependencies": {
-    "@unocss/eslint-plugin": "^0.62.3",
-    "eslint-plugin-vue": "^9.28.0",
-    "typescript-eslint": "^8.5.0"
+    "@unocss/eslint-plugin": "^65.5.0",
+    "eslint-plugin-vue": "^9.32.0",
+    "typescript-eslint": "^8.25.0"
   },
   "peerDependenciesMeta": {
     "@unocss/eslint-plugin": {
@@ -30,50 +27,51 @@
     }
   },
   "dependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
-    "@vitest/eslint-plugin": "^1.1.0",
-    "eslint": "^9.10.0",
-    "eslint-config-flat-gitignore": "^0.3.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-flat-config-utils": "^0.4.0",
-    "eslint-plugin-import-x": "^4.2.1",
-    "eslint-plugin-jsonc": "^2.16.0",
-    "eslint-plugin-n": "^17.10.2",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "@vitest/eslint-plugin": "^1.1.35",
+    "eslint": "^9.21.0",
+    "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-config-prettier": "^10.0.2",
+    "eslint-flat-config-utils": "^2.0.1",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-jsonc": "^2.19.1",
+    "eslint-plugin-n": "^17.15.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-regexp": "^2.6.0",
-    "eslint-plugin-unicorn": "^55.0.0",
-    "eslint-plugin-unused-imports": "^4.1.3",
-    "globals": "^15.9.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-unicorn": "^57.0.0",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "globals": "^16.0.0",
+    "jiti": "^2.4.2",
     "jsonc-eslint-parser": "^2.4.0",
-    "local-pkg": "^0.5.0",
-    "prettier": "^3.3.3"
+    "local-pkg": "^1.1.0",
+    "prettier": "^3.5.2"
   },
   "devDependencies": {
-    "@types/node": "^22.5.4",
-    "@unocss/eslint-plugin": "^0.62.3",
-    "bumpp": "^9.5.2",
-    "eslint-plugin-vue": "^9.28.0",
-    "eslint-typegen": "^0.3.2",
-    "esno": "^4.7.0",
-    "lint-staged": "^15.2.10",
+    "@types/node": "^22.13.5",
+    "@unocss/eslint-plugin": "^65.5.0",
+    "bumpp": "^10.0.3",
+    "eslint-plugin-vue": "^9.32.0",
+    "eslint-typegen": "^2.0.0",
+    "esno": "^4.8.0",
+    "lint-staged": "^15.4.3",
     "simple-git-hooks": "^2.11.1",
-    "tsup": "^8.2.4",
-    "typescript": "^5.6.2",
-    "typescript-eslint": "^8.5.0"
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.25.0"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"
   },
   "lint-staged": {
-    "*": "eslint --fix --flag unstable_ts_config"
+    "*": "eslint --fix"
   },
   "scripts": {
-    "build": "pnpm typegen && tsup --format esm,cjs --clean --dts",
+    "build": "pnpm typegen && tsup --clean --dts",
     "typegen": "esno scripts/typegen.ts",
     "dev": "npx @eslint/config-inspector --config eslint.config.ts",
-    "lint": "eslint . --flag unstable_ts_config",
-    "lint:fix": "eslint . --fix --flag unstable_ts_config",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "release": "bumpp && pnpm publish",
     "typecheck": "tsc --noEmit"
   }