@liuli-util/cli 3.10.1 → 3.11.0

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

@@ -2,15 +2,19 @@ import { Command } from 'commander'
 import { ESBuildProgram } from './ESBuildProgram'
 import path from 'path'
 
-const buildProgram = new ESBuildProgram(path.resolve())
-export const buildCommand = new Command('build')
+export const esbuildCommand = new Command('build')
   .addCommand(
-    new Command('pkg')
+    new Command('lib')
       .description('使用 esbulid 将 ts lib 打包到 dist 目录，格式为 esm/cjs')
       .option('-w --watch', '监视模式')
       .action(async (option: { watch?: boolean }) => {
-        await buildProgram.buildPkg(!!option.watch)
-      }),
+        const buildProgram = new ESBuildProgram({
+          base: path.resolve(),
+          isWatch: !!option.watch,
+        })
+        await buildProgram.buildLib()
+      })
+      .alias('pkg'),
   )
   .addCommand(
     new Command('cli')
@@ -19,6 +23,10 @@ export const buildCommand = new Command('build')
       )
       .option('-w, --watch', '监视模式')
       .action(async (option: { watch?: boolean }) => {
-        await buildProgram.buildCli(!!option.watch)
+        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
+}

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

@@ -0,0 +1,82 @@
+import { Plugin } from 'esbuild'
+
+/**
+ * 处理 nodejs 原生模块
+ * @link https://github.com/evanw/esbuild/issues/1051#issuecomment-806325487
+ */
+export function nativeNodeModules(): Plugin {
+  return {
+    name: 'native-node-modules',
+    setup(build) {
+      // If a ".node" file is imported within a module in the "file" namespace, resolve
+      // it to an absolute path and put it into the "node-file" virtual namespace.
+      build.onResolve({ filter: /\.node$/, namespace: 'file' }, (args) => ({
+        path: require.resolve(args.path, { paths: [args.resolveDir] }),
+        namespace: 'node-file',
+      }))
+
+      // Files in the "node-file" virtual namespace call "require()" on the
+      // path from esbuild of the ".node" file in the output directory.
+      build.onLoad({ filter: /.*/, namespace: 'node-file' }, (args) => ({
+        contents: `
+        import path from ${JSON.stringify(args.path)}
+        try { module.exports = require(path) }
+        catch {}
+      `,
+      }))
+
+      // If a ".node" file is imported within a module in the "node-file" namespace, put
+      // it in the "file" namespace where esbuild's default loading behavior will handle
+      // it. It is already an absolute path since we resolved it to one above.
+      build.onResolve(
+        { filter: /\.node$/, namespace: 'node-file' },
+        (args) => ({
+          path: args.path,
+          namespace: 'file',
+        }),
+      )
+
+      // Tell esbuild's default loading behavior to use the "file" loader for
+      // these ".node" files.
+      const opts = build.initialOptions
+      opts.loader = opts.loader || {}
+      opts.loader['.node'] = 'file'
+    },
+  }
+}
+
+/**
+ * 排除和替换 node 内置模块
+ */
+export function nodeExternals(): Plugin {
+  return {
+    name: 'esbuild-plugin-node-externals',
+    setup(build) {
+      build.onResolve({ filter: /(^node:)/ }, (args) => ({
+        path: args.path.slice(5),
+        external: true,
+      }))
+    },
+  }
+}
+
+/**
+ * 自动排除所有依赖项
+ * golang 不支持 js 的一些语法，参考 https://github.com/evanw/esbuild/issues/1634
+ */
+export function autoExternal(): Plugin {
+  return {
+    name: 'esbuild-plugin-auto-external',
+    setup(build) {
+      build.onResolve({ filter: /.*/ }, (args) => {
+        if (/^\.{1,2}\//.test(args.path)) {
+          return
+        }
+        return {
+          path: args.path,
+          external: true,
+        }
+      })
+    },
+  }
+}

package/src/commands/generate/GenerateProgram.ts

@@ -9,7 +9,7 @@ import {
   writeFile,
   writeJSON,
 } from 'fs-extra'
-import inquirer from 'inquirer'
+import { prompt } from 'enquirer'
 import { SyncProgram } from '../sync/SyncProgram'
 import { PathUtil } from '../../PathUtil'
 
@@ -30,7 +30,7 @@ export class GenerateProgram {
    */
   async generate(config: GenerateConfig): Promise<void> {
     if (!config.dest) {
-      const { dest } = await inquirer.prompt({
+      const { dest } = await prompt<{ dest: string }>({
         name: 'dest',
         type: 'input',
         message: '请输入项目名',
@@ -41,7 +41,7 @@ export class GenerateProgram {
       config.dest = path.resolve(dest)
     }
     if (!config.template) {
-      const { template } = await inquirer.prompt({
+      const { template } = await prompt<{ template: TemplateTypeEnum }>({
         name: 'template',
         type: 'list',
         message: '请选择模板',
@@ -69,10 +69,12 @@ export class GenerateProgram {
       (await pathExists(destFile)) &&
       (await readdir(destFile)).some((file) => pathExists(file))
     ) {
-      const { override } = await inquirer.prompt({
+      const { override } = await prompt<{
+        override: boolean
+      }>({
         name: 'override',
         type: 'confirm',
-        default: true,
+        initial: true,
         message: '目标位置不是一个空目录，确认要覆盖么？',
       })
       if (!override) {

package/src/commands/sync/SyncProgram.ts

@@ -1,24 +1,16 @@
 import { readFile, readJson, writeFile, writeJson } from 'fs-extra'
 import path from 'path'
-import { execSync } from 'child_process'
-import { merge } from 'lodash'
+import { merge } from 'lodash-es'
 import { PackageJson } from 'type-fest'
 import prettier from '@liuli-util/prettier-standard-config/package.json'
 import eslintTs from '@liuli-util/eslint-config-ts/package.json'
 import eslintReactTs from '@liuli-util/eslint-config-react-ts/package.json'
 import commitlint from '@liuli-util/commitlint-standard-config/package.json'
-import { prompt } from 'inquirer'
+import { prompt } from 'enquirer'
 import { isIncludeDep, isNpmPackage, isYarnRoot, isYarnSubModule } from './when'
 import { appendScript, arrayToMap, AsyncArray } from '../../utils'
 import { PathUtil } from '../../PathUtil'
 
-export function installDeps(base: string, deps: string[]): void {
-  execSync('yarn add -D -W ' + deps.join(' '), {
-    stdio: 'inherit',
-    cwd: base,
-  })
-}
-
 export async function mergeJson(base: string, json: object): Promise<void> {
   const pkgJsonFilePath = path.resolve(base, './package.json')
   await writeJson(
@@ -240,8 +232,10 @@ export class SyncProgram {
       }),
       (item) => item.type,
     )
-    const res = await prompt({
-      type: 'checkbox',
+    const res = await prompt<{
+      sync: string[]
+    }>({
+      type: 'multiselect',
       message: '请选择需要同步的配置项',
       name: 'sync',
       choices: [...configMap.keys()],

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

@@ -1,7 +1,7 @@
 import { mkdir, readJson, remove, writeJson } from 'fs-extra'
 import path from 'path'
 import { SyncConfigType, SyncProgram } from '../SyncProgram'
-import { merge } from 'lodash'
+import { merge } from 'lodash-es'
 import { PackageJson } from 'type-fest'
 
 describe('测试 SyncProgram', () => {
@@ -44,7 +44,7 @@ describe('测试 SyncProgram', () => {
   }, 100_000)
 })
 
-it('测试 lodash.merge', () => {
+it('测试 lodash-es.merge', () => {
   const res = merge({ arr: ['a'] }, { arr: ['b'] })
   expect(res).toEqual({ arr: ['b'] })
 })

package/src/index.ts

@@ -1 +1,3 @@
-export {}
+export * from './commands/esbuild/ESBuildProgram'
+export * from './commands/generate/GenerateProgram'
+export * from './commands/sync/SyncProgram'

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

@@ -1,7 +1,7 @@
 import { appendScript } from '../appendScript'
 
 describe('测试 appendScript', () => {
-  const newScript = 'pinefield sync'
+  const newScript = 'liuli-cli sync'
   it('脚本不存在', () => {
     expect(appendScript(undefined, newScript)).toBe(newScript)
   })

package/templates/cli/package.json

@@ -26,7 +26,7 @@
     "inquirer": "^8.1.5"
   },
   "devDependencies": {
-    "@liuli-util/cli": "^3.10.1",
+    "@liuli-util/cli": "^3.11.0",
     "@types/fs-extra": "^9.0.13",
     "@types/inquirer": "^8.1.2",
     "@types/jest": "^27.0.2",

package/templates/lib/package.json

@@ -18,7 +18,7 @@
     "preset": "ts-jest"
   },
   "devDependencies": {
-    "@liuli-util/cli": "^3.10.1",
+    "@liuli-util/cli": "^3.11.0",
     "@types/jest": "^27.0.2",
     "esno": "^0.9.1",
     "gh-pages": "^3.2.3",

package/dist/commands/generate/__tests__/GenerateProgram.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=GenerateProgram.test.d.ts.map

package/dist/commands/generate/__tests__/GenerateProgram.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"GenerateProgram.test.d.ts","sourceRoot":"","sources":["../../../../src/commands/generate/__tests__/GenerateProgram.test.ts"],"names":[],"mappings":""}

package/dist/commands/sync/__tests__/SyncProgram.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=SyncProgram.test.d.ts.map

package/dist/commands/sync/__tests__/SyncProgram.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SyncProgram.test.d.ts","sourceRoot":"","sources":["../../../../src/commands/sync/__tests__/SyncProgram.test.ts"],"names":[],"mappings":""}

package/dist/commands/sync/__tests__/when.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=when.test.d.ts.map

package/dist/commands/sync/__tests__/when.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"when.test.d.ts","sourceRoot":"","sources":["../../../../src/commands/sync/__tests__/when.test.ts"],"names":[],"mappings":""}