vite-plugin-deploy-oss 3.1.0 → 3.2.0

package/README.md

@@ -39,6 +39,9 @@ export default {
       // 默认 true：有上传失败时抛错并让构建失败
       failOnError: true,
 
+      // 生成并上传 OSS 汇总文件
+      manifest: true,
+
       // 修改打包后的资源路径
       configBase: `https://oss.eventnet.cn/H5/zz/test/`,
     }),
@@ -52,3 +55,20 @@ export default {
 - `open` 默认 `true`，建议通过环境变量控制开关（例如 `DEPLOY_OSS=1` 时再上传）。
 - `fancy` 默认 `true`，TTY 终端下会显示实时动效进度（速度、预计剩余、并发、当前文件）。
 - `failOnError` 默认 `true`，上传有失败会抛错，适合 CI 场景保证发布质量。
+- `manifest` 默认关闭。开启后会在构建目录生成并上传 `oss-manifest.json`。
+- `manifest: true` 时默认文件名为 `oss-manifest.json`，也支持 `manifest: { fileName: 'meta/oss-manifest.json' }` 自定义路径。
+- `oss-manifest.json` 仅包含本次成功上传的文件，不包含汇总文件自身。
+- `oss-manifest.json` 内容示例：
+
+```json
+{
+  "version": 1742467200000,
+  "files": [
+    {
+      "file": "assets/index-abc123.js",
+      "key": "H5/zz/test/assets/index-abc123.js",
+      "url": "https://oss.eventnet.cn/H5/zz/test/assets/index-abc123.js"
+    }
+  ]
+}
+```

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import oss from 'ali-oss';
 import { Plugin } from 'vite';
 
+interface ManifestOption {
+    fileName?: string;
+}
 interface vitePluginDeployOssOption extends Omit<oss.Options, 'accessKeyId' | 'accessKeySecret' | 'bucket' | 'region'> {
     configBase?: string;
     accessKeyId: string;
@@ -20,6 +23,7 @@ interface vitePluginDeployOssOption extends Omit<oss.Options, 'accessKeyId' | 'a
     concurrency?: number;
     retryTimes?: number;
     multipartThreshold?: number;
+    manifest?: boolean | ManifestOption;
 }
 declare function vitePluginDeployOss(option: vitePluginDeployOssOption): Plugin;
 

package/dist/index.js

@@ -2,11 +2,12 @@
 import oss from "ali-oss";
 import chalk from "chalk";
 import { globSync } from "glob";
-import { readdir, rm, stat, unlink } from "fs/promises";
-import { resolve } from "path";
+import { mkdir, readdir, rm, stat, unlink, writeFile } from "fs/promises";
+import { dirname, resolve } from "path";
 import ora from "ora";
 import { normalizePath } from "vite";
 var GARBAGE_FILE_REGEX = /(?:Thumbs\.db|\.DS_Store)$/i;
+var DEFAULT_MANIFEST_FILE_NAME = "oss-manifest.json";
 var removeEmptyDirectories = async (rootDir) => {
   const deletedDirectories = [];
   const visit = async (dirPath) => {
@@ -32,6 +33,45 @@ var removeEmptyDirectories = async (rootDir) => {
   return deletedDirectories;
 };
 var normalizeObjectKey = (targetDir, relativeFilePath) => normalizePath(`${targetDir}/${relativeFilePath}`).replace(/\/{2,}/g, "/").replace(/^\/+/, "");
+var normalizeManifestFileName = (fileName) => {
+  const normalized = normalizePath(fileName || DEFAULT_MANIFEST_FILE_NAME).replace(/^\/+/, "").replace(/\/{2,}/g, "/");
+  return normalized || DEFAULT_MANIFEST_FILE_NAME;
+};
+var resolveManifestFileName = (manifest) => {
+  if (!manifest) return null;
+  if (manifest === true) return DEFAULT_MANIFEST_FILE_NAME;
+  return normalizeManifestFileName(manifest.fileName);
+};
+var normalizeUrlBase = (base) => {
+  const normalized = base.replace(/\\/g, "/");
+  const protocolSeparatorIndex = normalized.indexOf("://");
+  if (protocolSeparatorIndex >= 0) {
+    const pathIndex = normalized.indexOf("/", protocolSeparatorIndex + 3);
+    if (pathIndex < 0) return normalized;
+    return `${normalized.slice(0, pathIndex)}${normalized.slice(pathIndex).replace(/\/{2,}/g, "/")}`;
+  }
+  if (normalized.startsWith("//")) {
+    const pathIndex = normalized.indexOf("/", 2);
+    if (pathIndex < 0) return normalized;
+    return `${normalized.slice(0, pathIndex)}${normalized.slice(pathIndex).replace(/\/{2,}/g, "/")}`;
+  }
+  return normalized.replace(/\/{2,}/g, "/");
+};
+var encodeUrlPath = (path) => encodeURI(path.replace(/^\/+/, ""));
+var joinUrlPath = (base, path) => `${normalizeUrlBase(base).replace(/\/+$/, "")}/${encodeUrlPath(path)}`;
+var resolveUploadedFileUrl = (relativeFilePath, objectKey, configBase, alias) => {
+  if (configBase) return joinUrlPath(configBase, relativeFilePath);
+  if (alias) return joinUrlPath(alias, objectKey);
+  return objectKey;
+};
+var createManifestPayload = (results, configBase, alias) => ({
+  version: Date.now(),
+  files: results.filter((result) => result.success).map((result) => ({
+    file: result.relativeFilePath,
+    key: result.name,
+    url: resolveUploadedFileUrl(result.relativeFilePath, result.name, configBase, alias)
+  }))
+});
 var formatBytes = (bytes) => {
   if (!Number.isFinite(bytes) || bytes <= 0) return "0 B";
   const units = ["B", "KB", "MB", "GB", "TB"];
@@ -91,6 +131,7 @@ function vitePluginDeployOss(option) {
     concurrency = 5,
     retryTimes = 3,
     multipartThreshold = 10 * 1024 * 1024,
+    manifest = false,
     ...props
   } = option || {};
   let buildFailed = false;
@@ -115,12 +156,13 @@ function vitePluginDeployOss(option) {
       errors.push("multipartThreshold must be > 0");
     return errors;
   };
+  const uploadSingleTask = async (client, task) => uploadFileWithRetry(client, task, false);
   const uploadFileWithRetry = async (client, task, silentLogs, maxRetries = retryTimes) => {
     const shouldUseMultipart = task.size >= multipartThreshold;
     const headers = {
       "x-oss-storage-class": "Standard",
       "x-oss-object-acl": "default",
-      "Cache-Control": noCache ? "no-cache" : "public, max-age=86400, immutable",
+      "Cache-Control": task.cacheControl || (noCache ? "no-cache" : "public, max-age=86400, immutable"),
       "x-oss-forbid-overwrite": overwrite ? "false" : "true"
     };
     for (let attempt = 1; attempt <= maxRetries; attempt++) {
@@ -142,7 +184,14 @@ function vitePluginDeployOss(option) {
               console.warn(`${chalk.yellow("\u26A0")} \u5220\u9664\u672C\u5730\u6587\u4EF6\u5931\u8D25: ${task.filePath}`);
             }
           }
-          return { success: true, file: task.filePath, name: task.name, size: task.size, retries: attempt - 1 };
+          return {
+            success: true,
+            file: task.filePath,
+            relativeFilePath: task.relativeFilePath,
+            name: task.name,
+            size: task.size,
+            retries: attempt - 1
+          };
         } else {
           throw new Error(`Upload failed with status: ${result.res.status}`);
         }
@@ -156,6 +205,7 @@ function vitePluginDeployOss(option) {
           return {
             success: false,
             file: task.filePath,
+            relativeFilePath: task.relativeFilePath,
             name: task.name,
             size: task.size,
             retries: attempt - 1,
@@ -172,6 +222,7 @@ function vitePluginDeployOss(option) {
     return {
       success: false,
       file: task.filePath,
+      relativeFilePath: task.relativeFilePath,
       name: task.name,
       size: task.size,
       retries: maxRetries,
@@ -192,9 +243,9 @@ function vitePluginDeployOss(option) {
         const name = normalizeObjectKey(uploadDir, relativeFilePath);
         try {
           const fileStats = await stat(filePath);
-          return { task: { filePath, name, size: fileStats.size } };
+          return { task: { filePath, relativeFilePath, name, size: fileStats.size } };
         } catch (error) {
-          return { task: null, error, filePath, name };
+          return { task: null, error, filePath, relativeFilePath, name };
         }
       })
     );
@@ -207,6 +258,7 @@ function vitePluginDeployOss(option) {
         results.push({
           success: false,
           file: candidate.filePath,
+          relativeFilePath: candidate.relativeFilePath,
           name: candidate.name,
           size: 0,
           retries: 0,
@@ -321,11 +373,12 @@ ${validationErrors.map((err) => `  - ${err}`).join("\n")}`);
         if (!open || !upload || buildFailed || !resolvedConfig) return;
         const startTime = Date.now();
         const client = new oss({ region, accessKeyId, accessKeySecret, secure, bucket, ...props });
+        const manifestFileName = resolveManifestFileName(manifest);
         const files = globSync("**/*", {
           cwd: outDir,
           nodir: true,
           ignore: Array.isArray(skip) ? skip : [skip]
-        }).map((file) => normalizePath(file));
+        }).map((file) => normalizePath(file)).filter((file) => file !== manifestFileName);
         if (files.length === 0) {
           console.log(`${chalk.yellow("\u26A0 \u6CA1\u6709\u627E\u5230\u9700\u8981\u4E0A\u4F20\u7684\u6587\u4EF6")}`);
           return;
@@ -382,6 +435,39 @@ ${chalk.gray("\u7EDF\u8BA1:")}`);
             }
             console.log("");
           }
+          if (manifestFileName) {
+            const manifestRelativeFilePath = manifestFileName;
+            const manifestFilePath = normalizePath(resolve(outDir, manifestRelativeFilePath));
+            const manifestObjectKey = normalizeObjectKey(uploadDir, manifestRelativeFilePath);
+            await mkdir(dirname(manifestFilePath), { recursive: true });
+            await writeFile(
+              manifestFilePath,
+              JSON.stringify(createManifestPayload(results, configBase, alias), null, 2),
+              "utf8"
+            );
+            const manifestStats = await stat(manifestFilePath);
+            const manifestResult = await uploadSingleTask(client, {
+              filePath: manifestFilePath,
+              relativeFilePath: manifestRelativeFilePath,
+              name: manifestObjectKey,
+              size: manifestStats.size,
+              cacheControl: "no-cache"
+            });
+            if (!manifestResult.success) {
+              throw manifestResult.error || new Error(`Failed to upload manifest: ${manifestRelativeFilePath}`);
+            }
+            const manifestUrl = resolveUploadedFileUrl(
+              manifestRelativeFilePath,
+              manifestObjectKey,
+              configBase,
+              alias
+            );
+            console.log(chalk.cyan("Manifest:"));
+            console.log(` ${chalk.gray("File:")}   ${chalk.yellow(manifestFilePath)}`);
+            console.log(` ${chalk.gray("Target:")} ${chalk.yellow(manifestObjectKey)}`);
+            console.log(` ${chalk.gray("URL:")}    ${chalk.green(manifestUrl)}`);
+            console.log("");
+          }
           try {
             await removeEmptyDirectories(outDir);
           } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-deploy-oss",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",