1. 程式人生 > >如何開發NPM包

如何開發NPM包

新建 specified 進入 version 簡單 script text .com strong

創建包目錄

D:\>mkdir mypackage && cd mypackage
D:\mypackage>npm init --yes

進入mypackage目錄,你會看到一個package.json文件,其內容如下:

{
  "name": "mypackage",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  
"keywords": [], "author": "", "license": "ISC" }

其中"main"指向了你的包的入口點,當別人使用你的模塊時require("mypackage"),實際返回的是"main"指向的"index.js"文件中的module exports

完成包功能

在mypackage目錄下創建index.js文件,並添加如下內容:

"use strict";

    module.exports = function sum(a, b) {
        return a+b;
    }

包的內容很簡單,就是完成一個加法運算

測試

新建一個項目mypackage_test用於測試

D:\>mkdir mypackage_test && cd mypackage_test

D:\mypackage_test>npm init --yes

(劃重點)在測試階段,如何不用每次改動都重新編譯並發布到NPM

方法1:絕對路徑引用

D:\mypackage_test>npm install D:/mypackage

此時查看package.json,其內容如下(註意粗體部分):

{
  "name": "mypackage_test",
  
"version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", "dependencies": { "mypackage": "file:../mypackage" } }

此時再到node_modules目錄下查看,目錄結構如下

技術分享圖片

方法2:使用“npm link”

D:\mypackage>npm link
D:\mypackage_test>npm link mypackage

此時再到node_modules目錄下去驗證

技術分享圖片

方法3:

D:\mypackage>npm pack
mypackage-1.0.0.tgz

此時會在mypackage目錄下生成mypackage-1.0.0.tgz文件

然後到mypackage_test目錄下執行命令

D:\mypackage_test>npm install D:\mypackage\mypackage-1.0.0.tgz

發布

你需要擁有npm賬號,使用npm publish命令,這裏不再多講了,很少用到

如何開發NPM包