@liuli-util/cli 3.12.0 → 3.15.0

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

@@ -1,4 +1,5 @@
 import { Plugin } from 'esbuild'
+import { writeJson } from 'fs-extra'
 
 /**
  * 处理 nodejs 原生模块
@@ -28,13 +29,10 @@ export function nativeNodeModules(): Plugin {
       // 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',
-        }),
-      )
+      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.
@@ -80,3 +78,18 @@ export function autoExternal(): Plugin {
     },
   }
 }
+
+/**
+ * 生成 metafile 的插件
+ * @param metafilePath
+ */
+export function metafile(metafilePath: string): Plugin {
+  return {
+    name: 'esbuild-plugin-metafile',
+    setup(builder) {
+      builder.onEnd(async (result) => {
+        await writeJson(metafilePath, result.metafile)
+      })
+    },
+  }
+}

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__/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__/.temp/package.json

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

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

@@ -5,7 +5,7 @@ import { merge } from 'lodash-es'
 import { PackageJson } from 'type-fest'
 
 describe('测试 SyncProgram', () => {
-  const tempPath = path.resolve(__dirname, 'temp')
+  const tempPath = path.resolve(__dirname, '.temp')
   const syncProgram = new SyncProgram(tempPath)
   beforeEach(async () => {
     await remove(tempPath)
@@ -30,9 +30,9 @@ describe('测试 SyncProgram', () => {
       workspaces,
     } as PackageJson)
     await syncProgram.sync()
-  }, 100_000)
+  })
 
-  it('测试初始化同步配置', async () => {
+  it.skip('测试初始化同步配置', async () => {
     await writeJson(path.resolve(tempPath, 'lerna.json'), {})
     const file = path.resolve(tempPath, 'package.json')
     await writeJson(file, {
@@ -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/commands/sync/__tests__/when.test.ts

@@ -1,9 +1,4 @@
-import {
-  isIncludeDep,
-  isNpmPackage,
-  isYarnRoot,
-  isYarnSubModule,
-} from '../when'
+import { isIncludeDep, isNpmPackage, isYarnRoot, isYarnSubModule } from '../when'
 import { pathExists, readJson } from 'fs-extra'
 import { PackageJson } from 'type-fest'
 import path from 'path'
@@ -15,32 +10,25 @@ describe('测试 when', () => {
   beforeAll(async () => {
     rootPath = (await findParent(__dirname, async (dir) => {
       const jsonPath = path.resolve(dir, 'package.json')
-      return (
-        (await pathExists(jsonPath)) &&
-        !!((await readJson(jsonPath)) as PackageJson).workspaces
-      )
+      return (await pathExists(jsonPath)) && !!((await readJson(jsonPath)) as PackageJson).workspaces
     }))!
-    subModulePath = (await findParent(__dirname, async (dir) =>
-      pathExists(path.join(dir, 'package.json')),
-    ))!
+    subModulePath = (await findParent(__dirname, async (dir) => pathExists(path.join(dir, 'package.json'))))!
   })
   it('测试 isNpmPackage', async () => {
     expect(await isNpmPackage(subModulePath)).toBeTruthy()
     expect(await isNpmPackage(rootPath)).toBeTruthy()
     expect(await isNpmPackage(__dirname)).toBeFalsy()
   })
-  it('测试 isYarnRoot', async () => {
+  it.skip('测试 isYarnRoot', async () => {
     expect(await isYarnRoot(rootPath)).toBeTruthy()
     expect(await isYarnRoot(subModulePath)).toBeFalsy()
   })
-  it('测试 isYarnSubModule', async () => {
+  it.skip('测试 isYarnSubModule', async () => {
     expect(await isYarnSubModule(subModulePath)).toBeTruthy()
     expect(await isYarnSubModule(rootPath)).toBeFalsy()
     expect(await isYarnSubModule(__dirname)).toBeFalsy()
   })
   it('测试 isIncludeDep', async () => {
-    expect(
-      await isIncludeDep(['vue'], path.resolve(__dirname, 'temp')),
-    ).toBeFalsy()
+    expect(await isIncludeDep(['vue'], path.resolve(__dirname, 'temp'))).toBeFalsy()
   })
 })

package/templates/cli/bin.js

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

package/templates/cli/package.json

@@ -8,37 +8,31 @@
   "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"
+    "start": "esno src/bin.ts"
   },
   "bin": {
-    "cli-name": "dist/bin.js"
+    "cli-name": "./bin.js"
   },
   "jest": {
     "preset": "ts-jest"
   },
   "dependencies": {
     "commander": "^8.2.0",
-    "fs-extra": "^10.0.0",
-    "inquirer": "^8.1.5"
+    "enquirer": "^2.3.6",
+    "fs-extra": "^10.0.0"
   },
   "devDependencies": {
-    "@liuli-util/cli": "^3.11.1",
+    "@liuli-util/cli": "workspace:*",
     "@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/templates/lib/package.json

@@ -8,25 +8,19 @@
   "license": "MIT",
   "scripts": {
     "build": "rimraf dist && liuli-cli build pkg",
-    "dev": "liuli-cli build pkg -w",
-    "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"
+    "dev": "liuli-cli build pkg -w"
   },
   "jest": {
     "preset": "ts-jest"
   },
   "devDependencies": {
-    "@liuli-util/cli": "^3.11.1",
+    "@liuli-util/cli": "workspace:*",
     "@types/jest": "^27.0.2",
     "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/esbuild/__tests__/.temp/getDeps/package.json

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