如何自己寫一個公用的NPM包

• 2019 年 12 月 4 日
• 筆記

本文作者：IMWeb 釕子_rawbin 原文出處：IMWeb社區 未經同意，禁止轉載

以markdown-clear,創建過程為例，講解整個NPM包創建和發布流程

1 如何創建一個包

1.1 創建並使用一個工程

• 在GitHub上新建一個倉庫,其名markdown-clear
• clone 這個工程到本地

1.2 添加LICENCE或LICENSE文件， 說明對應的開源協議

• 到SPDX License List 或者Open Source Initiative，下載相應協議的模板，我們這裡選用MIT
• 修改必要的協議時間和作者

MIT License  Copyright (c) <year> <copyright holders>    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

1.3 添加README或者ReadMe.md或者README.md文件

• 說明項目的一些資訊
• 給出詳細參考資料的鏈接
• 給讀者一個整體的導航內容

1.4 添加.gitignore 文件，忽略不需要提交的文件變更

• 可以去github gitignore 下載一個最相近的模板然後改改
• 可以去gitignore.io生成一個,然後把內容拿下了
• 可以參考gitignore.io 文檔，自己配命令行工具，以便隨時可以玩
• 我們這裡生成了一個Node + IntellJ-all 的結果
• 內容語法參考gitignore doc

1.5 初始化NPM包

• 使用npm init 初始化工程
• 按照提示填入相應的內容

1.6 到這裡的目錄結構

• 工程三大件以及npm包配置文件都有了

markdown-clear  ------------- .gitignore  ------------- LICENCE  ------------- README.md  ------------- package.json

1.7 EditorConfig

跨編輯器的編輯器設置，網站掛了，EditorConfig

1.8 ESLint

新一代JavaScript程式碼品質檢測工具ESLint

2 程式碼結構組織

2.1 加入程式碼相關的目錄

markdown-clear  -------------- src     // 源程式碼目錄 比如coffee,typescript,es6+等程式碼的目錄  -------------- lib     // 轉義生成的程式碼目錄，比如babel轉義後的es5程式碼的目錄  -------------- docs    // 程式碼相關的設計和使用文檔  -------------- tests   // 相關的測試目錄

2.2 程式碼實現

• 寫程式碼 src 目錄
• 轉換後的程式碼 lib 目錄

2.2.1 使用babel 轉換程式碼

• babel官網
• babel 配置文件 .babelrc

{    "presets":["es2015","stage-0"]  }

• 添加 npm 命令

  "scripts": {      "build": "babel src -d lib",     }

2.2.2 實現一個可以全局安裝的npm包

• 添加package.json的配置

  "bin": {      "markdown-clear": "./lib/cli.js"    }

• cli.js文件第一行添加

#!/usr/bin/env node

2.3 測試

• 寫測試用例 tests 目錄
• 調用最終生成的 lib 下面的目錄
• 可以考慮使用測試框架 mocha, jasmine, karma…

2.3.1 安裝測試

• 使用npm 安裝本地文件 作為本地包

npm install path/to/markdown-clear

• 使用npm 安裝本地文件 作為全局包

npm install path/to/markdown-clear -g

2.4 文檔輸出

• 寫文檔 docs 目錄
• 寫程式碼相關的設計和使用文檔，沒有自然可以不用寫
• 這裡的文檔應該在README.md 中會有入口。

3 發布NPM包

• npm文檔
• 如果沒有註冊npm賬戶

npm adduser USERNAME

• 如果沒有登錄

npm login

• 登錄後發布包，在工程目錄下執行

npm publish