@kirklin/eslint-config 2.1.0 → 2.2.0

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/factory.ts
 import process3 from "process";
 import fs from "fs";
-import { isPackageExists as isPackageExists3 } from "local-pkg";
+import { isPackageExists as isPackageExists4 } from "local-pkg";
 
 // src/plugins.ts
 import { default as default2 } from "eslint-plugin-kirklin";
@@ -52,6 +52,7 @@ var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
 var GLOB_TOML = "**/*.toml";
 var GLOB_HTML = "**/*.htm?(l)";
+var GLOB_ASTRO = "**/*.astro";
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
   `**/__tests__/**/*.${GLOB_SRC_EXT}`,
@@ -94,6 +95,7 @@ var GLOB_EXCLUDE = [
   "**/.cache",
   "**/.output",
   "**/.vite-inspect",
+  "**/.yarn",
   "**/CHANGELOG*.md",
   "**/*.min.*",
   "**/LICENSE*",
@@ -135,7 +137,7 @@ async function imports(options = {}) {
         "kirklin/no-import-dist": "error",
         "kirklin/no-import-node-modules-by-path": "error",
         ...stylistic2 ? {
-          "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
+          "import/newline-after-import": ["error", { count: 1 }]
         } : {}
       }
     },
@@ -414,18 +416,14 @@ async function ensurePackages(packages) {
   if (process.env.CI || process.stdout.isTTY === false) {
     return;
   }
-  const nonExistingPackages = packages.filter((i) => !isPackageExists(i));
+  const nonExistingPackages = packages.filter((i) => i && !isPackageExists(i));
   if (nonExistingPackages.length === 0) {
     return;
   }
-  const { default: prompts } = await import("prompts");
-  const { result } = await prompts([
-    {
-      message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?`,
-      name: "result",
-      type: "confirm"
-    }
-  ]);
+  const p = await import("@clack/prompts");
+  const result = await p.confirm({
+    message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?`
+  });
   if (result) {
     await import("@antfu/install-pkg").then((i) => i.installPackage(nonExistingPackages, { dev: true }));
   }
@@ -673,6 +671,9 @@ async function perfectionist() {
   ];
 }
 
+// src/configs/formatters.ts
+import { isPackageExists as isPackageExists2 } from "local-pkg";
+
 // src/configs/stylistic.ts
 var StylisticConfigDefaults = {
   indent: 2,
@@ -723,17 +724,24 @@ async function stylistic(options = {}) {
 
 // src/configs/formatters.ts
 async function formatters(options = {}, stylistic2 = {}) {
-  await ensurePackages([
-    "eslint-plugin-format"
-  ]);
   if (options === true) {
     options = {
+      astro: isPackageExists2("astro"),
       css: true,
       graphql: true,
       html: true,
-      markdown: true
+      markdown: true,
+      slidev: isPackageExists2("@slidev/cli")
     };
   }
+  await ensurePackages([
+    "eslint-plugin-format",
+    options.markdown && options.slidev ? "prettier-plugin-slidev" : void 0,
+    options.astro ? "prettier-plugin-astro" : void 0
+  ]);
+  if (options.slidev && options.markdown !== true && options.markdown !== "prettier") {
+    throw new Error("`slidev` option only works when `markdown` is enabled with `prettier`");
+  }
   const {
     indent,
     quotes,
@@ -842,8 +850,10 @@ async function formatters(options = {}, stylistic2 = {}) {
   }
   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({
       files: [GLOB_MARKDOWN],
+      ignores: GLOB_SLIDEV,
       languageOptions: {
         parser: parserPlain
       },
@@ -863,6 +873,50 @@ async function formatters(options = {}, stylistic2 = {}) {
         ]
       }
     });
+    if (options.slidev) {
+      configs.push({
+        files: GLOB_SLIDEV,
+        languageOptions: {
+          parser: parserPlain
+        },
+        name: "kirklin:formatter:slidev",
+        rules: {
+          "format/prettier": [
+            "error",
+            {
+              printWidth: 120,
+              ...prettierOptions,
+              embeddedLanguageFormatting: "off",
+              parser: "slidev",
+              plugins: [
+                "prettier-plugin-slidev"
+              ]
+            }
+          ]
+        }
+      });
+    }
+  }
+  if (options.astro) {
+    configs.push({
+      files: [GLOB_ASTRO],
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "kirklin:formatter:astro",
+      rules: {
+        "format/prettier": [
+          "error",
+          {
+            ...prettierOptions,
+            parser: "astro",
+            plugins: [
+              "prettier-plugin-astro"
+            ]
+          }
+        ]
+      }
+    });
   }
   if (options.graphql) {
     configs.push({
@@ -886,7 +940,7 @@ async function formatters(options = {}, stylistic2 = {}) {
 }
 
 // src/configs/react.ts
-import { isPackageExists as isPackageExists2 } from "local-pkg";
+import { isPackageExists as isPackageExists3 } from "local-pkg";
 var ReactRefreshAllowConstantExportPackages = [
   "vite"
 ];
@@ -911,7 +965,7 @@ async function react(options = {}) {
     interopDefault(import("eslint-plugin-react-refresh"))
   ]);
   const isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some(
-    (i) => isPackageExists2(i)
+    (i) => isPackageExists3(i)
   );
   return [
     {
@@ -1268,6 +1322,8 @@ async function svelte(options = {}) {
           { args: "after-used", argsIgnorePattern: "^_", vars: "all", varsIgnorePattern: "^(_|\\$\\$Props$)" }
         ],
         ...stylistic2 ? {
+          "style/indent": "off",
+          // superseded by svelte/indent
           "style/no-trailing-spaces": "off",
           // superseded by svelte/no-trailing-spaces
           "svelte/derived-has-same-inputs-outputs": "error",
@@ -1585,6 +1641,26 @@ async function vue(options = {}) {
   ]);
   return [
     {
+      // This allows Vue plugin to work with auto imports
+      // https://github.com/vuejs/eslint-plugin-vue/pull/2422
+      languageOptions: {
+        globals: {
+          computed: "readonly",
+          defineEmits: "readonly",
+          defineExpose: "readonly",
+          defineProps: "readonly",
+          onMounted: "readonly",
+          onUnmounted: "readonly",
+          reactive: "readonly",
+          ref: "readonly",
+          shallowReactive: "readonly",
+          shallowRef: "readonly",
+          toRef: "readonly",
+          toRefs: "readonly",
+          watch: "readonly",
+          watchEffect: "readonly"
+        }
+      },
       name: "kirklin:vue:setup",
       plugins: {
         vue: pluginVue
@@ -1830,6 +1906,54 @@ async function toml(options = {}) {
   ];
 }
 
+// src/configs/astro.ts
+async function astro(options = {}) {
+  const {
+    files = [GLOB_ASTRO],
+    overrides = {},
+    stylistic: stylistic2 = true
+  } = options;
+  const [
+    pluginAstro,
+    parserAstro,
+    parserTs
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-astro")),
+    interopDefault(import("astro-eslint-parser")),
+    interopDefault(import("@typescript-eslint/parser"))
+  ]);
+  return [
+    {
+      name: "kirklin:astro:setup",
+      plugins: {
+        astro: pluginAstro
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserAstro,
+        parserOptions: {
+          extraFileExtensions: [".astro"],
+          parser: parserTs
+        }
+      },
+      name: "kirklin:astro:rules",
+      rules: {
+        "astro/no-set-html-directive": "off",
+        ...stylistic2 ? {
+          "style/indent": "off",
+          "style/jsx-closing-tag-location": "off",
+          "style/jsx-indent": "off",
+          "style/jsx-one-expression-per-line": "off",
+          "style/no-multiple-empty-lines": "off"
+        } : {},
+        ...overrides
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "name",
@@ -1850,14 +1974,15 @@ var VuePackages = [
 ];
 async function kirklin(options = {}, ...userConfigs) {
   const {
+    astro: enableAstro = false,
     componentExts = [],
     gitignore: enableGitignore = true,
-    isInEditor = !!((process3.env.VSCODE_PID || 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.CI),
     react: enableReact = false,
     svelte: enableSvelte = false,
-    typescript: enableTypeScript = isPackageExists3("typescript"),
+    typescript: enableTypeScript = isPackageExists4("typescript"),
     unocss: enableUnoCSS = false,
-    vue: enableVue = VuePackages.some((i) => isPackageExists3(i))
+    vue: enableVue = VuePackages.some((i) => isPackageExists4(i))
   } = options;
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions)) {
@@ -1940,6 +2065,12 @@ async function kirklin(options = {}, ...userConfigs) {
       overrides: getOverrides(options, "unocss")
     }));
   }
+  if (enableAstro) {
+    configs.push(astro({
+      overrides: getOverrides(options, "astro"),
+      stylistic: stylisticOptions
+    }));
+  }
   if (options.jsonc ?? true) {
     configs.push(
       jsonc({
@@ -2008,6 +2139,7 @@ function getOverrides(options, key) {
 var src_default = kirklin;
 export {
   GLOB_ALL_SRC,
+  GLOB_ASTRO,
   GLOB_CSS,
   GLOB_EXCLUDE,
   GLOB_HTML,
@@ -2033,6 +2165,7 @@ export {
   GLOB_VUE,
   GLOB_YAML,
   StylisticConfigDefaults,
+  astro,
   combine,
   comments,
   src_default as default,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@kirklin/eslint-config",
   "type": "module",
-  "version": "2.1.0",
-  "packageManager": "pnpm@8.15.1",
+  "version": "2.2.0",
+  "packageManager": "pnpm@8.15.5",
   "description": "Kirk Lin's ESLint config",
   "author": "Kirk Lin (https://github.com/kirklin/)",
   "license": "MIT",
@@ -26,18 +26,28 @@
   ],
   "peerDependencies": {
     "@unocss/eslint-plugin": ">=0.50.0",
+    "astro-eslint-parser": "^0.16.3",
     "eslint": ">=8.40.0",
+    "eslint-plugin-astro": "^0.31.4",
     "eslint-plugin-format": ">=0.1.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",
     "eslint-plugin-svelte": "^2.34.1",
+    "prettier-plugin-astro": "^0.13.0",
+    "prettier-plugin-slidev": "^1.0.5",
     "svelte-eslint-parser": "^0.33.1"
   },
   "peerDependenciesMeta": {
     "@unocss/eslint-plugin": {
       "optional": true
     },
+    "astro-eslint-parser": {
+      "optional": true
+    },
+    "eslint-plugin-astro": {
+      "optional": true
+    },
     "eslint-plugin-format": {
       "optional": true
     },
@@ -53,6 +63,12 @@
     "eslint-plugin-svelte": {
       "optional": true
     },
+    "prettier-plugin-astro": {
+      "optional": true
+    },
+    "prettier-plugin-slidev": {
+      "optional": true
+    },
     "svelte-eslint-parser": {
       "optional": true
     }
@@ -60,36 +76,36 @@
   "dependencies": {
     "@antfu/eslint-define-config": "1.23.0-2",
     "@antfu/install-pkg": "^0.3.1",
-    "@eslint-types/jsdoc": "48.0.4",
-    "@eslint-types/typescript-eslint": "^6.19.1",
-    "@eslint-types/unicorn": "^50.0.1",
-    "@stylistic/eslint-plugin": "^1.6.0",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "eslint-config-flat-gitignore": "^0.1.2",
+    "@clack/prompts": "^0.7.0",
+    "@eslint-types/jsdoc": "48.2.1",
+    "@eslint-types/typescript-eslint": "^7.2.0",
+    "@eslint-types/unicorn": "^51.0.1",
+    "@stylistic/eslint-plugin": "^1.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
+    "@typescript-eslint/parser": "^7.3.1",
+    "eslint-config-flat-gitignore": "^0.1.3",
     "eslint-merge-processors": "^0.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-i": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.0.5",
-    "eslint-plugin-jsonc": "^2.13.0",
+    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-jsonc": "^2.14.1",
     "eslint-plugin-kirklin": "^1.1.0",
-    "eslint-plugin-markdown": "^3.0.1",
+    "eslint-plugin-markdown": "^4.0.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-perfectionist": "^2.5.0",
-    "eslint-plugin-toml": "^0.9.2",
-    "eslint-plugin-unicorn": "^50.0.1",
-    "eslint-plugin-unused-imports": "^3.0.0",
-    "eslint-plugin-vitest": "^0.3.21",
-    "eslint-plugin-vue": "^9.21.1",
-    "eslint-plugin-yml": "^1.12.2",
+    "eslint-plugin-perfectionist": "^2.7.0",
+    "eslint-plugin-toml": "^0.10.0",
+    "eslint-plugin-unicorn": "^51.0.1",
+    "eslint-plugin-unused-imports": "^3.1.0",
+    "eslint-plugin-vitest": "^0.3.26",
+    "eslint-plugin-vue": "^9.23.0",
+    "eslint-plugin-yml": "^1.13.1",
     "eslint-processor-vue-blocks": "^0.1.1",
-    "globals": "^13.24.0",
+    "globals": "^14.0.0",
     "jsonc-eslint-parser": "^2.4.0",
     "local-pkg": "^0.5.0",
     "parse-gitignore": "^2.0.0",
     "picocolors": "^1.0.0",
-    "prompts": "^2.4.2",
     "toml-eslint-parser": "^0.9.3",
     "vue-eslint-parser": "^9.4.2",
     "yaml-eslint-parser": "^1.2.2",
@@ -98,36 +114,40 @@
   "devDependencies": {
     "@antfu/eslint-plugin-prettier": "5.0.1-1",
     "@antfu/ni": "^0.21.12",
-    "@stylistic/eslint-plugin-migrate": "^1.6.0",
-    "@types/eslint": "^8.56.2",
+    "@stylistic/eslint-plugin-migrate": "^1.7.0",
+    "@types/eslint": "^8.56.6",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.16",
+    "@types/node": "^20.11.30",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.32",
-    "@unocss/eslint-plugin": "^0.58.5",
-    "bumpp": "^9.3.0",
-    "eslint": "npm:eslint-ts-patch@8.56.0-0",
+    "@unocss/eslint-plugin": "^0.58.6",
+    "astro-eslint-parser": "^0.16.3",
+    "bumpp": "^9.4.0",
+    "eslint": "npm:eslint-ts-patch@8.57.0-0",
     "eslint-flat-config-viewer": "^0.1.11",
+    "eslint-plugin-astro": "^0.32.0",
     "eslint-plugin-format": "^0.1.0",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.5",
+    "eslint-plugin-react-refresh": "^0.4.6",
     "eslint-plugin-svelte": "^2.35.1",
-    "eslint-ts-patch": "8.56.0-0",
-    "esno": "^4.0.0",
+    "eslint-ts-patch": "8.57.0-0",
+    "esno": "^4.7.0",
     "execa": "^8.0.1",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "lint-staged": "^15.2.2",
+    "prettier-plugin-astro": "^0.13.0",
+    "prettier-plugin-slidev": "^1.0.5",
     "rimraf": "^5.0.5",
-    "simple-git-hooks": "^2.9.0",
-    "svelte": "^4.2.10",
+    "simple-git-hooks": "^2.11.0",
+    "svelte": "^4.2.12",
     "svelte-eslint-parser": "^0.33.1",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "vitest": "^1.2.2",
-    "vue": "^3.4.15",
-    "@kirklin/eslint-config": "2.1.0"
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.2",
+    "vitest": "^1.4.0",
+    "vue": "^3.4.21",
+    "@kirklin/eslint-config": "2.2.0"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"