怎麼開發一個npm包

一、註冊npm賬號

• 怎麼將程式碼提到github，大家都知道需要一個github賬號
• 同樣，開發一個npm包，當然也需要一個npm賬號，將npm包釋出到npm的託管伺服器
• 該例項包含了模組的區域性呼叫和全域性呼叫兩種方式

二、開發npm包

1.目錄構建

• npm init
• 專案結構：npm包實際是一個存檔檔案，即一個目錄直接打包為.zip或tar.gz格式的檔案，安裝後解壓還原為目錄。完全符合CommonJS規範的包目錄應該包含如下這些檔案。

      .
      ├── bin           //命令配置
      ├── README.md     //說明文件
 

      ├── index.js      //主入口
      ├── src           //功能檔案
      ├── package.json  //包資訊
      └── test          //測試用例

生產package.json檔案，裡面要注意引數，repository:”“一定要填寫倉庫地址，因為最後npmjs，會從線上倉庫獲取。
證明是否登入成功：
　

npm who am i

2.開發模組

• 入口index.js模組
  非全域性安裝(npm install xxx)，則多有的函式介面都通過index.js暴露給外部呼叫

      /**
      * Hello World
      * @function
 
 hello
      **/
      const hello = function(key){
          console.log('Hello World!');
      };

      exports.hello     = hello;

• init.js模組

      const exec = require('child_process').exec;

      exports.run = function(name) {
          //初始化一個空資料夾
          exec('mkdir ' + name,function() {
 

              console.log('king init命令已執行...');
          });
      };

• start.js模組

     const express = require('express');
      const app     = express();

      exports.run = function(options) {
          const port = options.port || 3000;
          app.listen(port);
          console.log('服務已啟動，正在監聽' + port + '埠...');
      };

3.配置全域性命令

bin目錄下寫配置程式碼

• cli.js自定義命令，主要通過引入commander模組去處理，包括命令描述、引數及執行動作
• king.js檔名稱應與全域性命令king保持一致，做命令的入口，具體看demo

三、釋出npm包

1.npm login

npm login  //沒有註冊賬號的，npm adduser

2.npm publish

npm publish .

如果你以後修改了程式碼，然後想要同步到 npm 上的話請修改 package.json 中的 version 然後再次 publish，更新的版本上傳的版本要大於上次

1.使用 cnpm 的注意報錯：

    no_perms Private mode enable, only admin can publish this module

　　設定回原本的就可以了：

 npm config set registry http://registry.npmjs.org 

　　2.npm包package.json中registory屬性一定要填寫，每次publish npm時package.json中version版本一定要大於上一次。

　 3.npm publish failed put 500 unexpected status code 401這樣的報錯資訊，往往是沒有登入成功，操作npm login

管理包許可權：

　　通常，一個包只有一個擁有許可權進行釋出。如果需要多人進行釋出，可以使用npm owner 命令幫助你管理包的所有者：

　npm owner ls eventproxy

　　使用這個命令，也可以新增包的擁有者，刪除一個包的擁有者：

npm owner ls <package name>
npm owner add <user> <package name>
npm owner rm <user> <package name>

四、全域性安裝和區域性安裝

1.區域性安裝

• 所有的函式功能介面都由index.js暴露給外部
• src裡面可以放功能程式碼，src –> index.js只做output，暴露給外部呼叫

2.全域性安裝

• 包全域性安裝的情況，一般是做自動化工具，關鍵在於配置全域性命令，與index.js無關
• 通過bin目錄下與全域性命令相同的js檔案(如king.js)處理command的輸入【如：king start】
• 來，讓我們看看執行king –help的效果

五、常見問題

1. npm publish出錯

 npm ERR! publish Failed PUT 403
    npm ERR! Darwin 16.0.0
    npm ERR! argv "/usr/local/Cellar/node/5.6.0/bin/node" "/usr/local/bin/npm" "publish"
    npm ERR! node v5.6.0
    npm ERR! npm  v3.10.3
    npm ERR! code E403

    npm ERR! "You cannot publish over the previously published version 0.0.43." : npm-develop
    npm ERR!
    npm ERR! If you need help, you may report this error at:
    npm ERR!     <https://github.com/npm/npm/issues>

    npm ERR! Please include the following file with any support request:
    npm ERR!     /Volumes/work/private/github/npm-develop/npm-debug.log

沒有更新package.json的版本號，每次的版本號必須大於上次，否則無法publish

2. 採用sudo npm publish

password應該輸入的是本機開機密碼，非npm賬號密碼

3. 全域性命令無效

package.json中的bin命令配置，屬性值應該和指令碼名稱一致

"bin": {
  "king": "./bin/king.js"
}

1. 釋出包過程可能會遇到很多問題，我印象比較深刻的是npm ERR publish 403
   You do not have permission to publish ‘somepackage’.Are you logged in as
   the corrent user?:somepackage
   意思是我沒許可權釋出somepackage，並問我是否使用了正確的賬號，
   那也許是somepackage被別人釋出過了吧，所以我修改了package.json檔案
   把name改成somepackage_xiaoguoping.

6.驗證

這裡先使用npm install 你釋出出去的包的名字，然後看看命令列裡面是不是把你的包下載了下來。如果下載成功，就說明你的包已經成功地釋出在npm上了。

或者你親自上npm這個網站（該帶梯子的請自帶梯子），然後在搜尋框裡面輸入你剛才寫下來的關鍵字。。。不過，如果你的包的星星（點贊）數量不夠的話應該會排到很尾。。。所以我建議你用包名直接搜（反正我用關鍵字找找不到我的包。。。）：

在你執行完npm init這個步驟之後，你把程式碼扔進這個包裡面後，就形成了一個本地的包，可以直接把這個包扔到專案裡面node_module這個資料夾裡面的，然後在你的專案裡面就可以直接：

  var a=require('你的包名');

直接使用包名引入，不用檔案路徑了，就像引入fs或者http模組一樣

測試完確定沒有什麼bug之後再執行npm publish哦