@ntnyq/eslint-config 3.9.3 → 3.10.0

package/README.md

@@ -109,7 +109,7 @@ Check for detail in:
 ### Config interface
 
 ```ts
-export interface ConfigOptions extends ConfigOptionsInternal {
+export interface ConfigOptions extends ConfigOptionsInternal, OptionsExtensions {
   command?: ConfigCommandOptions
   comments?: ConfigCommentsOptions
   ignores?: ConfigIgnoresOptions
@@ -123,6 +123,7 @@ export interface ConfigOptions extends ConfigOptionsInternal {
    * bellow can be disabled
    */
   antfu?: boolean | ConfigAntfuOptions
+  depend?: boolean | ConfigDependOptions
   githubAction?: boolean | ConfigGitHubActionOptions
   gitignore?: boolean | ConfigGitIgnoreOptions
   jsonc?: boolean | ConfigJsoncOptions
@@ -140,6 +141,11 @@ export interface ConfigOptions extends ConfigOptionsInternal {
   unocss?: boolean | ConfigUnoCSSOptions
   vue?: boolean | ConfigVueOptions
   yml?: boolean | ConfigYmlOptions
+
+  /**
+   * bellow need enable explicitly
+   */
+  svgo?: boolean | ConfigSVGOOptions
 }
 ```
 

package/dist/index.cjs

@@ -51,6 +51,7 @@ __export(src_exports, {
   GLOB_MARKDOWN_CODE: () => GLOB_MARKDOWN_CODE,
   GLOB_MARKDOWN_NESTED: () => GLOB_MARKDOWN_NESTED,
   GLOB_NODE_MODULES: () => GLOB_NODE_MODULES,
+  GLOB_PACKAGE_JSON: () => GLOB_PACKAGE_JSON,
   GLOB_PINIA_STORE: () => GLOB_PINIA_STORE,
   GLOB_POSTCSS: () => GLOB_POSTCSS,
   GLOB_SCSS: () => GLOB_SCSS,
@@ -69,6 +70,7 @@ __export(src_exports, {
   command: () => command,
   comments: () => comments,
   defineESLintConfig: () => defineESLintConfig,
+  depend: () => depend,
   esX: () => esX,
   format: () => format,
   getOverrides: () => getOverrides,
@@ -102,6 +104,7 @@ __export(src_exports, {
   pinia: () => pinia,
   pluginAntfu: () => import_eslint_plugin_antfu.default,
   pluginComments: () => import_eslint_plugin_eslint_comments.default,
+  pluginDepend: () => pluginDepend,
   pluginEsX: () => import_eslint_plugin_es_x.default,
   pluginFormat: () => import_eslint_plugin_format.default,
   pluginGitHubAction: () => import_eslint_plugin_github_action.default,
@@ -116,6 +119,7 @@ __export(src_exports, {
   pluginPrettier: () => import_eslint_plugin_prettier.default,
   pluginRegexp: () => pluginRegexp,
   pluginStylistic: () => import_eslint_plugin3.default,
+  pluginSvgo: () => import_eslint_plugin_svgo.default,
   pluginToml: () => import_eslint_plugin_toml.default,
   pluginTypeScript: () => import_typescript_eslint2.plugin,
   pluginUnicorn: () => import_eslint_plugin_unicorn.default,
@@ -132,6 +136,7 @@ __export(src_exports, {
   sort: () => sort,
   specials: () => specials,
   stylistic: () => stylistic,
+  svgo: () => svgo,
   test: () => test,
   toArray: () => toArray,
   toml: () => toml,
@@ -182,10 +187,12 @@ var parserPlain = {
 
 // src/eslint/plugins.ts
 var pluginRegexp = __toESM(require("eslint-plugin-regexp"), 1);
+var pluginDepend = __toESM(require("eslint-plugin-depend"), 1);
 var import_eslint_plugin_n = __toESM(require("eslint-plugin-n"), 1);
 var import_eslint_plugin_vue = __toESM(require("eslint-plugin-vue"), 1);
 var import_eslint_plugin_es_x = __toESM(require("eslint-plugin-es-x"), 1);
 var import_eslint_plugin_yml = __toESM(require("eslint-plugin-yml"), 1);
+var import_eslint_plugin_svgo = __toESM(require("eslint-plugin-svgo"), 1);
 var import_eslint_plugin_toml = __toESM(require("eslint-plugin-toml"), 1);
 var import_eslint_plugin_pinia = __toESM(require("eslint-plugin-pinia"), 1);
 var import_eslint_plugin_ntnyq = __toESM(require("eslint-plugin-ntnyq"), 1);
@@ -237,6 +244,7 @@ var GLOB_POSTCSS = "**/*.{p,post}css";
 var GLOB_JSON = "**/*.json";
 var GLOB_JSON5 = "**/*.json5";
 var GLOB_JSONC = "**/*.jsonc";
+var GLOB_PACKAGE_JSON = "**/package.json";
 var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
@@ -1132,6 +1140,17 @@ var vitest = (options = {}) => [
   }
 ];
 
+// src/configs/svgo.ts
+var import_eslint_plugin_svgo2 = require("eslint-plugin-svgo");
+var svgo = (options = {}) => [
+  // TODO: remove after fix type
+  // @ts-expect-error type
+  {
+    ...(0, import_eslint_plugin_svgo2.config)(options),
+    name: "ntnyq/svgo"
+  }
+];
+
 // src/configs/antfu.ts
 var antfu = (options = {}) => [
   {
@@ -1194,6 +1213,8 @@ var jsdoc = (options = {}) => [
             // magic-comments
             "vite-ignore",
             "unocss-include",
+            // eslint-plugin-command (block comment only)
+            "regex101",
             // non-standard, but common used
             "compatibility",
             "category",
@@ -1476,6 +1497,47 @@ var ntnyq = (options = {}) => [
   }
 ];
 
+// src/configs/depend.ts
+var depend = (options = {}) => {
+  const {
+    files = [GLOB_SRC],
+    // check package.json file
+    packageJson: enableCheckPackageJson = true
+  } = options;
+  const configs2 = [
+    {
+      name: "ntnyq/depend",
+      files,
+      plugins: {
+        depend: pluginDepend
+      },
+      rules: {
+        "depend/ban-dependencies": "error",
+        // Overrides rules
+        ...options.overrides
+      }
+    }
+  ];
+  if (enableCheckPackageJson) {
+    configs2.push({
+      name: "ntnyq/depend/package-json",
+      files: [GLOB_PACKAGE_JSON],
+      plugins: {
+        depend: pluginDepend
+      },
+      languageOptions: {
+        parser: parserJsonc
+      },
+      rules: {
+        "depend/ban-dependencies": "error",
+        // Overrides rules
+        ...options.overrides
+      }
+    });
+  }
+  return configs2;
+};
+
 // src/configs/regexp.ts
 var regexp = (options = {}) => {
   const recommendedConfig = pluginRegexp.configs["flat/recommended"];
@@ -1716,10 +1778,60 @@ var format = (options = {}) => {
 };
 
 // src/configs/command.ts
+var import_commands2 = require("eslint-plugin-command/commands");
 var import_config = __toESM(require("eslint-plugin-command/config"), 1);
+
+// src/commands/regexper.ts
+var import_commands = require("eslint-plugin-command/commands");
+var regexper = (0, import_commands.defineCommand)({
+  name: "regexper",
+  // @regexper https://regexper.com/#(%5Cb%7C%5Cs%7C%5E)(%40regexper)(%5Cs%5CS%2B)%3F(%5Cb%7C%5Cs%7C%24)
+  match: /(\b|\s|^)(@regexper)(\s\S+)?(\b|\s|$)/,
+  action(ctx) {
+    const literal = ctx.findNodeBelow((node2) => {
+      return node2.type === "Literal" && "regex" in node2;
+    });
+    if (!literal) {
+      return ctx.reportError("Unable to find a regexp literal to generate");
+    }
+    const [_fullStr = "", spaceBefore = "", commandStr = "", existingUrl = "", _spaceAfter = ""] = ctx.matches;
+    const url = `https://regexper.com/#${encodeURIComponent(literal.regex.pattern)}`;
+    if (existingUrl.trim() === url.trim()) {
+      return;
+    }
+    const indexStart = ctx.comment.range[0] + ctx.matches.index + spaceBefore.length + 2;
+    const indexEnd = indexStart + commandStr.length + existingUrl.length;
+    ctx.report({
+      loc: {
+        start: ctx.source.getLocFromIndex(indexStart),
+        end: ctx.source.getLocFromIndex(indexEnd)
+      },
+      removeComment: false,
+      message: "Update the regexper link",
+      fix(fixer) {
+        return fixer.replaceTextRange([indexStart, indexEnd], `@regexper ${url}`);
+      }
+    });
+  }
+});
+
+// src/commands/index.ts
+var commands = [regexper];
+
+// src/configs/command.ts
 var command = (options = {}) => [
   {
-    ...(0, import_config.default)(options),
+    ...(0, import_config.default)({
+      ...options,
+      commands: [
+        // built-in commands
+        ...import_commands2.builtinCommands,
+        // config internal commands
+        ...commands,
+        // user custom commands
+        ...options.commands || []
+      ]
+    }),
     name: "ntnyq/command"
   }
 ];
@@ -1737,6 +1849,7 @@ var ignores = (customIgnores = []) => [
 ];
 
 // src/configs/importX.ts
+var { createNodeResolver } = import_eslint_plugin_import_x.default;
 var importX = (options = {}) => [
   {
     name: "ntnyq/import-x",
@@ -1744,9 +1857,11 @@ var importX = (options = {}) => [
       "import-x": import_eslint_plugin_import_x.default
     },
     settings: {
-      "import-x/resolver": {
-        node: { extensions: [".js", ".mjs", ".ts", ".mts", ".d.ts"] }
-      }
+      "import-x/resolver-next": [
+        createNodeResolver({
+          extensions: [".js", ".mjs", ".ts", ".mts", ".d.ts", ".json"]
+        })
+      ]
     },
     rules: {
       "import-x/no-unresolved": "off",
@@ -2694,14 +2809,17 @@ var perfectionist = (options = {}) => {
             type: "natural",
             ignoreCase: true,
             internalPattern: ["^~/.+", "^@/.+", "^#.+"],
-            newlinesBetween: "ignore"
+            newlinesBetween: "ignore",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-exports": [
           "error",
           {
             order: "asc",
-            type: "line-length"
+            type: "line-length",
+            groupKind: "values-first",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-named-exports": [
@@ -2710,7 +2828,8 @@ var perfectionist = (options = {}) => {
             type: "alphabetical",
             order: "asc",
             ignoreCase: true,
-            groupKind: "values-first"
+            groupKind: "values-first",
+            partitionByComment: true
           }
         ],
         "perfectionist/sort-named-imports": [
@@ -2720,7 +2839,8 @@ var perfectionist = (options = {}) => {
             order: "asc",
             ignoreCase: true,
             ignoreAlias: false,
-            groupKind: "values-first"
+            groupKind: "values-first",
+            partitionByComment: true
           }
         ],
         // Overrides rules
@@ -2922,6 +3042,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
     toml: enableTOML = true,
     jsonc: enableJSONC = true,
     antfu: enableAntfu = true,
+    depend: enableDepend = true,
     regexp: enableRegexp = true,
     unicorn: enableUnicorn = true,
     prettier: enablePrettier = true,
@@ -2929,7 +3050,9 @@ function defineESLintConfig(options = {}, ...userConfigs) {
     stylistic: enableStylistic = true,
     gitignore: enableGitIgnore = true,
     githubAction: enableGitHubAction = true,
-    perfectionist: enablePerfectionist = true
+    perfectionist: enablePerfectionist = true,
+    // disabled by default
+    svgo: enableSVGO = false
   } = options;
   const configs2 = [];
   if (enableVue) {
@@ -3082,6 +3205,14 @@ function defineESLintConfig(options = {}, ...userConfigs) {
       })
     );
   }
+  if (enableDepend) {
+    configs2.push(
+      ...depend({
+        ...resolveSubOptions(options, "depend"),
+        overrides: getOverrides(options, "depend")
+      })
+    );
+  }
   if (enableGitHubAction) {
     configs2.push(
       ...githubAction({
@@ -3089,6 +3220,13 @@ function defineESLintConfig(options = {}, ...userConfigs) {
       })
     );
   }
+  if (enableSVGO) {
+    configs2.push(
+      ...svgo({
+        ...resolveSubOptions(options, "svgo")
+      })
+    );
+  }
   const configSpecials = specials({
     ...resolveSubOptions(options, "specials")
   });
@@ -3127,6 +3265,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   GLOB_MARKDOWN_CODE,
   GLOB_MARKDOWN_NESTED,
   GLOB_NODE_MODULES,
+  GLOB_PACKAGE_JSON,
   GLOB_PINIA_STORE,
   GLOB_POSTCSS,
   GLOB_SCSS,
@@ -3145,6 +3284,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   command,
   comments,
   defineESLintConfig,
+  depend,
   esX,
   format,
   getOverrides,
@@ -3178,6 +3318,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   pinia,
   pluginAntfu,
   pluginComments,
+  pluginDepend,
   pluginEsX,
   pluginFormat,
   pluginGitHubAction,
@@ -3192,6 +3333,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   pluginPrettier,
   pluginRegexp,
   pluginStylistic,
+  pluginSvgo,
   pluginToml,
   pluginTypeScript,
   pluginUnicorn,
@@ -3208,6 +3350,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
   sort,
   specials,
   stylistic,
+  svgo,
   test,
   toArray,
   toml,