🔧 chore(app): 尝试通过配置文件的方式支持自定义使用

Author: OSpoon

.eslintignore

@@ -1,3 +1,4 @@
 .release-it.js
 build.config.ts
-./templates/
+./templates/
+dist

src/command/git-commit.ts

@@ -2,21 +2,38 @@ import type { CAC } from "cac";
 import enquirer from "enquirer";
 
 import { ACTIVATION, gitCommitScopes, gitCommitTypes } from "@/config";
-import { execCommand, loggerInfo } from "@/helper";
+import { execCommand, loadConfigModule, loggerInfo } from "@/helper";
 import { GitCommitOptions } from "@/types";
 
+const mergeConfig = async () => {
+  const config = await loadConfigModule();
+  const commands = config && config?.commands;
+  if (commands && commands.commit) {
+    const { gitCommitTypes: types, gitCommitScopes: scopes } = commands.commit;
+    return {
+      types: types && types.length > 0 ? types : gitCommitTypes,
+      scopes: scopes && scopes.length > 0 ? scopes : gitCommitScopes,
+    };
+  }
+  return {
+    types: gitCommitTypes,
+    scopes: gitCommitScopes,
+  };
+};
+
 const generateEnquirer = async (): Promise<
   Pick<GitCommitOptions, Exclude<keyof GitCommitOptions, "emoji">>
 > => {
-  const typesChoices = gitCommitTypes.map(({ emoji, code, description }) => {
+  const { types, scopes } = await mergeConfig();
+  const typesChoices = types.map(({ emoji, code, description }) => {
     const formatCode = `${code}:`.padEnd(20);
     return {
       name: `${emoji} ${code}`,
       message: `${emoji}${formatCode}${description}`,
     };
   });
 
-  const scopesChoices = gitCommitScopes.map(({ name, description }) => {
+  const scopesChoices = scopes.map(({ name, description }) => {
     const formatName = `${name}:`.padEnd(20);
     return {
       name,

src/config.ts

@@ -271,3 +271,12 @@ export const commands = [
     description: "查看 CodeGenius 版本信息",
   },
 ];
+
+export const DEFAULT_CONFIG_FILES = [
+  "codeg.config.js",
+  "codeg.config.mjs",
+  "codeg.config.ts",
+  "codeg.config.mts",
+  "codeg.config.cjs",
+  "codeg.config.cts",
+];

src/helper.ts

@@ -9,7 +9,12 @@ import execa from "execa";
 import fsExtra from "fs-extra";
 import { gray, green, red, yellow } from "kolorist";
 
-import { ACTIVATION, FRAMEWORKS, TEMPLATES } from "@/config";
+import {
+  ACTIVATION,
+  DEFAULT_CONFIG_FILES,
+  FRAMEWORKS,
+  TEMPLATES,
+} from "@/config";
 
 import { CodeGeniusOptions, CommandOptions } from "./types";
 
@@ -294,8 +299,10 @@ export const defineConfig = (config: CodeGeniusOptions): CodeGeniusOptions =>
 
 export async function cmdInstaller(cli: CAC, config: CodeGeniusOptions) {
   const { plugins } = config;
-  for (const plugin of plugins) {
-    plugin(cli).setup();
+  if (plugins) {
+    for (const plugin of plugins) {
+      plugin(cli).setup();
+    }
   }
 }
 
@@ -358,3 +365,19 @@ export const generateScripts = async () => {
   );
   printInfo("代理脚本 scripts.config.json 已完成同步");
 };
+
+export async function loadConfigModule(): Promise<
+  CodeGeniusOptions | undefined
+> {
+  let resolvedPath: string | undefined;
+  for (const filename of DEFAULT_CONFIG_FILES) {
+    const filePath = path.resolve(process.cwd(), filename);
+    if (!fs.existsSync(filePath)) continue;
+    resolvedPath = filePath;
+    break;
+  }
+
+  if (!resolvedPath) return;
+
+  return (await import(resolvedPath)).default;
+}

src/index.ts

@@ -50,11 +50,12 @@ const config = defineConfig({
   ],
 });
 
+export { config, defineConfig };
+
 export {
   checkGitUserEmail,
   checkGitUserName,
   clear,
-  config,
   createProject,
   eslintFix,
   gitCommit,

src/types.ts

@@ -54,13 +54,77 @@ export interface GitUserOptions {
   ruleEmail?: string;
 }
 
+export interface CommitOptions {
+  gitCommitTypes?: Array<CommitType>;
+  gitCommitScopes?: Array<CommitScope>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface VerifyOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ClearOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface HooksOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface DepcheckOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface RegistryOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface GituserOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface TemplateOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface FixOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface FormatOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ImpsortOptions {
+  // TODO
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ScriptOptions {
+  // TODO
+}
+
 export interface CodeGeniusOptions {
-  plugins: Array<
+  plugins?: Array<
     (cli: CAC) => {
       name: string;
       setup: () => void;
     }
   >;
+  commands?: {
+    commit?: CommitOptions;
+    verify?: VerifyOptions;
+    clear?: ClearOptions;
+    hooks?: HooksOptions;
+    depcheck?: DepcheckOptions;
+    registry?: RegistryOptions;
+    gituser?: GituserOptions;
+    template?: TemplateOptions;
+    fix?: FixOptions;
+    format?: FormatOptions;
+    impsort?: ImpsortOptions;
+    script?: ScriptOptions;
+  };
 }
 
 export interface GitCommitOptions {