进阶 oclif.io 2026-10-18 02:37:03 · 31 阅读
第46章 CLI 命令主题 (Topics) 的组织与配置
主题
随着 CLI 的规模不断扩大,将命令嵌套在“主题”中会很有用。只需将命令文件放入子目录即可实现。例如,Salesforce CLI 中有一个 sf config 主题,其中包含 sf config set 和 sf config get 等命令。目录结构如下:
package.json
src/
└── commands/
└── config/
├── index.ts
├── set.ts
└── get.ts
帮助说明默认为该目录下第一个命令的描述。如需自定义帮助说明,请将其添加到 package.json 中,格式如下: {
"oclif": {
"topics": {
"apps:favorites": { "description": "manage favorite apps" },
"config": { "description": "manage heroku config variables" },
}
}
}
可以通过在主题目录中创建子目录来生成子主题,但从用户体验角度出发,我们通常不建议层级超过 1 到 2 层,即使对于最大的 CLI 也是如此。
src/
└── commands/
└── config/
├── index.ts
├── set.ts
└── get.ts
帮助说明默认为该目录下第一个命令的描述。如需自定义帮助说明,请将其添加到 package.json 中,格式如下: {
"oclif": {
"topics": {
"apps:favorites": { "description": "manage favorite apps" },
"config": { "description": "manage heroku config variables" },
}
}
}
可以通过在主题目录中创建子目录来生成子主题,但从用户体验角度出发,我们通常不建议层级超过 1 到 2 层,即使对于最大的 CLI 也是如此。