@ntnyq/eslint-config 3.7.1 → 3.7.2

package/dist/index.cjs

@@ -1154,7 +1154,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",
@@ -1165,6 +1164,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',
@@ -2474,20 +2483,30 @@ var typescript = (options = {}) => {
 };
 
 // src/configs/githubAction.ts
-var githubAction = (options = {}) => [
-  {
+var import_eslint_plugin_github_action2 = require("eslint-plugin-github-action");
+var githubAction = (options = {}) => {
+  const {
+    // Support common overrides rules
+    overrides: overridesRules = {},
+    // Flat config options
+    ...restOptions
+  } = options;
+  const recommendedConfig = (0, import_eslint_plugin_github_action2.createRecommendedConfig)({
     name: "ntnyq/github-action",
     files: [GLOB_GITHUB_ACTION],
-    plugins: {
-      "github-action": import_eslint_plugin_github_action.default
-    },
-    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 perfectionist = (options = {}) => {
@@ -2592,7 +2611,8 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2628,6 +2648,7 @@ var perfectionist = (options = {}) => {
         //   {
         //     type: 'alphabetical',
         //     order: 'asc',
+        //     partitionByComment: true,
         //   },
         // ],
         "perfectionist/sort-intersection-types": [
@@ -2648,7 +2669,8 @@ var perfectionist = (options = {}) => {
               "tuple",
               "union",
               "nullish"
-            ]
+            ],
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2663,14 +2685,16 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-union-types": [
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         // Overrides rules
@@ -2690,21 +2714,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": [

package/dist/index.d.cts

@@ -1,6 +1,8 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ESLintPluginCommandOptions } from 'eslint-plugin-command/types';
+import { RecommendedOptions } from 'eslint-plugin-github-action';
+export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 import { Options } from 'eslint-processor-vue-blocks';
 export { default as processorVueBlocks } from 'eslint-processor-vue-blocks';
 import { Linter } from 'eslint';
@@ -26,7 +28,6 @@ export { default as pluginImport } from 'eslint-plugin-import-x';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginPrettier } from 'eslint-plugin-prettier';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
-export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
@@ -1541,6 +1542,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/max-jobs-per-action.html
      */
     'github-action/max-jobs-per-action'?: Linter.RuleEntry<GithubActionMaxJobsPerAction>;
+    /**
+     * disallow using external job.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-external-job.html
+     */
+    'github-action/no-external-job'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow using invalid key.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-invalid-key.html
+     */
+    'github-action/no-invalid-key'?: Linter.RuleEntry<[]>;
     /**
      * disallow using top level env.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-env.html
@@ -1551,6 +1562,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-permissions.html
      */
     'github-action/no-top-level-permissions'?: Linter.RuleEntry<[]>;
+    /**
+     * enforce action file extension.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-file-extension.html
+     */
+    'github-action/prefer-file-extension'?: Linter.RuleEntry<GithubActionPreferFileExtension>;
+    /**
+     * enforce the style of job step uses.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-step-uses-style.html
+     */
+    'github-action/prefer-step-uses-style'?: Linter.RuleEntry<GithubActionPreferStepUsesStyle>;
     /**
      * require action name to be set.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/require-action-name.html
@@ -9417,6 +9438,22 @@ type GithubActionJobIdCasing = [] | [
     })
 ];
 type GithubActionMaxJobsPerAction = [] | [number];
+type GithubActionPreferFileExtension = [] | [
+    (("yml" | "yaml") | {
+        extension?: ("yml" | "yaml");
+        caseSensitive?: boolean;
+    })
+];
+type GithubActionPreferStepUsesStyle = [] | [
+    (("release" | "commit" | "branch") | {
+        commit?: boolean;
+        release?: boolean;
+        branch?: boolean;
+        allowRepository?: boolean;
+        allowDocker?: boolean;
+        ignores?: string[];
+    })
+];
 type GroupedAccessorPairs = [] | [("anyOrder" | "getBeforeSet" | "setBeforeGet")];
 type HandleCallbackErr = [] | [string];
 type IdBlacklist = string[];
@@ -14725,7 +14762,7 @@ interface ConfigAntfuOptions extends OptionsOverrides {
 }
 interface ConfigCommentsOptions extends OptionsOverrides {
 }
-interface ConfigGitHubActionOptions extends OptionsOverrides {
+interface ConfigGitHubActionOptions extends RecommendedOptions, OptionsOverrides {
 }
 interface ConfigImportsOptions extends OptionsOverrides {
 }

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
 import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
 import { ESLintPluginCommandOptions } from 'eslint-plugin-command/types';
+import { RecommendedOptions } from 'eslint-plugin-github-action';
+export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 import { Options } from 'eslint-processor-vue-blocks';
 export { default as processorVueBlocks } from 'eslint-processor-vue-blocks';
 import { Linter } from 'eslint';
@@ -26,7 +28,6 @@ export { default as pluginImport } from 'eslint-plugin-import-x';
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
 export { default as pluginPrettier } from 'eslint-plugin-prettier';
 export { default as pluginStylistic } from '@stylistic/eslint-plugin';
-export { default as pluginGitHubAction } from 'eslint-plugin-github-action';
 export { default as pluginPerfectionist } from 'eslint-plugin-perfectionist';
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
 export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
@@ -1541,6 +1542,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/max-jobs-per-action.html
      */
     'github-action/max-jobs-per-action'?: Linter.RuleEntry<GithubActionMaxJobsPerAction>;
+    /**
+     * disallow using external job.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-external-job.html
+     */
+    'github-action/no-external-job'?: Linter.RuleEntry<[]>;
+    /**
+     * disallow using invalid key.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-invalid-key.html
+     */
+    'github-action/no-invalid-key'?: Linter.RuleEntry<[]>;
     /**
      * disallow using top level env.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-env.html
@@ -1551,6 +1562,16 @@ interface RuleOptions {
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/no-top-level-permissions.html
      */
     'github-action/no-top-level-permissions'?: Linter.RuleEntry<[]>;
+    /**
+     * enforce action file extension.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-file-extension.html
+     */
+    'github-action/prefer-file-extension'?: Linter.RuleEntry<GithubActionPreferFileExtension>;
+    /**
+     * enforce the style of job step uses.
+     * @see https://eslint-plugin-github-action.ntnyq.com/rules/prefer-step-uses-style.html
+     */
+    'github-action/prefer-step-uses-style'?: Linter.RuleEntry<GithubActionPreferStepUsesStyle>;
     /**
      * require action name to be set.
      * @see https://eslint-plugin-github-action.ntnyq.com/rules/require-action-name.html
@@ -9417,6 +9438,22 @@ type GithubActionJobIdCasing = [] | [
     })
 ];
 type GithubActionMaxJobsPerAction = [] | [number];
+type GithubActionPreferFileExtension = [] | [
+    (("yml" | "yaml") | {
+        extension?: ("yml" | "yaml");
+        caseSensitive?: boolean;
+    })
+];
+type GithubActionPreferStepUsesStyle = [] | [
+    (("release" | "commit" | "branch") | {
+        commit?: boolean;
+        release?: boolean;
+        branch?: boolean;
+        allowRepository?: boolean;
+        allowDocker?: boolean;
+        ignores?: string[];
+    })
+];
 type GroupedAccessorPairs = [] | [("anyOrder" | "getBeforeSet" | "setBeforeGet")];
 type HandleCallbackErr = [] | [string];
 type IdBlacklist = string[];
@@ -14725,7 +14762,7 @@ interface ConfigAntfuOptions extends OptionsOverrides {
 }
 interface ConfigCommentsOptions extends OptionsOverrides {
 }
-interface ConfigGitHubActionOptions extends OptionsOverrides {
+interface ConfigGitHubActionOptions extends RecommendedOptions, OptionsOverrides {
 }
 interface ConfigImportsOptions extends OptionsOverrides {
 }

package/dist/index.js

@@ -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',
@@ -2332,20 +2341,30 @@ 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 perfectionist = (options = {}) => {
@@ -2450,7 +2469,8 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2486,6 +2506,7 @@ var perfectionist = (options = {}) => {
         //   {
         //     type: 'alphabetical',
         //     order: 'asc',
+        //     partitionByComment: true,
         //   },
         // ],
         "perfectionist/sort-intersection-types": [
@@ -2506,7 +2527,8 @@ var perfectionist = (options = {}) => {
               "tuple",
               "union",
               "nullish"
-            ]
+            ],
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2521,14 +2543,16 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-union-types": [
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         // Overrides rules
@@ -2548,21 +2572,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": [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/eslint-config",
   "type": "module",
-  "version": "3.7.1",
+  "version": "3.7.2",
   "packageManager": "pnpm@9.14.4",
   "description": "An opinionated ESLint config preset of ntnyq",
   "keywords": [
@@ -53,22 +53,22 @@
     "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.13",
     "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-github-action": "^0.0.8",
     "eslint-plugin-import-x": "^4.4.3",
     "eslint-plugin-jsdoc": "^50.6.0",
     "eslint-plugin-jsonc": "^2.18.2",
@@ -77,13 +77,13 @@
     "eslint-plugin-perfectionist": "^4.1.2",
     "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",
@@ -106,7 +106,7 @@
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.6",
+    "vitest": "^2.1.7",
     "zx": "^8.2.4"
   },
   "engines": {