# @dtgov/version-compare-plugin

> version compare webpack plugin

Latest version **0.0.4** (published 2022-11-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install @dtgov/version-compare-plugin
pnpm add @dtgov/version-compare-plugin
yarn add @dtgov/version-compare-plugin
bun add @dtgov/version-compare-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2022-11-18 |
| First published | 2022-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | isept, yancong_yc, niejianbo |
| Keywords | version, compare, webpack, plugin |

## Links

- npm: https://www.npmjs.com/package/@dtgov/version-compare-plugin
- npm.io page: https://npm.io/package/@dtgov/version-compare-plugin

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^9.0.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2022-11-18
- 0.0.3 — 2022-10-09
- 0.0.2 — 2022-09-23

## README

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

<h3>Install</h3>

```bash
  npm i --save-dev @dtgov/version-compare-plugin
```
<h3>Options</h3>

|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: '服务器返回新版本' }
<h3>Usage</h3>

**webpack.config.js**
```js
const VersionComparePlugin = require('@dtgov/version-compare-plugin');

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

<!-- <h3>Flow</h3>
<img width="600" src="https://portal.zjzwfw.gov.cn/assets/miniapp/images/flow.png"> -->

---
_Source: https://npm.io/package/@dtgov/version-compare-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._