如何編寫一個npm包,能夠公共使用?

常常開發vue的項目,package.json文件你們應該都很是都清楚,所謂的依賴,就是js邏輯的暴露,如今告訴你們怎麼發佈本身寫的npm包,供全球人使用。html

npm包建立步驟

1.建立一個文件夾

mkdir test
cd test
npm init
而後一路回車便可vue

2.在test文件夾建立index.js(主入口文件)

index.js內容自定義便可
示例:git

module.exports = function(options) {github

const options = options || {};
return function(req, res, next) {
    console.log(req, res, next);
}

}npm

3.完善init初始化的package.json文件

name:包的名字,確保該名字是獨一無二的
version:包的版本,默認是1.0.0
description:包的描述
main:入口文件,默認是index.js
test command:測試命令
repository:git倉庫地址,通常爲」type」:」git」,」url」:」git的url」
keyword:這個挺重要,儘可能用比較貼切的關鍵字做爲這個包的索引,這樣纔能有更多的人搜索到你的包
author:寫你的帳號或者你的github帳號吧
license:開源協議用了哪一個json

4.添加LICENCE文件(咱們選擇MIT)

參考連接:https://spdx.org/licenses/MIT... & https://opensource.org/licens...
新建文件名稱爲:LICENSE 沒有後綴
內容輸入參考連接裏面的text內容便可。
將<year> 和 <copyright holders>修改成 對應的年份 和 版權擁有者名字測試

5.添加 README.md 文件 和 .gitignore

README.md 文件主要用於 該項目的一些說明,使用方法等
好看的版本信息參考連接:https://shields.iourl

6.發佈npm包

  • 首先,註冊npm帳號,連接:https://www.npmjs.com
  • 其次,打開終端,到test目錄,輸入:npm adduser;而後輸入npm whoami,若是出現註冊名字,說明成功
  • 最後,輸入npm publish --access=public,便可發佈成功
  • 測試是否發佈成功,直接 npm install 你的包名,或者去註冊帳戶查看
  • 若是更新版本,須要更改package.json裏面的版本號,否則會報錯

以上就是幾步,但願你們可以開發本身想作的npm包。code

相關文章
相關標籤/搜索