本文先介紹原生的node.js實現命令行交互，了解原生的api,然后通過commander.js和inquirer.js實現一個完整的交互命令行工具。
process （進程）
process對象是一個全局變量，它提供了當前node.js進程的信息并對其控制。因為其是一個全局變量所以無需在文件中引入。
需要用到的幾個api
process.argv
屬性返回一個數組。數組的第一個值是process.execPath,第二個是正在執行的JavaScript的文件路徑，其余參數為其它命令參數，這是我們來自定義命令的關鍵。
示例
新建argv.js
// argv.jsconsole.log(process.argv)
執行node命令node argv.js
node argv.js --name zhu## 輸出[ '/usr/local/bin/node', ## 執行當前腳本的Node二進制文件的絕對路徑 '/Users/zhuhuilong/Node/Book/argv.js', ## 文件的絕對路徑 '--name', ## 其余參數 'zhu' ]
接收自定義的命令參數進行處理輸出
// argv.jsconsole.log(process.argv)let argvs = process.argvlet param = argvs.splice(2)if(param[0] && param[0] == '--name'){ if(param[1]){ console.log(`hello ${param[1]}`) }else{ console.log('請輸入name') }}運行argv.js
node argv.js --name zhu## 輸出[ '/usr/local/bin/node', '/Users/zhuhuilong/Node/Book/argv.js', '--name', 'zhu' ]hello zhuparam [ '--name', 'zhu' ]
process.stdin與process.stdout
process.stdin(標準輸入)
process.stdin 屬性返回連接到 stdin (fd 0) 的流。 它是一個 net.Socket 流（也就是雙工流），除非 fd 0 指向一個文件，在這種情況下它是一個可讀流。
process.stdout(標準輸出)
process.stdout 屬性返回連接到 stdout (fd 1) 的流。 它是一個 net.Socket 流（也就是雙工流），除非 fd 1 指向一個文件，在這種情況下它是一個可寫流。
process.stdin.resume()
通俗來講就是控制臺等待我們輸入內容不退出進程，對輸入輸出進行交互。
新建inputout.js
// inputout.jsprocess.stdin.setEncoding('utf8')let argvs = process.argvlet param = argvs.splice(2)if (param[0] && param[0] == '--name') { if (param[1]) { console.log(`hello ${param[1]}`) } else { process.stdout.write(`請輸入name:`) process.stdin.resume() process.stdin.on('data', chunk => { if (!!chunk.replace(/[/r/n]/g, '')) { process.stdout.write(`你輸入的name是: ${chunk}`) process.stdin.emit('end') } else { process.stdout.write(`請輸入name:`) } }) }}process.stdin.on('end', () => { process.stdout.write('結束/n')})>執行node inputout.js --name
備注
在新版本node模式下可以使用process.stdin.on("readable",()=>{})代替process.stdin.resume()恢復輸入流接收。
示例：
process.stdin.on("readable", () => { var chunk = process.stdin.read(); console.log(typeof(chunk)) if (chunk !==null) { process.stdout.write(`data: ${chunk}`); process.stdin.emit("end"); }});process.stdin.on("end", () => { process.stdout.write("end");});從上面的示例我們可以拿到process.argv參數對其進行處理交互，但如果要實現更復雜的命令交互，使用上面的方法會很吃力。下面我們使用commander.js和inquirer來實現一個完整的node命令行工具(創建項目模版)。
commander.js
node.js命令行界面的完整解決方案，受Ruby Commander啟發。
commander.js的API簡述
program.version() 聲明版本
const program = require('commander')const pkg = require('../package.json')program.version(pkg.version)Options 解析
使用.option()方法定義commander的選項options，也可以作為選項的文檔。
var program = require('commander'); program .version('0.1.0') .option('-p, --peppers', 'Add peppers') .option('-P, --pineapple', 'Add pineapple') .option('-b, --bbq-sauce', 'Add bbq sauce') .option('-c, --cheese [type]', 'Add the specified type of cheese [marble]', 'marble') .parse(process.argv); console.log('you ordered a pizza with:');if (program.peppers) console.log(' - peppers');if (program.pineapple) console.log(' - pineapple');if (program.bbqSauce) console.log(' - bbq');console.log(' - %s cheese', program.cheese);添加自定義命令program.command()
var program = require('commander'); program .command('rm <dir>') //<>必選參數，如果是[]則是可選參數 .option('-r, --recursive', 'Remove recursively') .action(function (dir, cmd) { console.log('remove ' + dir + (cmd.recursive ? ' recursively' : '')) }) program.parse(process.argv)// command()可變參數/** 命令command有且只有最后一個參數可變不固定的。 要使參數變量可變，必須將...附加到參數名稱。**/program .version('0.1.0') .command('rmdir <dir> [otherDirs...]') .action(function (dir, otherDirs) { console.log('rmdir %s', dir); if (otherDirs) { otherDirs.forEach(function (oDir) { console.log('rmdir %s', oDir); }); } });program.parse(process.argv);program.action() 定義命令的回調函數
var program = require("commander");program .command("rm <dir>") .option("-r, --recursive", "Remove recursively") .option("-f, --force", "remove force") .action(function(dir, cmd) { // cmd為option參數選項 //console.log('cmd',cmd) if (cmd.recursive) { console.log("remove " + dir + " recursively"); } if (cmd.force) { console.log("remove " + dir + " forcefully"); } });program.parse(process.argv);inquirer.js
Inquirer.js 使用NodeJs做的一個通用交互式命令行用戶界面的集合。具有常用的控制臺交互操作。
由于交互的問題種類不同，inquirer為每個問題提供很多參數：
const program = require('commander')const inquirer = require('inquirer')const fs = require('fs')const path = require('path')const pkg = require('../package.json')const CWD = process.cwd()const promptList = [ { type: 'list', message: '請選擇一種模版', name: 'template', choices: ['vue', 'angular', 'webpack-m-pages'], filter: function(val) { return val.toLowerCase() } }]program .version(pkg.version) .command('create <dir>') .description('create project template') .action(function(dir, cmd) { const TEMPLATE_PATH = path.join(CWD, dir) if (fs.existsSync(TEMPLATE_PATH)) { } else { fs.mkdirSync(TEMPLATE_PATH) } if (dir) { inquirer.prompt(promptList).then(anwsers => { console.log(anwsers) }) } })program.parse(process.argv)運行 node cli/cli.js create vue
已經可以運行了，我們自定義一個命名替代每次都執行node
命令為：test-cli create <dir>
1、創建bin文件夾，在bin文件夾下創建index.js文件
#!/usr/bin/env noderequire('../cli/cli')2、修改package.json文件
添加bin選項
"bin": { "test-cli": "./bin/index.js" },3、執行npm link (如果沒有權限，執行sudo npm link)
4、測試
5、發布 npm publish (如果未登錄需先 npm login登錄)
6、發布完畢，需npm unlink解除本地的命令映射
npm install -g XXX
總結
以上所述是小編給大家介紹的node.js命令行教程圖文詳解,希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持！
如果你覺得本文對你有幫助，歡迎轉載，煩請注明出處，謝謝！
新聞熱點
疑難解答
