@kirklin/eslint-config 2.4.0 → 2.5.0

package/dist/index.js

@@ -25,8 +25,10 @@ var GLOB_SVELTE = "**/*.svelte";
 var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
+var GLOB_XML = "**/*.xml";
 var GLOB_HTML = "**/*.htm?(l)";
 var GLOB_ASTRO = "**/*.astro";
+var GLOB_ASTRO_TS = "**/*.astro/*.ts";
 var GLOB_GRAPHQL = "**/*.{g,graph}ql";
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
@@ -45,6 +47,7 @@ var GLOB_ALL_SRC = [
   GLOB_SVELTE,
   GLOB_VUE,
   GLOB_YAML,
+  GLOB_XML,
   GLOB_HTML
 ];
 var GLOB_EXCLUDE = [
@@ -71,6 +74,7 @@ var GLOB_EXCLUDE = [
   "**/.output",
   "**/.vite-inspect",
   "**/.yarn",
+  "**/vite.config.*.timestamp-*",
   "**/CHANGELOG*.md",
   "**/*.min.*",
   "**/LICENSE*",
@@ -102,8 +106,8 @@ var parserPlain = {
     }
   })
 };
-async function combine(...configs) {
-  const resolved = await Promise.all(configs);
+async function combine(...configs2) {
+  const resolved = await Promise.all(configs2);
   return resolved.flat();
 }
 function renameRules(rules, map) {
@@ -118,8 +122,8 @@ function renameRules(rules, map) {
     })
   );
 }
-function renamePluginInConfigs(configs, map) {
-  return configs.map((i) => {
+function renamePluginInConfigs(configs2, map) {
+  return configs2.map((i) => {
     const clone = { ...i };
     if (clone.rules) {
       clone.rules = renameRules(clone.rules, map);
@@ -187,15 +191,28 @@ async function astro(options = {}) {
     {
       files,
       languageOptions: {
+        globals: pluginAstro.environments.astro.globals,
         parser: parserAstro,
         parserOptions: {
           extraFileExtensions: [".astro"],
           parser: parserTs
-        }
+        },
+        sourceType: "module"
       },
       name: "kirklin/astro/rules",
+      processor: "astro/client-side-ts",
       rules: {
+        // use recommended rules
+        "astro/missing-client-only-directive-value": "error",
+        "astro/no-conflict-set-directives": "error",
+        "astro/no-deprecated-astro-canonicalurl": "error",
+        "astro/no-deprecated-astro-fetchcontent": "error",
+        "astro/no-deprecated-astro-resolve": "error",
+        "astro/no-deprecated-getentrybyslug": "error",
         "astro/no-set-html-directive": "off",
+        "astro/no-unused-define-vars-in-style": "error",
+        "astro/semi": "off",
+        "astro/valid-compile": "error",
         ...stylistic2 ? {
           "style/indent": "off",
           "style/jsx-closing-tag-location": "off",
@@ -260,7 +277,7 @@ var StylisticConfigDefaults = {
 async function stylistic(options = {}) {
   const {
     indent,
-    jsx,
+    jsx: jsx2,
     lessOpinionated = false,
     overrides = {},
     quotes,
@@ -273,7 +290,7 @@ async function stylistic(options = {}) {
   const config = pluginStylistic.configs.customize({
     flat: true,
     indent,
-    jsx,
+    jsx: jsx2,
     pluginName: "style",
     quotes,
     semi
@@ -307,18 +324,20 @@ async function stylistic(options = {}) {
 async function formatters(options = {}, stylistic2 = {}) {
   if (options === true) {
     options = {
-      astro: isPackageExists2("astro"),
+      astro: isPackageExists2("prettier-plugin-astro"),
       css: true,
       graphql: true,
       html: true,
       markdown: true,
-      slidev: isPackageExists2("@slidev/cli")
+      slidev: isPackageExists2("@slidev/cli"),
+      xml: isPackageExists2("@prettier/plugin-xml")
     };
   }
   await ensurePackages([
     "eslint-plugin-format",
     options.markdown && options.slidev ? "prettier-plugin-slidev" : void 0,
-    options.astro ? "prettier-plugin-astro" : void 0
+    options.astro ? "prettier-plugin-astro" : void 0,
+    options.xml ? "@prettier/plugin-xml" : void 0
   ]);
   if (options.slidev && options.markdown !== true && options.markdown !== "prettier") {
     throw new Error("`slidev` option only works when `markdown` is enabled with `prettier`");
@@ -342,6 +361,12 @@ async function formatters(options = {}, stylistic2 = {}) {
     },
     options.prettierOptions || {}
   );
+  const prettierXmlOptions = {
+    xmlQuoteAttributes: "double",
+    xmlSelfClosingSpace: true,
+    xmlSortAttributesByKey: false,
+    xmlWhitespaceSensitivity: "ignore"
+  };
   const dprintOptions = Object.assign(
     {
       indentWidth: typeof indent === "number" ? indent : 2,
@@ -351,7 +376,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     options.dprintOptions || {}
   );
   const pluginFormat = await interopDefault(import("eslint-plugin-format"));
-  const configs = [
+  const configs2 = [
     {
       name: "kirklin/formatter/setup",
       plugins: {
@@ -360,7 +385,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     }
   ];
   if (options.css) {
-    configs.push(
+    configs2.push(
       {
         files: [GLOB_CSS, GLOB_POSTCSS],
         languageOptions: {
@@ -412,7 +437,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     );
   }
   if (options.html) {
-    configs.push({
+    configs2.push({
       files: [GLOB_HTML],
       languageOptions: {
         parser: parserPlain
@@ -429,10 +454,32 @@ async function formatters(options = {}, stylistic2 = {}) {
       }
     });
   }
+  if (options.xml) {
+    configs2.push({
+      files: [GLOB_XML],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "kirklin/formatter/xml",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierXmlOptions,
+            ...prettierOptions,
+            parser: "xml",
+            plugins: [
+              "@prettier/plugin-xml"
+            ]
+          }
+        ]
+      }
+    });
+  }
   if (options.markdown) {
     const formater = options.markdown === true ? "prettier" : options.markdown;
     const GLOB_SLIDEV = !options.slidev ? [] : options.slidev === true ? ["**/slides.md"] : options.slidev.files;
-    configs.push({
+    configs2.push({
       files: [GLOB_MARKDOWN],
       ignores: GLOB_SLIDEV,
       languageOptions: {
@@ -455,7 +502,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       }
     });
     if (options.slidev) {
-      configs.push({
+      configs2.push({
         files: GLOB_SLIDEV,
         languageOptions: {
           parser: parserPlain
@@ -479,7 +526,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     }
   }
   if (options.astro) {
-    configs.push({
+    configs2.push({
       files: [GLOB_ASTRO],
       languageOptions: {
         parser: parserPlain
@@ -498,9 +545,20 @@ async function formatters(options = {}, stylistic2 = {}) {
         ]
       }
     });
+    configs2.push({
+      files: [GLOB_ASTRO, GLOB_ASTRO_TS],
+      name: "kirklin/formatter/astro/disables",
+      rules: {
+        "style/arrow-parens": "off",
+        "style/block-spacing": "off",
+        "style/comma-dangle": "off",
+        "style/indent": "off",
+        "style/no-multi-spaces": "off"
+      }
+    });
   }
   if (options.graphql) {
-    configs.push({
+    configs2.push({
       files: [GLOB_GRAPHQL],
       languageOptions: {
         parser: parserPlain
@@ -517,7 +575,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       }
     });
   }
-  return configs;
+  return configs2;
 }
 
 // src/configs/ignores.ts
@@ -601,6 +659,9 @@ async function javascript(options = {}) {
       linterOptions: {
         reportUnusedDisableDirectives: true
       },
+      name: "kirklin/javascript/setup"
+    },
+    {
       name: "kirklin/javascript/rules",
       plugins: {
         "kirklin": default2,
@@ -828,6 +889,23 @@ async function jsdoc(options = {}) {
   ];
 }
 
+// src/configs/jsx.ts
+async function jsx() {
+  return [
+    {
+      files: [GLOB_JSX, GLOB_TSX],
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          }
+        }
+      },
+      name: "kirklin/jsx/setup"
+    }
+  ];
+}
+
 // src/configs/jsonc.ts
 async function jsonc(options = {}) {
   const {
@@ -975,25 +1053,6 @@ async function markdown(options = {}) {
         "unicode-bom": "off",
         "unused-imports/no-unused-imports": "off",
         "unused-imports/no-unused-vars": "off",
-        // Type aware rules
-        ...{
-          "ts/await-thenable": "off",
-          "ts/dot-notation": "off",
-          "ts/no-floating-promises": "off",
-          "ts/no-for-in-array": "off",
-          "ts/no-implied-eval": "off",
-          "ts/no-misused-promises": "off",
-          "ts/no-throw-literal": "off",
-          "ts/no-unnecessary-type-assertion": "off",
-          "ts/no-unsafe-argument": "off",
-          "ts/no-unsafe-assignment": "off",
-          "ts/no-unsafe-call": "off",
-          "ts/no-unsafe-member-access": "off",
-          "ts/no-unsafe-return": "off",
-          "ts/restrict-plus-operands": "off",
-          "ts/restrict-template-expressions": "off",
-          "ts/unbound-method": "off"
-        },
         ...overrides
       }
     }
@@ -1050,7 +1109,7 @@ var NextJsPackages = [
 ];
 async function react(options = {}) {
   const {
-    files = [GLOB_TS, GLOB_TSX],
+    files = [GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX],
     overrides = {}
   } = options;
   await ensurePackages([
@@ -1290,6 +1349,7 @@ async function sortPackageJson() {
               "packageManager",
               "description",
               "author",
+              "contributors",
               "license",
               "funding",
               "homepage",
@@ -1702,10 +1762,15 @@ async function typescript(options = {}) {
     parserOptions = {}
   } = options;
   const files = options.files ?? [
-    GLOB_SRC,
+    GLOB_TS,
+    GLOB_TSX,
     ...componentExts.map((ext) => `**/*.${ext}`)
   ];
   const filesTypeAware = options.filesTypeAware ?? [GLOB_TS, GLOB_TSX];
+  const ignoresTypeAware = options.ignoresTypeAware ?? [
+    `${GLOB_MARKDOWN}/**`,
+    GLOB_ASTRO_TS
+  ];
   const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
   const isTypeAware = !!tsconfigPath;
   const typeAwareRules = {
@@ -1725,8 +1790,12 @@ async function typescript(options = {}) {
     "ts/no-unsafe-call": "error",
     "ts/no-unsafe-member-access": "error",
     "ts/no-unsafe-return": "error",
+    "ts/promise-function-async": "error",
     "ts/restrict-plus-operands": "error",
     "ts/restrict-template-expressions": "error",
+    "ts/return-await": ["error", "in-try-catch"],
+    "ts/strict-boolean-expressions": ["error", { allowNullableBoolean: true, allowNullableObject: true }],
+    "ts/switch-exhaustiveness-check": "error",
     "ts/unbound-method": "error"
   };
   const [
@@ -1766,9 +1835,11 @@ async function typescript(options = {}) {
     },
     // assign type-aware parser for type-aware files and type-unaware parser for the rest
     ...isTypeAware ? [
-      makeParser(true, filesTypeAware),
+      makeParser(true, filesTypeAware, ignoresTypeAware),
       makeParser(false, files, filesTypeAware)
-    ] : [makeParser(false, files)],
+    ] : [
+      makeParser(false, files)
+    ],
     {
       files,
       name: "kirklin/typescript/rules",
@@ -1813,14 +1884,12 @@ async function typescript(options = {}) {
     },
     ...isTypeAware ? [{
       files: filesTypeAware,
+      ignores: ignoresTypeAware,
       name: "kirklin/typescript/rules-type-aware",
-      rules: {
-        ...tsconfigPath ? typeAwareRules : {},
-        ...overrides
-      }
+      rules: typeAwareRules
     }] : [],
     {
-      files: ["**/*.d.ts"],
+      files: ["**/*.d.?([cm])ts"],
       name: "kirklin/typescript/disables/dts",
       rules: {
         "eslint-comments/no-unlimited-disable": "off",
@@ -2151,6 +2220,32 @@ async function yaml(options = {}) {
   ];
 }
 
+// src/configs/regexp.ts
+import { configs } from "eslint-plugin-regexp";
+async function regexp(options = {}) {
+  const config = configs["flat/recommended"];
+  const rules = {
+    ...config.rules
+  };
+  if (options.level === "warn") {
+    for (const key in rules) {
+      if (rules[key] === "error") {
+        rules[key] = "warn";
+      }
+    }
+  }
+  return [
+    {
+      ...config,
+      name: "kirklin/regexp/rules",
+      rules: {
+        ...rules,
+        ...options.overrides
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "name",
@@ -2187,8 +2282,10 @@ function kirklin(options = {}, ...userConfigs) {
     autoRenamePlugins = true,
     componentExts = [],
     gitignore: enableGitignore = true,
-    isInEditor = !!((process3.env.VSCODE_PID || process3.env.VSCODE_CWD || process3.env.JETBRAINS_IDE || process3.env.VIM) && !process3.env.CI),
+    isInEditor = !!((process3.env.VSCODE_PID || process3.env.VSCODE_CWD || process3.env.JETBRAINS_IDE || process3.env.VIM || process3.env.NVIM) && !process3.env.CI),
+    jsx: enableJsx = true,
     react: enableReact = false,
+    regexp: enableRegexp = true,
     solid: enableSolid = false,
     svelte: enableSvelte = false,
     typescript: enableTypeScript = isPackageExists4("typescript"),
@@ -2197,19 +2294,21 @@ function kirklin(options = {}, ...userConfigs) {
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions)) {
-    stylisticOptions.jsx = options.jsx ?? true;
+    stylisticOptions.jsx = enableJsx;
   }
-  const configs = [];
+  const configs2 = [];
   if (enableGitignore) {
     if (typeof enableGitignore !== "boolean") {
-      configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r(enableGitignore)]));
+      configs2.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r(enableGitignore)]));
     } else {
       if (fs.existsSync(".gitignore")) {
-        configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
+        configs2.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
       }
     }
   }
-  configs.push(
+  const typescriptOptions = resolveSubOptions(options, "typescript");
+  const tsconfigPath = "tsconfigPath" in typescriptOptions ? typescriptOptions.tsconfigPath : void 0;
+  configs2.push(
     ignores(),
     javascript({
       isInEditor,
@@ -2231,28 +2330,34 @@ function kirklin(options = {}, ...userConfigs) {
   if (enableVue) {
     componentExts.push("vue");
   }
+  if (enableJsx) {
+    configs2.push(jsx());
+  }
   if (enableTypeScript) {
-    configs.push(typescript({
-      ...resolveSubOptions(options, "typescript"),
+    configs2.push(typescript({
+      ...typescriptOptions,
       componentExts,
       overrides: getOverrides(options, "typescript")
     }));
   }
   if (stylisticOptions) {
-    configs.push(stylistic({
+    configs2.push(stylistic({
       ...stylisticOptions,
       lessOpinionated: options.lessOpinionated,
       overrides: getOverrides(options, "stylistic")
     }));
   }
+  if (enableRegexp) {
+    configs2.push(regexp(typeof enableRegexp === "boolean" ? {} : enableRegexp));
+  }
   if (options.test ?? true) {
-    configs.push(test({
+    configs2.push(test({
       isInEditor,
       overrides: getOverrides(options, "test")
     }));
   }
   if (enableVue) {
-    configs.push(vue({
+    configs2.push(vue({
       ...resolveSubOptions(options, "vue"),
       overrides: getOverrides(options, "vue"),
       stylistic: stylisticOptions,
@@ -2260,39 +2365,39 @@ function kirklin(options = {}, ...userConfigs) {
     }));
   }
   if (enableReact) {
-    configs.push(react({
+    configs2.push(react({
       overrides: getOverrides(options, "react"),
-      tsconfigPath: getOverrides(options, "typescript").tsconfigPath
+      tsconfigPath
     }));
   }
   if (enableSolid) {
-    configs.push(solid({
+    configs2.push(solid({
       overrides: getOverrides(options, "solid"),
-      tsconfigPath: getOverrides(options, "typescript").tsconfigPath,
+      tsconfigPath,
       typescript: !!enableTypeScript
     }));
   }
   if (enableSvelte) {
-    configs.push(svelte({
+    configs2.push(svelte({
       overrides: getOverrides(options, "svelte"),
       stylistic: stylisticOptions,
       typescript: !!enableTypeScript
     }));
   }
   if (enableUnoCSS) {
-    configs.push(unocss({
+    configs2.push(unocss({
       ...resolveSubOptions(options, "unocss"),
       overrides: getOverrides(options, "unocss")
     }));
   }
   if (enableAstro) {
-    configs.push(astro({
+    configs2.push(astro({
       overrides: getOverrides(options, "astro"),
       stylistic: stylisticOptions
     }));
   }
   if (options.jsonc ?? true) {
-    configs.push(
+    configs2.push(
       jsonc({
         overrides: getOverrides(options, "jsonc"),
         stylistic: stylisticOptions
@@ -2302,19 +2407,19 @@ function kirklin(options = {}, ...userConfigs) {
     );
   }
   if (options.yaml ?? true) {
-    configs.push(yaml({
+    configs2.push(yaml({
       overrides: getOverrides(options, "yaml"),
       stylistic: stylisticOptions
     }));
   }
   if (options.toml ?? true) {
-    configs.push(toml({
+    configs2.push(toml({
       overrides: getOverrides(options, "toml"),
       stylistic: stylisticOptions
     }));
   }
   if (options.markdown ?? true) {
-    configs.push(
+    configs2.push(
       markdown(
         {
           componentExts,
@@ -2324,7 +2429,7 @@ function kirklin(options = {}, ...userConfigs) {
     );
   }
   if (options.formatters) {
-    configs.push(formatters(
+    configs2.push(formatters(
       options.formatters,
       typeof stylisticOptions === "boolean" ? {} : stylisticOptions
     ));
@@ -2336,11 +2441,11 @@ function kirklin(options = {}, ...userConfigs) {
     return acc;
   }, {});
   if (Object.keys(fusedConfig).length) {
-    configs.push([fusedConfig]);
+    configs2.push([fusedConfig]);
   }
   let composer = new FlatConfigComposer();
   composer = composer.append(
-    ...configs,
+    ...configs2,
     ...userConfigs
   );
   if (autoRenamePlugins) {
@@ -2364,6 +2469,7 @@ var src_default = kirklin;
 export {
   GLOB_ALL_SRC,
   GLOB_ASTRO,
+  GLOB_ASTRO_TS,
   GLOB_CSS,
   GLOB_EXCLUDE,
   GLOB_GRAPHQL,
@@ -2388,6 +2494,7 @@ export {
   GLOB_TS,
   GLOB_TSX,
   GLOB_VUE,
+  GLOB_XML,
   GLOB_YAML,
   StylisticConfigDefaults,
   astro,
@@ -2405,12 +2512,14 @@ export {
   javascript,
   jsdoc,
   jsonc,
+  jsx,
   kirklin,
   markdown,
   node,
   parserPlain,
   perfectionist,
   react,
+  regexp,
   renamePluginInConfigs,
   renameRules,
   resolveSubOptions,