第43章 模板详解
第43章:Templates
运行 oclif generate 时,系统会提示你选择使用 CommonJS 还是 ESM 来构建你的 CLI。CommonJS 模块是 Node.js 中打包和复用 JavaScript 及 TypeScript 包的早期方式,而 ESM 模块现已成为官方标准格式。无论选择哪种方案,生成的 CLI 功能完全一致,包括相同的 tsconfig 文件、bin 脚本、示例命令等。
下面简要说明新生成的 CLI 中包含的内容。
Bin 脚本 生成的 CLI 项目包含 4 个 bin 脚本,既可用于生产环境,也可用于开发环境:
- bin/run.js:在生产环境运行 CLI(macOS 和 Linux) - bin/dev.js:在开发环境运行 CLI(macOS 和 Linux) - bin/run.cmd:在生产环境运行 CLI(Windows) - bin/dev.cmd:在开发环境运行 CLI(Windows)
package.json 中的 bin 入口指向 bin/run.js 文件,该文件指导 npm 在安装 CLI 时使用此脚本。如果使用 oclif pack 创建操作系统特定的安装程序,则会根据目标操作系统,将相应的运行脚本添加到最终的安装程序中。
我们建议本地开发时使用 dev 脚本。这样 oclif 会在运行时自动转译你的 TypeScript,无需在每次执行命令前手动编译代码。此外,dev 脚本会生成更详细的警告和错误信息,有助于快速定位问题。
dev.js 脚本使用 ts-node 作为 Node.js 运行时。但如果你偏好其他运行时,也可以使用以下任意一种:
- TypeScript Execute (tsx) - Bun - node - 如果使用 node 和 ESM,请确保使用允许 ESM 模块的 loader,例如 --loader ts-node/esm。详见 ESM 章节。
对于上述所有 Node.js 运行时,你可以将 dev.js 和 run.js 文件中的 hashbang (#!) 指向运行时的全局安装路径(如 ts-node),或指向本地安装路径(node_modules/.bin/ts-node)。
配置 生成的 CLI 还附带了几个配置文件,你可以轻松修改甚至移除这些文件以适应自身需求:
- .eslintrc.json:我们推荐的 eslint 插件和配置。 - .eslintignore:配合推荐 eslint 配置的 .eslintignore 文件。 - .mocharc.json:我们推荐的 mocha 配置。 - .prettierrc.json:我们推荐的 prettier 配置,基于 @oclif/prettier-config。 - tsconfig.json:我们推荐的 TypeScript 项目编译器选项。 - package.json:我们推荐的脚本、依赖项和 oclif 配置。
示例命令 生成的 CLI 项目包含两个示例命令,可作为构建自定义命令的基础:
- hello:src/commands/hello/index.ts - hello world:src/commands/hello/world.ts
示例测试 tests 目录下为每个示例命令生成了对应的测试文件。
这些测试使用 @oclif/test 和 mocha。但你可以根据实际需求,自由选择其他测试工具来配置测试。