如何釋出自己的NPM包(模組)?

Finit發表於2018-09-10

1.註冊NPM 賬號

註冊地址:www.npmjs.com/

2.初始化自己要釋出的專案

搭建本地環境:安裝node.js,包含了npm命令。 新建目錄,在該目錄下,初始化專案:npm init。 按照提示填寫初始化資訊,我的模組名稱為:finitxu-npm-test,初始版本號:v1.0.0。 模組名稱需遵循相關政策要求:www.npmjs.com/policies , 不能夠與已有NPM模組名衝突等等。 模組程式碼 index.js:

function npmDemo(argument) {
	var name = 'finit';
	var f1 =function f(arg){console.log(arg)}
	return {
		name:name,
		f1:f1
	}
}
module.exports=npmDemo();

複製程式碼

3.登入npm,釋出自己的npm包。

npm login
複製程式碼

根據提示輸入之前註冊的賬號、密碼。 釋出npm包:

npm publish
複製程式碼

此時在自己個人的npm賬號主頁可以看到該包。

4.使用自己釋出的包(模組)的示例程式碼:

安裝之前釋出的npm包:

npm install finitxu-npm-test
複製程式碼

新建其它目錄,初始化:npm init。 使用已釋出NPM包的示例程式碼test.js:

var test_npm = require('finitxu-npm-test');
console.log(test_npm)
console.log(test_npm.f1(11));
console.log(test_npm.name)

複製程式碼

執行示例程式碼:node test.js

輸出:

{ name: 'finit', f1: [Function: f] }
11
undefined
finit
複製程式碼

5.更新自己的NPM包(模組)及 readme檔案

修改程式碼和readme.md後,執行命令:

npm version patch
npm publish
複製程式碼

npm version後面引數說明:

patch:小變動,比如修復bug等,版本號變動 v1.0.0->v1.0.1

minor:增加新功能,不影響現有功能,版本號變動 v1.0.0->v1.1.0

major:破壞模組對向後的相容性,版本號變動 v1.0.0->v2.0.0

6.使用更新後的NPM包

更新NPM包:

針對patch: npm install finitxu-npm-test
針對minor: npm install finitxu-npm-test
針對major: npm install finitxu-npm-test@2.0.0
複製程式碼

其它內容與步驟4相同。


微信公眾號(技術很有趣),瞭解一下~

這裡寫圖片描述

相關文章