摘要：前言這是一篇關(guān)于如何使用構(gòu)建高性能高可讀性的現(xiàn)代化命令行工具的博客。對(duì)于命令行工具來(lái)說(shuō)，運(yùn)行時(shí)的權(quán)限是巨大的，但不要因此弄臟用戶的系統(tǒng)。

這是一篇關(guān)于如何使用 NodeJS 構(gòu)建高性能、高可讀性的現(xiàn)代化命令行工具的博客。

每當(dāng)我們想要?jiǎng)?chuàng)建一個(gè)基于 NodeJS 的命令行工具時(shí)，就會(huì)衍生出一堆問(wèn)題需要解決，比如如何準(zhǔn)備開(kāi)發(fā)環(huán)境，如何打包轉(zhuǎn)譯代碼，如何使代碼在轉(zhuǎn)譯后保持可調(diào)用的狀態(tài)同時(shí)盡可能的壓縮體積，
以及怎樣設(shè)計(jì)項(xiàng)目分配 Command 與 Option 等等，這會(huì)浪費(fèi)巨大的時(shí)間，而且并非一定有成果。這時(shí)你可以注意到社區(qū)幾乎所有的命令行工具都是自成一派，
并沒(méi)有嚴(yán)謹(jǐn)?shù)目蚣芑蚣s定約束，也無(wú)所謂的最佳實(shí)踐，這使想要特別是第一次想要開(kāi)發(fā)命令行工具的開(kāi)發(fā)者望而卻步，或是幾番努力最后卻不盡如人意。

舉個(gè)例子來(lái)說(shuō)，騰訊的 omi 是一個(gè)有眾多使用者的框架，但其命令行工具 omi / omi-cli 卻讓人貽笑大方。僅一些簡(jiǎn)單的下載和創(chuàng)建模板的任務(wù)，造出長(zhǎng)篇大論的文件不說(shuō)，下載
時(shí)依賴數(shù)千，包的體積巨大，整體項(xiàng)目毫無(wú)設(shè)計(jì)幾乎是隨心所欲、天馬行空，這就是開(kāi)發(fā)者本身并不擅長(zhǎng)此道，只學(xué)會(huì)了 糊屎。（何謂 糊屎，參閱 JS 優(yōu)雅指南 2）

FUNC 的出現(xiàn)就是為了解決這些問(wèn)題。func 本身的實(shí)現(xiàn)參閱了社區(qū)內(nèi)諸多基于 NodeJS 的命令行工具的優(yōu)秀實(shí)現(xiàn)，與流行的框架設(shè)計(jì)思路相結(jié)合，以優(yōu)雅的設(shè)計(jì)、小體積、高性能 等為目標(biāo)，
同時(shí)關(guān)注開(kāi)發(fā)者體驗(yàn)，大幅度的提升了命令行工具項(xiàng)目的可擴(kuò)展性與可讀性，幾乎是如今 NodeJS 社區(qū)中開(kāi)發(fā)命令行工具的最優(yōu)解。我們可以嘗試使用 func 構(gòu)建一個(gè)命令行工具。

在以前流行的一些命令行參數(shù)解析的庫(kù)中，我們?cè)跇?gòu)建項(xiàng)目前需要準(zhǔn)備大量的腳本與配置，甚至還要解決文件權(quán)限、bin、代碼轉(zhuǎn)譯等等問(wèn)題，但使用 func，我們可以僅通過(guò)一行命令
初始化項(xiàng)目：

npm init func

項(xiàng)目初始化后進(jìn)入文件夾，隨機(jī)使用 npm install 或 yarn 安裝依賴，現(xiàn)在就可以正式開(kāi)發(fā)了。
可以注意到，func 的項(xiàng)目模板中為我們準(zhǔn)備了 start 與 build 2 個(gè)腳本，它們都是由 func-service 驅(qū)動(dòng)的，幫助你一鍵切換開(kāi)發(fā)與生產(chǎn)模式，我們所要做的就是專注于
命令行邏輯本身，實(shí)現(xiàn)邏輯就夠了。

我們可以隨意的創(chuàng)建一個(gè)類，當(dāng)它被加上 Command 注解時(shí)這就是一個(gè)命令，而被加上 Option 注解時(shí)就會(huì)轉(zhuǎn)變?yōu)橐粋€(gè)選項(xiàng):

import { Command } from "func"

@Command({ name: "test" })
export class Test {
}

在命令行中運(yùn)行 test 時(shí)，Test 類將會(huì)被調(diào)用。選項(xiàng)也是同理。你可以在 constructor 中開(kāi)始自己的代碼，這和你在任何地方寫(xiě) NodeJS 沒(méi)有什么
不同，當(dāng)你覺(jué)得差不多的時(shí)候，運(yùn)行 npm build 就可以將它打包，一切就是這么簡(jiǎn)單。

有時(shí)候，當(dāng)我們需要使用到命令行攜帶的參數(shù)時(shí)，比如處理 something params -option 這樣復(fù)雜的輸入，你可以直接在類中注入命令行參數(shù)，對(duì)，就是像 IoC 那樣：

@Command({ name: "test" })
export class Test {
  constructor(
    private args: CommandArgsProvider,
  ) {
  }
}

CommandArgsProvider 實(shí)際上是一個(gè) class 類型，當(dāng)你標(biāo)記一個(gè)參數(shù)為此類型時(shí)，func 會(huì)在運(yùn)行時(shí)為你注入所有的命令參數(shù)，
同樣的也支持 OptionArgsProvider 、RegisterProvider 等等，你可以在 官方的文檔 閱讀它們的具體類型。

運(yùn)行 npm build 可以得到一個(gè)打包后的文件，這是由 ncc 編譯后的文件，通常它只有一個(gè) (如果攜帶 extra 可能會(huì)有多個(gè)，但它們會(huì)自動(dòng)鏈接)，
同時(shí)為你鏈接好了 bin，你要做的唯一一件事就是將包發(fā)布出去。為什么 func 使用這種方式發(fā)布呢？

我們知道當(dāng)你在安裝一個(gè)包或是使用 npx 執(zhí)行包時(shí) (這在使用命令行工具的人群中很常見(jiàn))，NPM 所花費(fèi)的時(shí)間大約在 3 個(gè)部分，即對(duì)比包的依賴，下載包，執(zhí)行。
首先我們知道 func 的項(xiàng)目足夠的小，能夠大量介紹下載時(shí)間，同時(shí)也有足夠好的性能，現(xiàn)在要解決的就是在大量依賴時(shí)的對(duì)比分析問(wèn)題，將文件打包成單文件不依賴
外部環(huán)境時(shí)會(huì)極大的減少所需時(shí)間，如果你再將所有的依賴移入 devDependencies 中，幾乎能夠在一瞬間完成 分析 - 下載 - 運(yùn)行 這三個(gè)步驟。這樣的體驗(yàn)是難以想象的。
是的，這里推薦你把所有的依賴當(dāng)做開(kāi)發(fā)依賴處理，這似乎違背了 NPM Package 的開(kāi)發(fā)哲學(xué)，但在使用 func 構(gòu)建命令行應(yīng)用時(shí)這樣做卻大有裨益。

在運(yùn)行 func build 完成的包時(shí)，我們注意到幾乎無(wú)需任何依賴，這是因?yàn)樵趩蝹€(gè)文件中已經(jīng) bundle 了所有的所需資源，也就意味著用戶在運(yùn)行 .js 文件時(shí)，
堆棧中真的就只有 .js 文件內(nèi)的內(nèi)容，不會(huì)引用其他，不會(huì)加載任何無(wú)關(guān)緊要的東西。此時(shí)我們也就無(wú)需用戶關(guān)心 dependencies，甚至可以移除它們，這樣一來(lái)，
下載或即時(shí)運(yùn)行時(shí)就直接跳過(guò)了 對(duì)比依賴版本 這一步，這其中省略了無(wú)數(shù)的請(qǐng)求也就會(huì)會(huì)極大的增加速度，npm init func 能夠在 1 秒左右立刻開(kāi)始安裝也是這樣的道理。

現(xiàn)在你已經(jīng)知道了怎樣快速的構(gòu)建一個(gè)合格且優(yōu)雅的命令行工具，那怎樣做的更好呢？通常來(lái)說(shuō)你需要遵循這幾點(diǎn)：

不因?yàn)樾」δ芤刖薮蟮陌?，不引入依賴爆炸的包?/strong>

舉例來(lái)說(shuō)，download-git-repo 是一個(gè)很不錯(cuò)的包，它能夠?yàn)槟愎?jié)約很多時(shí)間，但請(qǐng)注意它依賴了 download，如果你僅為了下載單個(gè)文件或只有很少的下載需求時(shí)，
這就顯得有些大材小用，download 會(huì)為你增加約 450 kb 的重量，卻只做了一件你 5 分鐘可以搞定的事情。同樣你的用戶也會(huì)為此付出巨大的時(shí)間代價(jià)。