科技微讯

如何用 Node.js 写一个 CLI 工具

使用 commander 可以方便的写一个 CLI 命令行工具,需要注意在 index.js 开头增加 #! /usr/bin/env node,并在 package.json 增加 bin 字段,例如:

"bin": {
    "todos": "./index.js" //todos 就是我们需要输入的命令,类似 ls、cd
}

发布前建议先在本地进行测试,测试的第一个步骤就是安装,有两种安装方式:

如果这个命令行工具只用于内部,不对外公开,可不发布到 npm,可通过 npm 的 workspace 功能让其他 project 直接引用。当然也可以作为 private package 发布到 npm 官方 registry 或 GitHub 的 npm registry。

可通过 package.json 中的 "files" 字段设置哪些文件会被发布到 registry,可通过 npm pack 检查 "files" 字段的设置是否正确以及是否生效。


参考文章:

暂无评论