@ntnyq/eslint-config 2.8.2 → 3.0.0-beta.2

package/dist/index.cjs

@@ -57,7 +57,7 @@ __export(src_exports, {
   GLOB_YAML: () => GLOB_YAML,
   command: () => command,
   comments: () => comments,
-  defineConfig: () => defineConfig,
+  getOverrides: () => getOverrides,
   getVueVersion: () => getVueVersion,
   hasTypeScript: () => hasTypeScript,
   hasUnoCSS: () => hasUnoCSS,
@@ -97,8 +97,10 @@ __export(src_exports, {
   pluginYaml: () => import_eslint_plugin_yml.default,
   prettier: () => prettier,
   regexp: () => regexp,
+  resolveSubOptions: () => resolveSubOptions,
   sortPackageJson: () => sortPackageJson,
   sortTsConfig: () => sortTsConfig,
+  toArray: () => toArray,
   toml: () => toml,
   tseslint: () => import_typescript_eslint.default,
   typescript: () => typescript,
@@ -123,6 +125,12 @@ var hasVue = (0, import_local_pkg.isPackageExists)("vue") || (0, import_local_pk
 });
 var hasUnoCSS = (0, import_local_pkg.isPackageExists)("unocss") || (0, import_local_pkg.isPackageExists)("@unocss/postcss") || (0, import_local_pkg.isPackageExists)("@unocss/webpack") || (0, import_local_pkg.isPackageExists)("@unocss/nuxt");
 
+// src/utils/toArray.ts
+function toArray(val) {
+  val = val ?? [];
+  return Array.isArray(val) ? val : [val];
+}
+
 // src/utils/interopDefault.ts
 async function interopDefault(mod) {
   const resolved = await mod;
@@ -138,9 +146,15 @@ async function loadPlugin(name) {
   return interopDefault(mod);
 }
 
-// src/utils/defineConfig.ts
-function defineConfig(configs = []) {
-  return configs;
+// src/utils/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+
+// src/utils/getOverrides.ts
+function getOverrides(options, key) {
+  const sub = resolveSubOptions(options, key);
+  return "overrides" in sub && sub.overrides ? sub.overrides : {};
 }
 
 // src/globs.ts
@@ -230,12 +244,16 @@ var GLOB_EXCLUDE = [
 ];
 
 // src/configs/ignores.ts
-var ignores = defineConfig([
+var ignores = (customIgnores = []) => [
   {
     name: "ntnyq/ignores",
-    ignores: GLOB_EXCLUDE
+    ignores: [
+      ...GLOB_EXCLUDE,
+      // Overrides built-in ignores
+      ...customIgnores
+    ]
   }
-]);
+];
 
 // src/plugins.ts
 var import_typescript_eslint = __toESM(require("typescript-eslint"), 1);
@@ -261,7 +279,7 @@ var parserVue = __toESM(require("vue-eslint-parser"), 1);
 var parserJsonc = __toESM(require("jsonc-eslint-parser"), 1);
 
 // src/configs/node.ts
-var node = defineConfig([
+var node = (options = {}) => [
   {
     name: "ntnyq/node",
     plugins: {
@@ -275,13 +293,15 @@ var node = defineConfig([
       "node/no-path-concat": "error",
       "node/prefer-global/buffer": ["error", "never"],
       "node/prefer-global/process": ["error", "never"],
-      "node/process-exit-as-throw": "error"
+      "node/process-exit-as-throw": "error",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/jsdoc.ts
-var jsdoc = defineConfig([
+var jsdoc = (options = {}) => [
   {
     name: "ntnyq/jsdoc",
     plugins: {
@@ -304,13 +324,15 @@ var jsdoc = defineConfig([
       "jsdoc/require-returns-description": "warn",
       "jsdoc/require-yields-check": "warn",
       "jsdoc/check-alignment": "warn",
-      "jsdoc/multiline-blocks": "warn"
+      "jsdoc/multiline-blocks": "warn",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/imports.ts
-var imports = defineConfig([
+var imports = (options = {}) => [
   {
     name: "ntnyq/imports",
     plugins: {
@@ -347,13 +369,15 @@ var imports = defineConfig([
           pathGroups: [{ pattern: "{{@,~}/,#}**", group: "internal" }],
           pathGroupsExcludedImportTypes: ["type"]
         }
-      ]
+      ],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/unicorn.ts
-var unicorn = defineConfig([
+var unicorn = (options = {}) => [
   {
     name: "ntnyq/unicorn",
     plugins: {
@@ -423,30 +447,69 @@ var unicorn = defineConfig([
       "unicorn/prefer-array-find": "error",
       "unicorn/prefer-array-some": "error",
       "unicorn/prefer-array-flat-map": "error",
-      "unicorn/prefer-array-index-of": "error"
+      "unicorn/prefer-array-index-of": "error",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/prettier.ts
-var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
-var prettier = defineConfig([
+var prettier = (options = {}) => [
   {
     name: "ntnyq/prettier",
     plugins: {
       prettier: import_eslint_plugin_prettier.default
     },
     rules: {
-      ...import_eslint_config_prettier.default.rules,
+      "vue/array-bracket-newline": "off",
+      "vue/array-bracket-spacing": "off",
+      "vue/array-element-newline": "off",
+      "vue/arrow-spacing": "off",
+      "vue/block-spacing": "off",
+      "vue/block-tag-newline": "off",
+      "vue/brace-style": "off",
+      "vue/comma-dangle": "off",
+      "vue/comma-spacing": "off",
+      "vue/comma-style": "off",
+      "vue/dot-location": "off",
+      "vue/func-call-spacing": "off",
+      "vue/html-closing-bracket-newline": "off",
+      "vue/html-closing-bracket-spacing": "off",
+      "vue/html-end-tags": "off",
+      "vue/html-indent": "off",
+      "vue/html-quotes": "off",
+      "vue/key-spacing": "off",
+      "vue/keyword-spacing": "off",
+      "vue/max-attributes-per-line": "off",
+      "vue/multiline-html-element-content-newline": "off",
+      "vue/multiline-ternary": "off",
+      "vue/mustache-interpolation-spacing": "off",
+      "vue/no-extra-parens": "off",
+      "vue/no-multi-spaces": "off",
+      "vue/no-spaces-around-equal-signs-in-attribute": "off",
+      "vue/object-curly-newline": "off",
+      "vue/object-curly-spacing": "off",
+      "vue/object-property-newline": "off",
+      "vue/operator-linebreak": "off",
+      "vue/quote-props": "off",
+      "vue/script-indent": "off",
+      "vue/singleline-html-element-content-newline": "off",
+      "vue/space-in-parens": "off",
+      "vue/space-infix-ops": "off",
+      "vue/space-unary-ops": "off",
+      "vue/template-curly-spacing": "off",
       ...import_eslint_plugin_prettier.default.configs.recommended.rules,
-      "prettier/prettier": "warn"
+      "prettier/prettier": "warn",
+      // Overrides built-in rules
+      ...options.overrides
     }
   },
   /**
    * Languages that prettier currently does not support
    */
   {
-    name: "ntnyq/prettier/ignore",
+    name: "ntnyq/prettier/disabled",
     files: [GLOB_TOML],
     plugins: {
       prettier: import_eslint_plugin_prettier.default
@@ -455,10 +518,10 @@ var prettier = defineConfig([
       "prettier/prettier": "off"
     }
   }
-]);
+];
 
 // src/configs/comments.ts
-var comments = defineConfig([
+var comments = (options = {}) => [
   {
     name: "ntnyq/eslint-comments",
     plugins: {
@@ -466,15 +529,17 @@ var comments = defineConfig([
     },
     rules: {
       ...import_eslint_plugin_eslint_comments.default.configs.recommended.rules,
-      "@eslint-community/eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }]
+      "@eslint-community/eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/javascript.ts
 var import_globals = __toESM(require("globals"), 1);
 var import_js = __toESM(require("@eslint/js"), 1);
-var javascript = defineConfig([
+var javascript = (option = {}) => [
   {
     name: "ntnyq/js/recommended",
     ...import_js.default.configs.recommended
@@ -685,7 +750,9 @@ var javascript = defineConfig([
           memberSyntaxSortOrder: ["none", "all", "multiple", "single"],
           allowSeparatedGroups: false
         }
-      ]
+      ],
+      // Overrides built-in rules
+      ...option.overrides
     }
   },
   {
@@ -703,8 +770,8 @@ var javascript = defineConfig([
       "max-lines-per-function": "off"
     }
   }
-]);
-var jsx = defineConfig([
+];
+var jsx = () => [
   {
     name: "ntnyq/jsx",
     files: ["**/*.jsx"],
@@ -716,10 +783,10 @@ var jsx = defineConfig([
       }
     }
   }
-]);
+];
 
 // src/configs/typescript.ts
-var typescriptCore = import_typescript_eslint.default.config({
+var typescriptCore = (options = {}) => import_typescript_eslint.default.config({
   name: "ntnyq/ts/core",
   extends: [...import_typescript_eslint.default.configs.recommended],
   files: [GLOB_TS, GLOB_TSX],
@@ -782,10 +849,12 @@ var typescriptCore = import_typescript_eslint.default.config({
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/consistent-indexed-object-style": "off"
-  }
+  },
+  // Overrides built-in rules
+  ...options.overrides
 });
-var typescript = defineConfig([
-  ...typescriptCore,
+var typescript = (options = {}) => [
+  ...typescriptCore(options),
   {
     name: "ntnyq/ts/dts",
     files: [GLOB_DTS],
@@ -809,10 +878,10 @@ var typescript = defineConfig([
     files: [GLOB_JS],
     rules: {}
   }
-]);
+];
 
 // src/configs/unusedImports.ts
-var unusedImports = defineConfig([
+var unusedImports = (options = {}) => [
   {
     name: "ntnyq/unused-imports",
     plugins: {
@@ -829,13 +898,15 @@ var unusedImports = defineConfig([
           args: "after-used",
           argsIgnorePattern: "^_"
         }
-      ]
+      ],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/perfectionist.ts
-var perfectionist = defineConfig([
+var perfectionist = (options = {}) => [
   {
     name: "ntnyq/perfectionist",
     plugins: {
@@ -866,24 +937,28 @@ var perfectionist = defineConfig([
         }
       ],
       "perfectionist/sort-named-exports": ["warn", { groupKind: "values-first" }],
-      "perfectionist/sort-named-imports": ["warn", { groupKind: "values-first" }]
+      "perfectionist/sort-named-imports": ["warn", { groupKind: "values-first" }],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/regexp.ts
-var regexp = defineConfig([
+var regexp = (options = {}) => [
   /**
    * https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/rules/recommended.ts
    */
   {
     name: "ntnyq/regexp",
-    ...pluginRegexp.configs["flat/recommended"]
+    ...pluginRegexp.configs["flat/recommended"],
+    // Overrides built-in rules
+    ...options.overrides
   }
-]);
+];
 
 // src/configs/unocss.ts
-var unocss = defineConfig([
+var unocss = (options = {}) => [
   {
     name: "ntnyq/unocss",
     plugins: {
@@ -892,17 +967,24 @@ var unocss = defineConfig([
     rules: {
       "unocss/order": "error",
       // We don't use this
-      "unocss/order-attributify": "off"
+      "unocss/order-attributify": "off",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/command.ts
 var import_config = __toESM(require("eslint-plugin-command/config"), 1);
-var command = defineConfig([(0, import_config.default)()]);
+var command = () => [
+  {
+    ...(0, import_config.default)(),
+    name: "ntnyq/command"
+  }
+];
 
 // src/configs/vitest.ts
-var vitest = defineConfig([
+var vitest = (options = {}) => [
   {
     name: "ntnyq/test",
     plugins: {
@@ -910,10 +992,12 @@ var vitest = defineConfig([
     },
     files: [GLOB_TEST],
     rules: {
-      ...import_eslint_plugin2.default.configs.recommended.rules
+      ...import_eslint_plugin2.default.configs.recommended.rules,
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/vue.ts
 var import_node_process2 = __toESM(require("process"), 1);
@@ -938,13 +1022,11 @@ var vue3Rules = {
   ...import_eslint_plugin_vue.default.configs["vue3-strongly-recommended"].rules,
   ...import_eslint_plugin_vue.default.configs["vue3-recommended"].rules
 };
-var vue = defineConfig([
+var vue = (options = {}) => [
   ...import_typescript_eslint.default.config({
     name: "ntnyq/vue/ts",
     files: [GLOB_VUE],
-    // TODO: Remove this when `typescript-eslint` is aligned with `eslint`
-    // @ts-expect-error - `typescript-eslint` is not aligned with eslint
-    extends: typescriptCore
+    extends: typescriptCore()
   }),
   {
     name: "ntnyq/vue/core",
@@ -1178,13 +1260,15 @@ var vue = defineConfig([
           singleline: 1,
           multiline: 1
         }
-      ]
+      ],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/yml.ts
-var yml = defineConfig([
+var yml = (options = {}) => [
   {
     name: "ntnyq/yaml",
     files: [GLOB_YAML],
@@ -1198,13 +1282,15 @@ var yml = defineConfig([
       ...import_eslint_plugin_yml.default.configs.standard.rules,
       ...import_eslint_plugin_yml.default.configs.prettier.rules,
       "yml/no-empty-mapping-value": "off",
-      "yml/quotes": ["error", { avoidEscape: false, prefer: "single" }]
+      "yml/quotes": ["error", { avoidEscape: false, prefer: "single" }],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/toml.ts
-var toml = defineConfig([
+var toml = (options = {}) => [
   {
     name: "ntnyq/toml",
     files: [GLOB_TOML],
@@ -1233,13 +1319,15 @@ var toml = defineConfig([
       "toml/padding-line-between-tables": "error",
       "toml/quoted-keys": "error",
       "toml/spaced-comment": "error",
-      "toml/table-bracket-spacing": "error"
+      "toml/table-bracket-spacing": "error",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/sort.ts
-var sortPackageJson = defineConfig([
+var sortPackageJson = () => [
   {
     name: "ntnyq/sort/package-json",
     files: ["**/package.json"],
@@ -1337,8 +1425,8 @@ var sortPackageJson = defineConfig([
       ]
     }
   }
-]);
-var sortTsConfig = defineConfig([
+];
+var sortTsConfig = () => [
   {
     name: "ntnyq/sort/tsconfig",
     files: ["**/tsconfig.json", "**/tsconfig.*.json"],
@@ -1453,10 +1541,10 @@ var sortTsConfig = defineConfig([
       ]
     }
   }
-]);
+];
 
 // src/configs/jsonc.ts
-var jsonc = defineConfig([
+var jsonc = (options = {}) => [
   {
     name: "ntnyq/jsonc",
     files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
@@ -1493,13 +1581,15 @@ var jsonc = defineConfig([
         {
           allowMultiplePropertiesPerLine: true
         }
-      ]
+      ],
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/configs/markdown.ts
-var markdown = defineConfig([
+var markdown = (options = {}) => [
   ...import_eslint_plugin_markdown.default.configs.recommended,
   {
     name: "ntnyq/markdown/extensions",
@@ -1521,63 +1611,131 @@ var markdown = defineConfig([
       "@typescript-eslint/no-namespace": "off",
       "@typescript-eslint/no-unused-vars": "off",
       "@typescript-eslint/no-extraneous-class": "off",
-      "@typescript-eslint/no-use-before-define": "off"
+      "@typescript-eslint/no-use-before-define": "off",
+      // Overrides built-in rules
+      ...options.overrides
     }
   }
-]);
+];
 
 // src/core.ts
-function ntnyq(config = [], {
-  vue: enableVue = hasVue,
-  unocss: enableUnoCSS = hasUnoCSS,
-  vitest: enableVitest = hasVitest,
-  prettier: enablePrettier = true,
-  markdown: enableMarkdown = true,
-  command: enableCommand = true
-} = {}) {
-  const configs = defineConfig([
+function ntnyq(options = {}, customConfig = []) {
+  const configs = [
     /**
      * Basic
      */
-    ...ignores,
-    ...jsdoc,
-    ...jsx,
-    ...node,
-    ...imports,
-    ...unicorn,
-    ...comments,
-    ...javascript,
-    ...regexp,
-    ...typescript,
-    /**
-     * Language extensions
-     */
-    ...yml,
-    ...toml,
-    ...jsonc,
-    ...sortPackageJson,
-    ...sortTsConfig
-  ]);
-  if (enableVue) {
-    configs.push(...vue);
+    ...ignores(options.ignores),
+    ...jsx(),
+    ...node({
+      overrides: getOverrides(options, "node")
+    }),
+    ...imports({
+      overrides: getOverrides(options, "imports")
+    }),
+    ...javascript({
+      overrides: getOverrides(options, "javascript")
+    })
+  ];
+  if (options.unicorn ?? true) {
+    configs.push(
+      ...unicorn({
+        overrides: getOverrides(options, "unicorn")
+      })
+    );
+  }
+  if (options.regexp ?? true) {
+    configs.push(
+      ...regexp({
+        overrides: getOverrides(options, "regexp")
+      })
+    );
+  }
+  if (options.jsdoc ?? true) {
+    configs.push(
+      ...jsdoc({
+        overrides: getOverrides(options, "jsdoc")
+      })
+    );
+  }
+  if (options.comments ?? true) {
+    configs.push(
+      ...comments({
+        overrides: getOverrides(options, "comments")
+      })
+    );
+  }
+  if (options.typescript ?? hasTypeScript) {
+    configs.push(
+      ...typescript({
+        overrides: getOverrides(options, "typescript")
+      })
+    );
+  }
+  if (options.sortTsConfig ?? true) {
+    configs.push(...sortTsConfig());
+  }
+  if (options.sortPackageJson ?? true) {
+    configs.push(...sortPackageJson());
+  }
+  if (options.yml ?? true) {
+    configs.push(
+      ...yml({
+        overrides: getOverrides(options, "yml")
+      })
+    );
+  }
+  if (options.toml ?? true) {
+    configs.push(
+      ...toml({
+        overrides: getOverrides(options, "toml")
+      })
+    );
+  }
+  if (options.jsonc ?? true) {
+    configs.push(
+      ...jsonc({
+        overrides: getOverrides(options, "jsonc")
+      })
+    );
   }
-  if (enableVitest) {
-    configs.push(...vitest);
+  if (options.vue ?? hasVue) {
+    configs.push(
+      ...vue({
+        overrides: getOverrides(options, "vue")
+      })
+    );
   }
-  if (enableUnoCSS) {
-    configs.push(...unocss);
+  if (options.vitest ?? hasVitest) {
+    configs.push(
+      ...vitest({
+        overrides: getOverrides(options, "vitest")
+      })
+    );
   }
-  if (enableMarkdown) {
-    configs.push(...markdown);
+  if (options.unocss ?? hasUnoCSS) {
+    configs.push(
+      ...unocss({
+        overrides: getOverrides(options, "unocss")
+      })
+    );
   }
-  if (enableCommand) {
-    configs.push(...command);
+  if (options.markdown ?? true) {
+    configs.push(
+      ...markdown({
+        overrides: getOverrides(options, "markdown")
+      })
+    );
   }
-  if (enablePrettier) {
-    configs.push(...prettier);
+  if (options.command ?? true) {
+    configs.push(...command());
   }
-  if (Object.keys(config).length > 0) {
-    configs.push(...Array.isArray(config) ? config : [config]);
+  configs.push(...toArray(customConfig));
+  if (options.prettier ?? true) {
+    configs.push(
+      ...prettier({
+        overrides: getOverrides(options, "prettier")
+      })
+    );
   }
   return configs;
 }
@@ -1610,7 +1768,7 @@ function ntnyq(config = [], {
   GLOB_YAML,
   command,
   comments,
-  defineConfig,
+  getOverrides,
   getVueVersion,
   hasTypeScript,
   hasUnoCSS,
@@ -1650,8 +1808,10 @@ function ntnyq(config = [], {
   pluginYaml,
   prettier,
   regexp,
+  resolveSubOptions,
   sortPackageJson,
   sortTsConfig,
+  toArray,
   toml,
   tseslint,
   typescript,