从0开始用node写一个自己的命令行程序

前言

什么是命令行程序呢？像我们常见的webpack，vue-cli都属于命令行程序。
本文将带你从0开始用node写一个自己的命令行程序，并发布到npm。

准备工作

我打算写一个统计个人代码提交量的命令行工具，起名 git-tool。
npm地址见 git-tool，GitHub地址见 git-tool。

1. 在GitHub上新建一个项目git-tool。
2. 克隆到本地进行开发。
3. 执行npm init创建package.json文件。

// 其他代码
"bin": {
    "git-tool": "./index.js"
},
// 其他代码

bin字段里面的key值可以随便取名，value值为对应的执行文件。

4. 新建index文件。

#!/usr/bin/env node
console.log('git-tool')

#!/usr/bin/env node的意思是让系统自己去找node的执行程序，该行必不可少。

5. 执行npm link
   如果执行该命令报错，参考https://docs.npmjs.com/getting-started/fixing-npm-permissio

6. 运行git-tool
   我们发现控制台会打印出git-tool。

   图一

实现

经过以上步骤我们已经基本搭好环境了，下面就可以开始写自己的逻辑了。

• 参数读取
  process.argv用来获取命令行参数。
  修改index.js文件

  #!/usr/bin/env node
  console.log('git-tool')
  console.log(process.argv)
  

  然后执行git-tool ss cd，结果如下图所示：

  图二

process.argv返回一个数组，数组前两位是固定的，分别是node程序的路径和脚本存放的位置，从第三位开始才是额外输入的内容。
npm社区有一些优秀的命令行参数解析包，如yargs，commander.js
我使用的是commander.js

• 插件
  commander.js的基本使用很简单，

  #!/usr/bin/env node
  const program = require('commander');
  program.version('1.0.0')
  program
   .command('codeLineNum')
   .description('统计git提交代码量')
   .option("--author [author]", "统计指定作者git提交代码量")
   .action(function (options) {
     console.log(options.author)
   })
  program.parse(process.argv);
  

  此时执行git-tool -h，效果如下：

  图三

它会帮我们自动做一些事情，很方便。

• 思路
  我们要实现统计代码提交量的目的，就必须借助git命令。
  git log --author="username" --pretty=tformat: --numstat
  该命令输出如下：
  

  图四
  第一列为增加的代码行数，第二列为删除的代码行数，第三列为改动的文件。
  一些管道命令符可以处理这些数据，但是Windows系统不支持。
  所以我的思路是把数据写到文件中，然后在逐行读取进行处理。

• 代码
  具体实现细节就不展开了，有兴趣的可以去GitHub看源码。
  最终实现效果如下

  图五 图六

发布npm包

1. 创建npm账户（如果已有，略过该步骤）
   注册地址：https://www.npmjs.com/signup
2. 登陆
   npm login
3. 发布
   npm publish

每次发布时都需要更改package.json 中的version；
发布需将npm registry地址设为 http://registry.npmjs.org
npm config set registry http://registry.npmjs.org

参考资料

手把手教你使用nodejs编写cli(命令行)
Node.js 命令行程序开发教程-阮一峰