如何從0開始用node寫一個(gè)自己的命令行程序

更新時(shí)間：2018年12月29日 14:21:42 作者：tiancai啊呆

這篇文章主要介紹了如何從0開始用node寫一個(gè)自己的命令行程序，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

前言

什么是命令行程序呢？像我們常見的webpack，vue-cli都屬于命令行程序。

本文將帶你從0開始用node寫一個(gè)自己的命令行程序，并發(fā)布到npm。

準(zhǔn)備工作

我打算寫一個(gè)統(tǒng)計(jì)個(gè)人代碼提交量的命令行工具，起名 git-tool 。

npm地址見git-tool ，GitHub地址見 git-tool 。

1、在GitHub上新建一個(gè)項(xiàng)目git-tool。

2、克隆到本地進(jìn)行開發(fā)。

3、執(zhí)行npm init創(chuàng)建package.json文件。

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

bin字段里面的key值可以隨便取名，value值為對應(yīng)的執(zhí)行文件。

4、新建index文件。

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

#!/usr/bin/env node 的意思是讓系統(tǒng)自己去找node的執(zhí)行程序，該行必不可少。

5、執(zhí)行 npm link

如果執(zhí)行該命令報(bào)錯(cuò)，參考 https://docs.npmjs.com/getting-started/fixing-npm-permissio

6、運(yùn)行 git-tool

我們發(fā)現(xiàn)控制臺(tái)會(huì)打印出git-tool。

圖一

實(shí)現(xiàn)

經(jīng)過以上步驟我們已經(jīng)基本搭好環(huán)境了，下面就可以開始寫自己的邏輯了。

參數(shù)讀取

process.argv 用來獲取命令行參數(shù)。

修改index.js文件

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

然后執(zhí)行 git-tool ss cd ，結(jié)果如下圖所示：

圖二

process.argv 返回一個(gè)數(shù)組，數(shù)組前兩位是固定的，分別是node程序的路徑和腳本存放的位置，從第三位開始才是額外輸入的內(nèi)容。

npm社區(qū)有一些優(yōu)秀的命令行參數(shù)解析包，如 yargs ， commander.js

我使用的是 commander.js

插件

commander.js 的基本使用很簡單，

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

此時(shí)執(zhí)行 git-tool -h ，效果如下：