@liuli-util/cli 3.9.0 → 3.11.0

package/dist/utils/findParent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findParent.d.ts","sourceRoot":"","sources":["../../src/utils/findParent.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAClC,MAAM,GAAG,IAAI,CAAA;AAChB,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAC3C,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA"}

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './arrayToMap';
+export * from './appendScript';
+export * from './findParent';
+export * from './AsyncArray';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liuli-util/cli",
-  "version": "3.9.0",
+  "version": "3.11.0",
   "description": "一个针对于库和 CLI 应用程序打包的零配置 CLI",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -8,43 +8,55 @@
   "license": "MIT",
   "scripts": {
     "setup": "yarn build",
-    "start": "ts-node src/bin.ts",
     "build": "rimraf dist && yarn start build cli",
-    "dev": "yarn start build cli -w"
+    "dev": "yarn start build cli -w",
+    "start": "esno src/bin.ts"
   },
+  "workspaces": [
+    "templates/*"
+  ],
   "bin": {
     "liuli-cli": "dist/bin.js"
   },
   "jest": {
-    "preset": "ts-jest"
+    "preset": "ts-jest",
+    "moduleNameMapper": {
+      "lodash-es": "lodash"
+    }
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@liuli-util/liuli-cli-plugin-build": "^0.1.0",
-    "@liuli-util/liuli-cli-plugin-generate": "^0.1.0",
-    "@liuli-util/liuli-cli-plugin-sync": "^0.1.0",
-    "chalk": "^4.1.2",
-    "commander": "^7.0.0",
+    "@liuli-util/commitlint-standard-config": "^0.1.6",
+    "@liuli-util/eslint-config-react-ts": "^0.1.0",
+    "@liuli-util/eslint-config-ts": "^0.2.0",
+    "@liuli-util/prettier-standard-config": "^0.1.0",
+    "chokidar": "^3.5.2",
+    "commander": "^8.2.0",
+    "enquirer": "^2.3.6",
+    "esbuild": "^0.13.2",
     "fs-extra": "^10.0.0",
-    "inquirer": "^8.1.0",
-    "lodash": "^4.17.21"
+    "glob": "^7.2.0",
+    "glob-promise": "^4.2.0",
+    "lodash-es": "^4.17.21",
+    "spinnies": "^0.5.1",
+    "ts-morph": "^12.0.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.11",
-    "@types/inquirer": "^7.3.1",
-    "@types/jest": "^26.0.23",
-    "@types/lodash": "^4.14.168",
-    "@types/node": "^12.20.6",
-    "@types/rollup-plugin-auto-external": "^2.0.1",
-    "jest": "^26.6.3",
+    "@types/fs-extra": "^9.0.13",
+    "@types/glob": "^7",
+    "@types/jest": "^27.0.2",
+    "@types/lodash-es": "^4.17.5",
+    "@types/node": "^16.9.6",
+    "esno": "^0.9.1",
+    "jest": "^27.2.1",
+    "lodash": "^4.17.21",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.5.6",
-    "ts-node": "^10.0.0",
-    "type-fest": "^1.1.1",
-    "typescript": "^4.3.4"
+    "ts-jest": "^27.0.5",
+    "type-fest": "^2.3.4",
+    "typescript": "^4.4.3"
   },
   "repository": {
     "type": "git",

package/src/@types/global.d.ts

@@ -0,0 +1,8 @@
+declare module 'spinnies' {
+  type Spinnie = (id: string, args: { text: string }) => void
+  export default class Spinnies {
+    add: Spinnie
+    succeed: Spinnie
+    fail: Spinnie
+  }
+}

package/src/PathUtil.ts

@@ -0,0 +1,8 @@
+import path from 'path'
+
+export class PathUtil {
+  /**
+   * 从这个项目的根目录读取，开发环境是 src/../，运行时则是 dist/../
+   */
+  static readonly RootPath = path.resolve(__dirname, '..')
+}

package/src/bin.ts

@@ -1,11 +1,11 @@
 import { Command } from 'commander'
-import { command as buildCommand } from '@liuli-util/liuli-cli-plugin-build'
-import { command as initCommand } from '@liuli-util/liuli-cli-plugin-generate'
-import { command as syncCommand } from '@liuli-util/liuli-cli-plugin-sync'
+import { esbuildCommand } from './commands/esbuild'
+import { generateCommand } from './commands/generate'
+import { syncCommand } from './commands/sync'
 
 const main = new Command()
 main
-  .addCommand(buildCommand)
-  .addCommand(initCommand)
+  .addCommand(esbuildCommand)
+  .addCommand(generateCommand)
   .addCommand(syncCommand)
   .parse()

package/src/commands/esbuild/ESBuildProgram.ts

@@ -0,0 +1,288 @@
+import { build, BuildOptions, Platform, Plugin } from 'esbuild'
+import { pathExists, readJson } from 'fs-extra'
+import * as path from 'path'
+import { PackageJson } from 'type-fest'
+import { Project } from 'ts-morph'
+import { promise } from 'glob-promise'
+import { IOptions } from 'glob'
+import { nativeNodeModules, nodeExternals } from './util/esbuildPlugins'
+import { watch } from 'chokidar'
+import Spinnies from 'spinnies'
+import { debounce } from './util/debounce'
+
+interface ESBuildProgramOptions {
+  base: string
+  isWatch: boolean
+}
+
+interface Task {
+  title: string
+  task(): Promise<any>
+}
+
+export class ESBuildProgram {
+  constructor(private readonly options: ESBuildProgramOptions) {}
+
+  static readonly globalExternal = ['esbuild', 'pnpapi', 'ts-morph']
+
+  /**
+   * 获取所有依赖
+   */
+  static async getDeps(base: string): Promise<string[]> {
+    const json = (await readJson(
+      path.resolve(base, 'package.json'),
+    )) as PackageJson
+    return Object.keys({
+      ...json.dependencies,
+      ...json.devDependencies,
+      ...json.peerDependencies,
+    })
+  }
+
+  /**
+   * 获取所在模块的类型
+   */
+  static async getPlatform(base: string): Promise<Platform> {
+    const tsconfigPath = path.resolve(base, 'tsconfig.json')
+    if (await pathExists(tsconfigPath)) {
+      const tsconfigJson = await readJson(tsconfigPath)
+      if (
+        (tsconfigJson.compilerOptions.lib as string[]).some(
+          (lib) => lib.toLowerCase() === 'dom',
+        )
+      ) {
+        return 'browser'
+      }
+    }
+    const pkgPath = path.resolve(base, 'package.json')
+    if (await pathExists(pkgPath)) {
+      const pkgJson = (await readJson(pkgPath)) as PackageJson
+      if (Object.keys(pkgJson.devDependencies ?? {}).includes('@types/node')) {
+        return 'node'
+      }
+    }
+    return 'neutral'
+  }
+  static getWatchOptions(base: string): {
+    pattern: string
+    options: IOptions
+  } {
+    const pattern = 'src/**/*.ts'
+    const options: Pick<IOptions, 'cwd' | 'ignore'> = {
+      cwd: base,
+      ignore: '**/__tests__/**/*',
+    }
+    return { pattern, options }
+  }
+  /**
+   * 生成类型定义
+   */
+  async genDTS(): Promise<void> {
+    const base = this.options.base
+    const { pattern, options } = ESBuildProgram.getWatchOptions(
+      this.options.base,
+    )
+    const project = new Project({
+      tsConfigFilePath: path.resolve(base, 'tsconfig.json'),
+      skipAddingFilesFromTsConfig: true,
+      compilerOptions: {
+        emitDeclarationOnly: true,
+        noEmit: false,
+        incremental: this.options.isWatch,
+      },
+    })
+    const fileList = (await promise(pattern, options)).map((filePath) =>
+      path.resolve(base, filePath),
+    )
+    project.addSourceFilesAtPaths(fileList)
+    await project.emit({
+      emitOnlyDtsFiles: true,
+    })
+  }
+
+  /**
+   * 获取构建 cjs 的选项
+   * @param deps
+   * @param platform
+   * @param plugins
+   */
+  getBuildCjsOption({
+    deps,
+    platform,
+  }: {
+    deps: string[]
+    platform: Platform
+  }): BuildOptions {
+    return {
+      outfile: './dist/index.js',
+      format: 'cjs',
+      sourcemap: true,
+      entryPoints: ['./src/index.ts'],
+      bundle: true,
+      external: [...ESBuildProgram.globalExternal, ...deps],
+      platform: platform,
+      minify: !this.options.isWatch,
+      incremental: this.options.isWatch,
+    }
+  }
+
+  /**
+   * 获取构建 esm 的选项
+   * @param deps
+   * @param platform
+   * @param plugins
+   */
+  getBuildESMOption({
+    deps,
+    platform,
+  }: {
+    deps: string[]
+    platform: Platform
+  }): BuildOptions {
+    return {
+      outfile: './dist/index.esm.js',
+      format: 'esm',
+      sourcemap: true,
+      entryPoints: ['./src/index.ts'],
+      bundle: true,
+      external: [...ESBuildProgram.globalExternal, ...deps],
+      platform: platform,
+      minify: !this.options.isWatch,
+      incremental: this.options.isWatch,
+    }
+  }
+
+  /**
+   * 获取构建 cli 的选项
+   * @param deps
+   * @param platform
+   * @param plugins
+   */
+  getBuildCliOption({
+    deps,
+    platform,
+  }: {
+    deps: string[]
+    platform: Platform
+  }): BuildOptions {
+    const plugins = ESBuildProgram.getPlugins(platform)
+    return {
+      entryPoints: ['./src/bin.ts'],
+      outfile: './dist/bin.js',
+      format: 'cjs',
+      sourcemap: true,
+      platform: platform,
+      bundle: true,
+      banner: {
+        js: '#!/usr/bin/env node',
+      },
+      external: [
+        ...ESBuildProgram.globalExternal,
+        ...(this.options.isWatch ? deps : []),
+      ],
+      plugins,
+      minify: !this.options.isWatch,
+      incremental: this.options.isWatch,
+    }
+  }
+
+  static getPlugins(platform: string): Plugin[] {
+    const plugins: Plugin[] = []
+    if (platform === 'node') {
+      plugins.push(nodeExternals(), nativeNodeModules())
+    }
+    return plugins
+  }
+
+  async buildLib(): Promise<void> {
+    await this.build(this.getBuildLibTask.bind(this))
+  }
+
+  async buildCli(): Promise<void> {
+    await this.build(this.getBuildCliTask.bind(this))
+  }
+
+  getBuildLibTask(deps: string[], platform: Platform): Task[] {
+    return [
+      {
+        title: '构建 esm',
+        task: () =>
+          build(
+            this.getBuildESMOption({
+              deps: deps,
+              platform: platform,
+            }),
+          ),
+      },
+      {
+        title: '构建 cjs',
+        task: () =>
+          build(
+            this.getBuildCjsOption({
+              deps: deps,
+              platform: platform,
+            }),
+          ),
+      },
+      {
+        title: '生成类型定义',
+        task: () => this.genDTS(),
+      },
+    ]
+  }
+  getBuildCliTask(deps: string[], platform: Platform): Task[] {
+    return [
+      {
+        title: '构建 cli',
+        task: () =>
+          build(
+            this.getBuildCliOption({
+              deps: deps,
+              platform: platform,
+            }),
+          ),
+      },
+      ...this.getBuildLibTask(deps, platform),
+    ]
+  }
+
+  static async execTask(spinnies: Spinnies, task: Task): Promise<void> {
+    const start = Date.now()
+    spinnies.add(task.title, { text: task.title })
+    try {
+      await task.task()
+      spinnies.succeed(task.title, {
+        text: `${task.title}: ${Date.now() - start}ms`,
+      })
+    } catch (e) {
+      spinnies.fail(task.title, { text: task.title })
+    }
+  }
+  async build(
+    genTasks: (deps: string[], platform: Platform) => Task[],
+  ): Promise<void> {
+    const run = async () => {
+      const start = Date.now()
+      const deps = await ESBuildProgram.getDeps(this.options.base)
+      const platform = await ESBuildProgram.getPlatform(this.options.base)
+      const tasks = genTasks(deps, platform)
+      const spinnies = new Spinnies()
+      await Promise.all(
+        tasks.map(async (task) => ESBuildProgram.execTask(spinnies, task)),
+      )
+      console.log(`构建完成: ${Date.now() - start}ms`)
+    }
+
+    if (!this.options.isWatch) {
+      await run()
+      return
+    }
+
+    const { pattern, options } = ESBuildProgram.getWatchOptions(
+      this.options.base,
+    )
+    await new Promise((resolve, reject) => {
+      watch(pattern, options).on('error', reject).on('all', debounce(run, 10))
+    })
+  }
+}

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

@@ -0,0 +1,125 @@
+import { ESBuildProgram } from '../ESBuildProgram'
+import * as path from 'path'
+import { mkdirp, pathExists, remove, writeJson } from 'fs-extra'
+import { PackageJson } from 'type-fest'
+import { build, Platform, Plugin } from 'esbuild'
+import { nativeNodeModules, nodeExternals } from '../util/esbuildPlugins'
+
+describe('测试 ESBuildProgram', () => {
+  describe('测试 getPlatform', () => {
+    const base: string = path.resolve(__dirname, '.temp/getPlatform')
+    beforeEach(async () => {
+      await remove(base)
+      await mkdirp(base)
+    })
+    it('测试 node 类型', async () => {
+      await writeJson(path.resolve(base, 'package.json'), {
+        devDependencies: {
+          '@types/node': '16',
+        },
+      } as PackageJson)
+      expect(await ESBuildProgram.getPlatform(base)).toBe('node' as Platform)
+    })
+    it('测试浏览器类型', async () => {
+      await writeJson(path.resolve(base, 'tsconfig.json'), {
+        compilerOptions: {
+          lib: ['DOM'],
+        },
+      })
+      expect(await ESBuildProgram.getPlatform(base)).toBe('browser' as Platform)
+    })
+    it('测试通用类型', async () => {
+      expect(await ESBuildProgram.getPlatform(base)).toBe('neutral' as Platform)
+    })
+  })
+  describe('测试 getDeps', () => {
+    const base: string = path.resolve(__dirname, '.temp/getDeps')
+    beforeEach(async () => {
+      await remove(base)
+      await mkdirp(base)
+    })
+    it('基本示例', async () => {
+      await writeJson(path.resolve(base, 'package.json'), {
+        devDependencies: {
+          '@types/node': '16',
+        },
+        dependencies: {
+          ora: '^6',
+        },
+        peerDependencies: {
+          typescript: '^4',
+        },
+      } as PackageJson)
+      const res = (await ESBuildProgram.getDeps(base)).sort()
+      console.log(res)
+      expect(res).toEqual(['@types/node', 'ora', 'typescript'].sort())
+    })
+  })
+  describe('测试构建相关', () => {
+    const base: string = path.resolve()
+    const program = new ESBuildProgram({
+      base,
+      isWatch: false,
+    })
+    let deps: string[]
+    let platform: Platform
+    let plugins: Plugin[]
+    beforeEach(async () => {
+      await remove(path.resolve(base, 'dist'))
+      deps = await ESBuildProgram.getDeps(base)
+      platform = await ESBuildProgram.getPlatform(base)
+      plugins = ESBuildProgram.getPlugins(platform)
+    })
+    it('测试 genDTS', async () => {
+      await program.genDTS()
+      expect(
+        await pathExists(path.resolve(base, 'dist/index.d.ts')),
+      ).toBeTruthy()
+    })
+    it('测试 getBuildCjsOption', async () => {
+      await build(
+        program.getBuildCjsOption({
+          deps: deps,
+          platform: platform,
+        }),
+      )
+      expect(await pathExists(path.resolve(base, 'dist/index.js'))).toBeTruthy()
+    })
+    it('测试 getBuildESMOption', async () => {
+      const option = program.getBuildESMOption({
+        deps: deps,
+        platform: platform,
+      })
+      console.log('option: ', deps, option)
+      await build(option)
+      expect(
+        await pathExists(path.resolve(base, 'dist/index.esm.js')),
+      ).toBeTruthy()
+    })
+    it('测试 getBuildCliOption', async () => {
+      await build(
+        program.getBuildCliOption({
+          deps: deps,
+          platform: platform,
+        }),
+      )
+      expect(await pathExists(path.resolve(base, 'dist/bin.js'))).toBeTruthy()
+    })
+  })
+})
+it('测试 esbuild', async () => {
+  await build({
+    outfile: './dist/bin.js',
+    format: 'cjs',
+    sourcemap: true,
+    entryPoints: ['./src/bin.ts'],
+    bundle: true,
+    external: [
+      ...ESBuildProgram.globalExternal,
+      // ...(await ESBuildProgram.getDeps(path.resolve())),
+    ],
+    platform: 'node',
+    plugins: [nativeNodeModules(), nodeExternals()],
+    treeShaking: true,
+  })
+})

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

@@ -0,0 +1,11 @@
+import Spinnies from 'spinnies'
+
+it('测试 spinnies', async () => {
+  const wait = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
+  const spinnies = new Spinnies()
+  spinnies.add('a', { text: '开始任务 a' })
+  spinnies.add('b', { text: '开始任务 b' })
+  await wait(3000)
+  spinnies.succeed('a', { text: '成功运行任务 a' })
+  spinnies.fail('b', { text: '成功运行任务 b' })
+})

package/src/commands/esbuild/index.ts

@@ -0,0 +1,32 @@
+import { Command } from 'commander'
+import { ESBuildProgram } from './ESBuildProgram'
+import path from 'path'
+
+export const esbuildCommand = new Command('build')
+  .addCommand(
+    new Command('lib')
+      .description('使用 esbulid 将 ts lib 打包到 dist 目录，格式为 esm/cjs')
+      .option('-w --watch', '监视模式')
+      .action(async (option: { watch?: boolean }) => {
+        const buildProgram = new ESBuildProgram({
+          base: path.resolve(),
+          isWatch: !!option.watch,
+        })
+        await buildProgram.buildLib()
+      })
+      .alias('pkg'),
+  )
+  .addCommand(
+    new Command('cli')
+      .description(
+        '使用 esbulid 将 ts cli 打包到 dist 目录，格式为 cjs，并且捆绑依赖',
+      )
+      .option('-w, --watch', '监视模式')
+      .action(async (option: { watch?: boolean }) => {
+        const buildProgram = new ESBuildProgram({
+          base: path.resolve(),
+          isWatch: !!option.watch,
+        })
+        await buildProgram.buildCli()
+      }),
+  )

package/src/commands/esbuild/util/debounce.ts

@@ -0,0 +1,29 @@
+/**
+ * 函数去抖
+ * 去抖 (debounce) 去抖就是对于一定时间段的连续的函数调用，只让其执行一次
+ * 注: 包装后的函数如果两次操作间隔小于 delay 则不会被执行, 如果一直在操作就会一直不执行, 直到操作停止的时间大于 delay 最小间隔时间才会执行一次, 不管任何时间调用都需要停止操作等待最小延迟时间
+ * 应用场景主要在那些连续的操作, 例如页面滚动监听, 包装后的函数只会执行最后一次
+ * 注: 该函数第一次调用一定不会执行，第一次一定拿不到缓存值，后面的连续调用都会拿到上一次的缓存值。如果需要在第一次调用获取到的缓存值，则需要传入第三个参数 {@param init}，默认为 {@code undefined} 的可选参数
+ * 注: 返回函数结果的高阶函数需要使用 {@see Proxy} 实现，以避免原函数原型链上的信息丢失
+ *
+ * @param fn 真正需要执行的操作
+ * @param delay 最小延迟时间，单位为 ms
+ * @param init 初始的缓存值，不填默认为 {@see undefined}
+ * @return 包装后有去抖功能的函数。该函数是异步的，与需要包装的函数 {@param fn} 是否异步没有太大关联
+ */
+export function debounce<
+  T extends (...args: any[]) => any,
+  R extends (...args: Parameters<T>) => Promise<ReturnType<T>>,
+>(fn: T, delay: number, init: any = null): R {
+  let flag: number
+  let result = init
+  return async function (...args) {
+    return new Promise((resolve) => {
+      if (flag) {
+        clearTimeout(flag as any)
+      }
+      flag = setTimeout(() => resolve((result = fn(...args))), delay) as any
+      setTimeout(() => resolve(result), delay)
+    })
+  } as R
+}