vite-plugin-version-watcher

自动检测前端版本更新并提示用户刷新页面的 Vite 插件。

安装

pnpm add vite-plugin-version-watcher -D

使用

在 Vite 配置文件中添加插件：

import { defineConfig } from 'vite';
import versionWatcher from 'vite-plugin-version-watcher';

export default defineConfig({
  plugins: [versionWatcher()],
});

参数

export interface VersionWatcherOptions {
    /** 检测开关，默认 true */
    enabled?: boolean;
    /** 检测间隔（毫秒），默认 0 0不开启轮询 */
    checkInterval?: number;
    /** 自定义检测路径，默认当前域名根路径 */
    checkPath?: string;
    /** 静默模式，不输出日志 */
    silent?: boolean;
    /** 自定义更新提示函数 */
    onUpdateDetected?: () => void;
    /** 忽略的路径模式（正则表达式） */
    ignorePaths?: RegExp;
    /** 防抖时间（毫秒），默认 300 */
    debounceTime?: number;
    /** 本地存储键名，默认 'rocktntz__app_version' */
    storageKey?: string;
}