1、准备好 Vue 插件
在发布 npm 之前,你需要按照Vue插件开发手册开发完成你的 Vue 插件。
2、创建一个简单的项目
通过 webpack-simple 来新建一个简单的项目。1
vue init webpack-simple [your plugin name]
目录结构如下图:

3、封装插件
1、创建 src/lib 目录,建立index.js文件

2、填充相应内容
1 | /* |
如果你的插件依赖其他 css 或者 库, 同样可以在 index.js 中 import。
4、配置
1、webpack配置
修改webpack.config.js1
2
3
4
5
6
7
8
9
10
11
12module.exports = {
entry: './src/lib/index.js',
output: {
path: path.resolve(__dirname, './dist'),
publicPath: '/dist/',
filename: 'plugin-name.js',
library: "plugin-name",
libraryTarget: 'umd',
umdNamedDefine: true
},
// ...
}
- entry 修改入口文件的路径
- output 配置最终输出的代码
- filename 输出的文件名称,修改成插件名称
- library 新增导出库的名称
- libraryTarget 新增导出库的方式
- umdNamedDefine 对AMD模块重命名
- webpack.config.js 按照上述配置完毕,可以通过 npm run build 来进行构建。
2、package.json配置
1 | { |
- private 修改成false, 表示公开库
- main 修改成构建后的输入文件
- repository 可以写上库的 github 地址
5、发布到npm
- npm login 来登录 npm 账户,或者注册
- 在项目根目录 npm publish 发布项目
最后
如果上述步骤顺利完成,开发者就可以通过npm install YourPluginName来安装到本地,通过ES6 import的方式来引入并使用。

