發(fā)布一個npm包,需要幾步?

npm(node package management),是nodejs內(nèi)置的包管理器。中心思想是共享代碼,在這里我們可以找到自己需要的包,安裝,使用,當(dāng)然也可以發(fā)布我們自己的包。那下面我就來說下,發(fā)布一個npm包,需要幾步?


發(fā)布一個npm包比大象裝冰箱麻煩一點點,也就是一點點,不信,你往下看??:

1、注冊npm賬號,點我注冊
2、登錄賬號,npm login,根據(jù)提示輸入用戶名和密碼
3、賜名,通過 npm info +包名 來查看包信息,包名不能重復(fù)
4、初始化包
??a、創(chuàng)建文件夾,mkdir + 包名
??b、進入目錄,cd + 包名
??c、初始化包,npm init
??d、按提示輸入信息,填充包的詳細信息,會生成package.js
??e、編寫package.js,根據(jù)需要填充目錄,安裝依賴,編寫代碼
常見目錄結(jié)構(gòu)如下:

index.js代碼示例??如下

function add (num1, num2) {
    return num1 + num2
}  

function sub (num1, num2) {
    return num1 - num2
} 

module.exports = {
    add,
    sub
};

5、編寫好代碼,發(fā)布, 在項目目錄下npm publish即可


注意點:
1、每次發(fā)布前,需修改版本號,package.js中的version
2、js包如何兼容ts--------------提供類型聲明文件(類型聲明文件的主文件名與JS庫文件的主文件名相同,后綴為d.ts,例如主文件名為“index.js”,則類型聲明文件名為“index.d.ts”)

index.index.d.ts代碼示例??如下:

export function add(n1: number, n2: number): number;
export function sub(n1: number, n2: number): number;

package.js增加types配置如下:

  "name": "xxxx",
  "version": "我是版本,默認1.0.0,每次發(fā)布時需要更新",
  "description": "我是包描述,幫助大家在使用npm search時找到這個包",
  "keywords": ["我是關(guān)鍵字","幫助大家在使用npm search時找到這個包"],
  "main": "index.js", // 我是入口文件
  "types": "index.d.ts", //我是類聲明文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {},
  "devDependencies": {},
  "author": "",
  "license": "ISC"

3、刪包
??a、刪除某個版本: npm unpublish 包名@版本號
??b、刪除整個包:npm unpublish 包名 --force

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容