從零開發一個node命令列工具

TNFE發表於2019-06-05
命令列

什麼是命令列工具？

命令列工具（Cmmand Line Interface）簡稱cli，顧名思義就是在命令列終端中使用的工具。我們常用的 git 、npm、vim 等都是 cli 工具，比如我們可以通過 git clone 等命令簡單把遠端程式碼複製到本地。

為什麼要用cli工具？

和 cli 相對的是圖形使用者介面（gui），windows 環境中幾乎都是 gui 工具，而 linux 環境中則幾乎都是 cli 工具，因為兩者使用者不同，gui 側重於易用，cli 則側重於效率。對於熟悉 gui 和整合開發環境（IDE）的程式設計師，這似乎很難理解。畢竟用滑鼠點點拽拽，不是更方便麼?

很遺憾，答案是否定的。gui對於某些簡單操作，可能更快、更方便。比如移動檔案、閱讀郵件或寫word文件。但如果你依賴 gui 完成全部工作，你將會錯過環境的某些能力，比如使常見任務自動化，或是利用各種工具的全部功能。並且，你也無法將工具組合，建立出定製的巨集工具。gui 的好處是所見即所得(what you see is what you get)。缺點是所見即全部所得(what you see is all you get)。

作為注重實效的程式設計師，你不斷的想要執行特別的操作（gui 可能不支援的操作）。當你想要快速地組合一些命令，以完成一次查詢或某種其他的任務時，cli 要更為合適。比如：檢視上週哪些js檔案沒有改動過：

# cli：
find . -name '*.js' -mtime +7 -print
# gui：
1.點選並轉到"查詢檔案",點選"檔名"欄位，敲入"*.js",選擇"修改日期"選項卡；
2.然後選擇"介於".點選"開始日期"，敲入專案開始的日期。
3.點選"結束日期",敲入1周以前的日期(確保手邊有日曆)，點選"開始查詢"；

如何開發一個 cli 工具？

基本上，使用任何成熟的語言都可以開發 cli 工具，作為一個前端小白，還是 JavaScript 比較順手，因此我們選用 node 作為開發語言。

建立一個專案

# 1.建立一個目錄：
mkdir kid-cli && cd kid-cli
# 2.因為最終我們要把cli釋出到npm上，所以需要初始化一個程式包: 
npm init
# 3.建立一個index.js檔案
touch index.js
# 4.開啟編輯器(vscode)
code  .
安裝 code 命令，執行 VS code 並開啟命令皮膚（ ⇧⌘P ），然後輸入 shell command 找到: Install 'code' command in PATH 就行了。

開啟index.js檔案，新增一段測試程式碼：

#!/usr/bin/env node

console.log('hello world!’)

終端執行 node 程式，需要先輸入 node 命令，比如

node index.js

可以正確輸出 hello world!，程式碼頂部的 #!/usr/bin/env node是告訴終端，這個檔案要使用 node 去執行。

建立一個命令

一般 cli都有一個特定的命令，比如 git，剛才使用的 code 等，我們也需要設定一個命令，就叫 kid 吧！如何讓終端識別這個命令呢？很簡單，開啟 package.json 檔案，新增一個欄位 bin，並且宣告一個命令關鍵字和對應執行的檔案：

# package.json
......
  "bin": {
    "kid": "index.js"
  },
......
如果想宣告多個命令，修改這個欄位就好了。

然後我們測試一下,在終端中輸入 kid，會提示:

zsh: command not found: kid

為什麼會這樣呢？回想一下，通常我們在使用一個 cli 工具時，都需要先安裝它，比如 vue-cli，使用前需要全域性安裝:

npm i vue-cli -g

而我們的 kid-cli 並沒有釋出到 npm 上，當然也沒有安裝過了，所以終端現在還不認識這個命令。通常我們想本地測試一個 npm 包，可以使用：npm link 這個命令，本地安裝這個包，我們執行一下：

npm link

然後再執行

kid

命令，看正確輸出 hello world! 了。

到此，一個簡單的命令列工具就完成了，但是這個工具並沒有任何卵用，彆著急，我們來一點一點增強它的功能。

檢視版本資訊

首先是檢視 cli 的版本資訊，希望通過如下命令來檢視版本資訊：

kid -v

這裡有兩個問題

  1. 如何獲取 -v 這引數？
  2. 如何獲取版本資訊？

在 node 程式中，通過 process.argv 可獲取到命令的引數，以陣列返回，修改 index.js，輸出這個陣列：

console.log(process.argv)

然後輸入任意命令，比如：

kid -v -h -lalala

控制檯會輸出

[ '/Users/shaolong/.nvm/versions/node/v8.9.0/bin/node',
  '/Users/shaolong/.nvm/versions/node/v8.9.0/bin/kid',
  '-v',
  '-h',
  '-lalala' ]

這個陣列的第三個引數就是我們想要的 -v。

第二個問題，版本資訊一般是放在package.json 檔案的 version 欄位中, require 進來就好了，改造後的 index.js 程式碼如下：

#!/usr/bin/env node
const pkg = require('./package.json')
const command = process.argv[2]

switch (command) {
    case '-v':
    console.log(pkg.version)
    break
    default:
    break
}

然後我們再執行kid -v，就可以輸出版本號了。

初始化一個專案

接下來我們來實現一個最常見的功能，利用 cli 初始化一個專案。

整個流程大概是這樣的：

  1. cd 到一個你想新建專案的目錄；
  2. 執行 kid init 命令，根據提示輸入專案名稱；
  3. cli 通過 git 拉取模版專案程式碼，並拷貝到專案名稱所在目錄中；

為了實現這個流程，我們需要解決下面幾個問題：

執行復雜的命令

上面的例子中，我們通過 process.argv 獲取到了命令的引數，但是當一個命令有多個引數，或者像新建專案這種需要使用者輸入專案名稱（我們稱作“問答”）的命令時，一個簡單的swith case 就顯得捉襟見肘了。這裡我們引用一個專門處理命令列互動的包：commander。

npm i commander --save

然後改造index.js

#!/usr/bin/env node

const program = require('commander')

program.version(require('./package.json').version)
program.parse(process.argv)

執行

kid -h

會輸出

Usage: kid [options] [command]

Options:

  -V, --version  output the version number
  -h, --help     output usage information

commander已經為我們建立好了幫助資訊，以及兩個引數 -V 和 -h，上面程式碼中的program.version 就是返回版本號，和之前的功能一致，program.parse 是將命令引數傳入commander 管道中，一般放在最後執行。

新增問答操作

接下來我們新增 kid init 的問答操作，這裡有需要引入一個新的包：inquirer, 這個包可以通過簡單配置讓 cli 支援問答互動。

npm i inquirer --save

index.js：

#!/usr/bin/env node

const program = require('commander')
var inquirer = require('inquirer')

const initAction = () => {
    inquirer.prompt([{
        type: 'input',
        message: '請輸入專案名稱:',
        name: 'name'
    }]).then(answers => {
        console.log('專案名為：', answers.name)
        console.log('正在拷貝專案，請稍等')
    })
}

program.version(require('./package.json').version)

program
    .command('init')
    .description('建立專案')
    .action(initAction)

program.parse(process.argv)

program.command 可以定義一個命令，description 新增一個描述，在 --help 中展示，action 指定一個回撥函式執行命令。inquirer.prompt 可以接收一組問答物件，type欄位表示問答型別，name 指定答案的key，可以在 answers 裡通過 name 拿到使用者的輸入，問答的型別有很多種，這裡我們使用 input，讓使用者輸入專案名稱。

執行 kid init，然後會提示輸入專案名稱，輸入後會列印出來。

執行 shell 指令碼

熟悉 git 和 linux 的同學幾句話便可以初始化一個專案：

git clone xxxxx.git --depth=1
mv xxxxx my-project
rm -rf ./my-project/.git
cd my-project
npm i

那麼如何在 node 中執行 shell 指令碼呢？只需要安裝 shelljs 這個包就可以輕鬆搞定。

npm i shelljs --save

假定我們想克隆 github 上 vue-admin-template 這個專案的程式碼，並自動安裝依賴，改造index.js，在 initAction 函式中加上執行shell指令碼的邏輯：

#!/usr/bin/env node

const program = require('commander')
const inquirer = require('inquirer')
const shell = require('shelljs')

const initAction = () => {
    inquirer.prompt([{
        type: 'input',
        message: '請輸入專案名稱:',
        name: 'name'
    }]).then(answers => {
        console.log('專案名為：', answers.name)
        console.log('正在拷貝專案，請稍等')
        
        const remote = 'https://github.com/PanJiaChen/vue-admin-template.git'
        const curName = 'vue-admin-template'
        const tarName = answers.name

        shell.exec(`
                git clone ${remote} --depth=1
                mv ${curName} ${tarName}
                rm -rf ./${tarName}/.git
                cd ${tarName}
                npm i
              `, (error, stdout, stderr) => {
            if (error) {
                console.error(`exec error: ${error}`)
                return
            }
            console.log(`${stdout}`)
            console.log(`${stderr}`)
        });
    })
}

program.version(require('./package.json').version)

program
    .command('init')
    .description('建立專案')
    .action(initAction)

program.parse(process.argv)

shell.exec 可以幫助我們執行一段指令碼，在回撥函式中可以輸出指令碼執行的結果。

測試一下我們初始化功能：

cd ..
kid init
# 輸入一個專案名稱

可以看到，cli已經自動從github上拉取vue-admin-template的程式碼，放在指定目錄，並幫我們自動安裝了依賴。

尾聲

最後別忘了將你的 cli 工具釋出到 npm 上，給更多的同學使用。

npm publish

怎麼樣，是不是感覺看似神祕的命令列開發其實也沒有什麼技術含量，上文列舉的只是 cli 開發的冰山一角，想要開發出強大的 cli 工具，除了需要熟悉 node 和常用工具包，更重要的是瞭解 linux 常用命令和檔案系統，希望各位同學可以受到啟發，開發出屬於自己的 cli 工具。

安利時間

前端的技術點眾多，其中不乏抽象且晦澀的知識點，它們用文字無法很直觀的表述出來，所以眾多開發者對這些知識點的理解都是是而非，如果我們通過圖畫來展示，就會很容易理解。因此Diagram專案希望開發者能通過這種方式吃透前端技術領域的知識點。
我們每週會定時更新，每期更新5張技術圖解或者思維導圖。
每週對著這些圖解來溫習，相信用不了多久，你也能成為前端大神！
專案github地址: https://github.com/Tnfe/TNFE-Diagram

相關文章