日韩av黄I国产麻豆传媒I国产91av视频在线观看I日韩一区二区三区在线看I美女国产在线I麻豆视频国产在线观看I成人黄色短片

歡迎訪問 生活随笔!

生活随笔

當(dāng)前位置: 首頁 >

如何编写一个npm包,可以公共使用?

發(fā)布時間:2025/3/21 57 豆豆
生活随笔 收集整理的這篇文章主要介紹了 如何编写一个npm包,可以公共使用? 小編覺得挺不錯的,現(xiàn)在分享給大家,幫大家做個參考.

經(jīng)常開發(fā)vue的項目,package.json文件大家應(yīng)該都非常都清楚,所謂的依賴,就是js邏輯的暴露,現(xiàn)在告訴大家怎么發(fā)布自己寫的npm包,供全球人使用。

npm包創(chuàng)建步驟

1.創(chuàng)建一個文件夾

mkdir test
cd test
npm init
然后一路回車即可

2.在test文件夾創(chuàng)建index.js(主入口文件)

index.js內(nèi)容自定義即可
示例:

module.exports = function(options) {

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

}

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

name:包的名字,確保該名字是獨一無二的
version:包的版本,默認是1.0.0
description:包的描述
main:入口文件,默認是index.js
test command:測試命令
repository:git倉庫地址,一般為”type”:”git”,”url”:”git的url”
keyword:這個挺重要,盡量用比較貼切的關(guān)鍵字作為這個包的索引,這樣才能有更多的人搜索到你的包
author:寫你的賬號或者你的github賬號吧
license:開源協(xié)議用了哪個

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

參考鏈接:https://spdx.org/licenses/MIT... & https://opensource.org/licens...
新建文件名稱為:LICENSE 沒有后綴
內(nèi)容輸入?yún)⒖兼溄永锩娴膖ext內(nèi)容即可。
將<year> 和 <copyright holders>修改為 對應(yīng)的年份 和 版權(quán)擁有者名字

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

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

6.發(fā)布npm包

  • 首先,注冊npm賬號,鏈接:https://www.npmjs.com
  • 其次,打開終端,到test目錄,輸入:npm adduser;然后輸入npm whoami,如果出現(xiàn)注冊名字,說明成功
  • 最后,輸入npm publish --access=public,即可發(fā)布成功
  • 測試是否發(fā)布成功,直接 npm install 你的包名,或者去注冊賬戶查看
  • 如果更新版本,需要更改package.json里面的版本號,不然會報錯

以上就是幾步,希望大家能夠開發(fā)自己想做的npm包。

總結(jié)

以上是生活随笔為你收集整理的如何编写一个npm包,可以公共使用?的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯,歡迎將生活随笔推薦給好友。