0.0.4 • Published 3 years ago

@dtgov/version-compare-plugin

Licence

ISC

Version

0.0.4

Deps

Size

10 kB

Vulns

Weekly

Summary Dependency Versions

webpack项目版本对比插件

生成项目版本文件，轮询请求文件进行版本对比判断是否更新，进行页面刷新

Install

  npm i --save-dev @dtgov/version-compare-plugin

Options

Name	Type	Default	Description
`enable`	`{Boolean}`	`true`	是否开启版本对比
`version`	`{String}`	`-`	生成版本号，默认随机生成
`filename`	`{String}`	`version.json`	生成文件名称
`path`	`{String}`	`/`	生成文件路径
`delay`	`{Number}`	`5`	轮询请求时间（分钟）
`autoReload`	`{Boolean}`	`false`	是否自动刷新页面，与 notice 互斥
`notice`	`{Boolean}`	`true`	是否弹框提醒版本更新，与 autoReload 互斥
`noticeText`	`{String}`	`有新版本发布，请刷新页面进行更新。`	弹框提醒文本
`showUpdateButton`	`{Boolean}`	`true`	是否显示弹框更新按钮
`updateButtonText`	`{String}`	`刷新`	弹框更新按钮文本
`callback`	`{Function}`	`-`	自定义版本对比结果处理函数，响应参数(当前版本, 服务端版本，服务端返回信息)

注：版本比对不同后会自动在 localStorage 设置缓存信息 _app_version_info_： { version: '当前版本', newVersion: '服务器返回新版本' }

Usage

webpack.config.js

const VersionComparePlugin = require('@dtgov/version-compare-plugin');

{
  plugins: [
    new VersionComparePlugin({
      enable: true,
      filename: 'version.json',
      // ...
    })
  ]
}

Keywords

version compare webpack plugin