@liuli-util/cli 3.13.0 → 3.16.0

package/src/commands/deploy/__tests__/util/deployGhPageWorker.ts

@@ -0,0 +1,16 @@
+import { GhPagesDeployService } from '../../DeployService'
+import * as path from 'path'
+
+async function deployGhPages() {
+  const tempPath = path.resolve(__dirname, '../.temp/')
+  const ghPagesDeployService = new GhPagesDeployService({
+    cwd: tempPath,
+    dest: 'dist',
+    remote: 'examples/test-app',
+  })
+  const now = Date.now()
+  await ghPagesDeployService.deploy().on('process', (title) => console.log(`[${now}] ${title}`))
+}
+
+// noinspection JSIgnoredPromiseFromCall
+deployGhPages()

package/src/commands/deploy/deploy.ts

@@ -0,0 +1,48 @@
+import {
+  BaseDeployOptions,
+  DeployTypeEnum,
+  GhPagesDeployService,
+  IDeployService,
+  SftpDeployOptions,
+  SftpDeployService,
+} from './DeployService'
+import * as path from 'path'
+import { pathExists, readJson } from 'fs-extra'
+
+async function getOptions(cwd: string): Promise<BaseDeployOptions> {
+  const pkgJsonPath = path.resolve(cwd, 'package.json')
+  if (await pathExists(pkgJsonPath)) {
+    const config = (await readJson(pkgJsonPath)).deploy
+    if (!config) {
+      throw new Error('找不到配置')
+    }
+    return config
+  }
+  throw new Error('找不到配置')
+}
+
+export async function deploy(options: Omit<BaseDeployOptions, 'type'>): Promise<void> {
+  const deployOptions = await getOptions(options.cwd)
+  let service: IDeployService
+  const _options = {
+    ...options,
+    ...deployOptions,
+  } as unknown as SftpDeployOptions
+  switch (deployOptions.type) {
+    case DeployTypeEnum.Sftp:
+      service = new SftpDeployService(_options)
+      break
+    case DeployTypeEnum.GhPages:
+      service = new GhPagesDeployService(_options)
+      break
+    default:
+      throw new Error('未知的部署预设类型 ' + deployOptions.type)
+  }
+  const [isValidate, errorText] = service.validate()
+  if (!isValidate) {
+    throw new Error(errorText)
+  }
+  await service.deploy().on('process', (title) => {
+    console.info(title)
+  })
+}

package/src/commands/deploy/index.ts

@@ -0,0 +1,7 @@
+import { Command } from 'commander'
+import { deploy } from './deploy'
+import * as path from 'path'
+
+export const deployCommand = new Command('deploy')
+  .description('部署项目到远端')
+  .action(() => deploy({ cwd: path.resolve() }))

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

@@ -0,0 +1,31 @@
+import { close, open, remove } from 'fs-extra'
+import path from 'path'
+
+export class FileLock {
+  constructor(private readonly lockFilePath: string) {}
+
+  private lockId?: number
+
+  /**
+   * 加锁
+   */
+  async lock(): Promise<boolean> {
+    try {
+      this.lockId = await open(path.resolve(this.lockFilePath), 'wx')
+      return true
+    } catch (e) {
+      return false
+    }
+  }
+
+  /**
+   * 解锁
+   */
+  async unlock(): Promise<void> {
+    if (!this.lockId) {
+      throw new Error('未加锁')
+    }
+    await remove(path.resolve(this.lockFilePath))
+    close(this.lockId)
+  }
+}

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

@@ -0,0 +1,34 @@
+import { ConditionalKeys, PromiseValue } from 'type-fest'
+
+type VoidFunc = ((...args: any[]) => void) | undefined
+
+export type EventExtPromise<T, E> = Promise<T> & {
+  on<K extends ConditionalKeys<E, VoidFunc>>(type: K, callback: E[K]): EventExtPromise<T, E>
+}
+
+export class PromiseUtil {
+  /**
+   * 创建一个支持 on* 事件的 Promise 实例
+   * @param executor
+   */
+  static wrapOnEvent<
+    F extends (events: any) => Promise<any>,
+    E extends Parameters<F>[0],
+    K extends ConditionalKeys<E, VoidFunc>,
+  >(executor: F): EventExtPromise<PromiseValue<ReturnType<F>>, E> {
+    const events: Partial<Pick<E, K>> = {}
+    const res = new Promise(async (resolve, reject) => {
+      await new Promise((resolve) => setTimeout(resolve, 0))
+      try {
+        resolve(await executor(events))
+      } catch (e) {
+        reject(e)
+      }
+    })
+    Reflect.set(res, 'on', (type: K, callback: E[K]) => {
+      events[type] = callback
+      return res
+    })
+    return res as any
+  }
+}

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

@@ -0,0 +1,30 @@
+import { create, CreateOptions } from 'tar'
+import { promise } from 'glob-promise'
+import * as path from 'path'
+
+export type ArchiveOptions = {
+  // sourceDir 源目录，一般设置为 dist
+  sourceDir: string
+  // destPath 目标位置，可能是 <packageName>.jpl
+  destPath: string
+}
+
+/**
+ * 创建 jpl 压缩文件
+ * @param options
+ */
+export async function createArchive(options: ArchiveOptions): Promise<void> {
+  const sourceDir = path.resolve(options.sourceDir)
+  const destPath = path.resolve(options.destPath)
+  const distFiles = (await promise(`${sourceDir}/**/*`, { nodir: true })).map((f) => f.substr(sourceDir.length + 1))
+  await create(
+    {
+      strict: true,
+      portable: true,
+      file: destPath,
+      cwd: sourceDir,
+      sync: true,
+    } as Partial<CreateOptions>,
+    distFiles,
+  )
+}

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

@@ -0,0 +1,13 @@
+import { exec, ExecOptions } from 'child_process'
+
+export function execPromise(command: string, options?: ExecOptions): Promise<string | Buffer> {
+  return new Promise((resolve, reject) => {
+    exec(command, options, (error, stdout) => {
+      if (error) {
+        reject(error)
+        return
+      }
+      resolve(stdout)
+    })
+  })
+}

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

@@ -0,0 +1,23 @@
+/**
+ * 等待指定的时间/等待指定表达式成立
+ * 如果未指定等待条件则立刻执行
+ * 注: 此实现在 nodejs 10- 会存在宏任务与微任务的问题，切记 async-await 本质上还是 Promise 的语法糖，实际上并非真正的同步函数！！！即便在浏览器，也不要依赖于这种特性。
+ * @param param 等待时间/等待条件
+ * @returns Promise 对象
+ */
+export function wait(param?: number | (() => boolean | Promise<boolean>)): Promise<void> {
+  return new Promise((resolve) => {
+    if (typeof param === 'number') {
+      setTimeout(resolve, param)
+    } else if (typeof param === 'function') {
+      const timer = setInterval(async () => {
+        if (await param()) {
+          clearInterval(timer)
+          resolve()
+        }
+      }, 100)
+    } else {
+      resolve()
+    }
+  })
+}

package/src/commands/esbuild/ESBuildProgram.ts

@@ -31,7 +31,7 @@ export class ESBuildProgram {
     this.options.isWatch = isWatch
   }
 
-  static readonly globalExternal = ['esbuild', 'pnpapi', 'ts-morph']
+  static readonly globalExternal = ['esbuild', 'pnpapi', 'ts-morph', 'ssh2']
 
   /**
    * 获取所有依赖
@@ -146,22 +146,14 @@ export class ESBuildProgram {
    * @param platform
    * @param plugins
    */
-  getBuildIifeOption({
-    deps,
-    platform,
-    globalName,
-  }: {
-    deps: string[]
-    platform: Platform
-    globalName: string
-  }): BuildOptions {
+  getBuildIifeOption({ platform, globalName }: { platform: Platform; globalName: string }): BuildOptions {
     return {
       entryPoints: [path.resolve(this.options.base, './src/index.ts')],
       outfile: path.resolve(this.options.base, './dist/index.iife.js'),
       format: 'iife',
       sourcemap: true,
       bundle: true,
-      external: [...ESBuildProgram.globalExternal, ...deps],
+      external: [...ESBuildProgram.globalExternal],
       platform: platform,
       minify: !this.options.isWatch,
       incremental: this.options.isWatch,
@@ -239,7 +231,6 @@ export class ESBuildProgram {
         task: async () => {
           return await this.build(
             this.getBuildIifeOption({
-              deps: deps,
               platform: platform,
               globalName: getPkgGlobalName(
                 ((await readJson(path.resolve(this.options.base, './package.json'))) as PackageJson).name!,

package/src/commands/esbuild/__tests__/.temp/getDeps/package.json

@@ -0,0 +1 @@
+{"devDependencies":{"@types/node":"16"},"dependencies":{"ora":"^6"},"peerDependencies":{"typescript":"^4"}}

package/src/commands/esbuild/__tests__/ESBuildProgram.test.ts

@@ -93,7 +93,6 @@ describe('测试 ESBuildProgram', () => {
     })
     it('测试 getBuildIifeOption', async () => {
       const option = program.getBuildIifeOption({
-        deps: deps,
         platform: platform,
         globalName: 'test',
       })

package/src/commands/generate/GenerateProgram.ts

@@ -1,14 +1,5 @@
 import path from 'path'
-import {
-  copy,
-  pathExists,
-  readdir,
-  readFile,
-  readJSON,
-  remove,
-  writeFile,
-  writeJSON,
-} from 'fs-extra'
+import { copy, pathExists, readdir, readFile, readJSON, remove, writeFile, writeJSON } from 'fs-extra'
 import { prompt } from 'enquirer'
 import { SyncProgram } from '../sync/SyncProgram'
 import { PathUtil } from '../../PathUtil'
@@ -43,12 +34,9 @@ export class GenerateProgram {
     if (!config.template) {
       const { template } = await prompt<{ template: TemplateTypeEnum }>({
         name: 'template',
-        type: 'list',
+        type: 'select',
         message: '请选择模板',
-        choices: [
-          TemplateTypeEnum.Lib,
-          TemplateTypeEnum.Cli,
-        ] as TemplateTypeEnum[],
+        choices: [TemplateTypeEnum.Lib, TemplateTypeEnum.Cli] as TemplateTypeEnum[],
       })
       config.template = template
     }
@@ -60,15 +48,9 @@ export class GenerateProgram {
       - 修改 package.json，删除 private，修改名字
     模板特定修改
      */
-    const srcFile = path.resolve(
-      PathUtil.RootPath,
-      `templates/${config.template}`,
-    )
+    const srcFile = path.resolve(PathUtil.RootPath, `templates/${config.template}`)
     const destFile = path.resolve(config.dest)
-    if (
-      (await pathExists(destFile)) &&
-      (await readdir(destFile)).some((file) => pathExists(file))
-    ) {
+    if ((await pathExists(destFile)) && (await readdir(destFile)).some((file) => pathExists(file))) {
       const { override } = await prompt<{
         override: boolean
       }>({
@@ -82,7 +64,9 @@ export class GenerateProgram {
       }
     }
     await remove(destFile)
-    await copy(srcFile, destFile)
+    await copy(srcFile, destFile, {
+      filter: (source) => path.basename(source) !== 'node_modules',
+    })
     await GenerateProgram.updatePackageJSON(destFile)
     await GenerateProgram.updateReadme(destFile)
     if (config.initSync) {

package/src/commands/generate/__tests__/.temp/test-cli/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

package/src/commands/generate/__tests__/.temp/test-cli/README.md

@@ -0,0 +1 @@
+# @liuli-util/cli-test-cli

package/src/commands/generate/__tests__/.temp/test-cli/bin.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// eslint-disable-next-line no-undef
+require('./dist/bin.js')

package/src/commands/generate/__tests__/.temp/test-cli/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "test-cli",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "rimraf dist && liuli-cli build cli",
+    "dev": "liuli-cli build cli -w",
+    "start": "esno src/bin.ts",
+    "docs:server": "live-server docs",
+    "docs:dev": "typedoc --watch",
+    "docs:build": "rimraf docs && typedoc",
+    "docs:deploy": "yarn docs:build && gh-pages -d docs/ -e / -a"
+  },
+  "bin": {
+    "cli-name": "./bin.js"
+  },
+  "jest": {
+    "preset": "ts-jest"
+  },
+  "dependencies": {
+    "commander": "^8.2.0",
+    "fs-extra": "^10.0.0",
+    "inquirer": "^8.1.5"
+  },
+  "devDependencies": {
+    "@liuli-util/cli": "^3.11.1",
+    "@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",
+    "esno": "^0.9.1",
+    "gh-pages": "^3.2.3",
+    "jest": "^27.2.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.0.5",
+    "type-fest": "^2.3.4",
+    "typedoc": "^0.22.4",
+    "typescript": "^4.4.3"
+  }
+}

package/src/commands/generate/__tests__/.temp/test-cli/src/bin.ts

@@ -0,0 +1,13 @@
+import { Command } from 'commander'
+import { prompt } from 'inquirer'
+
+new Command()
+  .action(async () => {
+    const { name } = await prompt<{ name: string }>({
+      type: 'input',
+      name: 'name',
+      message: '请输入名字',
+    })
+    console.log(`hello ${name}`)
+  })
+  .parse()

package/src/commands/generate/__tests__/.temp/test-cli/src/index.ts

@@ -0,0 +1 @@
+export {}

package/src/commands/generate/__tests__/.temp/test-cli/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": [
+      "ESNext"
+    ],
+    "outDir": "./dist",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": [
+    "src"
+  ],
+  "typedocOptions": {
+    "entryPoints": [
+      "src/index.ts"
+    ],
+    "out": "docs",
+    "readme": "README.md",
+    "gitRemote": "origin"
+  }
+}

package/src/commands/generate/__tests__/GenerateProgram.test.ts

@@ -1,19 +1,11 @@
 import { GenerateProgram, TemplateTypeEnum } from '../GenerateProgram'
 import path from 'path'
-import {
-  mkdir,
-  pathExists,
-  readFile,
-  readJson,
-  remove,
-  writeFile,
-  writeJson,
-} from 'fs-extra'
+import { mkdir, pathExists, readFile, readJson, remove, writeFile, writeJson } from 'fs-extra'
 import { PackageJson } from 'type-fest'
 
 describe('测试 InitProgram', () => {
   const initProgram = new GenerateProgram()
-  const tempPath = path.resolve(__dirname, 'temp')
+  const tempPath = path.resolve(__dirname, '.temp')
   it('生成项目', async () => {
     const dest = path.resolve(tempPath, 'lib-demo')
     await remove(dest)
@@ -22,7 +14,7 @@ describe('测试 InitProgram', () => {
       dest,
     })
     expect(await pathExists(dest)).toBeTruthy()
-  }, 100_000)
+  })
   describe('测试一些钩子', () => {
     beforeAll(async () => {
       await remove(tempPath)
@@ -34,18 +26,26 @@ describe('测试 InitProgram', () => {
         name: '@liuli-util/template',
       })
       await GenerateProgram.updatePackageJSON(tempPath)
-      expect(
-        ((await readJson(jsonPath)) as PackageJson).name?.endsWith('temp'),
-      ).toBeTruthy()
+      expect(((await readJson(jsonPath)) as PackageJson).name?.endsWith('temp')).toBeTruthy()
     })
     it('测试修改 readme', async () => {
       const readmePath = path.resolve(tempPath, 'README.md')
       await writeFile(readmePath, `# @liuli-util/template`)
       await GenerateProgram.updateReadme(tempPath)
       console.log('readme: ', await readFile(readmePath, 'utf-8'))
-      expect(
-        (await readFile(readmePath, 'utf-8')).endsWith('temp'),
-      ).toBeTruthy()
+      expect((await readFile(readmePath, 'utf-8')).endsWith('temp')).toBeTruthy()
+    })
+  })
+  describe('测试错误修复', () => {
+    it('修复 monorepo 中使用 cli 会复制 node_modules 的错误', async () => {
+      const program = new GenerateProgram()
+      const destPath = path.resolve(tempPath, 'test-cli')
+      await program.generate({
+        template: TemplateTypeEnum.Cli,
+        dest: destPath,
+        initSync: false,
+      })
+      expect(await pathExists(path.resolve(destPath, 'node_modules'))).toBeFalsy()
     })
   })
 })

package/src/commands/sync/SyncProgram.ts

@@ -13,13 +13,9 @@ import { PathUtil } from '../../PathUtil'
 
 export async function mergeJson(base: string, json: object): Promise<void> {
   const pkgJsonFilePath = path.resolve(base, './package.json')
-  await writeJson(
-    pkgJsonFilePath,
-    merge(await readJson(pkgJsonFilePath), json),
-    {
-      spaces: 2,
-    },
-  )
+  await writeJson(pkgJsonFilePath, merge(await readJson(pkgJsonFilePath), json), {
+    spaces: 2,
+  })
 }
 
 export type SyncConfigType =
@@ -68,10 +64,7 @@ export class SyncProgram {
         } as PackageJson)
       },
       async when(): Promise<boolean> {
-        return (
-          (await isNpmPackage()) &&
-          ((await isYarnRoot()) || !(await isYarnSubModule()))
-        )
+        return (await isNpmPackage()) && ((await isYarnRoot()) || !(await isYarnSubModule()))
       },
     },
     {
@@ -91,23 +84,14 @@ export class SyncProgram {
         } as PackageJson)
       },
       async when(): Promise<boolean> {
-        return (
-          (await isNpmPackage()) &&
-          ((await isYarnRoot()) || !(await isYarnSubModule()))
-        )
+        return (await isNpmPackage()) && ((await isYarnRoot()) || !(await isYarnSubModule()))
       },
     },
     {
       type: 'gitignore',
       handler: async () => {
         const gitignorePath = path.resolve(this.base, '.gitignore')
-        await writeFile(
-          gitignorePath,
-          await readFile(
-            path.resolve(PathUtil.RootPath, '_gitignore'),
-            'utf-8',
-          ),
-        )
+        await writeFile(gitignorePath, await readFile(path.resolve(PathUtil.RootPath, '_gitignore'), 'utf-8'))
       },
     },
     {
@@ -123,11 +107,7 @@ export class SyncProgram {
         } as PackageJson)
       },
       async when(): Promise<boolean> {
-        return (
-          (await isNpmPackage()) &&
-          !(await isIncludeDep(['vue'])) &&
-          !(await isIncludeDep(['react']))
-        )
+        return (await isNpmPackage()) && !(await isIncludeDep(['vue'])) && !(await isIncludeDep(['react']))
       },
     },
     {
@@ -154,6 +134,10 @@ export class SyncProgram {
             preset: 'ts-jest',
             testMatch: ['<rootDir>/src/**/__tests__/*.test.ts'],
           },
+          devDependencies: {
+            jest: '^27.4.3',
+            'ts-jest': '^27.0.7',
+          },
         })
       },
     },
@@ -171,10 +155,7 @@ export class SyncProgram {
         }
         let config = {
           scripts: {
-            postinstall: appendScript(
-              json?.scripts?.postinstall,
-              'npx simple-git-hooks',
-            ),
+            postinstall: appendScript(json?.scripts?.postinstall, 'npx simple-git-hooks'),
           },
           'simple-git-hooks': {
             'pre-commit': 'yarn lint-staged',
@@ -197,26 +178,19 @@ export class SyncProgram {
         await mergeJson(this.base, config as PackageJson)
       },
       async when(): Promise<boolean> {
-        return (
-          (await isNpmPackage()) &&
-          ((await isYarnRoot()) || !(await isYarnSubModule()))
-        )
+        return (await isNpmPackage()) && ((await isYarnRoot()) || !(await isYarnSubModule()))
       },
     },
   ]
 
   async sync(): Promise<void> {
-    const { sync } = (await readJson(
-      path.resolve(this.base, 'package.json'),
-    )) as {
+    const { sync } = (await readJson(path.resolve(this.base, 'package.json'))) as {
       sync?: SyncConfigType[]
     }
     if (!sync) {
       return
     }
-    const syncConfigs = this.syncConfigs.filter((config) =>
-      sync.includes(config.type),
-    )
+    const syncConfigs = this.syncConfigs.filter((config) => sync.includes(config.type))
     for (const syncConfig of syncConfigs) {
       await syncConfig.handler()
     }

package/src/commands/sync/__tests__/SyncProgram.test.ts

@@ -30,7 +30,7 @@ describe('测试 SyncProgram', () => {
       workspaces,
     } as PackageJson)
     await syncProgram.sync()
-  }, 100_000)
+  })
 
   it.skip('测试初始化同步配置', async () => {
     await writeJson(path.resolve(tempPath, 'lerna.json'), {})
@@ -42,6 +42,18 @@ describe('测试 SyncProgram', () => {
     await syncProgram.init()
     expect(((await readJson(file)).sync as string[]).length).toBeGreaterThan(0)
   }, 100_000)
+
+  it('测试同步 jest', async () => {
+    const jsonPath = path.resolve(tempPath, 'package.json')
+    await writeJson(jsonPath, {
+      name: 'temp',
+      sync: ['jest'] as SyncConfigType[],
+    } as PackageJson)
+    await syncProgram.sync()
+    const json = (await readJson(jsonPath)) as PackageJson
+    const devDeps = Object.keys(json.devDependencies!)
+    expect(devDeps.includes('jest') && devDeps.includes('ts-jest')).toBeTruthy()
+  })
 })
 
 it('测试 lodash-es.merge', () => {

package/src/utils/__tests__/nodeCacheDir.test.ts

@@ -0,0 +1,6 @@
+import { nodeCacheDir } from '../nodeCacheDir'
+
+it('测试 nodeCacheDir', () => {
+  const res = nodeCacheDir('liuli-cli')
+  console.log(res)
+})