从 1 到完美，用 node 写一个命令行工具

1. package.json 中的 bin 字段

现在，不管是前端项目还是 node 项目，一般都会用 npm 做包管理工具，而 package.json是其相关的配置信息。

对 node 项目而言，模块导出入口文件由 package.json 的 main 字段指定，而如果是要安装到命令行的工具，则是由 package.json 的 bin 字段指定。

1.1 配置单个命令

与包名同名

1. {

2.  "name": "pro",

3.  "bin": "bin/pro.js"

4. }

这样安装的命令名称就是 pro。

自定义命令名称（与包名不同名）

1. {

2.  "name": "pro-cli",

3.  "bin": {

4.    "pro": "bin/pro.js"

5.  }

6. }

这样安装的命令名称也是 pro。

1.2 配置多个命令

1. {

2.  "name": "pro-cli",

3.  "bin": {

4.    "pro": "bin/pro.js",

5.    "mini": "bin/mini.js"

6.  }

7. }

这样安装就有 pro 与 mini 两个命令。

2. 对应 bin/pro.js 文件的写法

1. #!/usr/bin/env node

3. require('../lib/pro');

与普通的 js 文件写法一样，只是前面要加上 #!/usr/bin/env node。

这段前缀代码叫 shebang，具体可以参考 Shebang (Unix) - Wikipedia。

3. 安装方式

3.1 全局安装

1. npm i -g pro-cli

这种安装方式可以在命令行全局使用。

1. pro dev

3. pro build

3.2 本地安装

1. npm i --save-dev pro-cli

这种安装方式需要配合 npm 一起使用，比如：

1. # package.json

2. {

3.  "scripts": {

4.    "dev": "pro dev",

5.    "build": "pro build"

6.  }

7. }

9. # 使用

10. npm run dev

11. npm run build

4. 选择合适的命令行封装库

一般来说，一个命令都会有如下的一些参数：

• -v,--version 或 -V,--version：查看版本号

• -h,--help：查看帮助信息

如果完全自己来写的，就会很麻烦，尤其是帮助信息。所以，选择一个好的命令行封装库，能够帮我们省去很多工作。

用的比较多的：

• commander.js

• yargs

• meow

以 commander.js 为例。

4.1 安装

1. npm install commander --save

4.2 注册

1. const commander = require('commander');

注册版本号与描述：

1. commander

2.  .version('0.0.1')

3.  .description('A cli application named pro');

注册参数（非子命令参数）：

1. commander

2.  .option('-p, --peppers', 'Add peppers')

3.  .option('-P, --pineapple', 'Add pineapple')

4.  .option('-b, --bbq-sauce', 'Add bbq sauce')

5.  .option('-c, --cheese [type]', 'Add the specified type of cheese [marble]', 'marble')

注册子命令：

1. commander

2.  .command('rm <dir>')

3.  .option('-r, --recursive', 'Remove recursively')

4.  .action((dir, cmd) => {

5.    console.log('remove ' + dir + (cmd.recursive ? ' recursively' : ''))

6.  })

解析：

1. commander.parse(process.argv);

4.3 使用

查看版本号：

1. pro -V

2. pro --version

4. # 打印结果

5. 0.0.1

运行 rm 子命令：

1. pro rm dir

查看帮助（ commander 会自动生成）：

1. pro -h

2. pro --help

4. # 打印结果

5. Usage: pro [options]

7. A cli application named pro

9. Options:

10.  -h, --help           output usage information

11.  -V, --version        output the version number

12.  -p, --peppers        Add peppers

13.  -P, --pineapple      Add pineapple

14.  -b, --bbq            Add bbq sauce

15.  -c, --cheese <type>  Add the specified type of cheese [marble]

16.  -C, --no-cheese      You do not want any cheese

更多用法查看 commander.js。

5. 常用的命令行相关工具库

5.1 minimist 解析命令行的参数

1. var argv = require('minimist')(process.argv.slice(2));

2. console.dir(argv);

1. $ node example/parse.js -a beep -b boop

2. { _: [], a: 'beep', b: 'boop' }

1. $ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop foo bar baz

2. { _: [ 'foo', 'bar', 'baz' ],

3.  x: 3,

4.  y: 4,

5.  n: 5,

6.  a: true,

7.  b: true,

8.  c: true,

9.  beep: 'boop' }

更多参考 minimist。

5.2 chalk: 让命令行的字符带上颜色

更多参考 chalk。

5.3 Inquirer.js 让命令行与用户进行交互，如输入、选择等。

更多参考 Inquirer.js。

5.4 shelljs 跨平台 Unix shell 命令 的 node 封装

1. var shell = require('shelljs');

3. if (!shell.which('git')) {

4.  shell.echo('Sorry, this script requires git');

5.  shell.exit(1);

6. }

8. // Copy files to release dir

9. shell.rm('-rf', 'out/Release');

10. shell.cp('-R', 'stuff/', 'out/Release');

12. // Replace macros in each .js file

13. shell.cd('lib');

14. shell.ls('*.js').forEach(function (file) {

15.  shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file);

16.  shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file);

17.  shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file);

18. });

19. shell.cd('..');

21. // Run external tool synchronously

22. if (shell.exec('git commit -am "Auto-commit"').code !== 0) {

23.  shell.echo('Error: Git commit failed');

24.  shell.exit(1);

25. }

更多参考 shelljs。

5.5 blessed-contrib 命令行图表

更多参考 blessed-contrib。

5.6 cash 跨平台 linux 命令 的 node 封装

与 shelljs 功能差不多。

1. const $ = require('cash');

2. const out = $.ls('.', {l: true});

更多参考 cash。

5.7 prompts 又一个让命令行与用户进行交互的工具

与 Inquirer.js 功能差不多。

更多参考 prompts。

5.8 ora 命令行加载中图标

更多参考 ora。

5.9 progress 命令行进度条

1. downloading [=====             ] 39/bps 29% 3.7s

更多参考 progress。

5.10 更多

更多关于命令行的工具库可以参考 command-line-utilities。

6. 比较常用的命令行 APP

命令行相关的应用就很多啦，比如 babel、 webpack、 rollup、 eslint 等，但这些不仅仅是命令行工具。

下面介绍一些纯命令行应用：

• vtop: 美美的 linux top 命令界面

• speed-test: 测试网络链接速度

• http-server: 零配置启动一个 http 服务器

• fkill-cli: 跨平台 kill 命令

更多纯命令行应用可以参考 command-line-apps。

原文发布时间为：2018-10-13

本文作者：senntyou

本文来自云栖社区合作伙伴“前端大学”，了解相关信息可以关注“前端大学”。