@liuli-util/cli 3.15.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']
 
   /**
    * 获取所有依赖

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/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/utils/__tests__/nodeCacheDir.test.ts

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

package/src/utils/nodeCacheDir.ts

@@ -0,0 +1,54 @@
+/*
+copy by https://github.com/LinusU/node-cachedir
+ */
+import * as os from 'os'
+import * as path from 'path'
+
+function posix(id: string) {
+  const cacheHome = process.env.XDG_CACHE_HOME || path.join(os.homedir(), '.cache')
+  return path.join(cacheHome, id)
+}
+
+function darwin(id: string) {
+  return path.join(os.homedir(), 'Library', 'Caches', id)
+}
+
+function win32(id: string) {
+  const appData = process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local')
+  return path.join(appData, id, 'Cache')
+}
+
+const implementation = (function () {
+  switch (os.platform()) {
+    case 'darwin':
+      return darwin
+    case 'win32':
+      return win32
+    case 'aix':
+    case 'android':
+    case 'freebsd':
+    case 'linux':
+    case 'netbsd':
+    case 'openbsd':
+    case 'sunos':
+      return posix
+    default:
+      console.error(
+        `(node:${
+          process.pid
+        }) [cachedir] Warning: the platform "${os.platform()}" is not currently supported by node-cachedir, falling back to "posix". Please file an issue with your platform here: https://github.com/LinusU/node-cachedir/issues/new`,
+      )
+      return posix
+  }
+})()
+
+export function nodeCacheDir(id: string): string {
+  if (id.length === 0) {
+    throw new Error('id cannot be empty')
+  }
+  if (/[^0-9a-zA-Z-]/.test(id)) {
+    throw new Error('id cannot contain special characters')
+  }
+
+  return implementation(id)
+}

package/templates/cli/tsconfig.json

@@ -1,28 +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"
-  }
-}
+{
+  "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/templates/lib/tsconfig.json

@@ -1,28 +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"
-  }
-}
+{
+  "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/tsconfig.json

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

package/src/commands/sync/__tests__/.temp/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "temp",
-  "sync": [
-    "jest"
-  ],
-  "jest": {
-    "preset": "ts-jest",
-    "testMatch": [
-      "<rootDir>/src/**/__tests__/*.test.ts"
-    ]
-  },
-  "devDependencies": {
-    "jest": "^27.4.3",
-    "ts-jest": "^27.0.7"
-  }
-}