如何在npm上发布自己的包

如何在 npm 上发布自己的包

npm 创建自己的包

一、一个简单的创建

1、创建 npm 账号

• 官网：https://www.npmjs.com/
• 创建账号入口：https://www.npmjs.com/signup

注意：需要进入邮箱验证

2、创建目录及初始化

$ mkdir ufrontend-test
$ cd ufrontend-test
ufrontend-test> npm init

3、文件内容及目录结构

注意：在生成 package.json 中，name 的名称和项目的名称保持一至

{
  "name": "ufrontend-test",
  "version": "1.0.0",
  "description": "","main":"index.js","scripts": {"ufrontend-test":"echo "Error: no test specified" && exit 1"},"author":"ufrontend","license":"ISC"
}

• 入口文件编写，index.js，加一句简单的打印

console.info('hello world');

├── ufrontend-test
│   ├── index.js
└── └── package.json

4、发布

• 项目根目录下，运行 npm addUser 命令，添加自己的用户信息

ufrontend-test> npm addUser

如果已经注册过账号，直接登录就行了

ufrontend-test> npm login

输入用户名、密码、邮箱

ufrontend-test> npm publish

发布完成后，在自己的 package 里，会看到对应的包

5、下载调用

ufrontend-test> npm install ufrontend-test -D

package.json

"devDependencies": {"ufrontend-test": "^1.0.0"}

index.js

require('ufrontend-test');

ufrontend-test> node index.js

输出：hello world

6、删除发布的包

ufrontend-test> npm --force unpublish ufrontend-test

注意：超过 24 小时就不能删除了

7、废弃包（这个包并不会删除，只是在别人下载使用的时候会提示）

ufrontend-test> npm deprecate --force ufrontend-test@1.0.0 "这个包不在维护了。"

8、更新包

• 先把 package.json 里的 version 版本号修改了，再执行 publish 命令就行了

ufrontend-test> npm publish

ufrontend-test> npm install ufrontend-test -D

二、require/import 导入及使用说明

1、目录结构

├── ufrontend-test2
│   ├── index.js
│   ├── package.json
└── └── readme.md

2、index.js（兼容 AMD 和 CMD 的写法）

;(function(global) {
    "use strict";
    var MyPlugin = function(opts) {console.log(opts);
    };
 
    MyPlugin.prototype = {init: function() {console.log('init');
        }
    };
 
    if (typeof module !== 'undefined' && module.exports) {module.exports = MyPlugin;} else if (typeof define === 'function') {define(function() {return MyPlugin;});
    }
    global.MyPlugin = MyPlugin;
 
})(this);

3、readme.md（插件说明）

4、下载使用

ufrontend-test> npm install ufrontend-test2 -D

• 在 index.js 中引入使用

var MyPlugin = require('ufrontend-test2');

MyPlugin({
    name: 'MyPlugin',
    version: '1.0.1'
});

MyPlugin.prototype.init();

运行命令

ufrontend-test> node index.js

结果：

{name: 'MyPlugin', version: '1.0.1'}
init

• 在 vue 项目 main.js 中，引入使用

ufrontend-test> npm install ufrontend-test4 -D

import MyPlugin from 'ufrontend-test4'
console.log(MyPlugin('hello my plugin.'))

let MyPlugin = require('ufrontend-test4');
console.log(MyPlugin('hello plugin.'))

5、加 git 仓库链接

"repository": {
  "type": "git",
  "url": "https://github.com/xxx/ufrontend_test2.git"
},

• 发布后，就可以在包中查看 git 仓库了

6、使用 webpack 打包

需要使用 webpack 对组件或者模块进行打包，因为可复用库的模块化，需要适合在任何场景中进行引用，比如 AMD/CMD、CommonJs、ES6、ES5 等环境。从 webpack 打包之后的头文件来看：

(function webpackUniversalModuleDefinition(root, factory) {if (typeof exports === 'object' && typeof module === 'object')
    module.exports = factory(); // node
  else if (typeof define === 'function' && define.amd)
    define([], factory);    //  AMD/CMD
  else if (typeof exports === 'object')
    exports["Url"] = factory(); 
  else
    root["Url"] = factory();})(this, function () {// somecode}

从代码可以看出，webpack 打包出来的文件是支持多场景的引用方式的。

下面我们只需要在 webpack.config.js 里添加 libraryTarget 配置，设为 umd 模式

output: {libraryTarget: "umd"}

目录结构：

├── ufrontend-test4
│   ├── build
│   ├── ├── main.min.js
│   ├── index.js
│   ├── package.json
└── └── webpack.config.js

{
  "name": "ufrontend-test4",
  "version": "1.0.4",
  "description": "","main":"./build/main.min.js","scripts": {"test":"echo "Error: no test specified" && exit 1"},"author":"ufrontend22","license":"ISC","devDependencies": {"webpack":"^3.1.0"}
}

main 是最终引入的文件

ufrontend-test> npm install

• webpack.config.js 指定 umd 模式

const webpack = require('webpack')
const path = require('path')

module.exports = {entry: ['./index.js'],
  output: {path: path.resolve(__dirname, './build'),
    filename: '[name].min.js',
    libraryTarget: 'umd'
  }
}

module.exports = {foo() {console.log('foo');
  },
  bar() {console.log('bar')
  }
}

使用 webpack 打包

ufrontend-test> webpack

ufrontend-test> npm login
ufrontend-test> npm publish

• 在 vue 项目中安装使用

ufrontend-test> npm install ufrontend-test4 -D

main.js

import {foo} from 'ufrontend-test4'
foo(); // foo