@coderwyd/eslint-config 2.6.3 → 2.7.0

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/plugins/index.ts
 import { default as default2 } from "eslint-plugin-antfu";
-import { default as default3 } from "eslint-plugin-eslint-comments";
+import { default as default3 } from "@eslint-community/eslint-plugin-eslint-comments";
 import * as pluginImport from "eslint-plugin-import-x";
 import { default as default4 } from "eslint-plugin-n";
 import { default as default5 } from "eslint-plugin-unicorn";
@@ -90,10 +90,14 @@ var GLOB_EXCLUDE = [
 ];
 
 // src/configs/ignores.ts
-function ignores() {
+function ignores(userIgnores = []) {
   return [
     {
-      ignores: GLOB_EXCLUDE
+      ignores: [
+        ...GLOB_EXCLUDE,
+        ...userIgnores
+      ],
+      name: "coderwyd/ignores"
     }
   ];
 }
@@ -268,9 +272,6 @@ function javascript(options = {}) {
         ],
         "no-restricted-syntax": [
           "error",
-          "DebuggerStatement",
-          "LabeledStatement",
-          "WithStatement",
           "TSEnumDeclaration[const=true]",
           "TSExportAssignment"
         ],
@@ -386,7 +387,10 @@ function javascript(options = {}) {
 
 // src/shared/index.ts
 import process from "node:process";
+import { fileURLToPath } from "node:url";
 import { getPackageInfoSync, isPackageExists } from "local-pkg";
+var scopeUrl = fileURLToPath(new URL(".", import.meta.url));
+var isCwdInScope = isPackageExists("@coderwyd/eslint-config");
 var parserPlain = {
   meta: {
     name: "parser-plain"
@@ -452,10 +456,13 @@ async function interopDefault(m) {
   const resolved = await m;
   return resolved.default || resolved;
 }
+function isPackageInScope(name) {
+  return isPackageExists(name, { paths: [scopeUrl] });
+}
 async function ensurePackages(packages) {
-  if (process.env.CI || process.stdout.isTTY === false)
+  if (process.env.CI || process.stdout.isTTY === false || isCwdInScope === false)
     return;
-  const nonExistingPackages = packages.filter((i) => !isPackageExists(i));
+  const nonExistingPackages = packages.filter((i) => !isPackageInScope(i));
   if (nonExistingPackages.length === 0)
     return;
   const { default: prompts } = await import("prompts");
@@ -481,6 +488,16 @@ function getOverrides(options, key) {
     ..."overrides" in sub ? sub.overrides || {} : {}
   };
 }
+function isInEditorEnv() {
+  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 || false);
+}
+function isInGitHooksOrLintStaged() {
+  return !!(process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged") || process.env.npm_lifecycle_script?.startsWith("nano-staged") || false);
+}
 
 // src/configs/jsdoc.ts
 async function jsdoc(options = {}) {
@@ -895,7 +912,7 @@ async function stylistic(options = {}) {
 // src/configs/typescript.ts
 import process2 from "node:process";
 async function typescript(options = {}) {
-  const { componentExts = [], overrides = {}, parserOptions = {} } = options;
+  const { componentExts = [], overrides = {}, overridesTypeAware = {}, parserOptions = {} } = options;
   const files = options.files ?? [
     GLOB_TS,
     GLOB_TSX,
@@ -968,8 +985,8 @@ async function typescript(options = {}) {
     },
     // assign type-aware parser for type-aware files and type-unaware parser for the rest
     ...isTypeAware ? [
-      makeParser(true, filesTypeAware, ignoresTypeAware),
-      makeParser(false, files, filesTypeAware)
+      makeParser(false, files),
+      makeParser(true, filesTypeAware, ignoresTypeAware)
     ] : [makeParser(false, files)],
     {
       files,
@@ -1036,8 +1053,8 @@ async function typescript(options = {}) {
         ignores: ignoresTypeAware,
         name: "coderwyd/typescript/rules-type-aware",
         rules: {
-          ...tsconfigPath ? typeAwareRules : {},
-          ...overrides
+          ...typeAwareRules,
+          ...overridesTypeAware
         }
       }
     ] : [],
@@ -1457,39 +1474,6 @@ function perfectionist() {
         "perfectionist/sort-named-imports": [
           "warn",
           { groupKind: "values-first" }
-        ],
-        "perfectionist/sort-vue-attributes": [
-          "error",
-          {
-            // Based on: https://vuejs.org/style-guide/rules-recommended.html#element-attribute-order
-            customGroups: {
-              CONDITIONALS: "v-*(else-if|if|else|show|cloak)",
-              CONTENT: "v-*(html|text)",
-              DEFINITION: "*(is|:is|v-is)",
-              // OTHER_DIRECTIVES e.g. 'v-custom-directive'
-              EVENTS: "*(v-on|@*)",
-              GLOBAL: "*(:id|id)",
-              LIST_RENDERING: "v-for",
-              RENDER_MODIFIERS: "v-*(pre|once)",
-              SLOT: "*(v-slot|slot)",
-              TWO_WAY_BINDING: "*(v-model|v-model:*)",
-              UNIQUE: "*(ref|key|:ref|:key)"
-            },
-            groups: [
-              "DEFINITION",
-              "LIST_RENDERING",
-              "CONDITIONALS",
-              "RENDER_MODIFIERS",
-              "GLOBAL",
-              "UNIQUE",
-              "SLOT",
-              "TWO_WAY_BINDING",
-              "unknown",
-              "EVENTS",
-              "CONTENT"
-            ],
-            type: "natural"
-          }
         ]
       }
     }
@@ -1957,8 +1941,6 @@ function jsx() {
 // src/index.ts
 var flatConfigProps = [
   "name",
-  "files",
-  "ignores",
   "languageOptions",
   "linterOptions",
   "processor",
@@ -1987,7 +1969,6 @@ async function defineConfig(options = {}, ...userConfigs) {
       html: true
     },
     gitignore: enableGitignore = true,
-    isInEditor: isInEditor2 = isInEditor,
     jsx: enableJsx = true,
     react: enableReact = false,
     regexp: enableRegexp = true,
@@ -1997,6 +1978,12 @@ async function defineConfig(options = {}, ...userConfigs) {
     unocss: enableUnoCSS = false,
     vue: enableVue = hasVue
   } = options;
+  let isInEditor2 = options.isInEditor;
+  if (isInEditor2 == null) {
+    isInEditor2 = isInEditorEnv();
+    if (isInEditor2)
+      console.log("[@coderwyd/eslint-config] Detected running in editor, some rules are disabled.");
+  }
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions))
     stylisticOptions.jsx = enableJsx;
@@ -2005,17 +1992,20 @@ async function defineConfig(options = {}, ...userConfigs) {
     if (typeof enableGitignore !== "boolean") {
       configs2.push(
         interopDefault(import("eslint-config-flat-gitignore")).then((r) => [
-          r(enableGitignore)
+          r({
+            ...enableGitignore,
+            name: "coderwyd/gitignore"
+          })
         ])
       );
     } else {
-      configs2.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r({ strict: false })]));
+      configs2.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r({ name: "coderwyd/gitignore", strict: false })]));
     }
   }
   const typescriptOptions = resolveSubOptions(options, "typescript");
   const tsconfigPath = "tsconfigPath" in typescriptOptions ? typescriptOptions.tsconfigPath : void 0;
   configs2.push(
-    ignores(),
+    ignores(options.ignores),
     javascript({
       isInEditor: isInEditor2,
       overrides: getOverrides(options, "javascript")
@@ -2126,6 +2116,9 @@ async function defineConfig(options = {}, ...userConfigs) {
       )
     );
   }
+  if ("files" in options) {
+    throw new Error('[@coderwyd/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];
@@ -2146,6 +2139,9 @@ export {
   getOverrides,
   getVueVersion,
   interopDefault,
+  isInEditorEnv,
+  isInGitHooksOrLintStaged,
+  isPackageInScope,
   parserPlain,
   renamePluginInConfigs,
   renameRules,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coderwyd/eslint-config",
   "type": "module",
-  "version": "2.6.3",
+  "version": "2.7.0",
   "description": "Donny's ESLint config",
   "author": "Donny Wang <donny526@outlook.com> (https://github.com/coderwyd/)",
   "license": "MIT",
@@ -37,7 +37,7 @@
   "peerDependencies": {
     "@eslint-react/eslint-plugin": "^1.5.8",
     "@unocss/eslint-plugin": ">=0.50.0",
-    "eslint": "^8.56.0 || ^9.0.0",
+    "eslint": "^9.5.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",
     "eslint-plugin-svelte": ">=2.35.1",
@@ -68,30 +68,31 @@
     }
   },
   "dependencies": {
-    "@antfu/install-pkg": "^0.3.3",
-    "@stylistic/eslint-plugin": "^2.6.2",
+    "@antfu/install-pkg": "^0.4.1",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
+    "@stylistic/eslint-plugin": "^2.7.1",
     "@toml-tools/parser": "^1.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.0.1",
-    "@typescript-eslint/parser": "^8.0.1",
-    "@vitest/eslint-plugin": "^1.0.0",
-    "eslint-config-flat-gitignore": "^0.1.8",
+    "@typescript-eslint/eslint-plugin": "^8.3.0",
+    "@typescript-eslint/parser": "^8.3.0",
+    "@vitest/eslint-plugin": "^1.1.0",
+    "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-merge-processors": "^0.1.0",
-    "eslint-plugin-antfu": "^2.3.4",
+    "eslint-plugin-antfu": "^2.3.6",
     "eslint-plugin-command": "^0.2.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-format": "^0.1.2",
-    "eslint-plugin-import-x": "^3.1.0",
-    "eslint-plugin-jsdoc": "^50.0.1",
+    "eslint-plugin-import-x": "^4.1.1",
+    "eslint-plugin-jsdoc": "^50.2.2",
     "eslint-plugin-jsonc": "^2.16.0",
     "eslint-plugin-n": "^17.10.2",
-    "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-perfectionist": "^3.1.3",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-perfectionist": "^3.3.0",
     "eslint-plugin-regexp": "^2.6.0",
     "eslint-plugin-unicorn": "^55.0.0",
     "eslint-plugin-unused-imports": "^4.1.3",
     "eslint-plugin-vue": "^9.27.0",
     "eslint-processor-vue-blocks": "^0.1.2",
-    "eslint-typegen": "^0.3.0",
+    "eslint-typegen": "^0.3.1",
     "globals": "^15.9.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
@@ -103,44 +104,45 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@antfu/ni": "^0.22.1",
-    "@eslint-react/eslint-plugin": "^1.9.1",
-    "@eslint/config-inspector": "^0.5.2",
-    "@stylistic/eslint-plugin-migrate": "^2.6.2",
-    "@types/eslint": "^9.6.0",
+    "@antfu/ni": "^0.23.0",
+    "@eslint-react/eslint-plugin": "^1.12.3",
+    "@eslint/config-inspector": "^0.5.4",
+    "@stylistic/eslint-plugin-migrate": "^2.7.1",
+    "@types/eslint": "^9.6.1",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.14.15",
+    "@types/node": "^20.16.2",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.33",
-    "@unocss/eslint-plugin": "^0.61.9",
-    "bumpp": "^9.4.2",
-    "eslint": "^9.9.0",
+    "@unocss/eslint-plugin": "^0.62.3",
+    "bumpp": "^9.5.2",
+    "eslint": "^9.9.1",
     "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-react-refresh": "^0.4.9",
+    "eslint-plugin-react-refresh": "^0.4.11",
     "eslint-plugin-svelte": "2.43.0",
     "eslint-plugin-tailwindcss": "^3.17.4",
-    "execa": "^9.3.0",
+    "execa": "^9.3.1",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
-    "lint-staged": "^15.2.8",
+    "jiti": "^1.21.6",
+    "lint-staged": "^15.2.9",
     "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.11.1",
-    "svelte": "^4.2.18",
+    "svelte": "^4.2.19",
     "svelte-eslint-parser": "^0.41.0",
     "tsup": "^8.2.4",
-    "tsx": "^4.17.0",
+    "tsx": "^4.19.0",
     "typescript": "^5.5.4"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpx nano-staged"
   },
   "nano-staged": {
-    "*": "eslint --fix"
+    "*": "eslint --flag unstable_ts_config --fix"
   },
   "scripts": {
     "build": "nr build:typegen && tsup",
     "dev": "npx @eslint/config-inspector",
-    "lint": "eslint .",
+    "lint": "eslint --flag unstable_ts_config .",
     "lint:fix": "eslint . --fix",
     "build:inspector": "pnpm build && npx @eslint/config-inspector build",
     "build:typegen": "tsx scripts/typegen.ts",