feat(@142vip/fairy-cli): 拓展install、clean、changelog等命令

Author: mmdapl

packages/fairy-cli/src/commands/changelog.ts

@@ -10,6 +10,10 @@ async function generateChangelog(args: ChangelogOptions): Promise<void> {
   await VipExecutor.commandStandardExecutor(`npx changelog ${args.dry ? '--dry' : ''}`)
 }
 
+/**
+ * changelog命令
+ * - 生成CHANGELOG文档
+ */
 export async function changelogMain(program: VipCommander): Promise<void> {
   program
     .command(CliCommandEnum.CHANGELOG)

packages/fairy-cli/src/commands/clean.ts

@@ -1,5 +1,5 @@
 import type { VipCommander } from '@142vip/utils'
-import { VipInquirer, VipNodeJS } from '@142vip/utils'
+import { VipColor, VipConsole, VipInquirer, vipLogger, VipNodeJS } from '@142vip/utils'
 import { deleteAsync } from 'del'
 import { CliCommandEnum } from '../shared'
 
@@ -10,6 +10,7 @@ interface DelOptions {
   dryRun?: boolean
   force?: boolean
   all?: boolean
+  logger?: boolean
 }
 
 interface CleanUpOptions extends DelOptions {
@@ -24,6 +25,28 @@ interface CleanUpOptions extends DelOptions {
   gitHooks?: boolean
 }
 
+function generateDirPatterns(dirName: string | string[], delAll?: boolean): string[] {
+  let delDirs: string[] = []
+
+  if (typeof dirName === 'string') {
+    delDirs.push(dirName)
+  }
+  else {
+    delDirs.push(...dirName)
+  }
+
+  if (delAll) {
+    // 删除程序上下文中所有的该目录，注意路径取反规则
+    delDirs = delDirs.map(dir => dir.startsWith('!') ? `!**/${dir.substring(1)}` : `**/${dir}`)
+  }
+  else {
+    // 只删除该目录
+    delDirs = delDirs.map(dir => `${dir}`)
+  }
+
+  return delDirs
+}
+
 /**
  * 删除文件或文件夹
  * - 恢复项目初始状态
@@ -72,52 +95,34 @@ async function execCleanUp(args: CleanUpOptions): Promise<void> {
   }
 
   if (dirPatterns.length === 0) {
-    console.log('删除规则为空，不做删除操作处理，请传入有效参数！！')
+    vipLogger.log(VipColor.red('删除规则为空，不做删除操作处理，请传入有效参数！！'))
     return VipNodeJS.exitProcess(1)
   }
 
   // 删除前，对话框确认
   if (!args.ignoreTips) {
     const deleted = await VipInquirer.promptConfirm('是否需要删除?', true)
 
+    // 不删除，非0退出
     if (!deleted) {
-      // 不删除，非0退出
       return VipNodeJS.exitProcess(1)
     }
   }
 
-  // 需要删除的目录
-  console.log('删除规则：', dirPatterns)
-
   // 删除
   const deletedDirs = await deleteAsync(dirPatterns, {
     dryRun: args.dryRun,
     force: args.force,
     dot: true,
   })
-  console.log(deletedDirs)
-}
-
-function generateDirPatterns(dirName: string | string[], delAll?: boolean): string[] {
-  let delDirs: string[] = []
 
-  if (typeof dirName === 'string') {
-    delDirs.push(dirName)
+  // 日志追踪
+  if (args.logger) {
+    // 需要删除的目录
+    VipConsole.trace('删除规则：', dirPatterns)
+    vipLogger.println()
+    VipConsole.trace('删除的文件和目录：', deletedDirs)
   }
-  else {
-    delDirs.push(...dirName)
-  }
-
-  if (delAll) {
-    // 删除程序上下文中所有的该目录，注意路径取反规则
-    delDirs = delDirs.map(dir => dir.startsWith('!') ? `!**/${dir.substring(1)}` : `**/${dir}`)
-  }
-  else {
-    // 只删除该目录
-    delDirs = delDirs.map(dir => `${dir}`)
-  }
-
-  return delDirs
 }
 
 /**
@@ -126,18 +131,19 @@ function generateDirPatterns(dirName: string | string[], delAll?: boolean): stri
 export async function cleanUpMain(program: VipCommander): Promise<void> {
   program
     .command(CliCommandEnum.CLEAN)
-    .description('清除开发、构建等环境下的无用目录')
+    .description('清除开发、构建环境下产生的无用文件')
     .option('-n,--nuxt', '删除nuxt构建目录，包括.nuxt、.output目录', false)
     .option('-d,--dist', '删除dist目录', false)
     .option('-m,--midway', '删除midway构建目录', false)
-    .option('--turbo', '删除turbo缓存目录', false)
+    .option('-t,--turbo', '删除turbo缓存目录', false)
     .option('--vite', '删除vite缓存目录', false)
     .option('--deps', '删除node_modules目录', false)
-    .option('--coverage', '删除coverage目录', false)
+    .option('-c,--coverage', '删除coverage目录', false)
     .option('--git-hooks', '删除.git/hooks目录', false)
     .option('-f,--force', '强制删除，默认值：false', false)
-    .option('--all', '深度删除所有', false)
+    .option('-a,--all', '深度删除所有', false)
     .option('--ignore-tips', '忽略提示，直接删除', false)
+    .option('--logger', '开启日志追踪模式', false)
     .option('--dry-run', '试运行，不做实际删除操作', false)
     .action(async (args: CleanUpOptions) => {
       await execCleanUp(args)

packages/fairy-cli/src/commands/install.ts

@@ -1,46 +1,50 @@
 import type { VipCommander } from '@142vip/utils'
-import { VipExecutor } from '@142vip/utils'
+import { RegistryAddressEnum, VipInquirer, VipNpm } from '@142vip/utils'
 import { CliCommandEnum } from '../shared'
 
 interface InstallOptions {
-  pnpm: boolean
-  npm: boolean
   registry?: string
-  update: boolean
+  force?: boolean
+}
+/**
+ * 支持的依赖管理器
+ */
+enum InstallTypeEnum {
+  NPM = 'npm',
+  PNPM = 'pnpm',
 }
 
 /**
  * 依赖下载
  * - npm
  * - pnpm
  */
-async function execInstall(args: InstallOptions): Promise<void> {
-  // pnpm i --frozen-lockfile --registry https://registry.npmmirror.com
-  // npm ci
-  if (args.npm) {
-    // 使用npm下载
-    await VipExecutor.commandStandardExecutor(`npm ${args.update ? 'i' : 'ci'} --registry  ${args.registry}`)
+async function execInstall(installType: InstallTypeEnum, args: InstallOptions): Promise<void> {
+  if (installType === InstallTypeEnum.NPM) {
+    await VipNpm.installByNpm({ force: args.force, registry: args.registry })
   }
-  else {
-    // pnpm下载
-    await VipExecutor.commandStandardExecutor(`pnpm i ${args.update ? '' : '--frozen-lockfile'} --registry ${args.registry}`)
+  if (installType === InstallTypeEnum.PNPM) {
+    await VipNpm.installByPnpm({ force: args.force, registry: args.registry })
   }
 }
 
 /**
  * install 命令入口
- * @param program
  */
 export async function installMain(program: VipCommander): Promise<void> {
   program
     .command(CliCommandEnum.INSTALL)
     .aliases(['i', 'add'])
-    .description('pnpm ci dependencies')
-    .option('--pnpm', 'use pnpm ', true)
-    .option('--npm', 'use npm', false)
-    .option('--update', 'update lockfile，not use --frozen-lockfile', false)
-    .option('--registry', 'pnpm registry address，default ali cdn', 'https://registry.npmmirror.com')
-    .action((args: InstallOptions) => {
-      execInstall(args)
+    .description('下载、升级依赖版本')
+    .option('-f,--force', 'force the lock file to be updated', false)
+    .option('--registry', `pnpm registry address，default ali npm：${RegistryAddressEnum.VIP_NPM_ALIBABA}`, RegistryAddressEnum.VIP_NPM_ALIBABA)
+    .action(async (args: InstallOptions) => {
+      const installType = await VipInquirer.promptSelect<InstallTypeEnum>('选择下载方式', [
+        InstallTypeEnum.PNPM,
+        InstallTypeEnum.NPM,
+      ], {
+        default: InstallTypeEnum.PNPM,
+      })
+      await execInstall(installType, args)
     })
 }

packages/fairy-cli/src/index.ts

@@ -1,2 +1 @@
-export * from './fairy-cli'
 export * from './shared'