✨ refactor(app): 调整自定义配置文件的加载时机

OSpoon · OSpoon · commit d20ebef8ef8d · 2023-10-02T14:23:50.000+08:00
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,14 +1,14 @@
 import cac from "cac";
 
 import { cmdInstaller, handleError } from "@/helper";
-import { config } from "@/index";
+import { plugins } from "@/index";
 
 import pkg from "../package.json";
 
 const setupCli = async () => {
   const cli = cac("codeg");
 
-  cmdInstaller(cli, config);
+  await cmdInstaller(cli, plugins);
 
   cli.help();
   cli.version(pkg.version);
diff --git a/src/command/clear.ts b/src/command/clear.ts
@@ -6,11 +6,10 @@ import enquirer from "enquirer";
 import fs from "fs-extra";
 
 import { ACTIVATION, clearGlob } from "@/config";
-import { execCommand, loadConfigModule, loggerInfo, printInfo } from "@/helper";
-import { ClearOptions } from "@/types";
+import { execCommand, loggerInfo, printInfo } from "@/helper";
+import { ClearOptions, CodeGeniusOptions } from "@/types";
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
+const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.clear) {
     const { files } = commands.clear;
@@ -23,7 +22,9 @@ const mergeConfig = async () => {
   };
 };
 
-const generateEnquirer = async (): Promise<ClearOptions> => {
+const generateEnquirer = async (
+  config: CodeGeniusOptions,
+): Promise<ClearOptions> => {
   const files = fs
     .readdirSync(path.join(process.cwd(), "."))
     .filter((v) => !v.startsWith("."))
@@ -35,7 +36,7 @@ const generateEnquirer = async (): Promise<ClearOptions> => {
     });
   files.sort((v1, v2) => v1.sort - v2.sort);
 
-  const { paths } = await mergeConfig();
+  const { paths } = await mergeConfig(config);
   const fileMultiChoices = files.map((v) => {
     return {
       name: `./${v.file}`,
@@ -66,7 +67,7 @@ export const clear = async (paths: string[]) => {
   printInfo("清理结束");
 };
 
-export default function clearInstaller(cli: CAC) {
+export default function clearInstaller(cli: CAC, config: CodeGeniusOptions) {
   return {
     name: "clearInstaller",
     setup: () => {
@@ -77,7 +78,7 @@ export default function clearInstaller(cli: CAC) {
           const { pattern } = options;
           let paths = [];
           if (!pattern) {
-            const result = await generateEnquirer();
+            const result = await generateEnquirer(config);
             paths = result.files;
           } else {
             paths =
diff --git a/src/command/eslint-fix.ts b/src/command/eslint-fix.ts
@@ -3,15 +3,15 @@ import type { CAC } from "cac";
 import { ACTIVATION, eslintGlob } from "@/config";
 import {
   execCommand,
-  loadConfigModule,
   loggerError,
   loggerInfo,
   printError,
   printInfo,
 } from "@/helper";
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
+import { CodeGeniusOptions } from "./../types";
+
+const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.fix) {
     const { paths } = commands.fix;
@@ -41,7 +41,10 @@ export const eslintFix = async (paths: string[]) => {
   }
 };
 
-export default function eslintFixInstaller(cli: CAC) {
+export default function eslintFixInstaller(
+  cli: CAC,
+  config: CodeGeniusOptions,
+) {
   return {
     name: "eslintFixInstaller",
     setup: () => {
@@ -51,7 +54,7 @@ export default function eslintFixInstaller(cli: CAC) {
           default: [...eslintGlob],
         })
         .action(async (options) => {
-          const { paths } = await mergeConfig();
+          const { paths } = await mergeConfig(config);
           const { pattern } = options;
           if (pattern) {
             await eslintFix(typeof pattern === "string" ? [pattern] : pattern);
diff --git a/src/command/eslint-import-sort.ts b/src/command/eslint-import-sort.ts
@@ -6,11 +6,12 @@ import { ESLint } from "eslint";
 import fs from "fs-extra";
 
 import { ACTIVATION, impSortGlob } from "@/config";
-import { loadConfigModule, loggerInfo, printError, printInfo } from "@/helper";
+import { loggerInfo, printError, printInfo } from "@/helper";
 import { ImpSortOptions } from "@/types";
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
+import { CodeGeniusOptions } from "./../types";
+
+const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.impsort) {
     const { paths } = commands.impsort;
@@ -23,7 +24,9 @@ const mergeConfig = async () => {
   };
 };
 
-const generateEnquirer = async (): Promise<ImpSortOptions> => {
+const generateEnquirer = async (
+  config: CodeGeniusOptions,
+): Promise<ImpSortOptions> => {
   const files = fs
     .readdirSync(path.join(process.cwd(), "."))
     .filter((v) => !v.startsWith("."))
@@ -34,7 +37,7 @@ const generateEnquirer = async (): Promise<ImpSortOptions> => {
       };
     });
   files.sort((v1, v2) => v1.sort - v2.sort);
-  const { paths } = await mergeConfig();
+  const { paths } = await mergeConfig(config);
   const fileMultiChoices = files.map((v) => {
     return {
       name: `./${v.file}`,
@@ -82,7 +85,7 @@ export const impSort = async (paths: string[]) => {
   }
 };
 
-export default function impSortInstaller(cli: CAC) {
+export default function impSortInstaller(cli: CAC, config: CodeGeniusOptions) {
   return {
     name: "impSortInstaller",
     setup: () => {
@@ -93,7 +96,7 @@ export default function impSortInstaller(cli: CAC) {
           const { pattern } = options;
           let paths = [];
           if (!pattern) {
-            const result = await generateEnquirer();
+            const result = await generateEnquirer(config);
             paths = result.files;
           } else {
             paths =
diff --git a/src/command/git-user.ts b/src/command/git-user.ts
@@ -3,15 +3,15 @@ import type { CAC } from "cac";
 import { ACTIVATION, gitUserOptions } from "@/config";
 import {
   execCommand,
-  loadConfigModule,
   loggerInfo,
   printError,
   printInfo,
   printWarring,
 } from "@/helper";
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
+import { CodeGeniusOptions } from "./../types";
+
+const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.gituser) {
     const { ruleName, ruleEmail } = commands.gituser;
@@ -104,7 +104,7 @@ export async function checkGitUserEmail(ruleEmail: string) {
   }
 }
 
-export default function gitUserInstaller(cli: CAC) {
+export default function gitUserInstaller(cli: CAC, config: CodeGeniusOptions) {
   return {
     name: "gitUserInstaller",
     setup: () => {
@@ -117,7 +117,7 @@ export default function gitUserInstaller(cli: CAC) {
         .option("--rule-name <regexp>", "设置 user.name 匹配规则(转义字符串)")
         .option("--rule-email <regexp>", "设置 user.email 匹配规则(转义字符串)")
         .action(async (options) => {
-          const { ruleName, ruleEmail } = await mergeConfig();
+          const { ruleName, ruleEmail } = await mergeConfig(config);
           const { name, email, ruleName: rName, ruleEmail: rEmail } = options;
           if (!name && !email) {
             await checkGitUserName(ruleName || rName);
diff --git a/src/command/prettier-format.ts b/src/command/prettier-format.ts
@@ -1,10 +1,11 @@
 import type { CAC } from "cac";
 
 import { ACTIVATION, formatGlob } from "@/config";
-import { execCommand, loadConfigModule, loggerInfo } from "@/helper";
+import { execCommand, loggerInfo } from "@/helper";
 
-const mergeConfig = async () => {
-  const config = await loadConfigModule();
+import { CodeGeniusOptions } from "./../types";
+
+const mergeConfig = async (config: CodeGeniusOptions) => {
   const commands = config && config?.commands;
   if (commands && commands.format) {
     const { paths } = commands.format;
@@ -27,15 +28,18 @@ export const prettierFormat = async (paths: string[]) => {
   });
 };
 
-export default function prettierFormatInstaller(cli: CAC) {
+export default function prettierFormatInstaller(
+  cli: CAC,
+  config: CodeGeniusOptions,
+) {
   return {
     name: "prettierFormatInstaller",
     setup: () => {
       cli
         .command("format", "运行 prettier 格式化代码风格")
         .option("-p, --pattern <pattern>", "设置匹配规则")
         .action(async (options) => {
-          const { paths } = await mergeConfig();
+          const { paths } = await mergeConfig(config);
           const { pattern } = options;
           if (pattern) {
             await prettierFormat(
diff --git a/src/helper.ts b/src/helper.ts
@@ -17,7 +17,7 @@ import {
   TEMPLATES,
 } from "@/config";
 
-import { CodeGeniusOptions, CommandOptions } from "./types";
+import { CodeGeniusOptions, CommandOptions, Plugins } from "./types";
 
 const boxenBorderStyle = {
   padding: 1,
@@ -223,12 +223,10 @@ export const defineConfig = (config: CodeGeniusOptions): CodeGeniusOptions =>
  * @param cli
  * @param config
  */
-export async function cmdInstaller(cli: CAC, config: CodeGeniusOptions) {
-  const { plugins } = config;
-  if (plugins) {
-    for (const plugin of plugins) {
-      plugin(cli).setup();
-    }
+export async function cmdInstaller(cli: CAC, plugins: Plugins) {
+  const userConfig = await loadConfigModule();
+  for (const plugin of plugins) {
+    plugin(cli, userConfig).setup();
   }
 }
 
diff --git a/src/index.ts b/src/index.ts
@@ -29,34 +29,33 @@ import scriptRunInstaller from "@/command/script";
 import templateInstaller, { template } from "@/command/template";
 import { defineConfig } from "@/helper";
 
-const config = defineConfig({
-  plugins: [
-    rootInstaller,
-    gitCommitInstaller,
-    gitCommitVerifyInstaller,
-    gitUserInstaller,
-    gitInitSimpleHooksInstaller,
-    npmRegistryInstaller,
-    clearInstaller,
-    npmDepCheckInstaller,
-    eslintFixInstaller,
-    impSortInstaller,
-    prettierFormatInstaller,
-    createProjectInstaller,
-    templateInstaller,
-    lighthouseInstaller,
-    quantityInstaller,
-    scriptRunInstaller,
-  ],
-});
+import { Plugins } from "./types";
 
-export { config, defineConfig };
+export const plugins = [
+  rootInstaller,
+  gitCommitInstaller,
+  gitCommitVerifyInstaller,
+  gitUserInstaller,
+  gitInitSimpleHooksInstaller,
+  npmRegistryInstaller,
+  clearInstaller,
+  npmDepCheckInstaller,
+  eslintFixInstaller,
+  impSortInstaller,
+  prettierFormatInstaller,
+  createProjectInstaller,
+  templateInstaller,
+  lighthouseInstaller,
+  quantityInstaller,
+  scriptRunInstaller,
+] as Plugins;
 
 export {
   checkGitUserEmail,
   checkGitUserName,
   clear,
   createProject,
+  defineConfig,
   eslintFix,
   gitCommit,
   gitCommitVerify,
diff --git a/src/types.ts b/src/types.ts
@@ -56,13 +56,17 @@ export interface CommitOptions {
   gitCommitScopes?: Array<CommitScope>;
 }
 
+export type Plugins = Array<
+  (
+    cli: CAC,
+    config: CodeGeniusOptions | undefined,
+  ) => {
+    name: string;
+    setup: () => void;
+  }
+>;
+
 export interface CodeGeniusOptions {
-  plugins?: Array<
-    (cli: CAC) => {
-      name: string;
-      setup: () => void;
-    }
-  >;
   commands?: {
     commit?: CommitOptions;
     clear?: ClearOptions;
