使用 Node,如何制作一个专业的命令行工具?
共 6010字，需浏览 13分钟
·
2021-11-16 19:14
使用 Node 开发一个命令行工具很有意思，较为其它语言而言也更加简单，今天山月写一篇文章总结一下如何写一个友好且健壮的 cli 工具。
在阅读完本篇文章之后，「强烈推荐阅读」 Github 上的一篇文章: Node CLI 工具最佳实践。正如它的标题而言，在 Github 上用于 2000 颗星星的该文章的确称得上最佳实践。
长按识别二维码查看原文
标题：Node CLI 工具最佳实践「目录」
1. 命令行工具与环境变量 PATH2. 原理3. 从 package.json 说起4. 一个执行环境5. 解析命令输入6. 用户体验与丰富的色彩7. 可交互性8. 发布与安装9. 总结
1. 命令行工具与环境变量 PATH
什么是命令行工具？
最初印象大致是 ls，pwd 这些能够「在终端执行的系统命令」，这样的命令很多，数不胜数，被称为系统内置命令。
如果使用 which 查看他们的来历，则能够发现他们的庐山真面目:
# 由此可知，pwd 为一个系统内置命令
$ which pwd
pwd: shell built-in command
随着对 Linux/Unix 系统理解及使用的逐渐加深，发现了诸多的非内置命令:
top
ps
netstat
dig
man
使用 which 追根究底，发现它们实际执行的路径在某一个 bin 目录
$ which top
/usr/bin/top
$ which ps
/bin/ps
而这些 bin 目录在环境变量 PATH 中，豁然开朗。简而言之: 「在环境变量的 PATH 中路径的命令可在其它任意地方执行」。
export PATH=$HOME/bin:/usr/local/bin:$PATH
说起环境变量，你可以使用
env列出所有的环境变量。$ env
LANG=zh_CN.UTF-8
USER=root
LOGNAME=root
HOME=/root
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin
你好像想起点什么？在大学配置 Java 时被环境变量支配的各种恐惧？
是了，所有语言的可执行命令都要放在 PATH 下，只不过其它语言的安装工具自动给你做了这件事，而 Java 让你自己来处理它。
java
python
pip
node
npm
「开发命令行的原理也是如此，将你开发的命令行工具脚本置于环境变量 PATH 下的路径之中」，而本篇文章的目标就是:
使用 Javascript 这门前端开发者熟悉的语言，借助 Node 环境，开发一个命令行工具。
2. 原理
先看两个 Node 的命令行工具:
[serve](https://github.com/vercel/serve)一个流行的静态文件服务器，大名鼎鼎 Vercel 团队(Next.js 团队)的力作markdown一个山月自己写的解析 URL 到 markdow 的命令行。通过命令解析出他们指向的符号链接
$ ls -lah $(which serve)
lrwxr-xr-x 1 xiange admin 65B 7 12 2020 /usr/local/bin/serve -> ../../../Users/shanyue/.config/yarn/global/node_modules/.bin/serve
$ ls -lah $(which markdown)
lrwxr-xr-x 1 xiange admin 48B 1 28 20:06 /usr/local/bin/markdown -> ../lib/node_modules/markdown-read/md-read-cli.js
从中可以看出关于 Node 全局命令行的原理:
npm 全局下载某个 package 到路径
/usr/local/lib/node_modules下 (yarn 同理，对应路径~/.config/yarn/global/node_modules)根据该库的 package.json 中
bin字段的指示，把对应的命令行路径通过符号索引挂载到 PATH 路径对应的二进制脚本添加 x 权限 (可执行文件权限)
简而言之，Node 环境下的命令行工具，借助的原理无非是「环境变量 Path」与一个「符号链接」
3. 从 package.json 说起
在 「package.json 中的 bin 字段」，用以指定最终的命令行工具的名字
{
"bin": {
"serve": "./bin/serve.js"
}
}
如上所示，server 是最终在终端执行的命令，而 ./bin/serve.js 是该命令实际执行的脚本文件。
对于最终可执行的命令行工具，Node 项目一般倾向置文件于 bin 目录下，如以下 Typescript 关于它命令行的配置:
{
"bin": {
"tsc": "./bin/tsc",
"tsserver": "./bin/tsserver"
},
}
4. 一个执行环境
对于可直接执行的文件，需要指明执行环境，首行添加一行说明:
#!/usr/bin/env node
// code 往下写
这一句话是啥子意思了？
#!加解释器，标明该文件使用/usr/bin/env node来执行/usr/bin/env为 env 的绝对路径，用以在 PATH 路径中执行命令 (在各种不同的系统中，node 命令行的位置不同，因此使用env node找到路径并执行)env node在人为层面可理解为执行node命令
所以这句话的意思是: 「使用 node 解释器来执行这个脚本，而通过 env node 能够正确定位到 node 解释器的位置」
// 如果不写 #!/usr/bin/env node，需要这么执行
$ node serve .
// 如果写上 #!/usr/bin/env node，可以直接执行
$ serve .
5. 解析命令输入
在服务端应用中，可以通过 request.url.querystring 及 request.body 获取用户输入。
而在命令行工具中，可通过 progress.argv 可获取用户输入。请看以下示例：
$ node cmd.js 1 2 3
// Output: [
// '/usr/local/bin/node',
// '/Users/shanyue/cmd.js',
// '1',
// '2',
// '3',
// ]
process.argv
根据解析 process.argv 可以定制格式来获取各式各样的参数作为命令行的输入。`
当然解析参数也要参照 POSIX 兼容的基本规律: 格式、可选、必选、简写、说明、帮助等等。命令行工具命名协议 文章中已说的足够详细。
长按识别二维码查看原文
标题：命令行工具命名协议// 一个较为规整的命令行帮助
$ node --help
Usage: node [options] [ script.js ] [arguments]
node inspect [options] [ script.js | host:port ] [arguments]
Options:
- script read from stdin (default if no file name is provided,
interactive mode if a tty)
-- indicate the end of node options
--abort-on-uncaught-exception aborting instead of exiting causes a core file to be generated for
analysis
-c, --check syntax check script without executing
--completion-bash print source-able bash completion script
--cpu-prof Start the V8 CPU profiler on start up, and write the CPU profile to
disk before exit. If --cpu-prof-dir is not specified, write the profile
to the current working directory.
因为 POSIX 兼容繁杂的规则，以此衍生出了关于解析命令参数的多个库，站在巨人的肩膀上，在实际工作中就直接开用吧！
yargs: Star 8.5K，周下载量 4900K
长按识别二维码查看原文
标题：yargscommander: Star 19.7K，周下载量 5300K，tj 大神的作品
长按识别二维码查看原文
标题：commander
以下是一个 Demo: 使用 commander 解析不同的输入指令
const { program } = require('commander')
// 解析不同的指令输入
program
.option('-d, --debug', 'output extra debugging')
.option('-s, --small', 'small pizza size')
.option('-p, --pizza-type ' , 'flavour of pizza')
program.parse(process.argv)
const options = program.opts()
console.log(options)
6. 用户体验与丰富的色彩
Next 构建输出以上是 next build 命令行的标准输出，拥有色彩多样的高亮格式与丰富的列表展示，可以提供更丰富的用户体验。
目前大部分终端已支持彩色输出，即通过 ANSI 编码进行控制，并拥有成熟的库控制色彩。如 ansi-styles
长按识别二维码查看原文
标题：ansi-stylesimport styles from 'ansi-styles';
console.log(`${styles.green.open}Hello world!${styles.green.close}`);
丰富的高亮色彩如同代码高亮一样使用户可以快速抓住重点。把异常、警告、成功的信息用不同的颜色标出，命令行工具的输出一目了然。在现代构建工具，如 Webpack 下，也大都支持彩色输出。
以下是在命令行工具中常用的两个较为高级的色彩库，支持多种多样色彩的输出，当然基本原理仍是 ANSI 编码。
chalk
长按识别二维码查看原文
标题：chalkcolors
长按识别二维码查看原文
标题：colors
以下是 chalk 示例，Error 与 Warning 信息用不同的颜色表示
const chalk = require('chalk')
const error = chalk.bold.red
const warning = chalk.keyword('orange')
console.log(error('Error!'))
console.log(warning('Warning!'))
7. 可交互性
在 Web 中，可使用 Input 来展现丰富多彩的表单，如开关、多选、单选、输入框等。而在命令行工具中，也可借用多种库来实现强交互性。
enquirer
长按识别二维码查看原文
标题：enquirerora
长按识别二维码查看原文
标题：oraink
长按识别二维码查看原文
标题：ink
8. 发布与安装
在辛苦努力写完一个 cli 工具后，就是检验成果的时候。发布到 npm 仓库，可使所有人使用你的命令行工具，这也是最重要的一步
# 发布之前需要 npm login，登录到 npm registory
$ npm publish
发版成功后全局下载命令行工具，开始使用，示例用它抓取下我的博客首页
$ npm i -g markdown-read
/usr/local/bin/markdown -> /usr/local/lib/node_modules/markdown-read/md-read-cli.js
+ markdown-read@1.1.0
added 102 packages from 72 contributors and updated 10 packages in 33.15s
$ markdown https://shanyue.tech
## [#](#山月的琐碎博客记录) 山月的琐碎博客记录
本博客关于平常工作中在前端，后端以及运维中遇到问题的一些文章总结。以后也会做系列文章进行输出，如前端高级进阶系列，个人服务器指南系列。个人微信 shanyue94，欢迎添加交流
## [#](#名字由来) 名字由来
9. 总结
本篇文章由浅至深讲解了以下几方面的内容:
一个全局可执行的命令行工具的原理是什么
在 Node 中开发一个命令行工具所需要的配置
开发命令行工具时如何解析参数
并根据实践，开发了一个从 URL 中读取 Markdown 的小工具: markdown-read，欢迎 Star、下载及使用。
长按识别二维码查看原文
标题：markdown-read另外，我基于此命令行做了一个 Web 版，欢迎来体验: https://devtool.tech/html-md
HTML To Markdown 网页版