refactor(@142vip/utils): 代码改造，简化类型声明，调整工具核心工具方法

Author: mmdapl

packages/eslint-config/src/eslint.config.ts

@@ -1,7 +1,4 @@
-import type {
-  OptionsConfig,
-  TypedFlatConfigItem,
-} from '@antfu/eslint-config'
+import type { OptionsConfig, TypedFlatConfigItem } from '@antfu/eslint-config'
 import { antfu } from '@antfu/eslint-config'
 
 /**
@@ -37,11 +34,10 @@ type EslintConfigOptions = OptionsConfig & TypedFlatConfigItem
 /**
  * 定义Eslint配置
  * 参考：https://github.com/antfu/eslint-config
- * @param options
  */
-export async function defineVipEslintConfig(
+export function defineVipEslintConfig(
   options: EslintConfigOptions = {},
-): Promise<any> {
+): any {
   return antfu(defaultEslintConfig, {
     ...options,
     rules: {

packages/utils/src/constants.ts

@@ -1,4 +1,5 @@
-import process from 'node:process'
+import { VipNodeJS } from './core'
+
 /**
  * 一些地址信息
  */
@@ -51,7 +52,7 @@ export const OPEN_SOURCE_AUTHOR = {
  * @param baseName
  */
 export function getDocSiteBase(baseName: string): '/' | `/${string}/` {
-  const needProxy = process.env.NEED_PROXY ?? false
+  const needProxy = VipNodeJS.getProcessEnv('NEED_PROXY') ?? false
 
   return needProxy ? `/${baseName}/` : '/'
 }

packages/utils/src/core/docker.ts

@@ -1,7 +1,9 @@
-import * as process from 'node:process'
-import { VipSymbols } from '../pkgs/color'
-import { commandStandardExecutor, execCommand } from './exec'
-import { VipLogger } from './logger'
+import {
+  VipExecutor,
+  VipLogger,
+  VipNodeJS,
+  VipSymbols,
+} from '@142vip/utils'
 
 const vipLog = new VipLogger()
 
@@ -24,15 +26,15 @@ interface BuildImageDockerOptions extends DockerOptions {
  */
 async function scriptExecutor(command: string) {
   try {
-    const errorCode = await commandStandardExecutor(command)
+    const errorCode = await VipExecutor.commandStandardExecutor(command)
     if (errorCode !== 0) {
       vipLog.error(`Error Code: ${errorCode}`, { startLabel: 'commandStandardExecutor' })
-      process.exit(1)
+      VipNodeJS.exitProcess(1)
     }
   }
   catch {
     // 构建镜像出错时，直接退出
-    process.exit(1)
+    VipNodeJS.exitProcess(1)
   }
 }
 
@@ -41,7 +43,7 @@ async function scriptExecutor(command: string) {
  */
 async function isExistImage(imageName: string) {
   const command = `docker images -q ${imageName}`
-  const { code, stdout } = await execCommand(command)
+  const { code, stdout } = await VipExecutor.execCommand(command)
   return code === 0 && stdout.trim() !== ''
 }
 
@@ -50,23 +52,23 @@ async function isExistImage(imageName: string) {
  */
 async function deleteImage(imageName: string) {
   const command = `docker rmi -f ${imageName}`
-  return await execCommand(command)
+  return await VipExecutor.execCommand(command)
 }
 
 /**
  * 删除虚悬镜像
  */
 async function deletePruneImages() {
   const command = 'docker image prune -f'
-  return await execCommand(command)
+  return await VipExecutor.execCommand(command)
 }
 
 /**
  * 判断容器是否存在
  */
 async function isExistContainer(containerName: string) {
   const command = `docker ps -aq -f name=${containerName}`
-  const { code, stdout } = await execCommand(command)
+  const { code, stdout } = await VipExecutor.execCommand(command)
 
   return code === 0 && stdout.trim() !== ''
 }
@@ -76,15 +78,15 @@ async function isExistContainer(containerName: string) {
  */
 async function deleteContainer(containerName: string) {
   const command = `docker rm -f ${containerName}`
-  return await execCommand(command)
+  return await VipExecutor.execCommand(command)
 }
 
 /**
  * 是否安装docker
  */
 async function isExistDocker(args?: DockerOptions) {
   const command = 'docker -v'
-  const { code, stdout, stderr } = await execCommand(command)
+  const { code, stdout, stderr } = await VipExecutor.execCommand(command)
 
   // 打印日志
   if (args?.logger) {
@@ -106,7 +108,7 @@ async function isExistDocker(args?: DockerOptions) {
  */
 async function isExistDockerCompose(args?: DockerOptions) {
   const command = 'docker-compose -v'
-  const { code, stdout, stderr } = await execCommand(command)
+  const { code, stdout, stderr } = await VipExecutor.execCommand(command)
 
   // 打印日志
   if (args?.logger) {
@@ -196,33 +198,19 @@ interface CreateContainerOptions extends DockerOptions {
 async function createContainer(args: CreateContainerOptions) {
   if (args.networkName && !args.ip) {
     console.log('只指定ip，没有指定容器局域网')
-    process.exit(1)
+    VipNodeJS.exitProcess(1)
   }
   // 支持自定义网络
   const networkParams = args.networkName && args.ip ? `--network ${args.networkName} --ip` : ''
 
   const command = `docker run -d --name ${args.containerName} --restart=unless-stopped ${networkParams} ${args.imageName}`
-  await commandStandardExecutor(command)
-}
-
-export interface IVipDocker {
-  isExistDocker: typeof isExistDocker
-  isExistDockerCompose: typeof isExistDockerCompose
-  isExistImage: typeof isExistImage
-  isExistContainer: typeof isExistContainer
-  deleteImage: typeof deleteImage
-  deletePruneImages: typeof deletePruneImages
-  deleteContainer: typeof deleteContainer
-  pushImage: typeof pushImage
-  buildImage: typeof buildImage
-  createContainer: typeof createContainer
-  scriptExecutor: typeof scriptExecutor
+  await VipExecutor.commandStandardExecutor(command)
 }
 
 /**
  * docker工具
  */
-export const VipDocker: IVipDocker = {
+export const VipDocker = {
   isExistDocker,
   isExistDockerCompose,
   isExistImage,

packages/utils/src/core/exec.ts

@@ -1,7 +1,8 @@
 import * as childProcess from 'node:child_process'
 import { Buffer } from 'node:buffer'
-import * as process from 'node:process'
 import { execSync } from 'node:child_process'
+import { VipColor, VipConsole, VipLogger, VipNodeJS } from '@142vip/utils'
+import { name, version } from '../../package.json'
 
 type Command = string | string[]
 
@@ -13,35 +14,23 @@ export interface CmdResult {
   cmd: string
 }
 
-export interface FailedExec extends CmdResult {
-  error: Error
-}
-
-export interface SuccessfulExec extends CmdResult {
-  code: number | null
-}
-
 /**
  * 同步执行命令，并返回结果
- * @param cmd
- * @param opts
  */
-export async function execCommand(
+async function execCommand(
   cmd: Command,
   opts?: Omit<childProcess.SpawnOptionsWithoutStdio, 'stdio' | 'cwd'>,
 ): Promise<CmdResult> {
   const executable = Array.isArray(cmd) ? cmd.join(';') : cmd
   const options: childProcess.SpawnOptionsWithoutStdio = {
     ...opts,
     stdio: 'pipe',
-    cwd: process.cwd(),
+    cwd: VipNodeJS.getProcessCwd(),
   }
 
-  const { platform } = process
-
   try {
-    const cmd = platform === 'win32' ? 'cmd' : 'sh'
-    const arg = platform === 'win32' ? '/C' : '-c'
+    const cmd = VipNodeJS.getProcessPlatform() === 'win32' ? 'cmd' : 'sh'
+    const arg = VipNodeJS.getProcessPlatform() === 'win32' ? '/C' : '-c'
     const child = childProcess.spawn(cmd, [arg, executable], options)
 
     return new Promise((resolve) => {
@@ -83,29 +72,28 @@ export async function execCommand(
  * 标准Linux命令执行器
  * - 支持打印结果
  * - 异步
- * @param cmd
  */
-export function commandStandardExecutor(cmd: Command) {
+function commandStandardExecutor(cmd: Command) {
   const executable = Array.isArray(cmd) ? cmd.join('&&') : cmd
   const options: childProcess.SpawnOptionsWithoutStdio = {
     stdio: 'pipe',
-    cwd: process.cwd(),
+    cwd: VipNodeJS.getProcessCwd(),
   }
 
   return new Promise((resolve, reject) => {
-    const cmd = process.platform === 'win32' ? 'cmd' : 'sh'
-    const arg = process.platform === 'win32' ? '/C' : '-c'
+    const cmd = VipNodeJS.getProcessPlatform() === 'win32' ? 'cmd' : 'sh'
+    const arg = VipNodeJS.getProcessPlatform() === 'win32' ? '/C' : '-c'
     const child = childProcess.spawn(cmd, [arg, executable], options)
 
     child.stdout.on('data', (data: string) => {
       if (Buffer.isBuffer(data)) {
-        console.log(data.toString())
+        VipConsole.log(data.toString())
       }
     })
 
     child.stderr.on('data', (data) => {
       if (Buffer.isBuffer(data)) {
-        console.log(data.toString())
+        VipConsole.log(data.toString())
       }
     })
 
@@ -125,6 +113,56 @@ function execCommandSync(cmd: string, cwd?: string): string {
   return execSync(cmd, { encoding: 'utf8', cwd }).trim()
 }
 
+export interface ShellCommand {
+  command: string
+  description?: string
+}
+
+/**
+ * 脚本执行器，执行shell命令
+ */
+async function execShell(commands: ShellCommand[] | string | ShellCommand) {
+  // 全局日志
+  const vipLog = VipLogger.getInstance()
+
+  const projectName = VipColor.greenBright(`[${name}@${version}]`)
+
+  let runCommands: ShellCommand[] = []
+  if (typeof commands === 'string') {
+    runCommands.push({
+      command: commands,
+    })
+  }
+
+  if (typeof commands === 'object') {
+    // 批量执行
+    if (Array.isArray(commands)) {
+      runCommands = commands
+    }
+    else {
+      runCommands.push(commands)
+    }
+  }
+
+  // 批量执行
+  for (const { command, description = '脚本' } of runCommands) {
+    // 脚本命令打印
+    vipLog.log(`【${description}】${command}`, {
+      startLabel: `${projectName}执行的命令:`,
+      endLabel: '',
+    })
+
+    // 同步执行，标准命令执行器
+    await execCommand(command)
+  }
+}
+
+/**
+ * 执行器
+ */
 export const VipExecutor = {
   execCommandSync,
+  execCommand,
+  execShell,
+  commandStandardExecutor,
 }

packages/utils/src/core/git.ts

@@ -1,5 +1,4 @@
-import { VipSemver } from '../pkgs'
-import { VipExecutor } from './exec'
+import { VipExecutor, VipSemver } from '@142vip/utils'
 
 /**
  * Git提交信息
@@ -122,21 +121,7 @@ function execPush(args: string[]): void {
   VipExecutor.execCommandSync(`git push ${args.join(' ')}`)
 }
 
-export interface IVipGit {
-  getRecentCommit: typeof getRecentCommit
-  getFirstCommitHash: typeof getFirstCommitHash
-  getGitHubRepo: typeof getGitHubRepo
-  getCurrentBranch: typeof getCurrentBranch
-  isRepoShallow: typeof isRepoShallow
-  getTags: typeof getTags
-  getLastMatchingTag: typeof getLastMatchingTag
-  isPrerelease: typeof isPrerelease
-  execCommit: typeof execCommit
-  execTag: typeof execTag
-  execPush: typeof execPush
-}
-
-export const VipGit: IVipGit = {
+export const VipGit = {
   getRecentCommit,
   getFirstCommitHash,
   getGitHubRepo,

packages/utils/src/core/index.ts

@@ -3,5 +3,4 @@ export * from './logger'
 export * from './exec'
 export * from './git'
 export * from './docker'
-export * from './shell'
 export * from './package-json'

packages/utils/src/core/logger.ts

@@ -1,4 +1,4 @@
-import { VipColor } from '../pkgs/color'
+import { VipColor } from '@142vip/utils'
 
 export interface LoggerOptions {
   startLabel?: string
@@ -41,3 +41,5 @@ export class VipLogger {
     console.error(text)
   }
 }
+
+export const vipLogger = new VipLogger()

packages/utils/src/core/nodejs.ts

@@ -102,28 +102,7 @@ async function writeFileByUTF8(filePath: PathLike | FileHandle, data:
   return promises.writeFile(filePath, data, 'utf-8')
 }
 
-export interface IVipNodeJS {
-  // process
-  getProcessFirstArgv: typeof getProcessFirstArgv
-  getProcessArgv: typeof getProcessArgv
-  getCPUArch: typeof getCPUArch
-  setProcessEnv: typeof setProcessEnv
-  getProcessEnv: typeof getProcessEnv
-  getProcessPlatform: typeof getProcessPlatform
-  getProcessCwd: typeof getProcessCwd
-  getProcessVersions: typeof getProcessVersions
-  exitProcess: typeof exitProcess
-
-  // fs
-  exitPath: typeof exitPath
-  readFileToStrByUTF8: typeof readFileToStrByUTF8
-  writeFileByUTF8: typeof writeFileByUTF8
-
-  // path
-  pathJoin: typeof pathJoin
-}
-
-export const VipNodeJS: IVipNodeJS = {
+export const VipNodeJS = {
   getProcessFirstArgv,
   getProcessArgv,
   getCPUArch,