@liuli-util/cli 3.17.2 → 3.18.0

package/dist/commands/deploy/DeployService.d.ts

@@ -22,11 +22,11 @@ export interface BaseDeployOptions {
     debug: boolean;
     type: DeployTypeEnum;
 }
-export declare type SftpDeployOptions = Omit<BaseDeployOptions, 'type'> & {
+export interface SftpDeployOptions extends Omit<BaseDeployOptions, 'type'> {
+    dist: string;
     dest: string;
-    remote: string;
     sshConfig: ConnectOptions;
-};
+}
 /**
  * sftp 集成到远端
  */
@@ -36,10 +36,28 @@ export declare class SftpDeployService implements IDeployService {
     deploy(): EventExtPromise<void, DeployEvents>;
     validate(): [isValidate: boolean, errorText: string];
 }
-export declare type GhPagesDeployOptions = Omit<BaseDeployOptions, 'type'> & {
-    dest: string;
-    remote: string;
-};
+export interface GhPagesDeployOptions extends Omit<BaseDeployOptions, 'type'> {
+    /**
+     * 推送的本地目录
+     */
+    dist: string;
+    /**
+     * 推送的远端目录，默认为分支根目录
+     */
+    dest?: string;
+    /**
+     * 推送的项目 git 地址，默认为当前项目
+     */
+    repo?: string;
+    /**
+     * 推送的远端，默认为 origin
+     */
+    remote?: string;
+    /**
+     * 远端分支名，默认为 gh-pages
+     */
+    branch?: string;
+}
 /**
  * 将本地静态资源推送到 gh-pages 远端
  */

package/dist/commands/deploy/DeployService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DeployService.d.ts","sourceRoot":"","sources":["../../../src/commands/deploy/DeployService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAe,MAAM,oBAAoB,CAAA;AACjE,OAAe,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAUzD,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B;AAgBD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;IACpD;;OAEG;IACH,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;CAC9C;AAED,oBAAY,cAAc;IACxB,OAAO,aAAa;IACpB,IAAI,SAAS;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,OAAO,CAAA;IACd,IAAI,EAAE,cAAc,CAAA;CACrB;AAED,oBAAY,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,GAAG;IAChE,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,cAAc,CAAA;CAC1B,CAAA;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,iBAAiB;IAEvD,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC;IAc7C,QAAQ,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC;CAqBrD;AAED,oBAAY,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,GAAG;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,cAAc;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,oBAAoB;IAE1D,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC;IAgD7C,QAAQ,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC;CAclD"}
+{"version":3,"file":"DeployService.d.ts","sourceRoot":"","sources":["../../../src/commands/deploy/DeployService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAe,MAAM,oBAAoB,CAAA;AACjE,OAAe,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAWzD,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;IACpD;;OAEG;IACH,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;CAC9C;AAED,oBAAY,cAAc;IACxB,OAAO,aAAa;IACpB,IAAI,SAAS;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,OAAO,CAAA;IACd,IAAI,EAAE,cAAc,CAAA;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,cAAc,CAAA;CAC1B;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,iBAAiB;IAEvD,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC;IAc7C,QAAQ,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC;CAsBrD;AAED,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAC3E;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,cAAc;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,oBAAoB;IAE1D,MAAM,IAAI,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC;IA8E7C,QAAQ,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC;CAkBlD"}

package/dist/commands/deploy/util/validate.d.ts

@@ -0,0 +1,8 @@
+import { JSONSchemaType } from 'ajv';
+/**
+ * 使用 ajv 校验数据
+ * @param schema json 模式配置
+ * @param data 校验的数据
+ */
+export declare function validate<T>(schema: JSONSchemaType<T>, data: T): [isValid: boolean, errorText: string];
+//# sourceMappingURL=validate.d.ts.map

package/dist/commands/deploy/util/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../../src/commands/deploy/util/validate.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AAIzC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAQrG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liuli-util/cli",
-  "version": "3.17.2",
+  "version": "3.18.0",
   "description": "一个针对于库和 CLI 应用程序打包的零配置 CLI",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -25,6 +25,7 @@
     "@liuli-util/eslint-config-ts": "^0.2.0",
     "@liuli-util/prettier-standard-config": "^0.1.0",
     "ajv": "^8.8.2",
+    "ajv-formats": "^2.1.1",
     "ajv-i18n": "^4.2.0",
     "chokidar": "^3.5.2",
     "commander": "^8.2.0",
@@ -69,5 +70,5 @@
     "dev": "esno src/bin.ts build cli -w",
     "start": "esno src/bin.ts"
   },
-  "readme": "# @liuli-util/cli\r\n\r\n一个针对于库和 CLI 应用程序打包的零配置 CLI。\r\n\r\n## 起步\r\n\r\n### 安装\r\n\r\n```sh\r\nyarn add -D @liuli-util/cli # 局部安装\r\nnpm i -g @liuli-util/cli # 全局安装\r\n```\r\n\r\n### 打包\r\n\r\n```sh\r\nyarn liuli-cli build lib # 打包库\r\nyarn liuli-cli build cli # 打包 cli 引用程序\r\n```\r\n\r\n> 添加 `-w` 选项则启动 rollup 的监视模式，打包出来的 dist/ 不会压缩且不会将依赖项打进 bundle。\r\n\r\n![监视模式](https://liuli.dev/images/liuli-cli%20%E7%9B%91%E8%A7%86%E6%A8%A1%E5%BC%8F.gif)\r\n\r\n### 生成\r\n\r\n```sh\r\nyarn liuli-cli generate <name> --template lib # 生成 ts-lib 项目\r\nyarn liuli-cli generate <name> --template cli # 生成 cli 项目\r\n```\r\n\r\nutil 也支持交互式的创建项目\r\n\r\n```shell\r\nyarn liuli-cli generate\r\n```\r\n\r\n![liuli-cli 交互式创建截图](https://liuli.dev/images/liuli-cli%20%E4%BA%A4%E4%BA%92%E5%BC%8F%E5%88%9B%E5%BB%BA%E6%88%AA%E5%9B%BE.gif)\r\n\r\n### 同步配置\r\n\r\n```shell\r\nyarn liuli-cli sync\r\n```\r\n\r\n需要在 package.json 中指定同步哪些配置\r\n\r\n```json\r\n{\r\n  \"sync\": [\"prettier\", \"workspaces\", \"commitlint\", \"simplehooks\"]\r\n}\r\n```\r\n\r\n目前支持的配置项\r\n\r\n- prettier\r\n- commitlint\r\n- simplehooks\r\n- workspaces\r\n- gitignore\r\n- eslint-ts\r\n- eslint-vue-ts\r\n- jest\r\n\r\n未来的目标：默认将包括检查 cli 自身的同步（如果需要在 monorepo 之外使用的话），eslint/style-lint 之类，还有在没有配置时实现交互式 cli\r\n\r\n> 注：目前仅同步依赖而不会执行安装\r\n\r\n也支持交互式的初始化同步配置\r\n\r\n```shell\r\nyarn liuli-cli sync init\r\n```\r\n\r\n## 设计理念\r\n\r\n- 约定大于配置，如果可能应该不提供配置。VitePress 也是这样做的，参考：https://vitepress.vuejs.org/#lighter-page-weight 这会导致一些约束，包括以下内容\r\n  - 打包库时入口文件必须是 `src/index.ts`，出口文件则是 `dist/index.esm.js` 与 `dist/index.js`\r\n  - 打包 CLI 时入口文件必须是 `src/bin.ts`，出口文件则是 `dist/bin.js`\r\n  - 在打包 lib 时会将所有的依赖作为外部依赖处理，而在打包 cli 时会将所有依赖项打进 bundle\r\n\r\n## FAQ\r\n\r\n### 为什么底层没有选择 esbuild\r\n\r\n事实上，esbuild 本身非常非常非常快（重要的事情说三遍），但如果使用 js 封装 CLI，则性能会迅速降低。\r\n\r\n打包这个项目使用 esbuild、cli 封装、rollup 的时间对比如下\r\n\r\n| 打包方式 | 时间  |\r\n| -------- | ----- |\r\n| esbuild  | 0.49s |\r\n| cli 封装 | 3.2s  |\r\n| rollup   | 3.65s |\r\n\r\n> 现在 [vscode 插件打包官方推荐使用 esbuild](https://code.visualstudio.com/api/working-with-extensions/bundling-extension) ，吾辈在生产项目中也有过实践，长期而言吾辈比较看好这类更高性能的打包工具。\r\n\r\n### 为什么不捆绑外部依赖项\r\n\r\n主要原因是希望将捆绑的工作交由最终应用完成，避免重复捆绑相同的依赖，而且还可以避免处理 nodejs 中直接基于文件系统使用 `worker_threads` 的问题。\r\n"
+  "readme": "# @liuli-util/cli\r\n\r\n> [中文](https://github.com/rxliuli/liuli-tools/tree/master/apps/liuli-cli/README.zh-CN.md)\r\n\r\nA zero-configuration CLI packaged for libraries and CLI applications.\r\n\r\n## Getting started\r\n\r\n### Install\r\n\r\n```sh\r\nyarn add -D @liuli-util/cli # local installation\r\nnpm i -g @liuli-util/cli # install globally\r\n```\r\n\r\n### Bale\r\n\r\n```sh\r\nyarn liuli-cli build lib # package library\r\nyarn liuli-cli build cli # package cli reference program\r\n```\r\n\r\n> Add the `-w` option to start the watch mode of rollup, the packaged dist/ will not be compressed and the dependencies will not be included in the bundle.\r\n\r\n![Monitor Mode](https://liuli.dev/images/liuli-cli%20%E7%9B%91%E8%A7%86%E6%A8%A1%E5%BC%8F.gif)\r\n\r\n### Generate\r\n\r\n```sh\r\nyarn liuli-cli generate <name> --template lib # Generate ts-lib project\r\nyarn liuli-cli generate <name> --template cli # Generate cli project\r\n```\r\n\r\nutil also supports interactive project creation\r\n\r\n```shell\r\nyarn liuli-cli generate\r\n```\r\n\r\n![Liuli-cli interactively create screenshots](https://liuli.dev/images/liuli-cli%20%E4%BA%A4%E4%BA%92%E5%BC%8F%E5%88%9B %E5%BB%BA%E6%88%AA%E5%9B%BE.gif)\r\n\r\n### Sync configuration\r\n\r\n```shell\r\nyarn liuli-cli sync\r\n```\r\n\r\nWhich configuration needs to be synced in package.json\r\n\r\n```json\r\n{\r\n  \"sync\": [\"prettier\", \"workspaces\", \"commitlint\", \"simplehooks\"]\r\n}\r\n```\r\n\r\nCurrently supported configuration items\r\n\r\n- prettier\r\n- commitlint\r\n- simplehooks\r\n- workspaces\r\n- gitignore\r\n- eslint-ts\r\n- eslint-vue-ts\r\n- jest\r\n\r\nFuture goals: By default will include checking the synchronization of the cli itself (if it needs to be used outside of a monorepo), eslint/style-lint etc., and implementing an interactive cli when not configured\r\n\r\n> Note: Currently only the dependencies are synced and no installation is performed\r\n\r\nInteractive initialization synchronization configuration is also supported\r\n\r\n```shell\r\nyarn liuli-cli sync init\r\n```\r\n\r\n## design concept\r\n\r\n- Convention over configuration, configuration should not be provided if possible. VitePress does this too, reference: https://vitepress.vuejs.org/#lighter-page-weight This leads to some constraints, including the following\r\n  - When packaging the library, the entry file must be `src/index.ts`, and the export file must be `dist/index.esm.js` and `dist/index.js`\r\n  - When packaging the CLI, the entry file must be `src/bin.ts`, and the exit file must be `dist/bin.js`\r\n  - All dependencies will be treated as external dependencies when packaging lib, and all dependencies will be bundled when packaging cli\r\n\r\n## FAQ\r\n\r\n### Why not bundle external dependencies\r\n\r\nThe main reason is that you want to leave the bundling work to the final application, avoid bundling the same dependencies repeatedly, and also avoid dealing with the problem of using `worker_threads` directly based on the file system in nodejs.\r\n"
 }

package/src/commands/deploy/DeployService.ts

@@ -8,25 +8,12 @@ import localize from 'ajv-i18n/localize'
 import simpleGit from 'simple-git'
 import { nodeCacheDir } from '../../utils/nodeCacheDir'
 import { performance, PerformanceObserver } from 'perf_hooks'
+import { validate } from './util/validate'
 
 export interface DeployEvents {
   process(title: string): void
 }
 
-/**
- * 使用 ajv 校验数据
- * @param schema
- * @param data
- */
-function ajvValidate(schema: object, data: object): [isValid: boolean, errorText: string] {
-  const ajv = new Ajv({ allErrors: true, messages: false })
-  const res = ajv.validate(schema, data)
-  if (!res) {
-    localize.zh(ajv.errors)
-  }
-  return [res, ajv.errorsText()]
-}
-
 /**
  * 部署服务接口
  */
@@ -49,9 +36,9 @@ export interface BaseDeployOptions {
   type: DeployTypeEnum
 }
 
-export type SftpDeployOptions = Omit<BaseDeployOptions, 'type'> & {
+export interface SftpDeployOptions extends Omit<BaseDeployOptions, 'type'> {
+  dist: string
   dest: string
-  remote: string
   sshConfig: ConnectOptions
 }
 
@@ -69,38 +56,57 @@ export class SftpDeployService implements IDeployService {
         ...this.options.sshConfig,
         privateKey,
       })
-      await client.mkdir(this.options.remote, true)
-      await client.uploadDir(path.resolve(this.options.cwd, this.options.dest), this.options.remote)
+      await client.mkdir(this.options.dest, true)
+      await client.uploadDir(path.resolve(this.options.cwd, this.options.dist), this.options.dest)
       await client.end()
     })
   }
 
   validate(): [isValidate: boolean, errorText: string] {
-    return ajvValidate(
+    return validate<SftpDeployOptions>(
       {
         type: 'object',
         properties: {
+          debug: { type: 'boolean' },
           cwd: { type: 'string' },
+          dist: { type: 'string' },
           dest: { type: 'string' },
-          remote: { type: 'string' },
           sshConfig: {
             type: 'object',
             properties: {
               host: { type: 'string' },
               username: { type: 'string' },
             },
-          },
+          } as any,
         },
-        required: ['cwd', 'dest', 'remote', 'sshConfig'],
+        required: ['cwd', 'dist', 'dest', 'sshConfig', 'debug'],
       },
       this.options,
     )
   }
 }
 
-export type GhPagesDeployOptions = Omit<BaseDeployOptions, 'type'> & {
-  dest: string
-  remote: string
+export interface GhPagesDeployOptions extends Omit<BaseDeployOptions, 'type'> {
+  /**
+   * 推送的本地目录
+   */
+  dist: string
+  /**
+   * 推送的远端目录，默认为分支根目录
+   */
+  dest?: string
+  /**
+   * 推送的项目 git 地址，默认为当前项目
+   */
+  repo?: string
+  /**
+   * 推送的远端，默认为 origin
+   */
+  remote?: string
+  /**
+   * 远端分支名，默认为 gh-pages
+   */
+  branch?: string
 }
 
 /**
@@ -110,10 +116,10 @@ export class GhPagesDeployService implements IDeployService {
   constructor(private readonly options: GhPagesDeployOptions) {}
 
   deploy(): EventExtPromise<void, DeployEvents> {
-    const defaultRemote = 'origin'
-    const defaultBranch = 'gh-pages'
+    const defaultRemote = this.options.remote ?? 'origin'
+    const defaultBranch = this.options.branch ?? 'gh-pages'
     return PromiseUtil.wrapOnEvent(async (events: DeployEvents) => {
-      const obs = new PerformanceObserver((perfObserverList, observer) => {
+      const obs = new PerformanceObserver((perfObserverList) => {
         if (this.options.debug) {
           console.log(perfObserverList.getEntries())
         }
@@ -126,25 +132,48 @@ export class GhPagesDeployService implements IDeployService {
       }
       mark('开始推送')
       const git = simpleGit(this.options.cwd)
-      mark('获取当前项目的远端配置')
-      const originRemote = (await git.getRemotes(true)).find((item) => item.name === defaultRemote)
-      if (!originRemote) {
-        throw new Error('当前目录不是一个 git 项目或没有配置 git remote')
+      if (!this.options.repo) {
+        mark('获取当前项目的远端配置')
+        const originRemote = (await git.getRemotes(true)).find((item) => item.name === defaultRemote)
+        if (!originRemote) {
+          throw new Error('当前目录不是一个 git 项目或没有配置 git remote')
+        }
+        this.options.repo = originRemote.refs.fetch
       }
       const ghPagesRoot = path.resolve(nodeCacheDir('liuli-cli'), 'gh-pages')
-      const originRepoName = originRemote.refs.fetch.replace(new RegExp('[/:]', 'g'), '_')
+      const originRepoName = this.options.repo.replace(new RegExp('[/:]', 'g'), '_')
       const localRepoPath = path.resolve(ghPagesRoot, originRepoName)
+      let forcePush = false
       if (!(await pathExists(localRepoPath))) {
         mark('克隆项目')
-        await git.clone(originRemote.refs.fetch, localRepoPath, { '--branch': defaultBranch })
+        //如果失败，应该尝试克隆主分支，然后 checkout
+        try {
+          await git.clone(this.options.repo, localRepoPath, {
+            '--branch': defaultBranch,
+            '--single-branch': null,
+            '--depth': 1,
+          })
+        } catch (e) {
+          mark(`未找到 ${defaultBranch} 分支，尝试自动创建`)
+          await git.clone(this.options.repo, localRepoPath, {
+            '--single-branch': null,
+            '--depth': 1,
+          })
+          await git.cwd(localRepoPath)
+          await git.checkout({
+            '--orphan': defaultBranch,
+          })
+          forcePush = true
+        }
       } else {
+        await git.cwd(localRepoPath)
         mark('更新项目')
         await git.pull()
       }
       mark('复制文件')
-      const remoteDestPath = path.join(localRepoPath, this.options.remote)
+      const remoteDestPath = path.join(localRepoPath, this.options.dest ?? './')
       await mkdirp(remoteDestPath)
-      await copy(path.resolve(this.options.cwd, this.options.dest), remoteDestPath)
+      await copy(path.resolve(this.options.cwd, this.options.dist), remoteDestPath)
       mark('提交所有文件')
       await git.cwd(localRepoPath)
       await git.add('-A')
@@ -154,26 +183,30 @@ export class GhPagesDeployService implements IDeployService {
         await git.commit('Updates gh-pages by liuli-cli')
       }
       mark('推送到远端')
-      if ((await git.status()).ahead === 0) {
-        mark('没有更新，跳过推送')
-      } else {
+      if ((await git.status()).ahead > 0 || forcePush) {
         await git.push(defaultRemote, defaultBranch)
         mark('完成推送')
+      } else {
+        mark('没有更新，跳过推送')
       }
       obs.disconnect()
     })
   }
 
   validate(): [isValid: boolean, errorText: string] {
-    return ajvValidate(
+    return validate<GhPagesDeployOptions>(
       {
         type: 'object',
         properties: {
+          debug: { type: 'boolean' },
           cwd: { type: 'string' },
-          dest: { type: 'string' },
-          remote: { type: 'string' },
+          dist: { type: 'string' },
+          dest: { type: 'string', nullable: true },
+          repo: { type: 'string', nullable: true },
+          remote: { type: 'string', nullable: true },
+          branch: { type: 'string', nullable: true },
         },
-        required: ['cwd', 'dest', 'remote'],
+        required: ['debug', 'cwd', 'dist'],
       },
       this.options,
     )

package/src/commands/deploy/__tests__/DeployService.test.ts

@@ -1,7 +1,8 @@
 import * as path from 'path'
-import { mkdirp, remove, writeFile } from 'fs-extra'
-import { GhPagesDeployService, SftpDeployOptions, SftpDeployService } from '../DeployService'
+import { mkdirp, remove, unlink, writeFile } from 'fs-extra'
+import { GhPagesDeployOptions, GhPagesDeployService, SftpDeployOptions, SftpDeployService } from '../DeployService'
 import { execPromise } from '../util/execPromise'
+import { nodeCacheDir } from '../../../utils/nodeCacheDir'
 
 const tempPath = path.resolve(__dirname, '.temp')
 beforeAll(async () => {
@@ -25,14 +26,15 @@ beforeAll(async () => {
   )
 })
 
-describe('测试 SftpDeployService', () => {
+describe.skip('测试 SftpDeployService', () => {
   const options: SftpDeployOptions = {
+    debug: false,
     cwd: tempPath,
-    dest: 'dist',
-    remote: '/home/pinefield/apps/test',
+    dist: 'dist',
+    dest: process.env.dest!,
     sshConfig: {
-      host: '10.8.2.4',
-      username: 'pinefield',
+      host: process.env.host,
+      username: process.env.username,
     },
   }
   it('基本示例', async () => {
@@ -55,21 +57,52 @@ describe('测试 SftpDeployService', () => {
 })
 
 describe('测试 GhPagesDeployService', () => {
-  const ghPagesDeployService = new GhPagesDeployService({
+  const options: GhPagesDeployOptions = {
+    debug: false,
     cwd: tempPath,
-    dest: 'dist',
-    remote: 'examples/test-app',
+    dist: 'dist',
+    dest: '/',
+    repo: 'https://github.com/rxliuli/test-git.git',
+    remote: 'origin',
+    branch: 'gh-pages',
+  }
+  const ghPagesDeployService = new GhPagesDeployService(options)
+  const distPath = path.resolve(tempPath, 'dist')
+  const mock = jest.fn().mockImplementation((title) => console.log(title))
+  beforeEach(async () => {
+    await writeFile(
+      path.resolve(distPath, 'index.html'),
+      `<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>测试部署</title>
+  </head>
+  <body>
+    <h1>测试部署</h1>
+    <p>${Date.now()}</p>
+  </body>
+</html>
+    `,
+    )
+    mock.mockClear()
   })
   it('基本示例', async () => {
-    await ghPagesDeployService.deploy().on('process', (title) => console.log(title))
+    await ghPagesDeployService.deploy().on('process', mock)
+    console.log(mock.mock.calls)
+    expect(mock.mock.calls.some((item: string[]) => item.includes('完成推送'))).toBeTruthy()
   }, 10_000)
-  //TODO 无法使用单元测试
-  it.skip('并发推送', async () => {
-    const scriptPath = path.resolve(__dirname, './util/deployGhPageWorker.ts').replace(/\\/g, '/')
-    await Promise.all(
-      [1, 2].map(async () => {
-        await execPromise(`esno ${scriptPath}`)
-      }),
-    )
+  it('测试没有任何修改', async () => {
+    await writeFile(path.resolve(distPath, 'index.html'), 'test')
+    await ghPagesDeployService.deploy().on('process', mock)
+    await ghPagesDeployService.deploy().on('process', mock)
+    expect(mock.mock.calls.some((item: string[]) => item.includes('没有任何提交，跳过提交'))).toBeTruthy()
+    expect(mock.mock.calls.some((item: string[]) => item.includes('没有更新，跳过推送'))).toBeTruthy()
+  }, 20_000)
+  it('测试首次拉取代码', async () => {
+    const dir = path.resolve(nodeCacheDir('liuli-cli'), 'gh-pages', options.repo!.replace(new RegExp('[/:]', 'g'), '_'))
+    await remove(dir)
+    await ghPagesDeployService.deploy().on('process', mock)
+    expect(mock.mock.calls.some((item: string[]) => item.includes('克隆项目'))).toBeTruthy()
   }, 10_000)
 })

package/src/commands/deploy/util/validate.ts

@@ -0,0 +1,18 @@
+import Ajv, { JSONSchemaType } from 'ajv'
+import localize from 'ajv-i18n/localize'
+import formatsPlugin from 'ajv-formats'
+
+/**
+ * 使用 ajv 校验数据
+ * @param schema json 模式配置
+ * @param data 校验的数据
+ */
+export function validate<T>(schema: JSONSchemaType<T>, data: T): [isValid: boolean, errorText: string] {
+  const ajv = new Ajv({ allErrors: true, messages: false })
+  formatsPlugin(ajv)
+  const res = ajv.validate(schema, data)
+  if (!res) {
+    localize.zh(ajv.errors)
+  }
+  return [res, ajv.errorsText()]
+}

package/templates/cli/package.json

@@ -13,18 +13,14 @@
   "bin": {
     "cli-name": "./bin.js"
   },
-  "jest": {
-    "preset": "ts-jest"
-  },
   "dependencies": {
     "commander": "^8.2.0",
     "enquirer": "^2.3.6",
     "fs-extra": "^10.0.0"
   },
   "devDependencies": {
-    "@liuli-util/cli": "workspace:*",
+    "@liuli-util/cli": "^3.18.0",
     "@types/fs-extra": "^9.0.13",
-    "@types/inquirer": "^8.1.2",
     "@types/jest": "^27.0.2",
     "@types/lodash": "^4.14.173",
     "@types/node": "^16.9.6",

package/templates/cli/src/bin.ts

@@ -1,5 +1,5 @@
 import { Command } from 'commander'
-import { prompt } from 'inquirer'
+import { prompt } from 'enquirer'
 
 new Command()
   .action(async () => {

package/templates/lib/package.json

@@ -7,19 +7,12 @@
   "types": "dist/index.d.ts",
   "license": "MIT",
   "scripts": {
-    "build": "rimraf dist && liuli-cli build pkg",
-    "dev": "liuli-cli build pkg -w"
-  },
-  "jest": {
-    "preset": "ts-jest"
+    "build": "rimraf dist && liuli-cli build lib",
+    "dev": "liuli-cli build lib -w"
   },
   "devDependencies": {
-    "@liuli-util/cli": "workspace:*",
-    "@types/jest": "^27.0.2",
-    "esno": "^0.9.1",
-    "jest": "^27.2.1",
+    "@liuli-util/cli": "^3.18.0",
     "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.5",
     "type-fest": "^2.3.4",
     "typescript": "^4.4.3"
   }