@okcy/vite
v1.3.4
Published
Readme
@okcy/vite
基于 Vite+ 的构建工具扩展包,提供 OSS 资源上传等能力。
安装
pnpm add @okcy/vite使用
import { defineConfig } from "vite";
import uploadAssetsOSS from "@okcy/vite/upload";
export default defineConfig({
plugins: [
uploadAssetsOSS({
// 云服务商: "oss" | "cos" | "s3" | "obs"
provider: "oss",
oss: {
accessKeyId: process.env.OSS_ACCESS_KEY_ID,
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
bucket: "my-bucket",
region: "oss-cn-hangzhou",
},
// 需要上传的资源后缀
include: ["png", "jpg", "jpeg", "gif", "svg", "mp4", "webm"],
// CDN 公网访问地址
publicPath: "https://your-cdn-domain.com/",
// 最小文件大小(字节),默认 0
minSize: 0,
// 最大并发上传数,默认 3
maxConcurrency: 3,
// 是否在开发模式下上传,默认 false
dev: false,
// 是否显示详细日志,默认 false
verbose: false,
// 是否启用本地缓存,默认 true
cache: true,
// 缓存文件路径,默认 ".oss-cache.json"
cacheFile: ".oss-cache.json",
}),
],
});配置选项
| 选项 | 类型 | 默认值 | 说明 |
| ---------------- | --------- | ------------------- | ----------------------------------- |
| provider | string | — | 云服务商: oss / cos / s3 / obs |
| oss / cos / s3 / obs | object | — | 对应云服务的认证与存储桶配置 |
| include | string[] | — | 需上传的资源后缀列表 |
| publicPath | string | — | CDN 公网访问地址前缀 |
| minSize | number | 0 | 最小文件大小(字节) |
| maxConcurrency | number | 3 | 最大并发上传数 |
| dev | boolean | false | 开发模式下是否上传 |
| verbose | boolean | false | 是否显示详细日志 |
| cache | boolean | true | 是否启用本地缓存去重 |
| cacheFile | string | ".oss-cache.json" | 缓存文件路径 |
导出
| 导出路径 | 说明 |
| ------------------- | --------------------------------------------------- |
| @okcy/vite | 主入口(待扩展) |
| @okcy/vite/upload | OSS 资源上传插件,基于 vite-upload-assets-oss |
开发
pnpm dev # 监听构建
pnpm build # 生产构建