足球资料库数据/孙祥/nba五佳球/足球直播哪个平台好 - cctv5今日现场直播

首頁 > 知識庫 > 正文

從零開始打造個人專屬命令行工具集――yargs完全指南
2016-08-12 14:18:00   來源：來源：ideras.me微博   評論：0 點擊：

熟練使用命令行工具能極大的提高開發效率，linux自帶的命令行工具都非常的有用，但是這些工具都是按照通用需求開發出來的 ，如果有一些特別的需求，還是需要自己寫腳本來完成一些比如文件批量重命名，文件內容批量替換等任務來提供工作效率。

\

【引自ideras.me的博客】前言

使用命令行程序對程序員來說很常見，就算是前端工程師或者開發gui的，也需要使用命令行來編譯程序或者打包程序

熟練使用命令行工具能極大的提高開發效率，linux自帶的命令行工具都非常的有用，但是這些工具都是按照通用需求開發出來的 ，如果有一些特別的需求，還是需要自己寫腳本來完成一些比如文件批量重命名，文件內容批量替換等任務來提供工作效率。

在node.js出來之前，python經常被用來開發一些腳本完成特殊的任務，比如python爬蟲，python相關的教程有很多，有興趣的自己google。

得益于node.js的異步io特性，使用node開發io密集類任務變得非常簡單，這篇文章就為大家講講怎么使用node.js的yargs模塊來開發自己的命令行工具集合。

命令行參數解析

yargs是一個npm模塊用來完成命令行參數解析的，回到使用shell開發命令行的時代，getopts是第一代命令行參數解析工具，經過shell => python => node.js 的迭代，命令行參數解析程序其實沒有多大的進化，它們的目的始終是把用戶從命令行傳入的參數解析成指定的格式，供程序使用

雖然沒有多大變化，但是由于開發一個命令行參數解析模塊比較簡單，所以目前node社區存在很多類似yargs的開源項目，這里簡單列舉一下，有興趣的可以自己去了解一下， 然后選擇自己喜歡的項目來使用。

  • minimist 源自
  • optimist 模仿python的optimist項目
  • commander.js tj是node.js大神，co的作者, commander.js源自ruby的commander項目，作者也是tj
  • nopt npm項目中使用
  • nomnom 不再維護，不建議使用

yargs

讀過阮一峰的Node.js 命令行程序開發教程之后開始使用yargs開發自己命令行工具， 用過一段時間發現非常的好用。

自阮大神的文章發布以來，yargs有了一些改動，添加有很多有用的功能，特別是.commandDir(directory, [opts])這個功能，對打造命令行工具集合非常有用，所以寫一個新版本的yargs教程還是有必要的。

yargs的用法還算比較簡單，對英文有自信的可以去首頁閱讀原版：yargs

簡單模式

yargs默認使用兩個--作為參數的前綴，中間使用空格或者=都可以

下面的代碼展示了yargs最簡單的用法，你只需要引入yargs，就能讀取命令行參數，不需要寫任何的配置，非常的簡單

  1. #!/usr/bin/env node 
  2. var argv = require('yargs').argv; 
  3.  
  4. if (argv.ships > 3 && argv.distance < 53.5) { 
  5.     console.log('Plunder more riffiwobbles!'); 
  6. } else { 
  7.     console.log('Retreat from the xupptumblers!'); 
  8. }  
  1. $ ./plunder.js --ships=4 --distance=22 
  2. Plunder more riffiwobbles! 
  3.  
  4. $ ./plunder.js --ships 12 --distance 98.7 
  5. Retreat from the xupptumblers! 

示例代碼都來自官網：yargs

簡單模式還能讀取短變量如-x 4相當于argv.x = 4

簡單模式還能讀取布爾類型-s相當于argv.s = true

簡單模式還能讀取非-開始的變量，這種類型的變量保存在argv._數組里面

參數配置

簡單模式的功能都只用一行代碼就能實現

  1. var argv = require('yargs').argv; 

但是如果你想統計變量出現的次數怎么辦? 答案就是添加參數配置選項。

  1. #!/usr/bin/env node 
  2. var argv = require('yargs') 
  3.     .count('verbose') 
  4.     .alias('v', 'verbose') 
  5.     .argv; 
  6.  
  7. VERBOSE_LEVEL = argv.verbose; 
  8.  
  9. function WARN()  { VERBOSE_LEVEL >= 0 && console.log.apply(console, arguments); } 
  10. function INFO()  { VERBOSE_LEVEL >= 1 && console.log.apply(console, arguments); } 
  11. function DEBUG() { VERBOSE_LEVEL >= 2 && console.log.apply(console, arguments); } 
  12.  
  13. WARN("Showing only important stuff"); 
  14. INFO("Showing semi-important stuff too"); 
  15. DEBUG("Extra chatty mode"); 

上面的程序能統計verbose參數出現的次數，縮寫-v也會統計進去，具體調用例子參考下面的代碼

  1. $ node count.js 
  2. Showing only important stuff 
  3.  
  4. $ node count.js -v 
  5. Showing only important stuff 
  6. Showing semi-important stuff too 
  7.  
  8. $ node count.js -vv 
  9. Showing only important stuff 
  10. Showing semi-important stuff too 
  11. Extra chatty mode 
  12.  
  13. $ node count.js -v --verbose 
  14. Showing only important stuff 
  15. Showing semi-important stuff too 
  16. Extra chatty mode 

yargs提供很多接口用來幫助完善命令行程序，

提示用法

  1. var argv = require('yargs') 
  2.     .usage('Usage: $0 -w [num] -h [num]') 
  3.     .argv; 

必選參數

  1. #!/usr/bin/env node 
  2. var argv = require('yargs') 
  3.     .usage('Usage: $0 -w [num] -h [num]') 
  4.     .demand(['w','h']) 
  5.     .argv; 

 提供參數默認值

  1. #!/usr/bin/env node 
  2. var argv = require('yargs') 
  3.     .default('x', 10) 
  4.     .default('y', 10) 
  5.     .argv 
  6. ; 
  7. console.log(argv.x + argv.y); 

打印幫助信息

  1. #!/usr/bin/env node 
  2. var argv = require('yargs') 
  3.     .usage('Usage: $0 <command> [options]') 
  4.     .help('h') 
  5.     .alias('h', 'help') 
  6.     .epilog('copyright 2015') 
  7.     .argv; 

使用別名

  1. var argv = require('yargs') 
  2.     .usage('Usage: $0 <command> [options]') 
  3.     .alias('h', 'help') 
  4.     .argv; 

訪問argv.h相當于訪問argv.help

參數數組

  1. var argv = require('yargs') 
  2.     .usage('Usage: $0 <command> [options]') 
  3.     .alias('n', 'name') 
  4.     .array('n') 
  5.     .argv; 
  6.  
  7. console.log(argv.n); 

 調用

  1. node array_test.js -n abc test 

設置參數范圍

  1. var argv = require('yargs') 
  2.   .alias('i', 'ingredient') 
  3.   .describe('i', 'choose your sandwich ingredients') 
  4.   .choices('i', ['peanut-butter', 'jelly', 'banana', 'pickles']) 
  5.   .help('help') 
  6.   .argv 

上述代碼設定argv.i的值只能是['peanut-butter', 'jelly', 'banana', 'pickles']數組中的一個

上面是yargs比較簡單的用法，如果想閱讀完整版，建議去github上閱讀

子命令

yargs適合開發復雜的命令行程序的另一個原因是它支持子命令，而且子命令可以嵌套，這意味著你也可以開發出類似git這樣擁有上百個命令的程序

yargs的子命令有兩種模式：.command(*)和.commandDir(directory, [opts])

.command

  1. .command方法有三個接口 
  2.  
  3. .command(cmd, desc, [builder], [handler]) 
  4.  
  5. .command(cmd, desc, [module]) 
  6.  
  7. .command(module) 

其實它們的用法都差不多，可以把它們都看作傳遞一個module給yargs，這個module必須導出四個變量cmd, desc [builder], [handler]，其中builder和handler是方法，另外兩個是字符串

使用第一個接口的示例

  1. yargs 
  2.   .command( 
  3.     'get', 
  4.     'make a get HTTP request', 
  5.     function (yargs) { 
  6.       return yargs.option('u', { 
  7.         alias: 'url', 
  8.         describe: 'the URL to make an HTTP request to' 
  9.       }) 
  10.     }, 
  11.     function (argv) { 
  12.       console.log(argv.url) 
  13.     } 
  14.   ) 
  15.   .help() 
  16.   .argv  

使用第三個接口需要把這個模塊在單獨的文件，然后用require引入

這是模塊的代碼

  1. // my-module.js 
  2. exports.command = 'get <source> [proxy]' 
  3.  
  4. exports.describe = 'make a get HTTP request' 
  5.  
  6. exports.builder = { 
  7.   banana: { 
  8.     default: 'cool' 
  9.   }, 
  10.   batman: { 
  11.     default: 'sad' 
  12.   } 
  13. } 
  14.  
  15. exports.handler = function (argv) { 
  16.   // do something with argv. 
  17. }  

引入的時候這樣使用

  1. yargs.command(require('my-module')) 
  2.   .help() 
  3.   .argv 

當額外的模塊沒有定義cmd和desc的時候可以使用第二個接口

  1. yargs.command('get <source> [proxy]', 'make a get HTTP request', require('my-module')) 
  2.   .help() 
  3.   .argv 

這里建議使用第三個接口，這樣能保持模塊的內聚，這種模塊你能掛載在任何命令下面，遷移的時候不需要修改模塊代碼，只需要修改引入模塊的代碼就能實現

.commandDir

如果有大量的命令都使用上面的.command(module)來開發的話，這些模塊都有相同的結構，應該能有方法簡化這些命令的引入過程，把這個過程自動化，基于 這個目的yargs提供了.commandDir接口

下面參考一個我自己寫的項目pit

下面是這個項目的目錄結構

  1. . 
  2.  
  3. ├── pit 
  4.  
  5. │ ├── douban 
  6.  
  7. │ │ └── movie.js 
  8.  
  9. │ ├── douban.js 
  10.  
  11. │ ├── gg 
  12.  
  13. │ │ ├── client.js 
  14.  
  15. │ │ ├── login.js 
  16.  
  17. │ │ ├── scope.js 
  18.  
  19. │ │ ├── scope.json 
  20.  
  21. │ │ ├── secret.json 
  22.  
  23. │ │ ├── token.json 
  24.  
  25. │ │ └── upload.js 
  26.  
  27. │ ├── gg.js 
  28.  
  29. │ ├── git 
  30.  
  31. │ │ ├── commit.js 
  32.  
  33. │ │ ├── create.js 
  34.  
  35. │ │ ├── deploy.js 
  36.  
  37. │ │ ├── push.js 
  38.  
  39. │ │ └── token.json 
  40.  
  41. │ ├── git.js 
  42.  
  43. │ ├── gm.js 
  44.  
  45. │ ├── md5.js 
  46.  
  47. │ ├── news 
  48.  
  49. │ │ ├── bing.js 
  50.  
  51. │ │ ├── funs.js 
  52.  
  53. │ │ ├── funs.json 
  54.  
  55. │ │ ├── games.js 
  56.  
  57. │ │ ├── games.json 
  58.  
  59. │ │ ├── google.js 
  60.  
  61. │ │ ├── newsall.json 
  62.  
  63. │ │ ├── shops.js 
  64.  
  65. │ │ ├── shops.json 
  66.  
  67. │ │ ├── videos.js 
  68.  
  69. │ │ └── videos.json 
  70.  
  71. │ └── news.js 
  72.  
  73. └── pit.js 

pit.js：命令行的入口

  1. #!/usr/bin/env node 
  2.  
  3. require('yargs') 
  4.   .commandDir('pit') 
  5.   .demand(1) 
  6.   .help() 
  7.   .locale('en') 
  8.   .showHelpOnFail(true, 'Specify --help for available options') 
  9.   .argv 
  10. ··· 

這段代碼只指定讀取同目錄下同名文件夾`pit`下面的命令加載為子命令

> **注意**：commandDir默認只會加載目錄下第一級的文件，不會遞歸加載，如果想遞歸加載需要這樣寫`.commandDir('pit', {recurse: true})`

接著來看git子命令，因為git項目每次提交都要重復幾個相同的步驟，所有想開發一個更簡單的命令進行打包提交

git.js

  1. exports.command = 'git '; 
  2.  
  3. exports.desc = 'github command list'; 
  4.  
  5. exports.builder = function (yargs) { return yargs.commandDir('git') } 
  6.  
  7. exports.handler = function (argv) {} 

git也是加載一個目錄作為自己的子命令：以commit為例

commit.js

  1. 'use strict'; 
  2.  
  3. var fs = require('fs'); var path = require('path'); 
  4.  
  5. require('shelljs/global'); 
  6.  
  7. var Q = require('q'); 
  8.  
  9. function _exec(cmd) { var deferred = Q.defer(); exec(cmd, function (code, stdout, stderr) { deferred.resolve(); }); return deferred.promise; } 
  10.  
  11. exports.command = 'commit'; 
  12.  
  13. exports.desc = 'commit repo local'; 
  14.  
  15. exports.builder = function (yargs) { return yargs .help('h'); }; 
  16.  
  17. exports.handler = function (argv) { var repo = process.cwd(); var name = path.basename(repo); Q.fcall(function () { }) .then(() => _exec(git add .)) .then(() => _exec(git commit -m 'd')) .catch(function (err) { console.log(err); }) .done(() => { console.log(commit ${repo} done); }); 
  18.  
  19. } ``` 

這個命令默認運行在git項目的根目錄，和git命令不太一樣，git可以在項目根目錄下的任意子目錄里面運行。

使用shelljs來運行子命令，然后用Q進行promise封裝，保證命令的執行順序，同時把命令行輸出和錯誤信息都打印到 控制。

一個很簡單能節省時間的命令行程序，作為拋磚引玉之用

延伸

高手都是擅長使用命令行(電影里面的高手也一樣)，當你習慣使用命令行完成日常任務之后，慢慢的會形成一種依賴。繼續下去，你會考慮把所有的事情都用來命令行來完成，當然這個 目的不能實現，因為能自動完成所有任務的命令行不叫命令行——它叫AI

雖然不能開發一臺高智能ai，但是還是有很多任務能用命令行來完成的，這里寫下我的思路，供大家參考

api命令行

大型網站都提供自己的api接口配上oauth2.0認證，如果你想使用命令行來調用這些api接口，你完全可以做到

像aws，google cloud，aliyun這種云主機，使用命令行能節省很多運維的時間

另外你也可以參考上面pit.js寫的douban.js來抓取豆瓣的數據，豆瓣的公共api不需要認證就能訪問，用來做一些測試非常方便

命令行爬蟲

使用node.js開發爬蟲就像使用python一樣簡單，但是一個功能齊全的爬蟲必然少不了命令行接口，你不可能每次有新的需求都來修改代碼，下次再給大家分享我寫的一個簡單的基于 node.js的爬蟲項目

表單提交

對一些不提供api接口但是又想使用命令來進行交互的網站，你可以使用表單提交來進行登錄，然后做一些登錄之后才能做的事情：例如發表文章

現在很多的網站都支持使用markdown編輯文章，然后發布，對這一類網站你都可以開發自己的命令行統一進行管理，當你寫完文章之后，只需要一個簡單 的命令，就能把文章同時推送到各大網站

【編輯推薦】

  1. 你聽說過基于JavaScript的操作系統NodeOS嗎？
  2. Node.js發布6.0版本 提供2年長期支持
  3. 12個非常實用的JavaScript小技巧
  4. 為什么我從Python轉戰到Node.js
  5. 我的NodeJS一年之旅總結
【責任編輯：枯木 TEL：（010）68476606】

相關熱詞搜索：Javascript node 命令行

上一篇：Python 開發者如何正確使用 RStudio 編輯器
下一篇：在Docker和Kubernetes上運行MongoDB微服務

分享到： 收藏