vite-plugin-multiversion 1.0.0

package/README.md

@@ -0,0 +1,135 @@
+# vite-plugin-multiversion
+
+通过打包进行多版本控制的 Vite 插件
+
+## 安装
+
+```bash
+npm install vite-plugin-multiversion
+```
+
+## 使用
+
+### 1. vite.config.ts 配置
+
+```ts
+import { defineConfig, loadEnv } from 'vite'
+import { resolve } from 'path'
+import { versionLink, cleanOldVersions } from 'vite-plugin-multiversion'
+
+export default defineConfig(({ mode }) => {
+  const env = loadEnv(mode, resolve(process.cwd()))
+  const NowVersion = Date.now()
+  const outDir = mode === 'prod' ? 'dist-prod' : 'dist'
+
+  const appUrlPath = () => {
+    const base = env.VITE_APP_URL_PATH
+    if (mode === 'dev') return base
+    return base + NowVersion + '/'
+  }
+
+  return {
+    base: appUrlPath(),
+    build: {
+      outDir: outDir + `/${NowVersion}`,
+    },
+    plugins: [
+      // 其他插件
+    ].concat(env.VITE_APP_ENV === 'dev' ? [] : [
+      cleanOldVersions({
+        outDir,
+        now: NowVersion,
+        days: 1,
+      }),
+      versionLink({
+        versionDir: String(NowVersion),
+        outDir,
+      }),
+    ]),
+  }
+})
+```
+
+### 2. 环境变量
+
+`.env` 文件:
+```
+VITE_APP_URL_PATH=/
+VITE_APP_ENV=prod
+```
+
+`.env.admin` 文件:
+```
+VITE_APP_URL_PATH=/admin-web/
+VITE_APP_ENV=prod
+```
+
+## 插件说明
+
+### versionLink
+
+将版本目录下的 `index.html` 复制到 dist 根目录。
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| versionDir | string | - | 版本目录名（如时间戳） |
+| outDir | string | 'dist-prod' | 输出目录 |
+
+### cleanOldVersions
+
+删除超过指定天数的旧版本目录。
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| outDir | string | 'dist-prod' | 输出目录 |
+| days | number | 2 | 保留天数 |
+| now | number | Date.now() | 当前时间戳（用于测试） |
+| minVersions | number | 1 | 最少保留版本数 |
+
+## 目录结构
+
+打包后的目录结构:
+```
+dist-prod/
+├── index.html          # 当前版本入口
+├── 1709200000000/      # 版本1
+│   ├── index.html
+│   ├── assets/
+│   └── ...
+├── 1709300000000/      # 版本2
+│   ├── index.html
+│   ├── assets/
+│   └── ...
+└── 1709400000000/      # 当前版本
+    ├── index.html
+    ├── assets/
+    └── ...
+```
+
+## Nginx 配置
+
+```conf
+# root写法
+# VITE_APP_URL_PATH = '/'
+server {
+  listen 8084;
+  server_name localhost;
+  location / {
+    root 项目路径/dist-prod;
+    try_files $uri $uri/ /index.html;
+    index index.html;
+  }
+}
+
+# alias写法
+# VITE_APP_URL_PATH = '/admin-web/'
+server {
+  listen 8077;
+  server_name localhost;
+  location /admin-web {
+    alias 项目路径/dist-prod/;
+    try_files $uri $uri/ /admin-web/index.html;
+    index index.html;
+  }
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,17 @@
+import { Plugin } from 'vite';
+
+interface VersionLinkOptions {
+    versionDir: string;
+    outDir?: string;
+}
+declare function versionLink(options: VersionLinkOptions): Plugin;
+
+interface CleanOldVersionsOptions {
+    outDir?: string;
+    days?: number;
+    now?: number;
+    minVersions?: number;
+}
+declare function cleanOldVersions(options: CleanOldVersionsOptions): Plugin;
+
+export { type CleanOldVersionsOptions, type VersionLinkOptions, cleanOldVersions, versionLink };

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { Plugin } from 'vite';
+
+interface VersionLinkOptions {
+    versionDir: string;
+    outDir?: string;
+}
+declare function versionLink(options: VersionLinkOptions): Plugin;
+
+interface CleanOldVersionsOptions {
+    outDir?: string;
+    days?: number;
+    now?: number;
+    minVersions?: number;
+}
+declare function cleanOldVersions(options: CleanOldVersionsOptions): Plugin;
+
+export { type CleanOldVersionsOptions, type VersionLinkOptions, cleanOldVersions, versionLink };

package/dist/index.js

@@ -0,0 +1,126 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  cleanOldVersions: () => cleanOldVersions,
+  versionLink: () => versionLink
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/versionLink.ts
+var import_node_fs = __toESM(require("fs"));
+var import_node_path = __toESM(require("path"));
+function versionLink(options) {
+  const { versionDir, outDir = "dist-prod" } = options;
+  if (!versionDir) {
+    throw new Error("[version-link] versionDir is required");
+  }
+  return {
+    name: "version-link",
+    apply: "build",
+    closeBundle() {
+      try {
+        const outDirPath = import_node_path.default.resolve(process.cwd(), outDir);
+        const versionPath = import_node_path.default.join(outDirPath, versionDir, "index.html");
+        const copyPath = import_node_path.default.join(outDirPath, "index.html");
+        if (!import_node_fs.default.existsSync(versionPath)) {
+          console.error(`[version-link] \u6587\u4EF6\u4E0D\u5B58\u5728: ${versionPath}`);
+          return;
+        }
+        import_node_fs.default.copyFileSync(versionPath, copyPath);
+        console.log(`[version-link] \u2705 \u590D\u5236\u6210\u529F: ${versionDir}/index.html -> index.html`);
+      } catch (err) {
+        console.error("[version-link] \u64CD\u4F5C\u5931\u8D25:", err.message);
+      }
+    }
+  };
+}
+
+// src/cleanOldVersions.ts
+var import_node_fs2 = __toESM(require("fs"));
+var import_node_path2 = __toESM(require("path"));
+function cleanOldVersions(options) {
+  const { outDir = "dist-prod", days = 2, now, minVersions = 1 } = options;
+  return {
+    name: "clean-old-versions",
+    apply: "build",
+    closeBundle() {
+      if (process.env.NODE_ENV !== "production") {
+        return;
+      }
+      try {
+        const outDirPath = import_node_path2.default.resolve(process.cwd(), outDir);
+        if (!import_node_fs2.default.existsSync(outDirPath)) {
+          console.error(`[clean-old-versions] \u76EE\u5F55\u4E0D\u5B58\u5728: ${outDirPath}`);
+          return;
+        }
+        const currentTime = now || Date.now();
+        const msPerDay = 24 * 60 * 60 * 1e3;
+        const threshold = currentTime - days * msPerDay;
+        const entries = import_node_fs2.default.readdirSync(outDirPath, { withFileTypes: true });
+        const oldVersions = [];
+        for (const entry of entries) {
+          if (!entry.isDirectory()) continue;
+          if (entry.name === "index.html") continue;
+          const timestamp = Number(entry.name);
+          if (isNaN(timestamp)) continue;
+          if (timestamp < threshold) {
+            oldVersions.push({
+              dirPath: import_node_path2.default.join(outDirPath, entry.name),
+              timestamp,
+              entryName: entry.name
+            });
+          }
+        }
+        let deletedCount = 0;
+        const maxDeletable = oldVersions.length - minVersions;
+        oldVersions.forEach((item) => {
+          const { dirPath, timestamp, entryName } = item;
+          if (deletedCount >= maxDeletable) {
+            console.log(`[clean-old-versions] \u89E6\u53D1\u6700\u5C11\u4FDD\u7559 ${minVersions} \u4E2A\u65E7\u5386\u53F2: ${entryName}`);
+            return;
+          }
+          import_node_fs2.default.rmSync(dirPath, { recursive: true, force: true });
+          console.log(`[clean-old-versions] \u5DF2\u5220\u9664: ${entryName}`);
+          deletedCount++;
+        });
+        console.log(`[clean-old-versions] \u2705 \u6E05\u7406\u5B8C\u6210\uFF0C\u5220\u9664 ${deletedCount} \u4E2A\u76EE\u5F55`);
+      } catch (err) {
+        console.error("[clean-old-versions] \u64CD\u4F5C\u5931\u8D25:", err.message);
+      }
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  cleanOldVersions,
+  versionLink
+});

package/dist/index.mjs

@@ -0,0 +1,88 @@
+// src/versionLink.ts
+import fs from "fs";
+import path from "path";
+function versionLink(options) {
+  const { versionDir, outDir = "dist-prod" } = options;
+  if (!versionDir) {
+    throw new Error("[version-link] versionDir is required");
+  }
+  return {
+    name: "version-link",
+    apply: "build",
+    closeBundle() {
+      try {
+        const outDirPath = path.resolve(process.cwd(), outDir);
+        const versionPath = path.join(outDirPath, versionDir, "index.html");
+        const copyPath = path.join(outDirPath, "index.html");
+        if (!fs.existsSync(versionPath)) {
+          console.error(`[version-link] \u6587\u4EF6\u4E0D\u5B58\u5728: ${versionPath}`);
+          return;
+        }
+        fs.copyFileSync(versionPath, copyPath);
+        console.log(`[version-link] \u2705 \u590D\u5236\u6210\u529F: ${versionDir}/index.html -> index.html`);
+      } catch (err) {
+        console.error("[version-link] \u64CD\u4F5C\u5931\u8D25:", err.message);
+      }
+    }
+  };
+}
+
+// src/cleanOldVersions.ts
+import fs2 from "fs";
+import path2 from "path";
+function cleanOldVersions(options) {
+  const { outDir = "dist-prod", days = 2, now, minVersions = 1 } = options;
+  return {
+    name: "clean-old-versions",
+    apply: "build",
+    closeBundle() {
+      if (process.env.NODE_ENV !== "production") {
+        return;
+      }
+      try {
+        const outDirPath = path2.resolve(process.cwd(), outDir);
+        if (!fs2.existsSync(outDirPath)) {
+          console.error(`[clean-old-versions] \u76EE\u5F55\u4E0D\u5B58\u5728: ${outDirPath}`);
+          return;
+        }
+        const currentTime = now || Date.now();
+        const msPerDay = 24 * 60 * 60 * 1e3;
+        const threshold = currentTime - days * msPerDay;
+        const entries = fs2.readdirSync(outDirPath, { withFileTypes: true });
+        const oldVersions = [];
+        for (const entry of entries) {
+          if (!entry.isDirectory()) continue;
+          if (entry.name === "index.html") continue;
+          const timestamp = Number(entry.name);
+          if (isNaN(timestamp)) continue;
+          if (timestamp < threshold) {
+            oldVersions.push({
+              dirPath: path2.join(outDirPath, entry.name),
+              timestamp,
+              entryName: entry.name
+            });
+          }
+        }
+        let deletedCount = 0;
+        const maxDeletable = oldVersions.length - minVersions;
+        oldVersions.forEach((item) => {
+          const { dirPath, timestamp, entryName } = item;
+          if (deletedCount >= maxDeletable) {
+            console.log(`[clean-old-versions] \u89E6\u53D1\u6700\u5C11\u4FDD\u7559 ${minVersions} \u4E2A\u65E7\u5386\u53F2: ${entryName}`);
+            return;
+          }
+          fs2.rmSync(dirPath, { recursive: true, force: true });
+          console.log(`[clean-old-versions] \u5DF2\u5220\u9664: ${entryName}`);
+          deletedCount++;
+        });
+        console.log(`[clean-old-versions] \u2705 \u6E05\u7406\u5B8C\u6210\uFF0C\u5220\u9664 ${deletedCount} \u4E2A\u76EE\u5F55`);
+      } catch (err) {
+        console.error("[clean-old-versions] \u64CD\u4F5C\u5931\u8D25:", err.message);
+      }
+    }
+  };
+}
+export {
+  cleanOldVersions,
+  versionLink
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "vite-plugin-multiversion",
+  "version": "1.0.0",
+  "description": "Vite plugin for multi-version control through building",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "vite",
+    "plugin",
+    "multi-version",
+    "version-control"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0"
+  },
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  }
+}

package/src/cleanOldVersions.ts

@@ -0,0 +1,77 @@
+import type { Plugin } from 'vite'
+import fs from 'node:fs'
+import path from 'node:path'
+
+export interface CleanOldVersionsOptions {
+  outDir?: string
+  days?: number
+  now?: number
+  minVersions?: number
+}
+
+export function cleanOldVersions(options: CleanOldVersionsOptions): Plugin {
+  const { outDir = 'dist-prod', days = 2, now, minVersions = 1 } = options
+
+  return {
+    name: 'clean-old-versions',
+    apply: 'build',
+    closeBundle() {
+      if (process.env.NODE_ENV !== 'production') {
+        return
+      }
+
+      try {
+        const outDirPath = path.resolve(process.cwd(), outDir)
+
+        if (!fs.existsSync(outDirPath)) {
+          console.error(`[clean-old-versions] 目录不存在: ${outDirPath}`)
+          return
+        }
+
+        const currentTime = now || Date.now()
+        const msPerDay = 24 * 60 * 60 * 1000
+        const threshold = currentTime - days * msPerDay
+
+        const entries = fs.readdirSync(outDirPath, { withFileTypes: true })
+
+        const oldVersions: { dirPath: string; timestamp: number; entryName: string }[] = []
+
+        for (const entry of entries) {
+          if (!entry.isDirectory()) continue
+          if (entry.name === 'index.html') continue
+
+          const timestamp = Number(entry.name)
+          if (isNaN(timestamp)) continue
+
+          if (timestamp < threshold) {
+            oldVersions.push({
+              dirPath: path.join(outDirPath, entry.name),
+              timestamp,
+              entryName: entry.name,
+            })
+          }
+        }
+
+        let deletedCount = 0
+        const maxDeletable = oldVersions.length - minVersions
+
+        oldVersions.forEach(item => {
+          const { dirPath, timestamp, entryName } = item
+
+          if (deletedCount >= maxDeletable) {
+            console.log(`[clean-old-versions] 触发最少保留 ${minVersions} 个旧历史: ${entryName}`)
+            return
+          }
+
+          fs.rmSync(dirPath, { recursive: true, force: true })
+          console.log(`[clean-old-versions] 已删除: ${entryName}`)
+          deletedCount++
+        })
+
+        console.log(`[clean-old-versions] ✅ 清理完成，删除 ${deletedCount} 个目录`)
+      } catch (err: any) {
+        console.error('[clean-old-versions] 操作失败:', err.message)
+      }
+    },
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { versionLink, type VersionLinkOptions } from './versionLink'
+export { cleanOldVersions, type CleanOldVersionsOptions } from './cleanOldVersions'

package/src/versionLink.ts

@@ -0,0 +1,38 @@
+import type { Plugin } from 'vite'
+import fs from 'node:fs'
+import path from 'node:path'
+
+export interface VersionLinkOptions {
+  versionDir: string
+  outDir?: string
+}
+
+export function versionLink(options: VersionLinkOptions): Plugin {
+  const { versionDir, outDir = 'dist-prod' } = options
+
+  if (!versionDir) {
+    throw new Error('[version-link] versionDir is required')
+  }
+
+  return {
+    name: 'version-link',
+    apply: 'build',
+    closeBundle() {
+      try {
+        const outDirPath = path.resolve(process.cwd(), outDir)
+        const versionPath = path.join(outDirPath, versionDir, 'index.html')
+        const copyPath = path.join(outDirPath, 'index.html')
+
+        if (!fs.existsSync(versionPath)) {
+          console.error(`[version-link] 文件不存在: ${versionPath}`)
+          return
+        }
+
+        fs.copyFileSync(versionPath, copyPath)
+        console.log(`[version-link] ✅ 复制成功: ${versionDir}/index.html -> index.html`)
+      } catch (err: any) {
+        console.error('[version-link] 操作失败:', err.message)
+      }
+    },
+  }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "types": ["node"],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}