Auto Publish Plugin

Webpack plugin that supports automatic publishing of NPM packages.

安装

  npm i --save-dev @comkit/auto-publish-plugin

  yarn add --dev @comkit/auto-publish-plugin

使用

auto-publish-plugin支持自动发布 npm 包。

webpack.config.js

const path = require('path');
const AutoPublishWebpackPlugin = require('auto-publish-plugin').default;

module.exports = {
  entry: './index.js',
  plugins: [
    new AutoPublishWebpackPlugin({
      name: 'vue',
      output: path.resolve(__dirname, './dist'),
      registry: 'http://registry.npmjs.org/',
    }),
  ],
  output: {
    filename: 'name.js',
    path: path.resolve(__dirname, 'dist'),
  },
};

参数

Name	Type	Default	Description
name	string	required	生成的package.json中的包名称
rootDir	string	required	当前项目跟路径
output	string	required	打包后生成内容的文件夹路径
registry	string	http://registry.npmjs.org/	npm源

prerelease 下推送会自动在根目录提交并推送文件变成，并且生成对应 alpha 版本 Tag 同时自动提交。

环境变量

auto-publish-plugin还支持通过环境变量注入的方式更新包版本。

• __version__plugin__mode=patch
• __version__plugin__mode=minor
• __version__plugin__mode=major
• __version__plugin__mode=auto

当传递patch、minor、major时，会根据对应的值直接进行版本号修改跳过询问步骤。

当传递auto时，会进入版本号询问环节，支持上述三种定义以及输入自定义版本号。

默认不传递__version__plugin__mode时，开启询问模式。