剪藏
Rethinking your position
Learn how to learn
3R编码 | nestjs最佳实践 - 课程概览
3R编码 | Node.js开发环境搭建
3R编码 | Nestjs+Eslint+SWC应用初始化及断点调试
3R编码 | 装饰器与反射
3R编码 | Nestjs核心概念
3R编码 | 无懈可击的Linux服务器构建
3R编码 | 使用Turborepo+pnpm workspaces构建monorepo应用
3R编码 | 使用Gitea+Drone自建CICD平台
3R编码 | 整合Typeorm实现CRUD
3R编码 | 请求数据的验证和响应数据的序列化
3R编码 | 数据关联与树形嵌套结构的分类和评论的实现
3R编码 | 自定义全局的验证管道,拦截器和过滤器
3R编码 | 自定义数据验证约束及约束中的依赖注入
3R编码 | 批量操作及软删除(回收站)功能使用
3R编码 | 数据库与MeiliSearch的全文搜索
3R编码 | 数据操作代码的抽象化
3R编码 | 整合bun与pm2实现开发环境与生产环境免编译和自启
3R编码 | 自建配置系统实现
3R编码 | 嵌套路由与Swagger文档实现
3R编码 | 使用Yargs构建命令行工具
3R编码 | 生产环境下静默启动以及PM2 API的使用
3R编码 | 数据迁移功能的实现
3R编码 | 数据填充命令实现
3R编码 | 用户模块开发以及使用Passport实现JWT认证和无痛刷新
3R编码 | 基于CASL的RBAC动态角色及权限系统实现
3R编码 | 模型动态关联与基于CASL的动态权限的实现
3R编码 | 使用BullMQ实现异步验证短信与邮件发送
3R编码 | WebSocket实现消息广播功能
3R编码 | chapter27
3R编码 | chapter28
3R编码 | TS全栈+AI开发实战 - 课程概览
3R编码 | Node.js环境搭建及应用初始化
3R编码 | Next.js应用初始化
3R编码 | React内置Hooks的使用与自定义详解
3R编码 | Next.js中使用Zustand进行状态管理详解
3R编码 | Next.js核心概念及应用构建
微电子学第1话 MOS Differential Pair (I)
微电子学第1话 MOS Differential Pair (I)
微电子学第3话 CMRR
微电子学第2话 MOS Differential Pair (II)
终于有人讲了,凭什么三极管能放大?
降低人类负担:类型系统即边界
固态变压器SST是什么
本站点使用 MrDoc 构建
-
+
3R编码 | 使用Yargs构建命令行工具
### 预先阅读[](#预先阅读 "预先阅读的直接链接") 在学习本节课之前你需要阅读以下文档 - [yargs官网文档](http://yargs.js.org/docs/)或[3R教室的yargs翻译](https://3rcd.com/wiki/yargs/example)(版本较老,建议尽量看官网英文原版) - [Bun在TS中的基本使用](https://bun.sh/docs/typescript) ### 依赖解析[](#依赖解析 "依赖解析的直接链接") - `yargs`是一个构建命令行的工具 - `cross-env`用于跨平台指定环境变量 - `bun`是一个高性能的新型node解析器,能直接快速运行`.ts`源码(在生产环境中亦适用,但只适用于mac,linux等\*nix系统) - `ts-node`是一个**在开发环境**下直接运行`.ts`源码的工具(因为大量吃资源,无法在生产环境中使用,只适用于win平台用于作为替代bun的方案) 如果你是纯windows(非wsl2)下学习本课程,安装以下依赖 危险 非常不建议,热更新会超级慢 ``` pnpm add ts-node -D ``` 如果你在\*nix(mac,linux,wsl2等)下学习本课程,安装以下依赖 ``` pnpm add bun ``` 其他通用的依赖如下 ``` pnpm add yargspnpm add cross-env @types/yargs bun-types -D ``` 首先,我们把这节课的所有类型先编写好,这样后续写功能就会比较流畅了 ### 命令选项[](#命令选项 "命令选项的直接链接") 因为在命令中需要启动一个nestjs实例,对于一些即时运行的命令,比如数据迁移等,需要在运行后退出进程。否则,虽然就算实例关闭了,命令窗口还会卡在那边,因为进程没有结束掉 所以,除了继承yargs默认的`CommandModule`**命令模块**选项外,还需要添加一个`instant`用于设置瞬时命令 ``` // src/modules/core/types.tsexport interface CommandOption<T = RecordAny, U = RecordAny> extends CommandModule<T, U> { /** * 是否为执行后即退出进程的瞬时应用 */ instant?: boolean;} ``` ### 命令构造器[](#命令构造器 "命令构造器的直接链接") 该类型是命令构造函数的类型,这个函数在执行后将生成一个yargs命令模块,在参数中传入`app`,它包含了 - 当前运行的nest实例:`container` - 配置模块实例: `configure` - 以及所有的命令模块: `commands` ``` // src/modules/core/types.tsexport type CommandItem<T = Record<string, any>, U = Record<string, any>> = ( app: Required<App>,) => Promise<CommandOption<T, U>>; ``` ### 命令选项[](#命令选项-1 "命令选项的直接链接") 这是命令构造器的列表数组类型 ``` // src/modules/core/types.tsexport type CommandCollection = Array<CommandItem<any, any>>; ``` ### 应用创建选项[](#应用创建选项 "应用创建选项的直接链接") 改造一下应用创建参数类型,加个构造器列表生成函数类型 ``` // src/modules/core/types.ts/** * 创建应用的选项参数 */export interface CreateOptions { /** * 应用命令 */ commands: () => CommandCollection; // ...} ``` ### App类型[](#app类型 "App类型的直接链接") 同样地,给APP类型也添加一个命令类型,当然这边的命令是已经同构命令构造函数生成可直接传入yargs使用的命令模块 ``` // src/modules/core/types.ts/** * App对象类型 */export type App = { /** * 应用容器实例 */ container?: NestFastifyApplication; /** * 配置类实例 */ configure: Configure; /** * 命令列表 */ commands: CommandModule<RecordAny, RecordAny>[];}; ``` ### 修复应用[](#修复应用 "修复应用的直接链接") 我们分别给应用创建选项`CreateOptions`和应用`App`两个类型添加了`commands`,会看到代码报错了。需要修复一下 ``` // src/options.tsexport const createOptions: CreateOptions = { commands: () => [], // ...};// src/modules/core/helpers/app.ts/** * app实例常量 */export const app: App = { configure: new Configure(), commands: [] }; ``` 因为**bun**自身存在一些esm相关问题,所以我们需要更改几个类型的导入为`import type` ``` // src/modules/content/entities/category.entity.ts// src/modules/content/entities/tag.entity.ts// src/modules/content/entities/post.entity.ts// src/modules/content/entities/comment.entity.tsimport type { Relation } from 'typeorm';// src/modules/content/services/post.service.tsimport type { SearchType } from '../types';// src/modules/meilisearch/meilli.service.tsimport type { MelliConfig } from './types'; ``` 下面我们开始为我们的Nest应用添加自定义命令功能 ### 创建命令[](#创建命令 "创建命令的直接链接") 1. 根据传入的命令构建函数生成函数获取命令构造器列表 2. 执行所有的命令构造器函数,并为每个函数传入`app`参数,获取所有的yargs命令模块 3. 遍历这些命令模块,改造执行器函数。首先关闭container实例,然后执行命令执行器,最后判断如果是瞬时命令就退出进程 ``` // src/modules/core/helpers/command.ts/** * 创建命令 * @param factory * @param app */export async function createCommands( factory: () => CommandCollection, app: Required<App>,): Promise<CommandModule<any, any>[]> { const collection: CommandCollection = [...factory()]; const commands = await Promise.all(collection.map(async (command) => command(app))); return commands.map((command) => ({ ...command, handler: async (args: Arguments<RecordAny>) => { await app.container.close(); await command.handler(args); if (command.instant) process.exit(); }, }));} ``` ### 解析命令[](#解析命令 "解析命令的直接链接") 在app创建后把命令解析出来 ``` // src/modules/core/helpers/app.tsexport const createApp = (options: CreateOptions) => async (): Promise<App> => { // ... app.commands = await createCommands(options.commands, app as Required<App>); return app;}; ``` ### CLI构建[](#cli构建 "CLI构建的直接链接") 该函数用于构建CLI命令,使用生成的命令模块绑定yargs即可 ``` // src/modules/core/helpers/command.ts/** * 构建yargs cli * @param creator */export async function buildCli(creator: () => Promise<App>) { const app = await creator(); const bin = yargs(hideBin(process.argv)); app.commands.forEach((command) => bin.command(command)); bin.usage('Usage: $0 <command> [args]') .scriptName('cli') .demandCommand(1, '') .fail((msg, err, y) => { if (!msg && !err) { bin.showHelp(); process.exit(); } if (msg) console.error(chalk.red(msg)); if (err) console.error(chalk.red(err.message)); process.exit(); }) .strict() .alias('v', 'version') .help('h') .alias('h', 'help') .parse();} ``` ### 演示命令[](#演示命令 "演示命令的直接链接") 我们编写一个模拟命令来看一下效果 ``` // src/modules/core/commands/types.tsexport type DemoCommandArguments = { sleep?: boolean;};// src/modules/core/commands/demo.command.tsexport const DemoCommand: CommandItem<any, DemoCommandArguments> = async (app) => ({ command: ['demo', 'd'], describe: 'A demo command', builder: { sleep: { type: 'boolean', alias: 's', describe: ' App will sleep?', default: false, }, }, handler: async (args: Arguments<DemoCommandArguments>) => { const { configure } = app; const appName = await configure.get<string>('app.name'); const sleep = args.sleep ? ' will to sleep' : ''; console.log(`It's just a demo command, My app ${appName}${sleep}`); },});// src/modules/core/commands/index.tsexport * from './demo.command'; ``` ### 导入命令[](#导入命令 "导入命令的直接链接") 命令编写完后需要导入后才能生效,这边我们直接把命令放在`createCommands` 信息 后续非`CoreModule`核心命令的其他模块命令可以在外部的应用创建时传入 ``` // src/modules/core/helpers/command.tsexport async function createCommands( factory: () => CommandCollection, app: Required<App>,): Promise<CommandModule<any, any>[]> { const collection: CommandCollection = [...factory(), ...Object.values(coreCommands)]; // ...} ``` 要让命令跑起来,我们还需要编写一个运行命令的bin文件 ### 编写BIN[](#编写bin "编写BIN的直接链接") 这里的`#!/usr/bin/env node`用于在应用编译后,直接可以通过文件使用`./dist/console/bin.js`去运行命令,而不需要`node ./dist/console/bin.js`或者`bun ./dist/console/bin.js`去运行。不过我们后面都是用bun直接运行ts源码命令,所以在此处作用不大 这个文件用于创建一个app的创建器,并传入`buildCli`,这样就可以使用yargs构建一个命令工具了 \***nix系统下如下编写** ``` // src/console/bin.tsimport { createOptions } from '@/options';import { buildCli, createApp } from '../modules/core/helpers';buildCli(createApp(createOptions)); ``` **win系统下如下编写(使用`ts-node`加载ts文件)** 危险 再次提醒:强烈不建议使用裸win开发node.js应用,请尽量使用wsl2 提示 注意: win下是`.js`文件,不是`bin.ts` ``` // src\console\bin.js#!/usr/bin/env node/* eslint-disable global-require *//* eslint-disable @typescript-eslint/unbound-method *//* eslint-disable import/no-extraneous-dependencies */const { existsSync } = require('fs');const { resolve } = require('path');const projectPath = resolve(__dirname, '../../tsconfig.build.json');if (existsSync(projectPath)) { require('ts-node').register({ files: true, transpileOnly: true, project: projectPath, });}const { createOptions } = require('../constants');const { buildCli, createApp } = require('../modules/core/helpers');buildCli(createApp(createOptions)); ``` ### 添加脚本[](#添加脚本 "添加脚本的直接链接") 在win下我们把所有脚本添加好,而\*nix下的开发启动和编译等命令请看下一节课 #### \*nix系统[](#nix系统 "*nix系统的直接链接") 最后在`package.json`中添加一个脚本命令,使用`bun`来直接运行`bin.ts` 提示 注意: 这里的`--bun`参数用于透传bun运行时,因为如果运行编译后带有`#!/usr/bin/env node`的js文件可能会自动切换到node运行时。所以为了使用bun运行,必须加上这个参数。但是在此处直接运行ts文件,则不会有任何影响 备注 经测试后,最新版的bun运行nestjs代码无任何问题 ``` { "scripts": { "cli": "./node_modules/bun/bin/bun --bun ./console/bin.ts", // ... },} ``` #### windows系统[](#windows系统 "windows系统的直接链接") ``` { "scripts": { "cli": "cross-env NODE_ENV=development node ./src/console/bin.js", // ... },} ``` 运行`pnpm cli -h`可以看到我们刚才添加的命令已经存在了  运行`pnpm cli demo`或`pnpm demo s`输出应用名称 
peipeo
2026年11月8日 10:33
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码