进阶 oclif.io 2026-10-18 02:37:03 · 21 阅读
第27章 启用灵活分类 (Flexible Taxonomy)
灵活分类
如果你希望用户在执行命令时不必严格遵循预定义的命令分类结构,可以启用 flexibleTaxonomy,并在 package.json 的 oclif 配置节中添加一个钩子:
{
"oclif": {
"flexibleTaxonomy": true,
"hooks": {
"command_incomplete": "./dist/hooks/command_incomplete.js"
}
}
}
启用灵活分类主要有两大好处:
- 提升 CLI 的用户友好性。例如,假设存在命令
my-cli foobars list,若用户误输入my-cli list foobars,oclif 会自动识别并执行foobars list,而不会抛出错误。 - 当用户仅提供命令的部分参数时,有机会提示用户选择正确的完整命令。这有助于提高单个命令的可发现性,尤其是在命令数量庞大的场景下。更多细节请参阅“钩子实现”部分。
钩子实现
当 flexibleTaxonomy 处于启用状态时,只要用户输入不完整的命令(例如完整命令是 one two three,但用户只输入了 two),oclif 就会触发 command_incomplete 钩子。该钩子为你创建交互式用户体验提供了可能。
以下示例展示了如何使用 inquirer 包提示用户选择要运行的命令:
import { Hook, toConfiguredId, toStandardizedId } from '@oclif/core';
import { select } from '@inquirer/prompts';
const hook: Hook.CommandIncomplete = async function ({
config,
matches,
argv,
}) {
const command = await select({
message: 'Which of these commands would you like to run?',
choices: matches.map((p) => toConfiguredId(p.id, config)),
});
if (argv.includes('--help') || argv.includes('-h')) {
return config.runCommand('help', [toStandardizedId(command, config)]);
}
return config.runCommand(toStandardizedId(command, config), argv);
};
export default hook;
用户看到的提示界面如下:
$ my-cli list
? Which of these commands did you mean (Use arrow keys)
❯ foobars list
config list
env list