@antfu/eslint-config 1.2.0 → 2.0.0

package/README.md

@@ -87,13 +87,13 @@ For example:
 
 ### Migration
 
-We provided an experimental cli tool to help you migrate from the legacy config to the new flat config.
+We provided an experimental CLI tool to help you migrate from the legacy config to the new flat config.
 
 ```bash
-npx @antfu/eslint-config migrate
+npx @antfu/eslint-config@latest
 ```
 
-Before running the migration, make sure to commit your changes first.
+Before running the migration, make sure to commit your unsaved changes first.
 
 ## VS Code support (auto fix)
 
@@ -223,6 +223,7 @@ We don't recommend using this style in general usages, as there are shared optio
 ```js
 // eslint.config.js
 import {
+  combine,
   comments,
   ignores,
   imports,
@@ -240,21 +241,21 @@ import {
   yaml,
 } from '@antfu/eslint-config'
 
-export default [
-  ...ignores(),
-  ...javascript(/* Options */),
-  ...comments(),
-  ...node(),
-  ...jsdoc(),
-  ...imports(),
-  ...unicorn(),
-  ...typescript(/* Options */),
-  ...stylistic(),
-  ...vue(),
-  ...jsonc(),
-  ...yaml(),
-  ...markdown(),
-]
+export default combine(
+  ignores(),
+  javascript(/* Options */),
+  comments(),
+  node(),
+  jsdoc(),
+  imports(),
+  unicorn(),
+  typescript(/* Options */),
+  stylistic(),
+  vue(),
+  jsonc(),
+  yaml(),
+  markdown(),
+)
 ```
 
 </details>

package/dist/cli.cjs

@@ -46,7 +46,7 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "1.2.0";
+var version = "2.0.0";
 
 // src/cli/constants.ts
 var ARROW = import_picocolors.default.cyan("\u2192");
@@ -107,9 +107,9 @@ function isGitClean() {
 }
 
 // src/cli/run.ts
-var SKIP_PROMPT = !!import_node_process.default.env.SKIP_PROMPT;
-var SKIP_GIT_CHECK = !!import_node_process.default.env.SKIP_GIT_CHECK;
-async function run() {
+async function run(options = {}) {
+  const SKIP_PROMPT = !!import_node_process.default.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!import_node_process.default.env.SKIP_GIT_CHECK;
   const cwd = import_node_process.default.cwd();
   const pathFlatConfig = import_node_path.default.join(cwd, "eslint.config.js");
   const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
@@ -125,6 +125,8 @@ async function run() {
   const pkg = JSON.parse(pkgContent);
   pkg.devDependencies ?? (pkg.devDependencies = {});
   pkg.devDependencies["@antfu/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = "^8";
   await import_promises.default.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
   console.log(import_picocolors2.default.green(`${CHECK} changes wrote to package.json`));
   const eslintIgnores = [];
@@ -221,22 +223,19 @@ function header() {
 ${import_picocolors3.default.green(`@antfu/eslint-config `)}${import_picocolors3.default.dim(`v${version}`)}`);
 }
 var instance = (0, import_yargs.default)((0, import_helpers.hideBin)(import_node_process2.default.argv)).scriptName("@antfu/eslint-config").usage("").command(
-  "migrate",
-  "Migrate from legacy config to new flat config",
-  (args) => args.help(),
-  async (_args) => {
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
     header();
     console.log();
     try {
-      await run();
+      await run(args);
     } catch (error) {
       console.error(import_picocolors3.default.inverse(import_picocolors3.default.red(" Failed to migrate ")));
       console.error(import_picocolors3.default.red(`${CROSS} ${String(error)}`));
       import_node_process2.default.exit(1);
     }
   }
-).command("*", false, (args) => args, () => {
-  header();
-  instance.showHelp();
-}).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
 instance.help().argv;

package/dist/cli.js

@@ -17,7 +17,7 @@ import parse from "parse-gitignore";
 import c from "picocolors";
 
 // package.json
-var version = "1.2.0";
+var version = "2.0.0";
 
 // src/cli/constants.ts
 var ARROW = c.cyan("\u2192");
@@ -78,9 +78,9 @@ function isGitClean() {
 }
 
 // src/cli/run.ts
-var SKIP_PROMPT = !!process.env.SKIP_PROMPT;
-var SKIP_GIT_CHECK = !!process.env.SKIP_GIT_CHECK;
-async function run() {
+async function run(options = {}) {
+  const SKIP_PROMPT = !!process.env.SKIP_PROMPT || options.yes;
+  const SKIP_GIT_CHECK = !!process.env.SKIP_GIT_CHECK;
   const cwd = process.cwd();
   const pathFlatConfig = path.join(cwd, "eslint.config.js");
   const pathPackageJSON = path.join(cwd, "package.json");
@@ -96,6 +96,8 @@ async function run() {
   const pkg = JSON.parse(pkgContent);
   pkg.devDependencies ?? (pkg.devDependencies = {});
   pkg.devDependencies["@antfu/eslint-config"] = `^${version}`;
+  if (!pkg.devDependencies.eslint)
+    pkg.devDependencies.eslint = "^8";
   await fsp.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
   console.log(c2.green(`${CHECK} changes wrote to package.json`));
   const eslintIgnores = [];
@@ -192,22 +194,19 @@ function header() {
 ${c3.green(`@antfu/eslint-config `)}${c3.dim(`v${version}`)}`);
 }
 var instance = yargs(hideBin(process2.argv)).scriptName("@antfu/eslint-config").usage("").command(
-  "migrate",
-  "Migrate from legacy config to new flat config",
-  (args) => args.help(),
-  async (_args) => {
+  "*",
+  "Run the initialization or migration",
+  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  async (args) => {
     header();
     console.log();
     try {
-      await run();
+      await run(args);
     } catch (error) {
       console.error(c3.inverse(c3.red(" Failed to migrate ")));
       console.error(c3.red(`${CROSS} ${String(error)}`));
       process2.exit(1);
     }
   }
-).command("*", false, (args) => args, () => {
-  header();
-  instance.showHelp();
-}).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
+).showHelpOnFail(false).alias("h", "help").version("version", version).alias("v", "version");
 instance.help().argv;

package/dist/index.cjs

@@ -57,32 +57,13 @@ __export(src_exports, {
   default: () => src_default,
   ignores: () => ignores,
   imports: () => imports,
+  interopDefault: () => interopDefault,
   javascript: () => javascript,
   jsdoc: () => jsdoc,
   jsonc: () => jsonc,
   markdown: () => markdown,
   node: () => node,
-  parserJsonc: () => import_jsonc_eslint_parser.default,
-  parserTs: () => parserTs,
-  parserVue: () => import_vue_eslint_parser.default,
-  parserYaml: () => import_yaml_eslint_parser.default,
   perfectionist: () => perfectionist,
-  pluginAntfu: () => import_eslint_plugin_antfu.default,
-  pluginComments: () => import_eslint_plugin_eslint_comments.default,
-  pluginImport: () => pluginImport,
-  pluginJsdoc: () => import_eslint_plugin_jsdoc.default,
-  pluginJsonc: () => pluginJsonc,
-  pluginMarkdown: () => import_eslint_plugin_markdown.default,
-  pluginNoOnlyTests: () => import_eslint_plugin_no_only_tests.default,
-  pluginNode: () => import_eslint_plugin_n.default,
-  pluginPerfectionist: () => import_eslint_plugin_perfectionist.default,
-  pluginStylistic: () => import_eslint_plugin.default,
-  pluginTs: () => import_eslint_plugin2.default,
-  pluginUnicorn: () => import_eslint_plugin_unicorn.default,
-  pluginUnusedImports: () => import_eslint_plugin_unused_imports.default,
-  pluginVitest: () => import_eslint_plugin_vitest.default,
-  pluginVue: () => import_eslint_plugin_vue.default,
-  pluginYaml: () => pluginYaml,
   renameRules: () => renameRules,
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
@@ -100,32 +81,18 @@ module.exports = __toCommonJS(src_exports);
 var import_node_process2 = __toESM(require("process"), 1);
 var import_node_fs = __toESM(require("fs"), 1);
 var import_local_pkg = require("local-pkg");
-var import_eslint_config_flat_gitignore = __toESM(require("eslint-config-flat-gitignore"), 1);
 
 // src/plugins.ts
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
 var import_eslint_plugin_eslint_comments = __toESM(require("eslint-plugin-eslint-comments"), 1);
 var pluginImport = __toESM(require("eslint-plugin-i"), 1);
-var import_eslint_plugin_jsdoc = __toESM(require("eslint-plugin-jsdoc"), 1);
-var pluginJsonc = __toESM(require("eslint-plugin-jsonc"), 1);
-var import_eslint_plugin_markdown = __toESM(require("eslint-plugin-markdown"), 1);
 var import_eslint_plugin_n = __toESM(require("eslint-plugin-n"), 1);
-var import_eslint_plugin = __toESM(require("@stylistic/eslint-plugin"), 1);
-var import_eslint_plugin2 = __toESM(require("@typescript-eslint/eslint-plugin"), 1);
 var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
 var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-imports"), 1);
-var import_eslint_plugin_vue = __toESM(require("eslint-plugin-vue"), 1);
-var pluginYaml = __toESM(require("eslint-plugin-yml"), 1);
-var import_eslint_plugin_no_only_tests = __toESM(require("eslint-plugin-no-only-tests"), 1);
-var import_eslint_plugin_vitest = __toESM(require("eslint-plugin-vitest"), 1);
 var import_eslint_plugin_perfectionist = __toESM(require("eslint-plugin-perfectionist"), 1);
-var parserTs = __toESM(require("@typescript-eslint/parser"), 1);
-var import_vue_eslint_parser = __toESM(require("vue-eslint-parser"), 1);
-var import_yaml_eslint_parser = __toESM(require("yaml-eslint-parser"), 1);
-var import_jsonc_eslint_parser = __toESM(require("jsonc-eslint-parser"), 1);
 
 // src/configs/comments.ts
-function comments() {
+async function comments() {
   return [
     {
       name: "antfu:eslint-comments",
@@ -210,7 +177,7 @@ var GLOB_EXCLUDE = [
 ];
 
 // src/configs/ignores.ts
-function ignores() {
+async function ignores() {
   return [
     {
       ignores: GLOB_EXCLUDE
@@ -219,7 +186,7 @@ function ignores() {
 }
 
 // src/configs/imports.ts
-function imports(options = {}) {
+async function imports(options = {}) {
   const {
     stylistic: stylistic2 = true
   } = options;
@@ -250,7 +217,7 @@ function imports(options = {}) {
 
 // src/configs/javascript.ts
 var import_globals = __toESM(require("globals"), 1);
-function javascript(options = {}) {
+async function javascript(options = {}) {
   const {
     isInEditor = false,
     overrides = {}
@@ -467,7 +434,7 @@ function javascript(options = {}) {
 }
 
 // src/configs/jsdoc.ts
-function jsdoc(options = {}) {
+async function jsdoc(options = {}) {
   const {
     stylistic: stylistic2 = true
   } = options;
@@ -475,7 +442,8 @@ function jsdoc(options = {}) {
     {
       name: "antfu:jsdoc",
       plugins: {
-        jsdoc: import_eslint_plugin_jsdoc.default
+        // @ts-expect-error missing types
+        jsdoc: await interopDefault(import("eslint-plugin-jsdoc"))
       },
       rules: {
         "jsdoc/check-access": "warn",
@@ -502,8 +470,30 @@ function jsdoc(options = {}) {
   ];
 }
 
+// src/utils.ts
+async function combine(...configs) {
+  const resolved = await Promise.all(configs);
+  return resolved.flat();
+}
+function renameRules(rules, from, to) {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) => {
+      if (key.startsWith(from))
+        return [to + key.slice(from.length), value];
+      return [key, value];
+    })
+  );
+}
+function toArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
+async function interopDefault(m) {
+  const resolved = await m;
+  return resolved.default || resolved;
+}
+
 // src/configs/jsonc.ts
-function jsonc(options = {}) {
+async function jsonc(options = {}) {
   const {
     overrides = {},
     stylistic: stylistic2 = true
@@ -511,6 +501,13 @@ function jsonc(options = {}) {
   const {
     indent = 2
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
+  const [
+    pluginJsonc,
+    parserJsonc
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-jsonc")),
+    interopDefault(import("jsonc-eslint-parser"))
+  ]);
   return [
     {
       name: "antfu:jsonc:setup",
@@ -521,7 +518,7 @@ function jsonc(options = {}) {
     {
       files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
       languageOptions: {
-        parser: import_jsonc_eslint_parser.default
+        parser: parserJsonc
       },
       name: "antfu:jsonc:rules",
       rules: {
@@ -570,7 +567,7 @@ function jsonc(options = {}) {
 }
 
 // src/configs/markdown.ts
-function markdown(options = {}) {
+async function markdown(options = {}) {
   const {
     componentExts = [],
     overrides = {}
@@ -579,7 +576,8 @@ function markdown(options = {}) {
     {
       name: "antfu:markdown:setup",
       plugins: {
-        markdown: import_eslint_plugin_markdown.default
+        // @ts-expect-error missing types
+        markdown: await interopDefault(import("eslint-plugin-markdown"))
       }
     },
     {
@@ -651,7 +649,7 @@ function markdown(options = {}) {
 }
 
 // src/configs/node.ts
-function node() {
+async function node() {
   return [
     {
       name: "antfu:node",
@@ -673,7 +671,7 @@ function node() {
 }
 
 // src/configs/sort.ts
-function sortPackageJson() {
+async function sortPackageJson() {
   return [
     {
       files: ["**/package.json"],
@@ -889,14 +887,15 @@ function sortTsconfig() {
 }
 
 // src/configs/stylistic.ts
-function stylistic(options = {}) {
+async function stylistic(options = {}) {
   const {
     indent = 2,
     jsx = true,
     quotes = "single",
     semi = false
   } = options;
-  const config = import_eslint_plugin.default.configs.customize({
+  const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
+  const config = pluginStylistic.configs.customize({
     flat: true,
     indent,
     jsx,
@@ -909,7 +908,7 @@ function stylistic(options = {}) {
       name: "antfu:stylistic",
       plugins: {
         antfu: import_eslint_plugin_antfu.default,
-        style: import_eslint_plugin.default
+        style: pluginStylistic
       },
       rules: {
         ...config.rules,
@@ -925,26 +924,7 @@ function stylistic(options = {}) {
 
 // src/configs/typescript.ts
 var import_node_process = __toESM(require("process"), 1);
-
-// src/utils.ts
-function combine(...configs) {
-  return configs.flat();
-}
-function renameRules(rules, from, to) {
-  return Object.fromEntries(
-    Object.entries(rules).map(([key, value]) => {
-      if (key.startsWith(from))
-        return [to + key.slice(from.length), value];
-      return [key, value];
-    })
-  );
-}
-function toArray(value) {
-  return Array.isArray(value) ? value : [value];
-}
-
-// src/configs/typescript.ts
-function typescript(options) {
+async function typescript(options) {
   const {
     componentExts = [],
     overrides = {},
@@ -972,14 +952,20 @@ function typescript(options) {
     "ts/unbound-method": "error"
   };
   const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
+  const [
+    pluginTs,
+    parserTs
+  ] = await Promise.all([
+    interopDefault(import("@typescript-eslint/eslint-plugin")),
+    interopDefault(import("@typescript-eslint/parser"))
+  ]);
   return [
     {
       // Install the plugins without globs, so they can be configured separately.
       name: "antfu:typescript:setup",
       plugins: {
         antfu: import_eslint_plugin_antfu.default,
-        import: pluginImport,
-        ts: import_eslint_plugin2.default
+        ts: pluginTs
       }
     },
     {
@@ -1002,12 +988,12 @@ function typescript(options) {
       name: "antfu:typescript:rules",
       rules: {
         ...renameRules(
-          import_eslint_plugin2.default.configs["eslint-recommended"].overrides[0].rules,
+          pluginTs.configs["eslint-recommended"].overrides[0].rules,
           "@typescript-eslint/",
           "ts/"
         ),
         ...renameRules(
-          import_eslint_plugin2.default.configs.strict.rules,
+          pluginTs.configs.strict.rules,
           "@typescript-eslint/",
           "ts/"
         ),
@@ -1073,7 +1059,7 @@ function typescript(options) {
 }
 
 // src/configs/unicorn.ts
-function unicorn() {
+async function unicorn() {
   return [
     {
       name: "antfu:unicorn",
@@ -1113,7 +1099,7 @@ function unicorn() {
 }
 
 // src/configs/vue.ts
-function vue(options = {}) {
+async function vue(options = {}) {
   const {
     overrides = {},
     stylistic: stylistic2 = true
@@ -1121,33 +1107,41 @@ function vue(options = {}) {
   const {
     indent = 2
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
+  const [
+    pluginVue,
+    parserVue
+  ] = await Promise.all([
+    // @ts-expect-error missing types
+    interopDefault(import("eslint-plugin-vue")),
+    interopDefault(import("vue-eslint-parser"))
+  ]);
   return [
     {
       name: "antfu:vue:setup",
       plugins: {
-        vue: import_eslint_plugin_vue.default
+        vue: pluginVue
       }
     },
     {
       files: [GLOB_VUE],
       languageOptions: {
-        parser: import_vue_eslint_parser.default,
+        parser: parserVue,
         parserOptions: {
           ecmaFeatures: {
             jsx: true
           },
           extraFileExtensions: [".vue"],
-          parser: options.typescript ? parserTs : null,
+          parser: options.typescript ? await interopDefault(import("@typescript-eslint/parser")) : null,
           sourceType: "module"
         }
       },
       name: "antfu:vue:rules",
-      processor: import_eslint_plugin_vue.default.processors[".vue"],
+      processor: pluginVue.processors[".vue"],
       rules: {
-        ...import_eslint_plugin_vue.default.configs.base.rules,
-        ...import_eslint_plugin_vue.default.configs["vue3-essential"].rules,
-        ...import_eslint_plugin_vue.default.configs["vue3-strongly-recommended"].rules,
-        ...import_eslint_plugin_vue.default.configs["vue3-recommended"].rules,
+        ...pluginVue.configs.base.rules,
+        ...pluginVue.configs["vue3-essential"].rules,
+        ...pluginVue.configs["vue3-strongly-recommended"].rules,
+        ...pluginVue.configs["vue3-recommended"].rules,
         "node/prefer-global/process": "off",
         "vue/block-order": ["error", {
           order: ["script", "template", "style"]
@@ -1230,7 +1224,7 @@ function vue(options = {}) {
 }
 
 // src/configs/yaml.ts
-function yaml(options = {}) {
+async function yaml(options = {}) {
   const {
     overrides = {},
     stylistic: stylistic2 = true
@@ -1239,6 +1233,13 @@ function yaml(options = {}) {
     indent = 2,
     quotes = "single"
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
+  const [
+    pluginYaml,
+    parserYaml
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-yml")),
+    interopDefault(import("yaml-eslint-parser"))
+  ]);
   return [
     {
       name: "antfu:yaml:setup",
@@ -1249,7 +1250,7 @@ function yaml(options = {}) {
     {
       files: [GLOB_YAML],
       languageOptions: {
-        parser: import_yaml_eslint_parser.default
+        parser: parserYaml
       },
       name: "antfu:yaml:rules",
       rules: {
@@ -1281,21 +1282,29 @@ function yaml(options = {}) {
 }
 
 // src/configs/test.ts
-function test(options = {}) {
+async function test(options = {}) {
   const {
     isInEditor = false,
     overrides = {}
   } = options;
+  const [
+    pluginVitest,
+    pluginNoOnlyTests
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-vitest")),
+    // @ts-expect-error missing types
+    interopDefault(import("eslint-plugin-no-only-tests"))
+  ]);
   return [
     {
       name: "antfu:test:setup",
       plugins: {
         test: {
-          ...import_eslint_plugin_vitest.default,
+          ...pluginVitest,
           rules: {
-            ...import_eslint_plugin_vitest.default.rules,
+            ...pluginVitest.rules,
             // extend `test/no-only-tests` rule
-            ...import_eslint_plugin_no_only_tests.default.rules
+            ...pluginNoOnlyTests.rules
           }
         }
       }
@@ -1317,7 +1326,7 @@ function test(options = {}) {
 }
 
 // src/configs/perfectionist.ts
-function perfectionist() {
+async function perfectionist() {
   return [
     {
       name: "antfu:perfectionist",
@@ -1345,7 +1354,7 @@ var VuePackages = [
   "vitepress",
   "@slidev/cli"
 ];
-function antfu(options = {}, ...userConfigs) {
+async function antfu(options = {}, ...userConfigs) {
   const {
     componentExts = [],
     gitignore: enableGitignore = true,
@@ -1360,10 +1369,10 @@ function antfu(options = {}, ...userConfigs) {
   const configs = [];
   if (enableGitignore) {
     if (typeof enableGitignore !== "boolean") {
-      configs.push([(0, import_eslint_config_flat_gitignore.default)(enableGitignore)]);
+      configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r(enableGitignore)]));
     } else {
       if (import_node_fs.default.existsSync(".gitignore"))
-        configs.push([(0, import_eslint_config_flat_gitignore.default)()]);
+        configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
     }
   }
   configs.push(
@@ -1474,32 +1483,13 @@ var src_default = antfu;
   comments,
   ignores,
   imports,
+  interopDefault,
   javascript,
   jsdoc,
   jsonc,
   markdown,
   node,
-  parserJsonc,
-  parserTs,
-  parserVue,
-  parserYaml,
   perfectionist,
-  pluginAntfu,
-  pluginComments,
-  pluginImport,
-  pluginJsdoc,
-  pluginJsonc,
-  pluginMarkdown,
-  pluginNoOnlyTests,
-  pluginNode,
-  pluginPerfectionist,
-  pluginStylistic,
-  pluginTs,
-  pluginUnicorn,
-  pluginUnusedImports,
-  pluginVitest,
-  pluginVue,
-  pluginYaml,
   renameRules,
   sortPackageJson,
   sortTsconfig,