@ntnyq/eslint-config 3.7.1 → 3.8.0

package/dist/index.js

@@ -47,8 +47,8 @@ import { plugin } from "typescript-eslint";
 import { default as default11 } from "eslint-plugin-format";
 import { default as default12 } from "@unocss/eslint-plugin";
 import { default as default13 } from "@vitest/eslint-plugin";
-import { default as default14 } from "eslint-plugin-import-x";
-import { default as default15 } from "eslint-plugin-unicorn";
+import { default as default14 } from "eslint-plugin-unicorn";
+import { default as default15 } from "eslint-plugin-import-x";
 import { default as default16 } from "eslint-plugin-prettier";
 import { default as default17 } from "@stylistic/eslint-plugin";
 import { default as default18 } from "eslint-plugin-github-action";
@@ -1012,7 +1012,6 @@ var jsdoc = (options = {}) => [
       "jsdoc/check-line-alignment": "error",
       "jsdoc/check-param-names": "error",
       "jsdoc/check-property-names": "error",
-      "jsdoc/check-tag-names": "error",
       "jsdoc/check-types": "error",
       "jsdoc/empty-tags": "error",
       "jsdoc/multiline-blocks": "error",
@@ -1023,6 +1022,16 @@ var jsdoc = (options = {}) => [
       "jsdoc/no-multi-asterisks": "error",
       "jsdoc/require-asterisk-prefix": "error",
       "jsdoc/require-hyphen-before-param-description": "error",
+      "jsdoc/check-tag-names": [
+        "error",
+        {
+          definedTags: [
+            // magic-comments
+            "vite-ignore",
+            "unocss-include"
+          ]
+        }
+      ],
       // TODO: this after investigate
       // 'jsdoc/sort-tags': [
       //   'error',
@@ -1525,31 +1534,31 @@ var ignores = (customIgnores = []) => [
   }
 ];
 
-// src/configs/imports.ts
-var imports = (options = {}) => [
+// src/configs/importX.ts
+var importX = (options = {}) => [
   {
-    name: "ntnyq/imports",
+    name: "ntnyq/import-x",
     plugins: {
-      import: default14
+      "import-x": default15
     },
     settings: {
-      "import/resolver": {
+      "import-x/resolver": {
         node: { extensions: [".js", ".mjs", ".ts", ".mts", ".d.ts"] }
       }
     },
     rules: {
-      "import/no-unresolved": "off",
-      "import/no-absolute-path": "off",
-      "import/no-named-as-default-member": "off",
-      "import/no-named-default": "off",
+      "import-x/no-unresolved": "off",
+      "import-x/no-absolute-path": "off",
+      "import-x/no-named-as-default-member": "off",
+      "import-x/no-named-default": "off",
       // disabled in favor or `perfectionist/sort-imports`
-      "import/order": "off",
-      "import/first": "error",
-      "import/export": "error",
-      "import/no-self-import": "error",
-      "import/no-duplicates": "error",
-      "import/no-mutable-exports": "error",
-      "import/newline-after-import": "error",
+      "import-x/order": "off",
+      "import-x/first": "error",
+      "import-x/export": "error",
+      "import-x/no-self-import": "error",
+      "import-x/no-duplicates": "error",
+      "import-x/no-mutable-exports": "error",
+      "import-x/newline-after-import": "error",
       // Overrides rules
       ...options.overrides
     }
@@ -1571,7 +1580,7 @@ var unicorn = (options = {}) => [
   {
     name: "ntnyq/unicorn",
     plugins: {
-      unicorn: default15
+      unicorn: default14
     },
     rules: {
       "unicorn/escape-case": "error",
@@ -1693,12 +1702,12 @@ var specials = (options = {}) => [
     name: "ntnyq/specials/config-file",
     files: [`**/*.config*.${GLOB_SRC_EXT}`],
     plugins: {
-      import: default14,
+      "import-x": default15,
       perfectionist: default19
     },
     rules: {
       "no-console": "off",
-      "import/no-default-export": "off",
+      "import-x/no-default-export": "off",
       "@typescript-eslint/explicit-function-return-type": "off",
       "perfectionist/sort-objects": [
         "error",
@@ -1780,7 +1789,7 @@ var markdown = (options = {}) => {
         "no-restricted-imports": "off",
         "node/prefer-global/buffer": "off",
         "node/prefer-global/process": "off",
-        "import/no-unresolved": "off",
+        "import-x/no-unresolved": "off",
         "unused-imports/no-unused-imports": "off",
         "unused-imports/no-unused-vars": "off",
         "@typescript-eslint/comma-dangle": "off",
@@ -2323,8 +2332,8 @@ var typescript = (options = {}) => {
       rules: {
         "no-use-before-define": "off",
         "no-restricted-syntax": "off",
-        "import/no-duplicates": "off",
-        "import/newline-after-import": "off",
+        "import-x/no-duplicates": "off",
+        "import-x/newline-after-import": "off",
         "@typescript-eslint/no-use-before-define": "off"
       }
     }
@@ -2332,22 +2341,97 @@ var typescript = (options = {}) => {
 };
 
 // src/configs/githubAction.ts
-var githubAction = (options = {}) => [
-  {
+import { createRecommendedConfig } from "eslint-plugin-github-action";
+var githubAction = (options = {}) => {
+  const {
+    // Support common overrides rules
+    overrides: overridesRules = {},
+    // Flat config options
+    ...restOptions
+  } = options;
+  const recommendedConfig = createRecommendedConfig({
     name: "ntnyq/github-action",
     files: [GLOB_GITHUB_ACTION],
-    plugins: {
-      "github-action": default18
-    },
-    rules: {
-      "github-action/require-action-name": "error",
-      // Overrides rules
-      ...options.overrides
+    ...restOptions
+  });
+  return [
+    {
+      ...recommendedConfig,
+      rules: {
+        ...recommendedConfig.rules,
+        // Overrides rules
+        ...overridesRules
+      }
     }
-  }
-];
+  ];
+};
 
 // src/configs/perfectionist.ts
+var sharedGroups = [
+  "required-property",
+  "optional-property",
+  "required-method",
+  "optional-method",
+  "required-multiline-property",
+  "optional-multiline-property",
+  "required-multiline-method",
+  "optional-multiline-method",
+  "unknown",
+  "index-signature",
+  "multiline-index-signature"
+];
+var defaultSortInterfacesGroups = [...sharedGroups];
+var defaultSortObjectTypesGroups = [...sharedGroups];
+var defaultSortIntersectionTypesGroups = [
+  /**
+   * eg. 'foobar', 24, false
+   */
+  "literal",
+  /**
+   * eg. number, string
+   */
+  "keyword",
+  /**
+   * eg. FooBar
+   */
+  "named",
+  /**
+   * eg. Foo & Bar
+   */
+  "intersection",
+  /**
+   * eg. Foobar extends string ? Foo : Bar
+   */
+  "conditional",
+  /**
+   * eg. (...args: any[]) => void
+   */
+  "function",
+  /**
+   * eg. import('eslint').Linter
+   */
+  "import",
+  /**
+   * eg. { foo: string; bar: number; }
+   */
+  "object",
+  /**
+   * eg. keyof T
+   */
+  "operator",
+  /**
+   * eg. [string, number]
+   */
+  "tuple",
+  /**
+   * eg. Foo | Bar
+   */
+  "union",
+  /**
+   * eg. null | undefined
+   */
+  "nullish"
+];
 var perfectionist = (options = {}) => {
   const {
     sortEnums: enableSortEnums = true,
@@ -2450,7 +2534,8 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2481,32 +2566,22 @@ var perfectionist = (options = {}) => {
             order: "asc"
           }
         ],
-        // 'perfectionist/sort-interfaces': [
-        //   'error',
-        //   {
-        //     type: 'alphabetical',
-        //     order: 'asc',
-        //   },
-        // ],
+        "perfectionist/sort-interfaces": [
+          "error",
+          {
+            type: "alphabetical",
+            order: "asc",
+            partitionByComment: true,
+            groups: defaultSortInterfacesGroups
+          }
+        ],
         "perfectionist/sort-intersection-types": [
           "error",
           {
             type: "alphabetical",
             order: "asc",
-            groups: [
-              "intersection",
-              "named",
-              "conditional",
-              "function",
-              "import",
-              "keyword",
-              "literal",
-              "object",
-              "operator",
-              "tuple",
-              "union",
-              "nullish"
-            ]
+            partitionByComment: true,
+            groups: [...defaultSortIntersectionTypesGroups]
           }
         ],
         "perfectionist/sort-modules": [
@@ -2521,14 +2596,17 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true,
+            groups: []
           }
         ],
         "perfectionist/sort-union-types": [
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         // Overrides rules
@@ -2548,21 +2626,24 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-objects": [
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-sets": [
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2661,8 +2742,8 @@ function defineESLintConfig(options = {}, ...userConfigs) {
     ...command({
       ...resolveSubOptions(options, "command")
     }),
-    ...imports({
-      overrides: getOverrides(options, "imports")
+    ...importX({
+      overrides: getOverrides(options, "importX")
     }),
     ...jsdoc({
       typescript: !!enableTypeScript,
@@ -2844,6 +2925,9 @@ export {
   antfu,
   command,
   comments,
+  defaultSortInterfacesGroups,
+  defaultSortIntersectionTypesGroups,
+  defaultSortObjectTypesGroups,
   defineESLintConfig,
   format,
   getOverrides,
@@ -2854,7 +2938,7 @@ export {
   hasVitest,
   hasVue,
   ignores,
-  imports,
+  importX,
   interopDefault,
   javascript,
   jsdoc,
@@ -2877,7 +2961,7 @@ export {
   default21 as pluginComments,
   default11 as pluginFormat,
   default18 as pluginGitHubAction,
-  default14 as pluginImport,
+  default15 as pluginImportX,
   default9 as pluginJsdoc,
   default10 as pluginJsonc,
   default7 as pluginMarkdown,
@@ -2889,7 +2973,7 @@ export {
   default17 as pluginStylistic,
   default5 as pluginToml,
   plugin as pluginTypeScript,
-  default15 as pluginUnicorn,
+  default14 as pluginUnicorn,
   default12 as pluginUnoCSS,
   default20 as pluginUnusedImports,
   default13 as pluginVitest,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/eslint-config",
   "type": "module",
-  "version": "3.7.1",
+  "version": "3.8.0",
   "packageManager": "pnpm@9.14.4",
   "description": "An opinionated ESLint config preset of ntnyq",
   "keywords": [
@@ -53,42 +53,42 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "eslint": "^9.0.0"
+    "eslint": "^9.5.0"
   },
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
     "@eslint/js": "^9.16.0",
     "@eslint/markdown": "^6.2.1",
     "@stylistic/eslint-plugin": "^2.11.0",
-    "@unocss/eslint-plugin": "^0.64.1",
-    "@vitest/eslint-plugin": "^1.1.12",
+    "@unocss/eslint-plugin": "^0.65.0",
+    "@vitest/eslint-plugin": "^1.1.14",
     "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-flat-config-utils": "^0.4.0",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-antfu": "^2.7.0",
     "eslint-plugin-command": "^0.2.6",
     "eslint-plugin-format": "^0.1.3",
-    "eslint-plugin-github-action": "^0.0.6",
-    "eslint-plugin-import-x": "^4.4.3",
+    "eslint-plugin-github-action": "^0.0.8",
+    "eslint-plugin-import-x": "^4.5.0",
     "eslint-plugin-jsdoc": "^50.6.0",
     "eslint-plugin-jsonc": "^2.18.2",
     "eslint-plugin-n": "^17.14.0",
     "eslint-plugin-ntnyq": "^0.7.1",
-    "eslint-plugin-perfectionist": "^4.1.2",
+    "eslint-plugin-perfectionist": "^4.2.0",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-regexp": "^2.7.0",
-    "eslint-plugin-toml": "^0.11.1",
+    "eslint-plugin-toml": "^0.12.0",
     "eslint-plugin-unicorn": "^56.0.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "eslint-plugin-vue": "^9.32.0",
-    "eslint-plugin-yml": "^1.15.0",
+    "eslint-plugin-yml": "^1.16.0",
     "eslint-processor-vue-blocks": "^0.1.2",
-    "globals": "^15.12.0",
+    "globals": "^15.13.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.1",
     "prettier": "^3.4.1",
     "toml-eslint-parser": "^0.10.0",
-    "typescript-eslint": "^8.16.0",
+    "typescript-eslint": "^8.17.0",
     "vue-eslint-parser": "^9.4.3",
     "yaml-eslint-parser": "^1.2.3"
   },
@@ -106,7 +106,7 @@
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.6",
+    "vitest": "^2.1.8",
     "zx": "^8.2.4"
   },
   "engines": {