@ntnyq/eslint-config 3.5.1 → 3.6.0

package/dist/index.cjs

@@ -1042,25 +1042,25 @@ var toml = (options = {}) => [
       toml: import_eslint_plugin_toml.default
     },
     rules: {
-      "toml/comma-style": "error",
       "toml/keys-order": "error",
+      "toml/key-spacing": "error",
+      "toml/quoted-keys": "error",
+      "toml/comma-style": "error",
+      "toml/tables-order": "error",
       "toml/no-space-dots": "error",
-      "toml/no-unreadable-number-separator": "error",
-      "toml/precision-of-fractional-seconds": "error",
+      "toml/spaced-comment": "error",
       "toml/precision-of-integer": "error",
-      "toml/tables-order": "error",
-      "toml/indent": ["error", 2],
-      "toml/vue-custom-block/no-parsing-error": "error",
+      "toml/table-bracket-spacing": "error",
       "toml/array-bracket-newline": "error",
-      "toml/array-bracket-spacing": ["error", "never"],
-      "toml/array-element-newline": ["error", "never"],
       "toml/inline-table-curly-spacing": "error",
-      "toml/key-spacing": "error",
       "toml/padding-line-between-pairs": "error",
       "toml/padding-line-between-tables": "error",
-      "toml/quoted-keys": "error",
-      "toml/spaced-comment": "error",
-      "toml/table-bracket-spacing": "error",
+      "toml/no-unreadable-number-separator": "error",
+      "toml/precision-of-fractional-seconds": "error",
+      "toml/vue-custom-block/no-parsing-error": "error",
+      "toml/indent": ["error", 2],
+      "toml/array-bracket-spacing": ["error", "never"],
+      "toml/array-element-newline": ["error", "never"],
       // Overrides rules
       ...options.overrides
     }
@@ -1116,6 +1116,13 @@ var antfu = (options = {}) => [
 ];
 
 // src/configs/jsdoc.ts
+var typescriptRules = {
+  "jsdoc/no-undefined-types": "off",
+  "jsdoc/require-param-type": "off",
+  "jsdoc/require-property-type": "off",
+  "jsdoc/require-returns-type": "off",
+  "jsdoc/no-types": "error"
+};
 var jsdoc = (options = {}) => [
   {
     name: "ntnyq/jsdoc",
@@ -1123,23 +1130,204 @@ var jsdoc = (options = {}) => [
       jsdoc: import_eslint_plugin_jsdoc.default
     },
     rules: {
+      // Disabled rules
+      "jsdoc/tag-lines": "off",
+      // Use `jsdoc/sort-tags`
+      "jsdoc/text-escaping": "off",
+      // No need
+      // Fixable rules
+      "jsdoc/check-alignment": "error",
+      "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",
+      "jsdoc/no-bad-blocks": "error",
+      "jsdoc/no-blank-block-descriptions": "error",
+      "jsdoc/no-blank-blocks": "error",
+      "jsdoc/no-defaults": "error",
+      "jsdoc/no-multi-asterisks": "error",
+      "jsdoc/require-asterisk-prefix": "error",
+      "jsdoc/require-hyphen-before-param-description": "error",
+      // TODO: this after investigate
+      // 'jsdoc/sort-tags': [
+      //   'error',
+      //   {
+      //     tagSequence: [
+      //       {
+      //         // Module/file-level
+      //         tags: ['module', 'exports', 'file', 'fileoverview', 'overview', 'import'],
+      //       },
+      //       {
+      //         // Identifying (name, type)
+      //         tags: [
+      //           'typedef',
+      //           'interface',
+      //           'record',
+      //           'template',
+      //           'name',
+      //           'kind',
+      //           'type',
+      //           'alias',
+      //           'external',
+      //           'host',
+      //           'callback',
+      //           'func',
+      //           'function',
+      //           'method',
+      //           'class',
+      //           'constructor',
+      //         ],
+      //       },
+      //       {
+      //         // Relationships
+      //         tags: [
+      //           'modifies',
+      //           'mixes',
+      //           'mixin',
+      //           'mixinClass',
+      //           'mixinFunction',
+      //           'namespace',
+      //           'borrows',
+      //           'constructs',
+      //           'lends',
+      //           'implements',
+      //           'requires',
+      //         ],
+      //       },
+      //       {
+      //         // Long descriptions
+      //         tags: ['desc', 'description', 'classdesc', 'tutorial', 'copyright', 'license'],
+      //       },
+      //       {
+      //         // Simple annotations
+      //         tags: [
+      //           'const',
+      //           'constant',
+      //           'final',
+      //           'global',
+      //           'readonly',
+      //           'abstract',
+      //           'virtual',
+      //           'var',
+      //           'member',
+      //           'memberof',
+      //           'memberof!',
+      //           'inner',
+      //           'instance',
+      //           'inheritdoc',
+      //           'inheritDoc',
+      //           'override',
+      //           'hideconstructor',
+      //         ],
+      //       },
+      //       {
+      //         // Core function/object inf
+      //         tags: ['param', 'arg', 'argument', 'prop', 'property', 'return', 'returns'],
+      //       },
+      //       {
+      //         // Important behavior details
+      //         tags: [
+      //           'async',
+      //           'generator',
+      //           'default',
+      //           'defaultvalue',
+      //           'enum',
+      //           'augments',
+      //           'extends',
+      //           'throws',
+      //           'exception',
+      //           'yield',
+      //           'yields',
+      //           'event',
+      //           'fires',
+      //           'emits',
+      //           'listens',
+      //           'this',
+      //         ],
+      //       },
+      //       {
+      //         // Access
+      //         tags: ['static', 'private', 'protected', 'public', 'access', 'internal', 'package'],
+      //       },
+      //       {
+      //         // Other/unknown
+      //         tags: ['-other'],
+      //       },
+      //       {
+      //         // Supplementary descriptions
+      //         tags: ['see', 'example'],
+      //       },
+      //       {
+      //         // Other Closure (undocumented) metadata
+      //         tags: [
+      //           'closurePrimitive',
+      //           'customElement',
+      //           'expose',
+      //           'hidden',
+      //           'idGenerator',
+      //           'meaning',
+      //           'ngInject',
+      //           'owner',
+      //           'wizaction',
+      //         ],
+      //       },
+      //       {
+      //         // Other Closure (documented) metadata
+      //         tags: [
+      //           'define',
+      //           'dict',
+      //           'export',
+      //           'externs',
+      //           'implicitCast',
+      //           'noalias',
+      //           'nocollapse',
+      //           'nocompile',
+      //           'noinline',
+      //           'nosideeffects',
+      //           'polymer',
+      //           'polymerBehavior',
+      //           'preserve',
+      //           'struct',
+      //           'suppress',
+      //           'unrestricted',
+      //         ],
+      //       },
+      //       {
+      //         // Metadata
+      //         tags: ['category'],
+      //       },
+      //       {
+      //         // Non-Closure metadata
+      //         tags: [
+      //           'ignore',
+      //           'author',
+      //           'version',
+      //           'variation',
+      //           'since',
+      //           'deprecated',
+      //           'compatibility',
+      //           'todo',
+      //         ],
+      //       },
+      //     ],
+      //     alphabetizeExtras: true,
+      //     linesBetween: 1,
+      //   },
+      // ],
       "jsdoc/check-access": "warn",
-      "jsdoc/check-param-names": "warn",
-      "jsdoc/check-property-names": "warn",
-      "jsdoc/check-types": "warn",
-      "jsdoc/empty-tags": "warn",
       "jsdoc/implements-on-classes": "warn",
-      "jsdoc/no-defaults": "warn",
-      "jsdoc/no-multi-asterisks": "warn",
       "jsdoc/require-param-name": "warn",
       "jsdoc/require-property": "warn",
-      "jsdoc/require-property-description": "warn",
       "jsdoc/require-property-name": "warn",
+      "jsdoc/require-property-description": "warn",
       "jsdoc/require-returns-check": "warn",
       "jsdoc/require-returns-description": "warn",
       "jsdoc/require-yields-check": "warn",
-      "jsdoc/check-alignment": "warn",
-      "jsdoc/multiline-blocks": "warn",
+      // TypeScript rules overrides
+      ...options.typescript ? typescriptRules : {},
       // Overrides rules
       ...options.overrides
     }
@@ -1159,10 +1347,12 @@ var jsonc = (options = {}) => [
     },
     rules: {
       ...import_eslint_plugin_jsonc.default.configs["recommended-with-jsonc"].rules,
-      "jsonc/array-bracket-spacing": ["error", "never"],
-      "jsonc/comma-dangle": ["error", "never"],
-      "jsonc/comma-style": ["error", "last"],
+      "jsonc/no-octal-escape": "error",
       "jsonc/indent": ["error", 2],
+      "jsonc/comma-style": ["error", "last"],
+      "jsonc/comma-dangle": ["error", "never"],
+      "jsonc/object-curly-spacing": ["error", "always"],
+      "jsonc/array-bracket-spacing": ["error", "never"],
       "jsonc/key-spacing": [
         "error",
         {
@@ -1170,7 +1360,6 @@ var jsonc = (options = {}) => [
           afterColon: true
         }
       ],
-      "jsonc/no-octal-escape": "error",
       "jsonc/object-curly-newline": [
         "error",
         {
@@ -1178,7 +1367,6 @@ var jsonc = (options = {}) => [
           consistent: true
         }
       ],
-      "jsonc/object-curly-spacing": ["error", "always"],
       "jsonc/object-property-newline": [
         "error",
         {
@@ -1208,23 +1396,23 @@ var ntnyq = (options = {}) => [
 
 // src/configs/regexp.ts
 var regexp = (options = {}) => {
-  const config = pluginRegexp.configs["flat/recommended"];
-  const rules = {
-    ...config.rules
+  const recommendedConfig = pluginRegexp.configs["flat/recommended"];
+  const recommendedRules2 = {
+    ...recommendedConfig.rules
   };
   if (options.level === "warn") {
-    for (const key in rules) {
-      if (rules[key] === "error") {
-        rules[key] = "warn";
+    for (const key in recommendedRules2) {
+      if (recommendedRules2[key] === "error") {
+        recommendedRules2[key] = "warn";
       }
     }
   }
   return [
     {
-      ...config,
+      ...recommendedConfig,
       name: "ntnyq/regexp",
       rules: {
-        ...rules,
+        ...recommendedRules2,
         // Overrides rules
         ...options.overrides
       }
@@ -1499,8 +1687,8 @@ var imports = (options = {}) => [
 // src/configs/unicorn.ts
 var disabledRules2 = {
   "unicorn/better-regex": "off",
-  "unicorn/prefer-top-level-await": "off",
   "unicorn/explicit-length-check": "off",
+  "unicorn/prefer-top-level-await": "off",
   "unicorn/no-array-callback-reference": "off",
   /**
    * @see https://caniuse.com/?search=globalThis
@@ -1514,37 +1702,37 @@ var unicorn = (options = {}) => [
       unicorn: import_eslint_plugin_unicorn.default
     },
     rules: {
-      "unicorn/error-message": "error",
       "unicorn/escape-case": "error",
+      "unicorn/no-for-loop": "error",
+      "unicorn/no-lonely-if": "error",
+      "unicorn/error-message": "error",
       "unicorn/no-new-buffer": "error",
-      "unicorn/number-literal-case": "error",
+      "unicorn/no-hex-escape": "error",
+      "unicorn/throw-new-error": "error",
       "unicorn/prefer-includes": "error",
+      "unicorn/new-for-builtins": "error",
       "unicorn/prefer-type-error": "error",
-      "unicorn/throw-new-error": "error",
-      "unicorn/no-unnecessary-await": "error",
-      "unicorn/switch-case-braces": ["error", "avoid"],
-      "unicorn/no-typeof-undefined": "error",
+      "unicorn/prefer-math-trunc": "error",
+      "unicorn/no-console-spaces": "error",
+      "unicorn/no-zero-fractions": "error",
       "unicorn/prefer-regexp-test": "error",
+      "unicorn/number-literal-case": "error",
+      "unicorn/no-typeof-undefined": "error",
+      "unicorn/prefer-math-min-max": "error",
+      "unicorn/prefer-node-protocol": "error",
+      "unicorn/no-unnecessary-await": "error",
       "unicorn/no-static-only-class": "error",
-      "unicorn/no-zero-fractions": "error",
+      "unicorn/prefer-reflect-apply": "error",
+      "unicorn/prefer-negative-index": "error",
+      "unicorn/prefer-structured-clone": "error",
       "unicorn/custom-error-definition": "error",
       "unicorn/prefer-modern-math-apis": "error",
-      "unicorn/new-for-builtins": "error",
-      "unicorn/no-console-spaces": "error",
-      "unicorn/no-for-loop": "error",
-      "unicorn/no-hex-escape": "error",
-      "unicorn/no-lonely-if": "error",
-      "unicorn/prefer-keyboard-event-key": "error",
-      "unicorn/prefer-math-trunc": "error",
-      "unicorn/prefer-negative-index": "error",
-      "unicorn/prefer-node-protocol": "error",
       "unicorn/prefer-number-properties": "error",
-      "unicorn/prefer-optional-catch-binding": "error",
       "unicorn/prefer-prototype-methods": "error",
-      "unicorn/prefer-reflect-apply": "error",
-      "unicorn/prefer-math-min-max": "error",
-      "unicorn/prefer-structured-clone": "error",
+      "unicorn/prefer-keyboard-event-key": "error",
+      "unicorn/prefer-optional-catch-binding": "error",
       "unicorn/consistent-existence-index-check": "error",
+      "unicorn/switch-case-braces": ["error", "avoid"],
       "unicorn/catch-error-name": [
         "error",
         {
@@ -1559,24 +1747,24 @@ var unicorn = (options = {}) => [
       "unicorn/prefer-string-trim-start-end": "error",
       "unicorn/prefer-string-starts-ends-with": "error",
       // DOM
-      "unicorn/prefer-add-event-listener": "error",
-      "unicorn/no-invalid-remove-event-listener": "error",
       "unicorn/prefer-query-selector": "error",
       "unicorn/prefer-modern-dom-apis": "error",
+      "unicorn/prefer-dom-node-remove": "error",
       "unicorn/prefer-dom-node-append": "error",
       "unicorn/prefer-dom-node-dataset": "error",
-      "unicorn/prefer-dom-node-remove": "error",
+      "unicorn/prefer-add-event-listener": "error",
       "unicorn/prefer-dom-node-text-content": "error",
+      "unicorn/no-invalid-remove-event-listener": "error",
       // Array
       "unicorn/no-new-array": "error",
-      "unicorn/no-instanceof-array": "error",
       "unicorn/no-array-push-push": "error",
-      "unicorn/no-array-method-this-argument": "error",
       "unicorn/prefer-array-find": "error",
       "unicorn/prefer-array-some": "error",
+      "unicorn/no-instanceof-array": "error",
       "unicorn/prefer-array-flat-map": "error",
       "unicorn/prefer-array-index-of": "error",
       "unicorn/require-array-join-separator": "error",
+      "unicorn/no-array-method-this-argument": "error",
       // Set
       "unicorn/prefer-set-has": "error",
       "unicorn/prefer-set-size": "error",
@@ -1589,13 +1777,15 @@ var unicorn = (options = {}) => [
 
 // src/configs/specials.ts
 var import_globals = __toESM(require("globals"), 1);
-var specials = () => [
+var specials = (options = {}) => [
   {
     name: "ntnyq/specials/scripts",
     files: [`**/scripts/${GLOB_SRC}`],
     rules: {
       "no-console": "off",
-      "@typescript-eslint/explicit-function-return-type": "off"
+      "@typescript-eslint/explicit-function-return-type": "off",
+      // Overrides rules
+      ...options.overridesScriptsRules
     }
   },
   {
@@ -1603,7 +1793,9 @@ var specials = () => [
     files: [`**/cli/${GLOB_SRC}`, `**/cli.${GLOB_SRC_EXT}`],
     rules: {
       "no-console": "off",
-      "@typescript-eslint/explicit-function-return-type": "off"
+      "@typescript-eslint/explicit-function-return-type": "off",
+      // Overrides rules
+      ...options.overridesCliRules
     }
   },
   {
@@ -1620,9 +1812,14 @@ var specials = () => [
         {
           allow: ["^GM_.+"]
         }
-      ]
+      ],
+      // Overrides rules
+      ...options.overridesUserScriptsRules
     }
-  }
+  },
+  // More special case configs
+  // So don't need to append configs to composer
+  ...options.specialCaseConfigs ? options.specialCaseConfigs : []
 ];
 
 // src/configs/comments.ts
@@ -1713,6 +1910,7 @@ var markdown = (options = {}) => {
 var prettier = (options = {}) => {
   const {
     disabledFiles = [GLOB_TOML, GLOB_ASTRO, GLOB_SVELTE],
+    // User defined disabled files
     userDisabledFiles = []
   } = options;
   return [
@@ -2372,16 +2570,37 @@ var unusedImports = (options = {}) => [
 ];
 
 // src/core.ts
-async function defineESLintConfig(options = {}, ...userConfigs) {
-  const configs2 = [];
+function defineESLintConfig(options = {}, ...userConfigs) {
   const {
-    markdown: enableMarkdown = true,
-    gitignore: enableGitIgnore = true,
+    /**
+     * Shared options
+     */
+    extensions: supportedExtensions = [],
+    /**
+     * Conditional by deps
+     */
     vue: enableVue = hasVue,
+    test: enableTest = hasVitest,
     unocss: enableUnoCSS = hasUnoCSS,
     typescript: enableTypeScript = hasTypeScript,
-    extensions: supportedExtensions = []
+    /**
+     * Enabled by default
+     */
+    yml: enableYML = true,
+    sort: enableSort = true,
+    toml: enableTOML = true,
+    jsonc: enableJSONC = true,
+    antfu: enableAntfu = true,
+    regexp: enableRegexp = true,
+    unicorn: enableUnicorn = true,
+    prettier: enablePrettier = true,
+    markdown: enableMarkdown = true,
+    stylistic: enableStylistic = true,
+    gitignore: enableGitIgnore = true,
+    githubAction: enableGitHubAction = true,
+    perfectionist: enablePerfectionist = true
   } = options;
+  const configs2 = [];
   if (enableVue) {
     supportedExtensions.push("vue");
   }
@@ -2405,6 +2624,7 @@ async function defineESLintConfig(options = {}, ...userConfigs) {
       overrides: getOverrides(options, "imports")
     }),
     ...jsdoc({
+      typescript: !!enableTypeScript,
       overrides: getOverrides(options, "jsdoc")
     }),
     ...comments({
@@ -2415,7 +2635,7 @@ async function defineESLintConfig(options = {}, ...userConfigs) {
       overrides: getOverrides(options, "javascript")
     })
   );
-  if (options.perfectionist ?? true) {
+  if (enablePerfectionist) {
     configs2.push(
       ...perfectionist({
         ...resolveSubOptions(options, "perfectionist"),
@@ -2423,14 +2643,14 @@ async function defineESLintConfig(options = {}, ...userConfigs) {
       })
     );
   }
-  if (options.unicorn ?? true) {
+  if (enableUnicorn) {
     configs2.push(
       ...unicorn({
         overrides: getOverrides(options, "unicorn")
       })
     );
   }
-  if (options.regexp ?? true) {
+  if (enableRegexp) {
     configs2.push(
       ...regexp({
         ...resolveSubOptions(options, "regexp"),
@@ -2456,35 +2676,35 @@ async function defineESLintConfig(options = {}, ...userConfigs) {
       })
     );
   }
-  if (options.yml ?? true) {
+  if (enableYML) {
     configs2.push(
       ...yml({
         overrides: getOverrides(options, "yml")
       })
     );
   }
-  if (options.toml ?? true) {
+  if (enableTOML) {
     configs2.push(
       ...toml({
         overrides: getOverrides(options, "toml")
       })
     );
   }
-  if (options.jsonc ?? true) {
+  if (enableJSONC) {
     configs2.push(
       ...jsonc({
         overrides: getOverrides(options, "jsonc")
       })
     );
   }
-  if (options.sort ?? true) {
+  if (enableSort) {
     configs2.push(
       ...sort({
         ...resolveSubOptions(options, "sort")
       })
     );
   }
-  if (options.test ?? hasVitest) {
+  if (enableTest) {
     configs2.push(
       ...test({
         overrides: getOverrides(options, "test")
@@ -2509,34 +2729,35 @@ async function defineESLintConfig(options = {}, ...userConfigs) {
       })
     );
   }
-  if (options.antfu ?? true) {
+  if (enableAntfu) {
     configs2.push(
       ...antfu({
         overrides: getOverrides(options, "antfu")
       })
     );
   }
-  if (options.stylistic ?? true) {
+  if (enableStylistic) {
     configs2.push(
       ...stylistic({
         overrides: getOverrides(options, "stylistic")
       })
     );
   }
-  if (options.githubAction ?? true) {
+  if (enableGitHubAction) {
     configs2.push(
       ...githubAction({
         overrides: getOverrides(options, "githubAction")
       })
     );
   }
-  const configSpecials = specials();
-  const configPrettier = options.prettier ?? true ? prettier({
+  const configSpecials = specials({
+    ...resolveSubOptions(options, "specials")
+  });
+  const configPrettier = enablePrettier ? prettier({
     ...resolveSubOptions(options, "prettier"),
     overrides: getOverrides(options, "prettier")
   }) : [];
-  const composer = new import_eslint_flat_config_utils.FlatConfigComposer();
-  await composer.append(
+  const composer = new import_eslint_flat_config_utils.FlatConfigComposer(
     ...configs2,
     ...userConfigs,
     ...configSpecials,