@ntnyq/eslint-config 3.7.1 → 3.8.0

package/README.md

@@ -116,7 +116,7 @@ export interface ConfigOptions extends ConfigOptionsInternal {
 
   ignores?: ConfigIgnoresOptions
 
-  imports?: ConfigImportsOptions
+  importX?: ConfigImportsOptions
 
   command?: ConfigCommandOptions
 

package/dist/index.cjs

@@ -67,6 +67,9 @@ __export(src_exports, {
   antfu: () => antfu,
   command: () => command,
   comments: () => comments,
+  defaultSortInterfacesGroups: () => defaultSortInterfacesGroups,
+  defaultSortIntersectionTypesGroups: () => defaultSortIntersectionTypesGroups,
+  defaultSortObjectTypesGroups: () => defaultSortObjectTypesGroups,
   defineESLintConfig: () => defineESLintConfig,
   format: () => format,
   getOverrides: () => getOverrides,
@@ -77,7 +80,7 @@ __export(src_exports, {
   hasVitest: () => hasVitest,
   hasVue: () => hasVue,
   ignores: () => ignores,
-  imports: () => imports,
+  importX: () => importX,
   interopDefault: () => interopDefault,
   javascript: () => javascript,
   jsdoc: () => jsdoc,
@@ -100,7 +103,7 @@ __export(src_exports, {
   pluginComments: () => import_eslint_plugin_eslint_comments.default,
   pluginFormat: () => import_eslint_plugin_format.default,
   pluginGitHubAction: () => import_eslint_plugin_github_action.default,
-  pluginImport: () => import_eslint_plugin_import_x.default,
+  pluginImportX: () => import_eslint_plugin_import_x.default,
   pluginJsdoc: () => import_eslint_plugin_jsdoc.default,
   pluginJsonc: () => import_eslint_plugin_jsonc.default,
   pluginMarkdown: () => import_markdown.default,
@@ -189,8 +192,8 @@ var import_typescript_eslint2 = require("typescript-eslint");
 var import_eslint_plugin_format = __toESM(require("eslint-plugin-format"), 1);
 var import_eslint_plugin = __toESM(require("@unocss/eslint-plugin"), 1);
 var import_eslint_plugin2 = __toESM(require("@vitest/eslint-plugin"), 1);
-var import_eslint_plugin_import_x = __toESM(require("eslint-plugin-import-x"), 1);
 var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
+var import_eslint_plugin_import_x = __toESM(require("eslint-plugin-import-x"), 1);
 var import_eslint_plugin_prettier = __toESM(require("eslint-plugin-prettier"), 1);
 var import_eslint_plugin3 = __toESM(require("@stylistic/eslint-plugin"), 1);
 var import_eslint_plugin_github_action = __toESM(require("eslint-plugin-github-action"), 1);
@@ -1154,7 +1157,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 +1167,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',
@@ -1667,31 +1679,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: import_eslint_plugin_import_x.default
+      "import-x": import_eslint_plugin_import_x.default
     },
     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
     }
@@ -1835,12 +1847,12 @@ var specials = (options = {}) => [
     name: "ntnyq/specials/config-file",
     files: [`**/*.config*.${GLOB_SRC_EXT}`],
     plugins: {
-      import: import_eslint_plugin_import_x.default,
+      "import-x": import_eslint_plugin_import_x.default,
       perfectionist: import_eslint_plugin_perfectionist.default
     },
     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",
@@ -1922,7 +1934,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",
@@ -2465,8 +2477,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"
       }
     }
@@ -2474,22 +2486,97 @@ 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 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,
@@ -2592,7 +2679,8 @@ var perfectionist = (options = {}) => {
           "error",
           {
             type: "alphabetical",
-            order: "asc"
+            order: "asc",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-modules": [
@@ -2623,32 +2711,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": [
@@ -2663,14 +2741,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
@@ -2690,21 +2771,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": [
@@ -2803,8 +2887,8 @@ function defineESLintConfig(options = {}, ...userConfigs) {
     ...command({
       ...resolveSubOptions(options, "command")
     }),
-    ...imports({
-      overrides: getOverrides(options, "imports")
+    ...importX({
+      overrides: getOverrides(options, "importX")
     }),
     ...jsdoc({
       typescript: !!enableTypeScript,
@@ -2987,6 +3071,9 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   antfu,
   command,
   comments,
+  defaultSortInterfacesGroups,
+  defaultSortIntersectionTypesGroups,
+  defaultSortObjectTypesGroups,
   defineESLintConfig,
   format,
   getOverrides,
@@ -2997,7 +3084,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   hasVitest,
   hasVue,
   ignores,
-  imports,
+  importX,
   interopDefault,
   javascript,
   jsdoc,
@@ -3020,7 +3107,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   pluginComments,
   pluginFormat,
   pluginGitHubAction,
-  pluginImport,
+  pluginImportX,
   pluginJsdoc,
   pluginJsonc,
   pluginMarkdown,