原文章連結：請戳

Npm構建一個簡單的命令列工具

在團隊開發過程中，你是用什麼工具去呼叫private package的呢?最常見的答案就是：使用命令列工具來使用它。我們用兩部分來介紹如何製作其中一款命令列工具。

場景一：輕鬆部署GitHub pages

部署專案通常比較繁瑣，因此我們使用自動化來完成部署任務。目前，有很多的task runners都可以為我們自動化構建任務，但是最簡單的一種方式就是npm run scripts。
本章中，我們用構建一個GitHub page的例子來演示，當然我們也可以使用這種方式去部署其他服務，例如Heroku、AWS。或者你可以將它作為一個private package

釋出，裡面包含公司內部程式碼以及配置選項。

npm run scripts

首先，你定義一段可以被執行的字串指令，當你呼叫指令碼的時候，在命令列匯中執行npm run scripts，例如，我們為一個指令碼命名為patch-release，

#package.json
{
  "name": "index",
  "version": "1.0.1",
  "scripts": {
    "patch-release": "npm version patch && npm publish && git push --follow-tags"
  }
}
 

當你執行patch-release的時候，它會通過npm version來修改package.json中的version並且提交更新，然後釋出到npm，接著push到GitHub。
如果你在dependencies、devDependencies配置項中提前設定了modules,你就可以不用在將依賴包設定為全域性，它們將是可以直接使用的。並且你也可以在scripts中使用其他的指令碼npm run scripts

用指令碼釋出頁面

受git-it啟發，我們用指令碼來部署到GitHub pages，構建步驟如下：

"scripts": {
    "build": "...",
    "git-commit
 
": "git add -A . && git commit -a -m 'gh-pages update'",
    "git-push": "git push origin gh-pages --force && git checkout master",
    "deploy": "npm run build && npm run git-commit && npm run git-push"
  },

然後，在我們想要部署的時候，執行npm run deploy即可。

還有更好的方式嗎?

這種方式很棒。這將意味著你可以不用去記住那些冗長的字串指令，以及他們對應的flags。然而，你想按照這種方式部署到其他專案又得大量copy&paste。這將意味著在你的專案中又得大量重複您的程式碼。
那麼，我們怎麼才能遵循”don’t repeat yourself”原則呢？我們可以嘗試建立一個module,它可以將多個字串指令合併成為一條指令。這就是說我們在不同的專案裡面，可以很輕鬆的使用和維護這些指令還能分享給團隊。
詳情參見：戳這裡

Step1: 建立一個基本的命令列介面

首先，我們建立一個基本的Common line interface(也稱做CLI)。

1. 建立一個package 清單
   package 清單(即‘package.json’ 檔案)，它裡面含有基本資訊，例如包名稱(package name)，版本號(version)。
   如果你想給你的package限定使用範圍，供你的內部團隊使用時，你可以考慮使這個包成為private package,設定的範圍應該是你的使用者名稱。

   $ npm init --scope=xxx

2. 建立一個可被執行的指令碼檔案
   因為我們想要執行命令列，但是前提是我們需要用一個直譯器去啟動檔案（有時候我們稱為shebang line）

   
   #! ./node/env node
   
   console.log('console.log output')

現在我們執行測試一下：node bin/commit.js
3. 告訴命令列你的命令是什麼
我們想要執行一條命令，那麼我們首先得告訴Node如何才能找到能被執行的檔案，我們吧這條指令命名為github-pages-commit。同時，我們在package.json檔案中新增一個關鍵字:bin。

{
    "bin": {
         "github-pages-commit": "bin/commit.js"
    }
}

1. 確保命令可用
   為了測試你的命令被拾取到，使用npm link來執行關聯操作，這將確保你的指令（github-pages-commit）是可以被正確執行的。

step2: 執行被提交的命令

現在我們已經驗證了一個能被執行的CLI,我們可以新增我們的命令了。
npm run scripts 使用很方便，因為你可以很輕鬆在命令列中使用指令。在可複用的模組中執行這些指令碼很便捷，否則，我們的團隊就不能確保那些指令碼重用。
我們將使用shelljs模組來實現，或者你也可以使用node‘s child_process，但是使用shelljs有一個好處就是,你可以在window系統中使用大量的unix指令。具體參考文件： 請戳這裡。
1. 將shelljs 作為依賴

$ npm install --save shelljs

將會在package.json檔案中被新增為依賴（dependency）
2. 測試 shll.exec() 執行正常
為了確保我們掌握shell.exec()如何工作，我們將新增一個簡單的輸出宣告到 bin/commit.js

#! /node/env node

$ var shell = require('shelljs')
shell.exec('echo shell.exec works')

1. 使github-pages-commit 執行一個提交
   為此，我們在命令列中簡單的新增一個命令，用它來執行一次提交
   

   
   #! ./node/node
   
   $ var shell = require('shelljs')
   shell.exec("git add -A . && git commit -a -m 'update' ")

為了測試這個，開啟另一個命令列視窗並轉到您使用GitHub頁面的repo進行更改,然後執行github-pages-commit。在執行git log之後，您應該看到提交訊息的提交gh-pages update。

step3: 新增其他兩個命令

1. 新增 bin/push/js

   
   # /user/bin/env node
   
   $ var shell = require('shelljs')
   $ shell.exec('git push origin master --force')

2. 新增 bin/deploy.js
   我們通過定義過的其他指令進行合併

   
   #! /node/env node
   
   var shell = require("shelljs")
   shell.exec("github-pages-commit && github-pages-push")

3. 對映指令檔案

   {
     "github-pages-commit":"bin/commit.js",
     "github-pages-push":"bin/push.js",
     "githuv-pages-deploy":"bin/deploy.js"
   }

4. 再次執行npm link
   您需要npm link再次執行，以便它將建立兩個新的符號連結。
   現在您可以進行其他更改並執行github-pages-deploy以測試完整的任務。

step4: 釋出你的package

如果你之前從未釋出過軟體包，請戳這裡
因為這是一個有作用域的包，如果你想公開發布，必須使用access選項，瞭解更多請戳這裡

npm publish --access=publish

最後，付費會員可以釋出private package。

step5: 將你的命令新增為npm run scripts

我們可以告訴我們的團隊在全域性安裝這個模組，然後所有的指令都將可以在命令列中執行，我們不需要用npm 執行指令碼，但是全域性安裝有兩個缺點：首先，在新同事著手一個專案的時候他得體檢做一些準備工作，其次，當專案依賴更新的時候，你的團隊成員必須也要更新全域性模組。
相反，我們要使它的一個devDependencies在package.json為我們要部署的專案。通過這種方式，當新開發人員npm install開始執行專案時會下載它，並且每次開發人員執行時都會進行更新npm update。

$ npm install --save-dev @xxx/github-pages-deploy

現在您可以將可複用命令新增為npm執行指令碼

{
    "scripts":{
        "build": "....",
        "deploy": "github-pages-deploy"
    }
}

TO BE CONTINUE…