第12章 别名(Aliases)
命令别名
通过别名,你可以定义一个映射到特定命令的字符串。该命令可以通过 mycli config、mycli config:index 或 mycli config:list 等方式运行:
import {Command, Flags} from '@oclif/core' export class ConfigIndex extends Command { static aliases = ['config:index', 'config:list'] }
默认情况下,别名会定位到“真实”命令并直接执行。如果你为了向后兼容而提供命令别名,但希望用户优先使用“真实”命令名称,可以将 deprecateAliases 设置为 true,以提醒用户正确的命令名:
export class ConfigIndex extends Command { static aliases = ['config:index', 'config:list'] static deprecateAliases = true }
标志别名
这与命令别名类似,但作用于单个标志(Flag)。你可以为名称和短字符设置别名,并可选地在用户使用别名时发出警告:
export class ConfigIndex extends Command { static flags = { 'new-name': Flags.boolean({ char: 'c', aliases: ['old-name', 'o'], deprecateAliases: true }) } }
Bin 别名
创建一个能响应不同名称或“别名”的 CLI 很简单,只需在你的 CLI 的 package.json 中的 oclif 属性下添加 binAliases 即可:
{ "name": "mycli", "version": "0.0.0", "description": "My CLI", "main": "bin/run.js", "bin": { "mycli": "./bin/run.js", "mycli-alias": "./bin/run.js" }, "oclif": { "binAliases": ["mycli", "mycli-alias"] } }
添加此属性后,你的 CLI 就能响应这些名称中的任意一个。该属性在打包和构建过程中被使用,以分发给用户。注意,bin 部分也被修改以包含这两个别名,这正是 npm 创建 bin 别名的方式。为了提供统一的体验,无论采用何种安装方式,CLI 作者都必须将两者修改为一致。Bin 别名与 @oclif/plugin-autocomplete 配合良好,因此输入别名并使用自动补全的体验与使用原始名称完全相同。