refactor(@142vip/fairy-cli): 基于VipCommander的initCommand方法，重写fairy工具链 (#494)

mmdapl · web-flow · commit 2ea95c51226f · 2025-04-22T10:37:23.000+08:00
diff --git a/packages/fairy-cli/src/commands/changelog.ts b/packages/fairy-cli/src/commands/changelog.ts
@@ -1,6 +1,6 @@
 import type { VipCommander } from '@142vip/utils'
 import { VipExecutor } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface ChangelogOptions {
   dryRun?: boolean
@@ -19,8 +19,8 @@ async function generateChangelog(args: ChangelogOptions): Promise<void> {
  * - 生成CHANGELOG文档
  */
 export async function changelogMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.CHANGELOG)
-    .option('--dry-run', '试运行，生成`CHANGELOG`文档', false)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.CHANGELOG])
     .action(async (args: ChangelogOptions): Promise<void> => {
       await generateChangelog(args)
     })
diff --git a/packages/fairy-cli/src/commands/clean.ts b/packages/fairy-cli/src/commands/clean.ts
@@ -1,7 +1,13 @@
 import type { VipCommander } from '@142vip/utils'
-import { VipColor, VipConsole, VipInquirer, vipLogger, VipNodeJS } from '@142vip/utils'
+import {
+  VipColor,
+  VipConsole,
+  VipInquirer,
+  vipLogger,
+  VipNodeJS,
+} from '@142vip/utils'
 import { deleteAsync } from 'del'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 /**
  * 删除配置
@@ -129,7 +135,8 @@ async function execCleanUp(args: CleanUpOptions): Promise<void> {
  * fairy-cli clean 项目清理
  */
 export async function cleanUpMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.CLEAN)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.CLEAN])
     .option('-n,--nuxt', '删除nuxt构建目录，包括.nuxt、.output目录', false)
     .option('-d,--dist', '删除dist目录', false)
     .option('-m,--midway', '删除midway构建目录', false)
@@ -141,8 +148,6 @@ export async function cleanUpMain(program: VipCommander): Promise<void> {
     .option('-f,--force', '强制删除，默认值：false', false)
     .option('-a,--all', '深度删除所有', false)
     .option('--ignore-tips', '忽略提示，直接删除', false)
-    .option('--logger', '开启日志追踪模式', false)
-    .option('--dry-run', '试运行，不做实际删除操作', false)
     .action(async (args: CleanUpOptions): Promise<void> => {
       await execCleanUp(args)
     })
diff --git a/packages/fairy-cli/src/commands/commit.ts b/packages/fairy-cli/src/commands/commit.ts
@@ -14,7 +14,7 @@ import {
   VipMonorepo,
   VipNodeJS,
 } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 const GIT_NULL_SCOPE = '没有范围，那就选这个！！！'
 
@@ -39,9 +39,8 @@ interface CommitOptions {
  * - 基于@142vip/commit-linter
  */
 export async function commitMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.COMMIT)
-    .option('--dry-run', '试运行，Git Commit 提交信息', false)
-    .option('--vip', '@142vip组织专用功能', false)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.COMMIT])
     .option('--push', '是否要推送到远程', false)
     .action(async (vip, args: CommitOptions): Promise<void> => {
       if (vip) {
diff --git a/packages/fairy-cli/src/commands/copyright.ts b/packages/fairy-cli/src/commands/copyright.ts
@@ -1,7 +1,7 @@
 import type { VipCommander } from '@142vip/utils'
 import { CopyrightFileType, VipCopyright } from '@142vip/copyright'
 import { VipColor, VipConsole, VipInquirer, vipLogger, VipNodeJS } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface CopyrightOptions {
   maxLineCount: number
@@ -15,11 +15,10 @@ interface CopyrightOptions {
  * - 参考 @142vip/copyright模块
  */
 export async function copyrightMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.COPYRIGHT)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.COPYRIGHT])
     .option('-l,--max-line-count', '每页最大行数', value => Number.parseInt(value), 50)
     .option('-s,--max-source-count', '扫描的最大代码行数', value => Number.parseInt(value), 2000)
-    .option('--logger', '开启日志追踪模式', true)
-    .option('--dry-run', '试运行，生成软著源代码文档', false)
     .action(async (args: CopyrightOptions): Promise<void> => {
       const copyrightTitle = await VipInquirer.promptInputRequired('申请著作权登记的软件的全称：')
       const copyrightVersion = await VipInquirer.promptInputRequired('申请著作权登记的软件的版本号：')
diff --git a/packages/fairy-cli/src/commands/deploy.ts b/packages/fairy-cli/src/commands/deploy.ts
@@ -1,6 +1,6 @@
 import type { VipCommander } from '@142vip/utils'
 import { VipConsole } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface DeployOptions {
   githubPage: boolean
@@ -19,7 +19,8 @@ function DeployGithubPage() {}
  * deploy命令
  */
 export async function deployMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.DEPLOY)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.DEPLOY])
     .option('-gh,--github-page', '部署到Github Pages', false)
     .action((args: DeployOptions) => {
       execDeploy(args)
diff --git a/packages/fairy-cli/src/commands/install.ts b/packages/fairy-cli/src/commands/install.ts
@@ -1,6 +1,6 @@
 import type { VipCommander } from '@142vip/utils'
 import { RegistryAddressEnum, VipInquirer, VipNpm } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface InstallOptions {
   registry?: string
@@ -32,7 +32,8 @@ async function execInstall(installType: InstallTypeEnum, args: InstallOptions):
  * install 命令入口
  */
 export async function installMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.INSTALL)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.INSTALL])
     .option('-f,--force', '强制lock文件更新', false)
     .option('--registry', `NPM模块的源地址，默认：${RegistryAddressEnum.VIP_NPM_ALIBABA}`, RegistryAddressEnum.VIP_NPM_ALIBABA)
     .action(async (args: InstallOptions): Promise<void> => {
diff --git a/packages/fairy-cli/src/commands/lint.ts b/packages/fairy-cli/src/commands/lint.ts
@@ -1,6 +1,6 @@
 import type { VipCommander } from '@142vip/utils'
 import { VipExecutor } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface LintOptions {
   fix: boolean
@@ -19,7 +19,8 @@ async function execLint(args: LintOptions): Promise<void> {
  * - 参考：eslint-config模块
  */
 export async function lintMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.LINT)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.LINT])
     .option('-c,--config', 'Eslint配置文件路径', false)
     .option('-f,--fix', '是否需要基于Eslint规则自动修复', false)
     .action(async (args: LintOptions) => {
diff --git a/packages/fairy-cli/src/commands/login.ts b/packages/fairy-cli/src/commands/login.ts
@@ -1,6 +1,6 @@
 import type { VipCommander } from '@142vip/utils'
 import { VipColor, VipConsole, VipDocker, VipInquirer, vipLogger } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 enum LoginPlatformEnum {
   DOCKER = 'DOCKER',
@@ -48,7 +48,8 @@ async function loginNpm(): Promise<void> {
  * - npx fa login
  */
 export async function loginMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.LOGIN)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.LOGIN])
     .action(async () => {
       const loginType = await VipInquirer.promptSelect('选择需要登录的平台：', Object.values(LoginPlatformEnum))
       if (loginType === LoginPlatformEnum.DOCKER) {
diff --git a/packages/fairy-cli/src/commands/publish.ts b/packages/fairy-cli/src/commands/publish.ts
@@ -7,7 +7,7 @@ import {
   VipInquirer,
   vipLogger,
 } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface PublishOptions {
   registry?: string
@@ -41,9 +41,9 @@ async function publishNpm(args: PublishOptions): Promise<void> {
  * - npx fa publish
  */
 export async function publishMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.PUBLISH)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.PUBLISH])
     .option('-r,--registry', `NPM包的仓库地址，默认: ${RegistryAddressEnum.NPM}`, RegistryAddressEnum.NPM)
-    .option('-dry,--dry-run', '试运行，不会进行发布', false)
     .action(async (args: PublishOptions): Promise<void> => {
       await publishNpm(args)
     })
diff --git a/packages/fairy-cli/src/commands/release.ts b/packages/fairy-cli/src/commands/release.ts
@@ -1,6 +1,11 @@
 import type { VersionBumpOptions } from '@142vip/release-version'
 import type { VipCommander } from '@142vip/utils'
-import { printPreCheckRelease, releaseMonorepoPkg, releaseRoot } from '@142vip/fairy-cli'
+import {
+  CLI_COMMAND_DETAIL,
+  printPreCheckRelease,
+  releaseMonorepoPkg,
+  releaseRoot,
+} from '@142vip/fairy-cli'
 import { versionBump } from '@142vip/release-version'
 import {
   DEFAULT_RELEASE_ROOT_NAME,
@@ -14,7 +19,7 @@ import {
   VipPackageJSON,
 } from '@142vip/utils'
 import { name } from '../../package.json'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CommandEnum } from '../enums'
 
 interface ReleaseOptions extends Pick<VersionBumpOptions, 'preid' | 'tag' | 'commit' | 'push' | 'all' | 'execute'> {
   package?: string
@@ -47,7 +52,6 @@ async function execNormalRelease(args: ReleaseOptions): Promise<void> {
 
   // 指定文件更新版本
   await versionBump({
-    files: [],
     ...args.preid ? { preid: args.preid } : { perid: 'alpha' },
     // 是否需要标记
     ...args.tag ? { tag: args.tag } : {},
@@ -99,7 +103,8 @@ async function execVipRelease(args: VipReleaseExtraOptions): Promise<void> {
  * 功能迭代主功能
  */
 export async function releaseMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.RELEASE)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.RELEASE])
     .option('--push', '推送到Git远程', true)
     .option('--preid <preid>', 'ID for prerelease')
     .option('--commit <msg>', '提交信息', false)
@@ -110,7 +115,6 @@ export async function releaseMain(program: VipCommander): Promise<void> {
     .option('--package <package>', '指定需要发布的包')
     .option('--branch <branch>', '指定分支进行发布', 'next')
     .option('--check-release', '发布仓库主版本时，校验Monorepo中子模块版本', false)
-    .option('--vip', '@142vip组织专用功能', false)
     .option('-F, --filter <filter>', '模块的路径，例如："./package/*"', (value: string, previous: string[]) => {
       if (!value)
         return [value]
diff --git a/packages/fairy-cli/src/commands/sync.ts b/packages/fairy-cli/src/commands/sync.ts
@@ -9,7 +9,7 @@ import {
   VipNodeJS,
 } from '@142vip/utils'
 import fetch from 'node-fetch'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 /**
  * cnpm 同步状态
@@ -137,9 +137,9 @@ async function searchNpmPkgOnline(input: string | undefined, options: { signal:
  * sync命令入口
  */
 export async function syncMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.SYNC)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.SYNC])
     .argument('[packageName]', '需要同步的模块包名称')
-    .option('--vip', '142vip业务专用', false)
     .action(async (packageName: string | undefined, options): Promise<void> => {
       // 142vip本地业务
       if (packageName == null && options.vip) {
diff --git a/packages/fairy-cli/src/commands/turbopack.ts b/packages/fairy-cli/src/commands/turbopack.ts
@@ -1,6 +1,14 @@
 import type { VipCommander } from '@142vip/utils'
-import { VipColor, VipConsole, VipExecutor, VipInquirer, vipLogger, VipNodeJS, VipNpm } from '@142vip/utils'
-import { CommandEnum, initFairyCliCommand } from '../enums'
+import {
+  VipColor,
+  VipConsole,
+  VipExecutor,
+  VipInquirer,
+  vipLogger,
+  VipNodeJS,
+  VipNpm,
+} from '@142vip/utils'
+import { CLI_COMMAND_DETAIL, CommandEnum } from '../enums'
 
 interface TurboPackOptions {
   mode?: string
@@ -48,7 +56,8 @@ function getFilterRepo(repoNames: string[]): string {
  * - npx fa turbo --build
  */
 export async function turboPackMain(program: VipCommander): Promise<void> {
-  initFairyCliCommand(program, CommandEnum.TURBO)
+  program
+    .initCommand(CLI_COMMAND_DETAIL[CommandEnum.TURBO])
     .argument('[filters...]', '过滤器规则，参考：<https://turbo.build/repo/docs/crafting-your-repository/running-tasks#using-filters>')
     .option('-m,--mode', `命令的支持的模式`)
     .action(async (filters: string[], args: TurboPackOptions) => {
diff --git a/packages/fairy-cli/src/enums/command.enum.ts b/packages/fairy-cli/src/enums/command.enum.ts
@@ -1,4 +1,4 @@
-import type { VipCommander } from '@142vip/utils'
+import type { VipCommanderDetailRecord } from '@142vip/utils'
 
 export enum CommandEnum {
   LOGIN = 'login',
@@ -15,7 +15,7 @@ export enum CommandEnum {
   COMMIT = 'commit',
 }
 
-export const CliCommandDetail = {
+export const CLI_COMMAND_DETAIL: VipCommanderDetailRecord<CommandEnum> = {
   [CommandEnum.LOGIN]: {
     command: 'login',
     summary: '登录平台',
@@ -89,15 +89,3 @@ export const CliCommandDetail = {
     aliases: ['co', 'com'],
   },
 }
-
-/**
- * cli命令初始化
- */
-export function initFairyCliCommand(program: VipCommander, commandEnum: CommandEnum): VipCommander {
-  const { command, aliases, summary, description } = CliCommandDetail[commandEnum]
-  // 初始化命令
-  return program.command(command)
-    .aliases(aliases)
-    .summary(summary)
-    .description(description)
-}
diff --git a/packages/fairy-cli/src/enums/command.interface.ts b/packages/fairy-cli/src/enums/command.interface.ts
@@ -1,16 +1,3 @@
-export interface FairyCommandOptions {
-  /**
-   * 试运行
-   */
-  dryRun?: boolean
+import type { VipCommanderOptions } from '@142vip/utils'
 
-  /**
-   * 142vip 组织专用功能，用户标记是否用于142vip组织的项目
-   */
-  vip?: boolean
-
-  /**
-   * 是否开启日志追踪模式，打印重要执行日志
-   */
-  logger?: boolean
-}
+export interface FairyCommandOptions extends Omit<VipCommanderOptions, 'help'> {}
diff --git a/packages/fairy-cli/src/fairy-cli.ts b/packages/fairy-cli/src/fairy-cli.ts
@@ -57,5 +57,5 @@ export async function fairyCliMain(): Promise<void> {
   await commitMain(program)
 
   // 参数解析
-  program.parse(VipNodeJS.getProcessArgv())
+  await program.parseAsync(VipNodeJS.getProcessArgv())
 }
