Skip to content

auto-update-packages 使用说明

自动检测并更新项目依赖包的 Vite 插件。

使用建议

  • 交付项目:不建议使用此插件,自动更新可能导致依赖兼容性问题
  • 内部产品项目:可以使用,但仍推荐手动更新以确保稳定性

功能特性

  • 🔍 启动时自动检测依赖更新
  • 🔄 支持自动/手动更新模式
  • 🔕 可配置静默模式

插件使用方式

typescript
// vite.config.ts
import { defineConfig } from 'vite';
import { autoUpdatePackages } from '@pt/vite-plugins/auto-update';

export default defineConfig({
  plugins: [
    autoUpdatePackages({
      checkOnStart: true,   // 启动时检查更新
      autoUpdate: false,    // 是否自动更新(默认关闭)
      silent: false,        // 是否静默模式
    }),
  ],
});

配置选项

选项类型默认值说明
checkOnStartbooleantrue是否在 Vite 启动时检查依赖更新
autoUpdatebooleanfalse是否自动执行更新
silentbooleanfalse是否静默模式(不输出日志)

使用场景对比

场景是否推荐原因
内部产品开发✅ 可用快速迭代,便于保持依赖最新
交付项目❌ 不推荐自动更新可能破坏已验证的依赖版本
CI/CD 环境❌ 不推荐构建环境应使用锁定的依赖版本

最佳实践

  1. 开发环境:设置 autoUpdate: false,仅检查提示,手动决定是否更新
  2. 测试环境:可开启 autoUpdate: true,及时发现依赖兼容性问题
  3. 生产构建:建议在生产构建时禁用此插件

Released under the MIT License.