Vite腾讯云OSS上传插件

331 阅读1分钟

前言

这是一个将项目打包后的生产文件上传到腾讯云OSSVite Plugin

仓库

GitHub:vite-plugin-tencent-oss
NPM:vite-plugin-tencent-oss

功能特性

  • 默认跳过已存在的文件(不会下载文件),加快上传速度
  • 几乎零配置,使用 vite outDir 路径,上传到 oss 的相同路径中

备注:除了所有 html 文件以外,上传所有文件。因为 html 文件没有哈希值,且通常放在服务器上

效果预览:

preview

安装

pnpm i -D vite-plugin-tencent-oss

或者

yarn add -D vite-plugin-tencent-oss

或者

npm i -D vite-plugin-tencent-oss

基本使用

  1. vite.config.js 中注册本插件
  2. 设置 base 开发或生产环境服务的公共基础 URL 路径
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vitePluginTencentOss from 'vite-plugin-tencent-oss'

const options = {
  region: '<Your Region>',
  secretId: '<Your Secret ID>',
  secretKey: '<Your Secret Key>',
  bucket: '<Your Bucket>'
}

// https://vitejs.dev/config/
export default defineConfig({
  base: 'https://foo.com/', // 必须是 URL
  plugins: [vue(), vitePluginTencentOss(options)]
})
  1. 打包发布生产代码
pnpm run build

插件将会在打包完成后,上传 vite 配置 outDir 路径下的所有资源文件。

配置项

optionsdescriptiontypedefault
region腾讯云 oss 地域string
secretId腾讯云 oss 访问 IDstring
secretKey腾讯云 oss 访问密钥string
bucket腾讯云 oss 存储空间名称string
overwrite如果文件已存在,是否覆盖booleanfalse
ignore文件忽略规则。如果你使用空字符串 '',将不会忽略任何文件boolean'**/*.html'
test仅测试路径,不会有文件上传booleanfalse
enabled是否启用本插件booleantrue
...其他初始化 oss 的参数,详细信息请见 cloud.tencent.com/document/pr…any

鸣谢

本项目基于vite-plugin-ali-oss二次开发。