【Node.js】十行代码开发一个 Node 命令行工具(有道词典)

开发命令行原理

看似很神奇的功能，其实本质十分简单。

#!/usr/bin/env node
这句话，告诉了 *nix 系统，当前文件，应该使用什么工具/软件来执行

而这，就是 node 开发命令行工具的原理。也是其它语言开发命令行工具的原理，可以对比于 windows 下的 bat 文件。

基础知识

既然讲到基础，那就尽可能使用原生的语言、不引用多余模块的方式进行开发。

Node 命令行工具开发中，最重(常)要的代码/原生语句就是
1. process 系列：

process.argv;
process.on(single, callback);
process.exit(0);

其中, process.argv 用于获取敲击命令时，传入的参数；
process.exit() 用来退出程序，0 表示正常退出；process.on() 用来监听、接收系统传过来的信号（一般使用 kill -s 来传递 SINGLE 信号）

1. node 系列：
   

   这个系列的比较多。在使用 process 获取到输入的参数，node 就可以根据这些参数去做一些想做的事了。

如果操作完后，想操作文件，保存、修改、上传什么的，那就要用到其它模块了。这里也给 Node 的模块参考。比如： path、 fs、 request等了。

生成可执行命令

1. 写好的文件，在 *nix 系统中，是只有读写操作的。需要更改文件的可执行属性。

chmod 755 targetFile

1. 修改属性后的文件，具有了可以被执行的能力。在文件所在的目录下，敲入

./targetFile [arg1 arg2 ...]

即可执行. arg* 为你想传入的参数。
3. 这个时候，使用起来并不方便。我们可以使用 npm link 将当前文件软链接至全局对象下.

{
    "name": '你的工具名',
    "bin": {
        "myCommand": targetFile
    }
}

其中 myCommand 是你要在全局中使用该工具的名字。比如，你想输入 doSomething 来运行你写的工具。targetFile 指的是你写的文件名。即包含 #!/usr/bin/env node 语句的文件。

简单 Demo

以做一个命令行版本的翻译工具为例。
1. 创建文件夹 /translate/

mkdir translate

1. 打开文件夹。这里默认使用的是 vscode

code ./translate/

1. 编写 index.js

#!/usr/bin/env node
'use strict';
let q = require('request');

let word = process.argv[2] || 'try once';
q.get('http://fanyi.youdao.com/openapi.do?keyfrom=node-translator&key=2058911035&type=data&doctype=json&version=1.1&q=' + word, function(error, res, body){
    console.log('get the ', word, " is: ", JSON.parse(body).translation);
});

这里使用了网易的 API。参考，并引用了 正凯 的博文。由于现在申请 AI youdao 比以前麻烦很多，故直接使用了 正凯 的接口，大家用作参考即可，正式使用。

1. 修改 index.js 的属性

chmod 755 index.js

1. 编写 package.json 文件。在同目录下，编写

{
    "name": "clchenliang de fanyi",
    "bin": {
        "see": "index.js"
    }
}

1. 生成软链，全局使用。在当前目录下，输入：

npm link

测试

在我自己的机子上，进行测试。任意目录下，输入

see awesome

代码

process.exit(0)

常用的模块

1. yargs
2. shelljs
3. TJ 大神写的 command.js
4. color.js

命令行开发基础知识

node 交互

敲代码时遇到的问题

1. #! 后跟路径： #!/usr/bin/env
   

容易把 #!/ 当成一个操作符
*nix 系列操作系统将该语句当作解释器，用来解释、编译接下来的语句

npm link

process.argv 的形式有哪些，命令行参数、子命令

kill -s

命令行颜色控制

这一部分比较简单,也不属于太核心的概念,大家可以自行了解。常用的有 color.js 模块。