node.js如何制作命令行工具（一）

之前使用過一些全局安裝的NPM包，安裝完之后，可以通過其提供的命令，完成一些任務。比如Fis3，可以通過fis3 server start 開啟fis的靜態文件服務，通過fis3 release開啟文件編譯與發布；還有vue-cli，可以通過vue init webpack my-project來初始化vue+webpack的項目基礎配置。最近有一個需求，需要寫一個類似vue-cli的NPM包，通過命令行操作實現項目初始配置，所以就查看了相關資料，學習了一下如何使用node來生成自己的命令。

編寫命令行

命令的目標：在當前目錄下開啟一個靜態文件服務,端口號為8085

1.創建目錄

構成命令的基礎是需要一個命令文件web.js和package.json配置文件，執行以下命令：

$ mkdir node-commander #創建一個文件夾
$ cd node-commander && mkdir bin
$ npm init #初始化package.json文件
$ cd bin && touch web.js  #創建命令文件

2.命令文件

#!/usr/bin/env node

var express = require('express');
var path = process.cwd();

function run(argv) {
    if (argv[0] === '-v' || argv[0] === '--version') {
        console.log('version is 1.0.0');
    }
    else if (argv[0] === '-h' || argv[0] === '--help') {
        console.log('usage:\n');
        console.log('-v --version [show version]')
    }
    else if (argv[0] === '-s' || argv[0] === '--start') {
        var app = new express();
        app.use('/static', express.static(path));
        app.listen(8085, function () {
            console.log('server start at port 8085');
        });
    }
}

run(process.argv.slice(2));　　

 

文件的頭部務必加入#!/usr/bin/env node這行代碼，這里表示使用node作為腳本的解釋程序，node的路徑通過env來查找，可以避免node安裝路徑不一帶來的問題。

其中process為node進程中的全局變量，process.argv為一數組，數組內存儲着命令行的各個部分，argv[0]為node的安裝路徑，argv[1]為主模塊文件路勁，剩下為子命令或參數，如下：

node ./bin/web.js a b c
# process.argv的值為[ '/usr/local/bin/node', '/PATH/web.js', 'a', 'b', 'c' ]

　　

3.命令配置

在package.json文件中添加bin字段：

"bin": { 
    "web": "./bin/web.js"
  },　　

 

bin字段的作用：當安裝npm包時，npm將添加一條命令/usr/local/bin/web，web命令軟連接到web.js文件。

 

調試命令行

（1）采用install方法

進入npm包目錄下，執行全局install，根據package.json中bin的配置，為全局命令創建軟連。

 #  sudo npm install . -g
/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js

/usr/local/lib

`-- cli-demo@1.0.0
...

查看web命令

#  which web                
/usr/local/bin/web　　

 

執行web命令

#  web --start
server start at port 8085

 

（2）采用npm link方法

npm link方法創建了兩個軟連，命令與命令文件的軟連，全局包與實際包文件的軟連。

# sudo npm link

/usr/local/bin/web -> /usr/local/lib/node_modules/cli-demo/bin/web.js
/usr/local/lib/node_modules/cli-demo -> /Users/baidu/hwm/home/demos/node/node-commander　　

 

接下來可以按照方法（1）進行操作了。

發布命令包

通過npm publish進行發布，前提是有npm帳號。如何操作可以查看npm 官方文檔。

 

本文是通過原生node.js來開發命令工具，而vue-cli是采用commander.js來簡化命令工具開發，關於commander.js的使用方法，將在下一篇文章中介紹。