{"id":51664623,"url":"https://github.com/tiyee/vite-plugin-oss-upload","last_synced_at":"2026-07-14T19:04:36.738Z","repository":{"id":367912397,"uuid":"1272348452","full_name":"tiyee/vite-plugin-oss-upload","owner":"tiyee","description":"A Vite plugin that uploads bundled assets to Aliyun OSS and rewrites asset CDN addresses in the source code.","archived":false,"fork":false,"pushed_at":"2026-06-28T08:03:39.000Z","size":89,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-28T09:15:53.460Z","etag":null,"topics":["aliyun-oss","vite","vite-plugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/vite-plugin-oss-upload","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiyee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-17T14:21:11.000Z","updated_at":"2026-06-28T08:03:43.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/tiyee/vite-plugin-oss-upload","commit_stats":null,"previous_names":["tiyee/vite-plugin-oss-upload"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tiyee/vite-plugin-oss-upload","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiyee%2Fvite-plugin-oss-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiyee%2Fvite-plugin-oss-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiyee%2Fvite-plugin-oss-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiyee%2Fvite-plugin-oss-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiyee","download_url":"https://codeload.github.com/tiyee/vite-plugin-oss-upload/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiyee%2Fvite-plugin-oss-upload/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35474822,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-14T02:00:06.603Z","response_time":114,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aliyun-oss","vite","vite-plugin"],"created_at":"2026-07-14T19:04:35.633Z","updated_at":"2026-07-14T19:04:36.732Z","avatar_url":"https://github.com/tiyee.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vite-plugin-oss-upload\n\n一个可以将打包好的资源文件上传到阿里云 OSS，并把代码中资源引用替换为 CDN 地址的 Vite 插件。支持自定义参数处理\n\n## 特性\n\n- 🚀 打包完成后自动上传资源文件到阿里云 OSS\n- 🔁 自动重写构建产物中的资源引用为 CDN 地址\n- ✏️ 支持通过 `rewriteQueryString` 自定义（新增 / 改写 / 去除）资源引用的 querystring\n- ⚡ 并发上传（可配置），支持大文件批量场景\n- 🧪 支持 `test` 模式预演，不真正上传\n- 🗑️ 可选删除本地原文件与空目录\n- 🔐 支持从环境变量读取凭据，避免硬编码\n\n## 安装\n\n```bash\nnpm i vite-plugin-oss-upload -D\n# 或\npnpm add vite-plugin-oss-upload -D\n```\n\n\u003e 要求 Node.js \u003e= 18。\n\n## 配置参数\n\n### 必填\n\n| 参数 | 说明 |\n| --- | --- |\n| `accessKeyId` | 阿里云授权 accessKeyId |\n| `accessKeySecret` | 阿里云授权 accessKeySecret |\n| `bucket` | 上传到哪个 bucket |\n| `region` / `endpoint` | 二者至少配置其一。`region` 为区域如 `oss-cn-hangzhou`；`endpoint` 为完整访问域名（含内网域名，如 `oss-cn-hangzhou-internal.aliyuncs.com`），传入后优先于 `region` 生效 |\n\n### 可选\n\n| 参数 | 说明 | 默认值 |\n| --- | --- | --- |\n| `cdnHost` | 上传后用于替换的资源文件 CDN 域名，留空则跳过 CDN 重写 | `''` |\n| `from` | glob 字符串，指定要上传的文件 | `./dist/assets/**` |\n| `dist` | 上传到 OSS 的目录前缀 | `''`（根目录） |\n| `timeout` | OSS 单次请求超时（毫秒） | `30000` |\n| `overwrite` | 是否覆盖 OSS 同名文件 | `true` |\n| `verbose` | 是否打印上传日志 | `true` |\n| `test` | 测试模式：只打印不真正上传 | `false` |\n| `deleteOrigin` | 上传后是否删除本地原文件 | `false` |\n| `deleteEmptyDir` | 目录清空后是否删除空目录（需 `deleteOrigin: true`） | `false` |\n| `quitWpOnError` | 出错时是否中断打包 | `false` |\n| `version` | 版本号，配合 `setVersion` 使用 | `''` |\n| `setVersion` | 上传成功后的回调（一般用于上报版本号） | — |\n| `fileSuffix` | 需要上传的资源后缀 | `['jpg','jpeg','png','gif','svg','webp','ico','bmp','webm','avi','mp4','mp3','flv','mov']` |\n| `assetsDirectory` | 资源目录名，用于 CDN 路径替换 | `assets` |\n| `outputDirectory` | 打包输出目录 | `dist` |\n| `setOssPath` | 自定义 OSS 路径生成函数 | 以 `outputDirectory` 为基准的相对路径 |\n| `rewriteQueryString` | 改写资源引用的 querystring，签名 `(path, query) =\u003e string`。`path` 为 CDN 替换前的原始资源路径；`query` 入参与返回值**都包含 `?`**（如 `?v=1`），无查询串时为 `''`，返回 `''` 表示去掉查询串 | — |\n| `concurrency` | 并发上传数 | `5` |\n| `secure` | 是否使用 HTTPS（`true`）/ HTTP（`false`）。默认随 OSS 客户端自动判断 | — |\n\n### 内网自动探测\n\n当**未显式配置 `endpoint` 且未显式配置 `secure`** 时，插件会在 `configResolved` 阶段通过 TCP 端口探测判断当前是否处于阿里云内网环境（探测 `\u003cregion\u003e-internal.aliyuncs.com` 的 80 端口）：\n\n- **探测命中（内网）**：自动切换为内网 endpoint，并使用 HTTP（`secure: false`），提升上传速度、避免公网带宽。\n- **探测失败 / 超时**：视为非内网，沿用用户原有配置（region + 默认 HTTPS），**不会中断构建**。\n\n\u003e 该机制对 CI、无外网等环境安全：任何探测异常都静默回退，不抛错。\n\u003e 若需完全跳过自动探测，显式设置 `endpoint` 或 `secure` 即可。\n\n### 改写资源引用的 querystring\n\n`rewriteQueryString` 允许你在 CDN 路径替换时，自定义资源引用后面的 querystring（例如统一打版本号、缓存破坏标识等）。\n\n```ts\nrewriteQueryString?: (path: string, query: string) =\u003e string\n```\n\n- `path`：CDN 替换**前**的原始资源路径，如 `/assets/logo.png`，仅用于识别资源；\n- `query`：原 querystring，**包含前导 `?`**（如 `?v=1`）；若原引用没有查询串则为 `''`；\n- **返回值**：作为新的 querystring 拼接到 CDN 地址之后，同样**以 `?` 开头**（返回 `?v=2` 或 `v=2` 均可，插件会自动补齐 `?`）；返回 `''` 则**去掉**查询串。\n\n\u003e 不配置 `rewriteQueryString` 时，保持原 querystring 不变。\n\n示例：\n\n```javascript\nViteOSSPluginUpload({\n  cdnHost: 'https://cdn.xxx.com',\n  // ...其它配置\n  // 统一把所有资源引用的查询串替换为构建版本号\n  rewriteQueryString: (_path, _query) =\u003e `?v=${process.env.BUILD_VERSION}`,\n})\n```\n\n转换效果：\n\n| 原引用 | `rewriteQueryString` 返回值 | 替换后 |\n| --- | --- | --- |\n| `/assets/logo.png?v=1` | `?v=2` | `https://cdn.xxx.com/static/assets/logo.png?v=2` |\n| `/assets/logo.png` | `?cache=bust` | `https://cdn.xxx.com/static/assets/logo.png?cache=bust` |\n| `/assets/logo.png?v=1` | `''` | `https://cdn.xxx.com/static/assets/logo.png` |\n\n\u003e ⚠️ **安全提醒**：`accessKeyId` / `accessKeySecret` 非常敏感，请通过环境变量读取，切勿硬编码到提交到仓库的配置文件中。\n\n## 使用示例\n\n```javascript\n// vite.config.js\nimport { defineConfig } from 'vite'\nimport ViteOSSPluginUpload from 'vite-plugin-oss-upload'\n\nconst prod = process.env.NODE_ENV === 'production'\n\nexport default defineConfig({\n  plugins: [\n    prod \u0026\u0026\n      ViteOSSPluginUpload({\n        cdnHost: 'https://cdn.xxx.com',\n        from: './dist/assets/**', // 上传哪些文件\n        dist: '/static', // 上传到 OSS 的目录前缀\n        // 方式一：使用 region\n        region: process.env.OSS_REGION,\n        // 方式二：使用自定义 endpoint（如内网域名），优先级高于 region\n        // endpoint: 'oss-cn-hangzhou-internal.aliyuncs.com',\n        // secure: false, // 内网时可关闭 HTTPS\n        accessKeyId: process.env.OSS_ACCESS_KEY_ID,\n        accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,\n        bucket: process.env.OSS_BUCKET,\n        overwrite: true,\n        quitWpOnError: true,\n        // 改写资源引用的 querystring：入参与返回值均以 `?` 开头\n        // 用于统一打版本号 / 缓存破坏标识，返回 `''` 可去掉查询串\n        rewriteQueryString: (_path, _query) =\u003e `?v=${process.env.BUILD_VERSION ?? '1'}`,\n      }),\n  ].filter(Boolean),\n})\n```\n\n对应 `.env`（请加入 `.gitignore`）：\n\n```bash\nOSS_REGION=oss-cn-hangzhou\nOSS_ACCESS_KEY_ID=xxxxxxxx\nOSS_ACCESS_KEY_SECRET=xxxxxxxx\nOSS_BUCKET=my-bucket\n```\n\n## 开发\n\n```bash\npnpm install\npnpm build       # 构建产物（dist）\npnpm test        # 运行单元测试\npnpm test:watch  # 监听模式\npnpm lint        # 代码检查\npnpm typecheck   # 类型检查\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiyee%2Fvite-plugin-oss-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiyee%2Fvite-plugin-oss-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiyee%2Fvite-plugin-oss-upload/lists"}