@ntnyq/eslint-config 3.3.1 → 3.4.0

package/README.md

@@ -109,20 +109,24 @@ Check for detail in:
 
 ```ts
 export interface ConfigOptions extends ConfigOptionsInternal {
-  ignores?: ConfigIgnoresOptions
-
-  sort?: boolean | ConfigSortOptions
+  node?: ConfigNodeOptions
 
-  command?: boolean | ConfigCommandOptions
+  jsdoc?: ConfigJsdocOptions
 
-  gitignore?: boolean | ConfigGitIgnoreOptions
+  ignores?: ConfigIgnoresOptions
 
   imports?: ConfigImportsOptions
 
-  node?: ConfigNodeOptions
+  command?: ConfigCommandOptions
+
+  comments?: ConfigCommentsOptions
 
   javascript?: ConfigJavaScriptOptions
 
+  sort?: boolean | ConfigSortOptions
+
+  gitignore?: boolean | ConfigGitIgnoreOptions
+
   stylistic?: boolean | ConfigStylisticOptions
 
   typescript?: boolean | ConfigTypeScriptOptions
@@ -133,10 +137,6 @@ export interface ConfigOptions extends ConfigOptionsInternal {
 
   perfectionist?: boolean | ConfigPerfectionistOptions
 
-  comments?: boolean | ConfigCommentsOptions
-
-  jsdoc?: boolean | ConfigJsdocOptions
-
   unocss?: boolean | ConfigUnoCSSOptions
 
   regexp?: boolean | ConfigRegexpOptions

package/dist/index.cjs

@@ -33,6 +33,7 @@ __export(src_exports, {
   DEFAULT_PRETTIER_OPTIONS: () => DEFAULT_PRETTIER_OPTIONS,
   GLOB_ALL_SRC: () => GLOB_ALL_SRC,
   GLOB_ASTRO: () => GLOB_ASTRO,
+  GLOB_ASTRO_TS: () => GLOB_ASTRO_TS,
   GLOB_CSS: () => GLOB_CSS,
   GLOB_DIST: () => GLOB_DIST,
   GLOB_DTS: () => GLOB_DTS,
@@ -65,7 +66,6 @@ __export(src_exports, {
   antfu: () => antfu,
   command: () => command,
   comments: () => comments,
-  createTypeScriptConfig: () => import_typescript_eslint.config,
   defineESLintConfig: () => defineESLintConfig,
   format: () => format,
   getOverrides: () => getOverrides,
@@ -110,7 +110,7 @@ __export(src_exports, {
   pluginRegexp: () => pluginRegexp,
   pluginStylistic: () => import_eslint_plugin3.default,
   pluginToml: () => import_eslint_plugin_toml.default,
-  pluginTypeScript: () => import_typescript_eslint3.plugin,
+  pluginTypeScript: () => import_typescript_eslint2.plugin,
   pluginUnicorn: () => import_eslint_plugin_unicorn.default,
   pluginUnoCSS: () => import_eslint_plugin.default,
   pluginUnusedImports: () => import_eslint_plugin_unused_imports.default,
@@ -129,8 +129,7 @@ __export(src_exports, {
   toArray: () => toArray,
   toml: () => toml,
   typescript: () => typescript,
-  typescriptConfigs: () => import_typescript_eslint4.configs,
-  typescriptCore: () => typescriptCore,
+  typescriptConfigs: () => import_typescript_eslint3.configs,
   unicorn: () => unicorn,
   unocss: () => unocss,
   unusedImports: () => unusedImports,
@@ -146,16 +145,13 @@ var import_eslint_flat_config_utils = require("eslint-flat-config-utils");
 // src/configs/vue.ts
 var import_eslint_merge_processors3 = require("eslint-merge-processors");
 
-// src/eslint/utils.ts
-var import_typescript_eslint = require("typescript-eslint");
-
 // src/eslint/parsers.ts
-var import_typescript_eslint2 = __toESM(require("typescript-eslint"), 1);
+var import_typescript_eslint = __toESM(require("typescript-eslint"), 1);
 var parserVue = __toESM(require("vue-eslint-parser"), 1);
 var parserToml = __toESM(require("toml-eslint-parser"), 1);
 var parserYaml = __toESM(require("yaml-eslint-parser"), 1);
 var parserJsonc = __toESM(require("jsonc-eslint-parser"), 1);
-var parserTypeScript = import_typescript_eslint2.default.parser;
+var parserTypeScript = import_typescript_eslint.default.parser;
 var parserPlain = {
   meta: {
     name: "plain-eslint-parser"
@@ -188,7 +184,7 @@ var import_markdown = __toESM(require("@eslint/markdown"), 1);
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
 var import_eslint_plugin_jsdoc = __toESM(require("eslint-plugin-jsdoc"), 1);
 var import_eslint_plugin_jsonc = __toESM(require("eslint-plugin-jsonc"), 1);
-var import_typescript_eslint3 = require("typescript-eslint");
+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);
@@ -202,7 +198,7 @@ var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-
 var import_eslint_plugin_eslint_comments = __toESM(require("@eslint-community/eslint-plugin-eslint-comments"), 1);
 
 // src/eslint/configs.ts
-var import_typescript_eslint4 = require("typescript-eslint");
+var import_typescript_eslint3 = require("typescript-eslint");
 
 // src/eslint/processors.ts
 var import_eslint_merge_processors = require("eslint-merge-processors");
@@ -236,6 +232,7 @@ var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
 var GLOB_HTML = "**/*.htm?(l)";
 var GLOB_ASTRO = "**/*.astro";
+var GLOB_ASTRO_TS = "**/*.astro/*.ts";
 var GLOB_SVELTE = "**/*.svelte";
 var GLOB_MARKDOWN = "**/*.md";
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
@@ -306,126 +303,6 @@ var GLOB_EXCLUDE = [
   "**/.yarnrc"
 ];
 
-// src/configs/typescript.ts
-var import_node_process = __toESM(require("process"), 1);
-var typescriptCore = (options = {}) => {
-  const isTypeAware = !!options.tsconfigPath;
-  const configs2 = (0, import_typescript_eslint.config)({
-    name: "ntnyq/ts/core",
-    extends: [...import_typescript_eslint4.configs.recommended],
-    files: [GLOB_TS, GLOB_TSX],
-    languageOptions: {
-      parser: parserTypeScript,
-      parserOptions: {
-        sourceType: "module",
-        ...isTypeAware ? {
-          projectService: {
-            defaultProject: options.tsconfigPath
-          },
-          tsconfigRootDir: import_node_process.default.cwd()
-        } : {}
-      }
-    },
-    rules: {
-      // Disabled in favor of ts rules
-      "no-redeclare": "off",
-      "no-use-before-define": "off",
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-redeclare": [
-        "error",
-        {
-          builtinGlobals: false,
-          ignoreDeclarationMerge: true
-        }
-      ],
-      "@typescript-eslint/no-use-before-define": [
-        "error",
-        {
-          functions: false,
-          classes: false,
-          variables: true,
-          allowNamedExports: false,
-          enums: true,
-          typedefs: false,
-          ignoreTypeReferences: false
-        }
-      ],
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          // Args after the last used will be reported
-          args: "after-used",
-          argsIgnorePattern: "^_",
-          caughtErrors: "all",
-          caughtErrorsIgnorePattern: "^_",
-          destructuredArrayIgnorePattern: "^_",
-          varsIgnorePattern: "^_",
-          ignoreRestSiblings: true
-        }
-      ],
-      "@typescript-eslint/no-unused-expressions": [
-        "error",
-        {
-          allowShortCircuit: true,
-          allowTernary: true,
-          allowTaggedTemplates: true
-        }
-      ],
-      "@typescript-eslint/consistent-type-imports": [
-        "error",
-        {
-          prefer: "type-imports",
-          fixStyle: "separate-type-imports",
-          disallowTypeAnnotations: false
-        }
-      ],
-      "@typescript-eslint/no-empty-object-type": [
-        "error",
-        {
-          allowInterfaces: "always",
-          allowObjectTypes: "always"
-        }
-      ],
-      "@typescript-eslint/consistent-type-assertions": [
-        "error",
-        {
-          assertionStyle: "as",
-          objectLiteralTypeAssertions: "allow-as-parameter"
-        }
-      ],
-      "@typescript-eslint/prefer-as-const": "warn",
-      "@typescript-eslint/no-namespace": "off",
-      "@typescript-eslint/ban-ts-comment": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/naming-convention": "off",
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "@typescript-eslint/triple-slash-reference": "off",
-      "@typescript-eslint/explicit-member-accessibility": "off",
-      "@typescript-eslint/explicit-function-return-type": "off",
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "@typescript-eslint/consistent-indexed-object-style": "off",
-      // Overrides rules
-      ...options.overrides
-    }
-  });
-  return configs2;
-};
-var typescript = (options = {}) => [
-  ...typescriptCore(options),
-  {
-    name: "ntnyq/ts/types",
-    files: [GLOB_DTS, "**/types/**/*.ts"],
-    rules: {
-      "no-use-before-define": "off",
-      "no-restricted-syntax": "off",
-      "import/no-duplicates": "off",
-      "import/newline-after-import": "off",
-      "@typescript-eslint/no-use-before-define": "off"
-    }
-  }
-];
-
 // src/configs/vue.ts
 var vue2Rules = {
   ...import_eslint_plugin_vue.default.configs.base.rules,
@@ -623,23 +500,18 @@ var vue = (options = {}) => {
   const isVue3 = options.vueVersion !== 2;
   const sfcBlocks = options.sfcBlocks === true ? {} : options.sfcBlocks ?? {};
   return [
-    ...(0, import_typescript_eslint.config)({
-      name: "ntnyq/vue/ts",
-      files: [GLOB_VUE],
-      extends: typescriptCore()
-    }),
     {
       name: "ntnyq/vue/setup",
       plugins: {
         vue: import_eslint_plugin_vue.default,
-        "@typescript-eslint": import_typescript_eslint3.plugin
+        "@typescript-eslint": import_typescript_eslint2.plugin
       },
       languageOptions: {
         parserOptions: {
           sourceType: "module",
           ecmaVersion: "latest",
           extraFileExtensions: [".vue"],
-          parser: "@typescript-eslint/parser",
+          parser: parserTypeScript,
           ecmaFeatures: {
             jsx: true
           }
@@ -1293,9 +1165,9 @@ var ntnyq = (options = {}) => [
 
 // src/configs/regexp.ts
 var regexp = (options = {}) => {
-  const config2 = pluginRegexp.configs["flat/recommended"];
+  const config = pluginRegexp.configs["flat/recommended"];
   const rules = {
-    ...config2.rules
+    ...config.rules
   };
   if (options.level === "warn") {
     for (const key in rules) {
@@ -1306,7 +1178,7 @@ var regexp = (options = {}) => {
   }
   return [
     {
-      ...config2,
+      ...config,
       name: "ntnyq/regexp",
       rules: {
         ...rules,
@@ -1385,12 +1257,12 @@ var DEFAULT_PRETTIER_OPTIONS = {
 
 // src/utils/env.ts
 var import_node_path = require("path");
-var import_node_process2 = __toESM(require("process"), 1);
+var import_node_process = __toESM(require("process"), 1);
 var import_local_pkg = require("local-pkg");
 var hasTypeScript = (0, import_local_pkg.isPackageExists)("typescript");
 var hasVitest = (0, import_local_pkg.isPackageExists)("vitest");
 var hasVue = (0, import_local_pkg.isPackageExists)("vue") || (0, import_local_pkg.isPackageExists)("nuxt") || (0, import_local_pkg.isPackageExists)("vitepress") || (0, import_local_pkg.isPackageExists)("@slidev/cli") || (0, import_local_pkg.isPackageExists)("vue", {
-  paths: [(0, import_node_path.resolve)(import_node_process2.default.cwd(), "playground")]
+  paths: [(0, import_node_path.resolve)(import_node_process.default.cwd(), "playground")]
 });
 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");
 
@@ -1731,9 +1603,9 @@ var comments = (options = {}) => [
 var markdown = (options = {}) => {
   if (!Array.isArray(import_markdown.default.configs?.processor)) return [];
   return [
-    ...import_markdown.default.configs.processor.map((config2) => ({
-      ...config2,
-      name: `ntnyq/${config2.name}`
+    ...import_markdown.default.configs.processor.map((config) => ({
+      ...config,
+      name: `ntnyq/${config.name}`
     })),
     {
       name: "ntnyq/markdown/disabled/code-blocks",
@@ -2099,6 +1971,198 @@ var jsx = () => [
   }
 ];
 
+// src/configs/typescript.ts
+var import_node_process2 = __toESM(require("process"), 1);
+var typeAwareRules = {
+  "dot-notation": "off",
+  "require-await": "off",
+  "no-implied-eval": "off",
+  "no-throw-literal": "off",
+  // too strict
+  "@typescript-eslint/strict-boolean-expressions": "off",
+  "@typescript-eslint/require-await": "error",
+  "@typescript-eslint/unbound-method": "error",
+  "@typescript-eslint/no-unsafe-call": "error",
+  "@typescript-eslint/await-thenable": "error",
+  "@typescript-eslint/no-for-in-array": "error",
+  "@typescript-eslint/no-implied-eval": "error",
+  "@typescript-eslint/only-throw-error": "error",
+  "@typescript-eslint/no-unsafe-return": "error",
+  "@typescript-eslint/no-unsafe-argument": "error",
+  "@typescript-eslint/no-misused-promises": "error",
+  "@typescript-eslint/no-unsafe-assignment": "error",
+  "@typescript-eslint/no-floating-promises": "error",
+  "@typescript-eslint/promise-function-async": "error",
+  "@typescript-eslint/restrict-plus-operands": "error",
+  "@typescript-eslint/triple-slash-reference": "error",
+  "@typescript-eslint/no-unsafe-member-access": "error",
+  "@typescript-eslint/switch-exhaustiveness-check": "error",
+  "@typescript-eslint/no-unnecessary-type-assertion": "error",
+  "@typescript-eslint/restrict-template-expressions": "error",
+  "@typescript-eslint/no-redundant-type-constituents": "error",
+  "@typescript-eslint/no-duplicate-type-constituents": "error",
+  "@typescript-eslint/return-await": ["error", "in-try-catch"],
+  "@typescript-eslint/dot-notation": ["error", { allowKeywords: true }]
+};
+var recommendedRules = import_typescript_eslint3.configs.recommended.reduce((rules, config) => {
+  return { ...rules, ...config.rules || {} };
+}, {});
+var typescript = (options = {}) => {
+  const enableTypeAwareLint = !!options?.tsconfigPath;
+  const {
+    filesTypeAware = [GLOB_TS, GLOB_TSX],
+    ignoresTypeAware = [GLOB_ASTRO, `${GLOB_MARKDOWN}/**`],
+    overridesTypeAwareRules = {},
+    parserOptions = {}
+  } = options;
+  function createParserConfig(enableTypeAware = false, files = [], ignores2 = []) {
+    const parserConfig = {
+      name: `ntnyq/ts/${enableTypeAware ? "parser-type-aware" : "parser"}`,
+      files,
+      ignores: [...ignores2],
+      languageOptions: {
+        parser: parserTypeScript,
+        parserOptions: {
+          // extraFileExtensions: [''],
+          sourceType: "module",
+          ...enableTypeAware ? {
+            projectService: {
+              allowDefaultProject: ["./*.js"],
+              defaultProject: options.tsconfigPath
+            },
+            tsconfigRootDir: import_node_process2.default.cwd()
+          } : {},
+          ...parserOptions
+        }
+      }
+    };
+    return parserConfig;
+  }
+  return [
+    {
+      name: "ntnyq/ts/setup",
+      plugins: {
+        "@typescript-eslint": import_typescript_eslint2.plugin,
+        antfu: import_eslint_plugin_antfu.default
+      }
+    },
+    ...enableTypeAwareLint ? [
+      createParserConfig(false, [GLOB_TS, GLOB_TSX]),
+      createParserConfig(true, filesTypeAware, ignoresTypeAware)
+    ] : [createParserConfig(false, [GLOB_TS, GLOB_TSX])],
+    {
+      name: "ntnyq/ts/rules",
+      files: [GLOB_TS, GLOB_TSX],
+      rules: {
+        ...recommendedRules,
+        // Disabled in favor of ts rules
+        "no-redeclare": "off",
+        "no-use-before-define": "off",
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-redeclare": [
+          "error",
+          {
+            builtinGlobals: false,
+            ignoreDeclarationMerge: true
+          }
+        ],
+        "@typescript-eslint/no-use-before-define": [
+          "error",
+          {
+            functions: false,
+            classes: false,
+            variables: true,
+            allowNamedExports: false,
+            enums: true,
+            typedefs: false,
+            ignoreTypeReferences: false
+          }
+        ],
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          {
+            // Args after the last used will be reported
+            args: "after-used",
+            argsIgnorePattern: "^_",
+            caughtErrors: "all",
+            caughtErrorsIgnorePattern: "^_",
+            destructuredArrayIgnorePattern: "^_",
+            varsIgnorePattern: "^_",
+            ignoreRestSiblings: true
+          }
+        ],
+        "@typescript-eslint/no-unused-expressions": [
+          "error",
+          {
+            allowShortCircuit: true,
+            allowTernary: true,
+            allowTaggedTemplates: true
+          }
+        ],
+        "@typescript-eslint/consistent-type-imports": [
+          "error",
+          {
+            prefer: "type-imports",
+            fixStyle: "separate-type-imports",
+            disallowTypeAnnotations: false
+          }
+        ],
+        "@typescript-eslint/no-empty-object-type": [
+          "error",
+          {
+            allowInterfaces: "always",
+            allowObjectTypes: "always"
+          }
+        ],
+        "@typescript-eslint/consistent-type-assertions": [
+          "error",
+          {
+            assertionStyle: "as",
+            objectLiteralTypeAssertions: "allow-as-parameter"
+          }
+        ],
+        "@typescript-eslint/prefer-as-const": "warn",
+        "@typescript-eslint/no-namespace": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/triple-slash-reference": "off",
+        "@typescript-eslint/explicit-member-accessibility": "off",
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/consistent-indexed-object-style": "off",
+        // Overrides rules
+        ...options.overrides
+      }
+    },
+    ...enableTypeAwareLint ? [
+      {
+        name: "ntnyq/ts/rules/type-aware",
+        files: [...filesTypeAware],
+        ignores: [...ignoresTypeAware],
+        rules: {
+          ...typeAwareRules,
+          // Overrides type aware rules
+          ...overridesTypeAwareRules
+        }
+      }
+    ] : [],
+    {
+      name: "ntnyq/ts/types",
+      files: [GLOB_DTS, "**/types/**/*.ts"],
+      rules: {
+        "no-use-before-define": "off",
+        "no-restricted-syntax": "off",
+        "import/no-duplicates": "off",
+        "import/newline-after-import": "off",
+        "@typescript-eslint/no-use-before-define": "off"
+      }
+    }
+  ];
+};
+
 // src/configs/githubAction.ts
 var githubAction = (options = {}) => [
   {
@@ -2231,7 +2295,7 @@ var unusedImports = (options = {}) => [
 ];
 
 // src/core.ts
-function defineESLintConfig(options = {}, userConfigs = []) {
+async function defineESLintConfig(options = {}, ...userConfigs) {
   const configs2 = [];
   if (options.gitignore ?? true) {
     configs2.push(
@@ -2246,9 +2310,18 @@ function defineESLintConfig(options = {}, userConfigs = []) {
     ...node({
       overrides: getOverrides(options, "node")
     }),
+    ...command({
+      ...resolveSubOptions(options, "command")
+    }),
     ...imports({
       overrides: getOverrides(options, "imports")
     }),
+    ...jsdoc({
+      overrides: getOverrides(options, "jsdoc")
+    }),
+    ...comments({
+      overrides: getOverrides(options, "comments")
+    }),
     ...javascript({
       ...resolveSubOptions(options, "javascript"),
       overrides: getOverrides(options, "javascript")
@@ -2277,20 +2350,6 @@ function defineESLintConfig(options = {}, userConfigs = []) {
       })
     );
   }
-  if (options.jsdoc ?? true) {
-    configs2.push(
-      ...jsdoc({
-        overrides: getOverrides(options, "jsdoc")
-      })
-    );
-  }
-  if (options.comments ?? true) {
-    configs2.push(
-      ...comments({
-        overrides: getOverrides(options, "comments")
-      })
-    );
-  }
   if (options.typescript ?? hasTypeScript) {
     configs2.push(
       ...typescript({
@@ -2359,13 +2418,6 @@ function defineESLintConfig(options = {}, userConfigs = []) {
       })
     );
   }
-  if (options.command ?? true) {
-    configs2.push(
-      ...command({
-        ...resolveSubOptions(options, "command")
-      })
-    );
-  }
   if (options.antfu ?? true) {
     configs2.push(
       ...antfu({
@@ -2393,9 +2445,9 @@ function defineESLintConfig(options = {}, userConfigs = []) {
     overrides: getOverrides(options, "prettier")
   }) : [];
   const composer = new import_eslint_flat_config_utils.FlatConfigComposer();
-  composer.append(
+  await composer.append(
     ...configs2,
-    ...toArray(userConfigs),
+    ...userConfigs,
     ...configSpecials,
     ...configPrettier
   );
@@ -2406,6 +2458,7 @@ function defineESLintConfig(options = {}, userConfigs = []) {
   DEFAULT_PRETTIER_OPTIONS,
   GLOB_ALL_SRC,
   GLOB_ASTRO,
+  GLOB_ASTRO_TS,
   GLOB_CSS,
   GLOB_DIST,
   GLOB_DTS,
@@ -2438,7 +2491,6 @@ function defineESLintConfig(options = {}, userConfigs = []) {
   antfu,
   command,
   comments,
-  createTypeScriptConfig,
   defineESLintConfig,
   format,
   getOverrides,
@@ -2503,7 +2555,6 @@ function defineESLintConfig(options = {}, userConfigs = []) {
   toml,
   typescript,
   typescriptConfigs,
-  typescriptCore,
   unicorn,
   unocss,
   unusedImports,