教你使用Nodejs开发命令行

发布时间：2020-04-25 08:30:02 作者：咘咘✨ 阅读量：1455

前言

找到合适的工具包，开发nodejs命令行工具是很容易的

准备工作

nodejs v6.10.1
npm v3.10.10

版本号是我当前使用的版本，可自行选择

Hello World

分4步：

index.js
package.json
根目录下执行npm link
执行命令nhw => hello world

touch index.js创建一个index.js文件，内容如下：

#! /usr/bin/env node

console.log(&#39;hello world&#39;)

用npm init创建一个package.json文件，之后修改成如下:

{
    &quot;name&quot;: &quot;npmhelloworld&quot;, 
    &quot;bin&quot;: {
        &quot;nhw&quot;: &quot;index.js&quot; 
    },
    &quot;preferGlobal&quot;: true,
    &quot;version&quot;: &quot;1.0.0&quot;,
    &quot;description&quot;: &quot;&quot;,
    &quot;scripts&quot;: {
        &quot;test&quot;: &quot;echo \&quot;Error: no test specified\&quot; &amp;&amp; exit 1&quot;
    },
    &quot;author&quot;: &quot;jerryni &lt;jerryni2014@gmail.com&gt;&quot;,
    &quot;license&quot;: &quot;ISC&quot;
}

内容详解

index.js

#! /usr/bin/env node

stackoverflow.com/questions/3…

这句话是一个shebang line实例, 作用是告诉系统运行这个文件的解释器是node；
比如，本来需要这样运行node ./file.js，但是加上了这句后就可以直接./file.js运行了

package.json

{
    // 模块系统的名字，如require(&#39;npmhelloworld&#39;)
    &quot;name&quot;: &quot;npmhelloworld&quot;, 
    &quot;bin&quot;: {
        &quot;nhw&quot;: &quot;index.js&quot; // nhw就是命令名 ，index.js就是入口
    },

    // 加入 安装的时候, 就会有-g的提示了
    &quot;preferGlobal&quot;: true,


    // 去掉main: &#39;xxx.js&#39;  是模块系统的程序入口
    &quot;version&quot;: &quot;1.0.0&quot;,
    &quot;description&quot;: &quot;&quot;,
    &quot;scripts&quot;: {
        &quot;test&quot;: &quot;echo \&quot;Error: no test specified\&quot; &amp;&amp; exit 1&quot;
    },
    &quot;author&quot;: &quot;jerryni &lt;jerryni2014@gmail.com&gt;&quot;,
    &quot;license&quot;: &quot;ISC&quot;
}

npm link命令

执行后，控制台里面会有以下输出：

/usr/local/bin/nhw -&gt; /usr/local/lib/node_modules/npmhelloworld/index.js
/usr/local/lib/node_modules/npmhelloworld -&gt; /Users/nirizhe/GitHub/npmhelloworld

解释：创建了2个软链接分别放到系统环境变量$PATH目录里，nhw命令和npmhellworld模块。npm link在用户使用的场景下是不需要执行的，用户使用npm i -g npmhellworld命令安装即可。

发布项目到npm官网供大家使用

设置npm用户名，没有的话先到npm官方网站注册一个：

npm set init.author.name &quot;Your Name&quot;
npm set init.author.email &quot;you@example.com&quot;
npm set init.author.url &quot;http://yourblog.com&quot;

npm adduser

项目根目录运行：

npm publish

注意：

每次发布需要修改package.json中的版本号，否则无法发布

如何处理命令行参数

当下比较流程的几个工具对比

这边使用yargs

npm install --save yargs

请看之前我实战一段代码

大概是这个样子：

var argv = yargs
    .option(&#39;name&#39;, {
        type: &#39;string&#39;,
        describe: &#39;[hostName] Switch host by name&#39;,
        alias: &#39;n&#39;
    })
    .option(&#39;list&#39;, {
        boolean: true,
        default: false,
        describe: &#39;Show hostName list&#39;,
        alias: &#39;l&#39;
    })
    .option(&#39;close&#39;, {
        type: &#39;string&#39;,
        describe: &#39;close certain host&#39;,
        alias: &#39;c&#39;
    })
    .example(&#39;chost -n localhost&#39;, &#39;Switch localhost successfully!&#39;)
    .example(&#39;chost -c localhost&#39;, &#39;Close localhost successfully!&#39;)
    .example(&#39;chost -l&#39;, &#39;All host name list: xxx&#39;)
    .help(&#39;h&#39;)
    .alias(&#39;h&#39;, &#39;help&#39;)
    .epilog(&#39;copyright 2017&#39;)
    .argv

效果：

单元测试

推荐使用mocha

var assert = require(&#39;assert&#39;);
describe(&#39;Array&#39;, function() {
  describe(&#39;#indexOf()&#39;, function() {
    it(&#39;should return -1 when the value is not present&#39;, function() {
      assert.equal(-1, [1,2,3].indexOf(4));
    });
  });
});

执行

$ ./node_modules/mocha/bin/mocha

  Array
    #indexOf()
      ✓ should return -1 when the value is not present


  1 passing (9ms)

让你的项目显得正规(github badges)

实际效果就是这些小图标：

这里可以找到各式各样的badges:
github.com/badges/shie…

持续集成（CI）和代码覆盖率

travis-ci:

用github帐号登录，这时网站上列出你github上的项目
在项目根目录放.travis.yml这个文件，并写好简单的配置
```
language: node_js
node_js:
- &quot;6&quot;
```
在项目的package.json中添加测试脚本，因为travis默认会执行npm test
```
&quot;scripts&quot;: {
  &quot;test&quot;: &quot;mocha&quot;
}
```

在travis设置成功后，继续覆盖率的处理：

安装2个依赖

npm install istanbul coveralls --save-dev

travis的配置文件中添加

language: node_js
node_js:
- &quot;6&quot;
after_script:
- npm run coverage

修改package.json中的测试脚本

&quot;scripts&quot;: {
  &quot;test&quot;: &quot;node ./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha&quot;,
  &quot;coverage&quot;: &quot;cat ./coverage/lcov.info | coveralls&quot;
}