Node.js躬行記(3)——命令列工具
一、自定義
建立一個空目錄,然後通過npm init命令初始化package.json檔案,並按提示輸入相關資訊或直接回車使用預設資訊,生成的內容如下所示。
{ "name": "pwct", "version": "1.0.0", "description": "命令列工具測試", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { "type": "git", "url": "git+https://github.com/pwstrick/pwct.git" }, "author": "strick", "license": "ISC", "bugs": { "url": "https://github.com/pwstrick/pwct/issues" }, "homepage": "https://github.com/pwstrick/pwct#readme" }
在模組中建立bin目錄,並儲存一個名為pwct.js的指令碼,內容如下(只做演示,沒有加邏輯)。其中#!/usr/bin/env node語句用於指定指令碼的直譯器。
#!/usr/bin/env node console.log("命令列工具測試");
更新package.json檔案,新增bin欄位,並新增以下配置。
"bin": { "pwct": "./bin/pwct.js" }
如果現在在終端執行pwct命令,那麼會出現下面的錯誤提示。
$ pwct bash: pwct: command not found
為了能測試剛剛新增的命令,需要使用npm link命令(執行結果如下所示),它能模擬全域性安裝,而不用釋出模組。
C:\AppData\Roaming\npm\pwct -> C:\AppData\Roaming\npm\node_modules\pwct\bin\pwct.js C:\AppData\Roaming\npm\node_modules\pwct -> D:\node\demo
再次在終端執行pwct命令,就能打印出預期的結果,如下所示。
$ pwct 命令列工具測試
命令列的引數可以從process.argv陣列中獲得,直接修改pwct.js檔案,新增一條列印process.argv的語句,如下所示。由於使用了npm link來連結模組,因此無須重新發布和安裝就能直接除錯。
#!/usr/bin/env node console.log(process.argv);
在終端執行pwct -h命令,得到的陣列如下所示,省略了前兩個元素的絕對路徑。
$ pwct -h [ 'node.exe', 'pwct.js', '-h' ]
二、包的管理
1)釋出
當要將模組作為包釋出到npm官網時,首先需要註冊一個帳號,然後使用npm login命令在終端登入,再通過npm publish命令釋出,釋出成功後得到的結果如下。
$ npm publish npm notice npm notice package: [email protected] npm notice === Tarball Contents === npm notice 494B package.json npm notice 221B bin/pwct.js npm notice === Tarball Details === npm notice name: pwct npm notice version: 1.0.0 npm notice package size: 527 B npm notice unpacked size: 715 B npm notice shasum: 16cd277ffad852d2d2ac60534b557df28854f93f npm notice integrity: sha512-/j+dfkz63nZVW[...]RYnfU8DgOEcHQ== npm notice total files: 2 npm notice + [email protected]
2)更新
當需要更新一個已釋出的包時,可以先執行下面命令中的一個,三條命令會分別對主版本號、次版本號和補丁版本號進行加一的處理。
npm version major npm version minor npm version patch
例如執行patch命令,結果如下所示。
$ npm version patch v1.0.1
然後再執行npm publish命令,進行更新處理。
3)刪除
可以刪除特定版本號的包,語法如下所示。
npm unpublish 包名@版本號
執行下面的命令,就能移除官網上指定版本的包。
$ npm unpublish [email protected] [email protected]
如果要刪除整個包,語法如下。
npm unpublish 包名 --force
執行下面的命令,就能將官網上的包整個移除。
$ npm unpublish pwct --force npm WARN using --force I sure hope you know what you are doing. -pwct
4)安裝
npm install命令除了可以跟包名之外,還能與GitHub的SSH地址組合,如下所示。
npm install git+ssh://github.com:pwstrick/pwct.git
三、Commander.js
上述所舉的是一個極簡命令,而一般的命令格式會包含三部分,如下所示。
command [options] [arguments]
(1)command:命令名稱,例如pwct。
(2)options:配置選項,字首可以是單個連字元(-)或兩個連字元(--),前者與引數簡稱組合,後者與引數全稱組合,例如-h、--help。
(3)arguments:引數列表,有些選項也會帶引數。
在檢視命令幫助時,會出現[]、<>、|等符號,它們的含義如下:
(1)[]:可選的。
(2)<>:可變選項,一般是多選一,而且必須要選其一。
(3)x|y|z:多選一,如果加上[],可不選。
(4)-abc:多選,如果加上[],可不選。
接下來使用第三方的Node命令列模組:Commander.js,編寫出更加專業的命令,如下所示。注意,命令名稱改為pwcta。
#!/usr/bin/env node const program = require('commander'); program .version('1.0.0', '-v, --version', '版本') .option('-d, --debug', '除錯') .option('-b, --build [dir]', '構建') .parse(process.argv); if (program.debug) console.log(program.opts()); if (program.build) console.log('loading');
version()方法可定義當前命令的版本。option()方法可定義命令的配置選項。parse()方法可讓解析出的全稱引數成為program的屬性。
執行“pwcta -d -b ./list”命令,得到的結果如下所示,opts()方法可得到引數的鍵值對。
$ pwcta -d -b ./list { version: '1.0.0', debug: true, build: './list' } loading
幫助選項(-h和--help)預設已提供,執行“pwcta -h”命令得到的結果如下。
$ pwcta -h Usage: pwcta [options] Options: -v, --version 版本 -d, --debug 除錯 -b, --build [dir] 構建 -h, --help display help for command
&n