淺談node.js 命令行工具(cli)

一. 先了解一下package.json

每個項目的根目錄都有一個 package.json 文件，定義了這個項目所需要的各種模塊，以及項目的配置信息,下面是一個比較完整的package.json文件

{
 "name": "vue-cli",
 "version": "2.9.3",
 "description": "A simple CLI for scaffolding Vue.js projects.",
 "preferGlobal": true,
 "bin": {
 "vue": "bin/vue",
 "vue-init": "bin/vue-init",
 "vue-list": "bin/vue-list"
 },
 "repository": {
 "type": "",
 "url": ""
 },
 "keywords": [
 ],
 "author": "litongqian",
 "license": "MIT",
 "bugs": {
 "url": ""
 },
 "homepage": "",
 "scripts": {
 "test": "npm run lint && npm run e2e",
 "start": "node index.js"
 },
 "dependencies": {
 "async": "^2.4.0",
 "chalk": "^2.1.0",
 },
 "devDependencies": {
 "chai": "^4.1.2",
 "eslint": "^3.19.0",
 },
 "engines": {
 "node": ">=6.0.0"
 }
}

1. 其中scripts字段

指定了運行腳本命令的npm命令行縮寫，比如start指定了運行 npm run start 時，所要執行的命令。

2. bin字段

bin項用來指定各個內部命令對應的可執行文件的位置

"bin": {
 "vue": "bin/vue",
 "vue-init": "bin/vue-init",
 "vue-list": "bin/vue-list"
 },

上面代碼指定， vue 命令對應的可執行文件為 bin 子目錄下的 vue 。

3. npm link

開發NPM模塊的時候，有時我們會希望，邊開發邊試用，比如本地調試的時候， require('myModule') 會自動加載本機開發中的模塊。Node規定，使用一個模塊時，需要將其安裝到全局的或項目的 node_modules 目錄之中。對于開發中的模塊，解決方法就是在全局的 node_modules 目錄之中，生成一個符號鏈接，指向模塊的本地目錄。

npm link 就能起到這個作用，會自動建立這個符號鏈接。

請設想這樣一個場景，你開發了一個模塊 myModule ，目錄為 src/myModule ，你自己的項目 myProject 要用到這個模塊，項目目錄為 src/myProject 。首先，在模塊目錄（ src/myModule ）下運行 npm link 命令。

src/myModule$ npm link

上面的命令會在NPM的全局模塊目錄內，生成一個符號鏈接文件，該文件的名字就是 package.json 文件中指定的模塊名。

/path/to/global/node_modules/myModule -> src/myModule

這個時候，已經可以全局調用 myModule 模塊了。但是，如果我們要讓這個模塊安裝在項目內，還要進行下面的步驟。

切換到項目目錄，再次運行 npm link 命令，并指定模塊名。

src/myProject$ npm link myModule

上面命令等同于生成了本地模塊的符號鏈接。

代碼如下:src/myProject/node_modules/myModule -> /path/to/global/node_modules/myModule

然后，就可以在你的項目中，加載該模塊了。

var myModule = require('myModule');

這樣一來， myModule 的任何變化，都可以直接反映在 myProject 項目之中。但是，這樣也出現了風險，任何在 myProject 目錄中對 myModule 的修改，都會反映到模塊的源碼中。

如果你的項目不再需要該模塊，可以在項目目錄內使用 npm unlink 命令，刪除符號鏈接。

src/myProject$ npm unlink myModule

二. 可執行腳本

寫一個簡單的腳本hello

$ mkdir hello #創建一個文件夾

$ cd hello && touch hello #創建命令文件

#!/usr/bin/env node
console.log('hello world');

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

打開 /usr/bin/env,可以查看到PATH,操作系統通過路徑找到node

然后，修改 hello 的權限。

$ chmod 755 hello
$./hello

如果想把 hello 前面的路徑去除，可以將 hello 的路徑加入環境變量 PATH。但是，另一種更好的做法，是在當前目錄下新建 package.json ，寫入下面的內容。

{
 "name": "hello",
 "bin": {
 "hello": "./hello"
 }
}

然后執行 npm link 命令。不明白的看上面

$ npm link

執行后會產生一個全局的映射關系,就可以全局使用hello命令了

三.命令行參數

命令行參數可以用系統變量 process.argv 獲取。

修改hello腳本

#!/usr/bin/env node
console.log('hello ', process.argv);

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

$ hello a b c

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

腳本可以通過 child_process 模塊新建子進程，從而執行 Unix 系統命令,修改hello

exec 方法用于執行bash命令, exec 方法最多可以接受兩個參數，第一個參數是所要執行的shell命令，第二個參數是回調函數，該函數接受三個參數，分別是發生的錯誤、標準輸出的顯示結果、標準錯誤的顯示結果。

#!/usr/bin/env node
var name = process.argv[2];
var exec = require('child_process').exec;

var child = exec('echo hello ' + name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

執行$ hello litongqian

如果我們想查看所有文件,修改hello

var name = process.argv[2];
var exec = require('child_process').exec;

var child = exec(name, function(err, stdout, stderr) {
 if (err) throw err;
 console.log(stdout);
});

執行$ hello ls 

hello目錄下有三個文件

四、shelljs 模塊

shell.js 模塊重新包裝了 child_process，調用系統命令更加方便。它需要安裝后使用。

npm install --save shelljs

然后，改寫腳本。

#!/usr/bin/env node
var name = process.argv[2];
var shell = require("shelljs");

shell.exec("echo hello " + name);

五、yargs 模塊

shelljs 只解決了如何調用 shell 命令，而 yargs 模塊能夠解決如何處理命令行參數。它也需要安裝。

$ npm install --save yargs

yargs 模塊提供 argv 對象，用來讀取命令行參數。請看改寫后的 hello 。

#!/usr/bin/env node
var argv = require('yargs').argv;

console.log('hello ', argv.name);

使用時，下面兩種用法都可以。

$ hello --name=tom
hello tom

$ hello --name tom
hello tom

也就是說，process.argv 的原始返回值如下。

$ node hello --name=tom
[ 'node',
 '/usr/local/bin/hell',
 '--name=tom' ]

yargs 可以上面的結果改為一個對象，每個參數項就是一個鍵值對。

六.發布命令包

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

本文是通過原生node.js來開發命令工具，而vue-cli是采用commander.js來簡化命令工具開發,

了解了執行流程,去學習對應的模塊,就很好知道原理了!,本文拋個磚頭

最后:有時我們用到的命令行不是全局安裝的,而是本地安裝的

1. package.json bin字段

bin項用來指定各個內部命令對應的可執行文件的位置。

"name":"someTool",
"bin": {
 "someTool": "./bin/someTool.js"
}

上面代碼指定，someTool 命令對應的可執行文件為 bin 子目錄下的 someTool.js。

當一個項目依賴上面的someTool工具時,同時只是本地安裝

{
 "name": "myproject",
 "devDependencies": {
 "someTool": "latest"
 },
 "scripts": {
 start: 'someTool build' //等同于start: './node_modules/someTool/someTool.js build'

 }
}

npm會尋找這個文件，在 node_modules/.bin/ 目錄下建立符號鏈接。在上面的例子中，someTool.js會建立符號鏈接 npm_modules/.bin/someTool 。由于 node_modules/.bin/ 目錄會在運行時加入系統的PATH變量，因此在運行npm時，就可以不帶路徑，直接通過命令來調用這些腳本。

因此，像上面這樣的寫法可以采用簡寫。

scripts: { 
 start: './node_modules/someTool/someTool.js build'
}

// 簡寫為

scripts: { 
 start: 'someTool build'
}

所有 node_modules/.bin/ 目錄下的命令，都可以用 npm run [命令] 的格式運行。在命令行下，鍵入 npm run ，然后按tab鍵，就會顯示所有可以使用的命令。

1. npm run

上面代碼中， scripts 字段指定了兩項命令 start ，輸入 npm run-script start 或者 npm run start ，就會執行  someTool build 。 npm run 是 npm run-script 的縮寫，一般都使用前者，但是后者可以更好地反應這個命令的本質。

npm run 命令會自動在環境變量 $PATH 添加 node_modules/.bin 目錄，所以 scripts 字段里面調用命令時不用加上路徑，這就避免了全局安裝NPM模塊。

npm run 如果不加任何參數，直接運行，會列出 package.json 里面所有可以執行的腳本命令。

npm內置了兩個命令簡寫， npm test 等同于執行 npm run test ， npm start 等同于執行 npm run start 。

npm run 會創建一個Shell，執行指定的命令，并臨時將 node_modules/.bin 加入PATH變量，這意味著本地模塊可以直接運行。

舉例來說，你執行ESLint的安裝命令。

$ npm i eslint --save-dev

運行上面的命令以后，會產生兩個結果。首先，ESLint被安裝到當前目錄的 node_modules 子目錄；其次， node_modules/.bin 目錄會生成一個符號鏈接 node_modules/.bin/eslint ，指向ESLint模塊的可執行腳本。

然后，你就可以在 package.json 的 script 屬性里面，不帶路徑的引用 eslint 這個腳本。

{
 "name": "Test Project",
 "devDependencies": {
 "eslint": "^1.10.3"
 },
 "scripts": {
 "lint": "eslint ."
 }
}

等到運行 npm run lint 的時候，它會自動執行 ./node_modules/.bin/eslint . 。

如果直接運行 npm run 不給出任何參數，就會列出 scripts 屬性下所有命令。

$ npm run
Available scripts in the user-service package:
 lint
 jshint **.js
 test
 mocha test/

到此,結束!

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com