建立屬於自己的NPM包

南風一濺發表於2018-12-10
NPM

1、建立NPM賬號

這一步很簡單，只需訪問npm官網建立一個賬號

2、開始建立屬於自己的NPM包

2.1、npm init

在執行這一步前，先給自己的第一個NPM取一個名字，命名需要注意以下規範：

1、不要與已存在的其他npm包重名 2、包名不能出現大寫 3、不能混淆作者身份 4、符合npm標準，不能有冒犯性的命名，或是別人的商標名 5、在package.json檔案的相應行中指定名稱。

在自己的npm包目錄下執行npm init命令，按提示一步一步輸入即可。其中必填的只有三項

name：npm包名，不可以出現大寫 version：npm包版本號，預設1.0.0 main: npm包入口檔案，預設index.js

填完後目錄下生成package.json 詳細的package.json配置說明見https://docs.npmjs.com/getting-started/using-a-package.json

2.2、開始編寫npm包

在目錄下的index.js，即配置的main入口編寫程式碼，先來一行簡單的程式碼：

var sayHello = function (msg) {
  console.log(msg || 'Hello, world!')
}

module.exports = sayHello
複製程式碼

至此，一個簡單的npm包就已經寫完了，接下來就可以釋出了。

2.3、開始釋出自己的npm包

1、執行npm login輸入第一步中建立的npm賬號，通過npm whoami檢驗當前登入的npm賬號。確認賬號已註冊可訪問https://npmjs.com/~username。 2、如果你的npm包目錄下有很多檔案，需要忽略一些檔案不上傳，可以新增.gitignore檔案到根目錄，新增需要忽略的目錄或檔案到.gitignore：

ignoreFile01
ignoreDirectory02
複製程式碼

3、建立一個readme.md，給你的包做個說明，告訴別人怎麼使用你的包 4、現在可以執行npm publish釋出你自己的npm包了。成功後的提示：

+ your-package-name@1.0.0
複製程式碼

2.4、用一用自己的npm包

訪問https://npmjs.com/package/即可看到你自己的npm包了，像使用其他所有npm包那樣， 執行npm i yourPackageName即可下載自己的npm包並使用了！

2.5、更新自己的npm包

修改了自己的npm包後需要重新發布: 1、執行npm version <update_type>，已存在的版本號不允許重複。執行完命令，新的版本號會反應到目錄下的package.json。 2、改變版本後執行npm publish即可更新自己的npm包。

至此，如何建立屬於自己的NPM包完結 測試案例：

www.npmjs.com/package/win…

相關文章