以markdown-clear,創(chuàng)建過程為例，講解整個(gè)NPM包創(chuàng)建和發(fā)布流程
1 如何創(chuàng)建一個(gè)包
1.1 創(chuàng)建并使用一個(gè)工程
- 在GitHub上新建一個(gè)倉庫,其名
markdown-clear -
clone這個(gè)工程到本地
1.2 添加LICENCE或LICENSE文件， 說明對(duì)應(yīng)的開源協(xié)議
- 到SPDX License List 或者Open Source Initiative，下載相應(yīng)協(xié)議的模板，我們這里選用MIT
- 修改必要的協(xié)議時(shí)間和作者
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文件
- 說明項(xiàng)目的一些信息
- 給出詳細(xì)參考資料的鏈接
- 給讀者一個(gè)整體的導(dǎo)航內(nèi)容
1.4 添加.gitignore 文件，忽略不需要提交的文件變更
- 可以去github gitignore 下載一個(gè)最相近的模板然后改改
- 可以去gitignore.io生成一個(gè),然后把內(nèi)容拿下了
- 可以參考gitignore.io 文檔，自己配命令行工具，以便隨時(shí)可以玩
- 我們這里生成了一個(gè)Node + IntellJ-all 的結(jié)果
- 內(nèi)容語法參考gitignore doc
1.5 初始化NPM包
- 使用
npm init初始化工程 - 按照提示填入相應(yīng)的內(nèi)容
1.6 到這里的目錄結(jié)構(gòu)
- 工程三大件以及npm包配置文件都有了
markdown-clear
------------- .gitignore
------------- LICENCE
------------- README.md
------------- package.json
1.7 EditorConfig
跨編輯器的編輯器設(shè)置，網(wǎng)站掛了，EditorConfig
1.8 ESLint
新一代JavaScript代碼質(zhì)量檢測(cè)工具ESLint
2 代碼結(jié)構(gòu)組織
2.1 加入代碼相關(guān)的目錄
markdown-clear
-------------- src // 源代碼目錄 比如coffee,typescript,es6+等代碼的目錄
-------------- lib // 轉(zhuǎn)義生成的代碼目錄，比如babel轉(zhuǎn)義后的es5代碼的目錄
-------------- docs // 代碼相關(guān)的設(shè)計(jì)和使用文檔
-------------- tests // 相關(guān)的測(cè)試目錄
2.2 代碼實(shí)現(xiàn)
- 寫代碼 src 目錄
- 轉(zhuǎn)換后的代碼 lib 目錄
2.2.1 使用babel 轉(zhuǎn)換代碼
- babel官網(wǎng)
- babel 配置文件
.babelrc
{
"presets":["es2015","stage-0"]
}
- 添加 npm 命令
"scripts": {
"build": "babel src -d lib",
}
2.2.2 實(shí)現(xiàn)一個(gè)可以全局安裝的npm包
- 添加
package.json的配置
"bin": {
"markdown-clear": "./lib/cli.js"
}
-
cli.js文件第一行添加
#!/usr/bin/env node
2.3 測(cè)試
- 寫測(cè)試用例 tests 目錄
- 調(diào)用最終生成的 lib 下面的目錄
- 可以考慮使用測(cè)試框架 mocha, jasmine, karma...
2.3.1 安裝測(cè)試
- 使用npm 安裝本地文件 作為本地包
npm install path/to/markdown-clear
- 使用npm 安裝本地文件 作為全局包
npm install path/to/markdown-clear -g
2.4 文檔輸出
- 寫文檔 docs 目錄
- 寫代碼相關(guān)的設(shè)計(jì)和使用文檔，沒有自然可以不用寫
- 這里的文檔應(yīng)該在README.md 中會(huì)有入口。
3 發(fā)布NPM包
- npm文檔
- 如果沒有注冊(cè)npm賬戶
npm adduser USERNAME
- 如果沒有登錄
npm login
- 登錄后發(fā)布包，在工程目錄下執(zhí)行
npm publish
