怎么從零開發一個node命令行工具

本篇內容介紹了“怎么從零開發一個node命令行工具”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

什么是命令行工具？

命令行工具（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的代碼，放在指定目錄，并幫我們自動安裝了依賴。

“怎么從零開發一個node命令行工具”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！