nuxt-gin-tools 0.1.16 → 0.1.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-gin-tools",
-  "version": "0.1.16",
+  "version": "0.1.17",
   "description": "This project is used as a dependency for [nuxt-gin-starter](https://github.com/RapboyGao/nuxt-gin-starter.git)",
   "bin": {
     "nuxt-gin": "index.js"
@@ -16,6 +16,7 @@
     "7zip-min": "^2.1.0",
     "chalk": "^5.4.1",
     "concurrently": "^9.2.0",
+    "fast-glob": "^3.3.3",
     "fs-extra": "^11.3.0"
   },
   "devDependencies": {
@@ -25,4 +26,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
   }
-}
+}

package/src/pack.d.ts

@@ -1,3 +1,55 @@
+export interface PackConfig {
+    /**
+     * 额外需要打包的文件映射
+     * key: 源文件路径（相对于项目根目录或绝对路径）
+     * value: 打包后对应位置（相对于服务器构建目录或绝对路径）
+     */
+    extraFiles?: Record<string, string>;
+    /**
+     * 额外需要打包的文件 Glob（相对于项目根目录）
+     */
+    extraFilesGlobs?: string[];
+    /**
+     * 排除文件/目录 Glob（相对于项目根目录）
+     */
+    exclude?: string[];
+    /**
+     * 打包输出 zip 名称（相对于默认 zip 目录）
+     */
+    zipName?: string;
+    /**
+     * 打包输出 zip 路径（相对于项目根目录或绝对路径）
+     */
+    zipPath?: string;
+    /**
+     * 服务器构建输出目录（相对于项目根目录或绝对路径）
+     */
+    serverPath?: string;
+    /**
+     * 打包前钩子
+     */
+    beforePack?: () => Promise<void> | void;
+    /**
+     * 打包后钩子
+     */
+    afterPack?: (zipPath: string) => Promise<void> | void;
+    /**
+     * 是否清理 dist
+     */
+    cleanDist?: boolean;
+    /**
+     * 是否写入启动脚本和 package.json
+     */
+    writeScripts?: boolean;
+    /**
+     * 写入/覆盖 package.json 内容
+     */
+    packageJson?: Record<string, unknown>;
+    /**
+     * 复制时是否覆盖同名文件
+     */
+    overwrite?: boolean;
+}
 /**
  * 生成相对于服务器构建目录的绝对路径
  * @param relativePath - 相对路径
@@ -7,6 +59,7 @@ export declare function builtPath(relativePath: string): string;
 export declare const ZIP_PATH: string;
 export declare const SERVER_PATH: string;
 export declare const ORIGINAL_DIST_PATH: string;
+export declare const PACK_CONFIG_PATH: string;
 export declare const SERVER_EXECUTABLE: string;
 export declare const PACKAGE_JSON_CONTENT: {
     private: boolean;
@@ -15,9 +68,7 @@ export declare const PACKAGE_JSON_CONTENT: {
     };
 };
 export declare const FILES_TO_COPY: {
-    "vue/.output": string;
-    ".build/.server/production.exe": string;
-    "server.config.json": string;
+    [k: string]: string;
 };
 /**
  * 构建并打包项目的主函数
@@ -27,5 +78,5 @@ export declare const FILES_TO_COPY: {
  * 4. 打包文件为 7z 格式
  * 5. 清理原始 dist 目录
  */
-export declare function buildAndPack(): Promise<void>;
+export declare function buildAndPack(config?: PackConfig): Promise<void>;
 export default buildAndPack;

package/src/pack.js

@@ -45,7 +45,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FILES_TO_COPY = exports.PACKAGE_JSON_CONTENT = exports.SERVER_EXECUTABLE = exports.ORIGINAL_DIST_PATH = exports.SERVER_PATH = exports.ZIP_PATH = void 0;
+exports.FILES_TO_COPY = exports.PACKAGE_JSON_CONTENT = exports.SERVER_EXECUTABLE = exports.PACK_CONFIG_PATH = exports.ORIGINAL_DIST_PATH = exports.SERVER_PATH = exports.ZIP_PATH = void 0;
 exports.builtPath = builtPath;
 exports.buildAndPack = buildAndPack;
 // 导入项目构建工具，用于执行 Nuxt 项目的构建流程
@@ -57,6 +57,7 @@ const FS = __importStar(require("fs-extra"));
 // 导入路径处理模块，用于规范化和解析文件路径
 const Path = __importStar(require("path"));
 const os = __importStar(require("os"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
 /**
  * 生成相对于服务器构建目录的绝对路径
  * @param relativePath - 相对路径
@@ -71,6 +72,7 @@ exports.ZIP_PATH = Path.resolve(process.cwd(), ".build/production/server.7z");
 exports.SERVER_PATH = Path.resolve(process.cwd(), ".build/production/server");
 // 定义原始 dist 目录路径，用于清理操作
 exports.ORIGINAL_DIST_PATH = Path.resolve(process.cwd(), "dist");
+exports.PACK_CONFIG_PATH = Path.resolve(process.cwd(), "pack.config.json");
 exports.SERVER_EXECUTABLE = os.platform() === "win32" ? "server-production.exe" : "server-production"; // 根据操作系统选择可执行文件名
 // 定义打包后项目的 package.json 内容
 exports.PACKAGE_JSON_CONTENT = {
@@ -79,54 +81,119 @@ exports.PACKAGE_JSON_CONTENT = {
         start: "./server-production.exe", // 定义启动命令
     },
 };
-// 定义需要复制到构建目录的文件映射关系
-exports.FILES_TO_COPY = {
-    "vue/.output": builtPath("vue/.output"), // Vue 应用构建输出
-    [`.build/.server/production.exe`]: builtPath("server-production.exe"), // 生产环境可执行文件
-    "server.config.json": builtPath("server.config.json"), // 服务器配置文件
+// 定义需要复制到构建目录的文件映射关系（目标为构建目录下的相对路径）
+const DEFAULT_FILES_TO_COPY = {
+    "vue/.output": "vue/.output", // Vue 应用构建输出
+    [`.build/.server/production.exe`]: "server-production.exe", // 生产环境可执行文件
+    "server.config.json": "server.config.json", // 服务器配置文件
 };
+// 兼容旧导出：默认构建目录下的绝对目标路径
+exports.FILES_TO_COPY = Object.fromEntries(Object.entries(DEFAULT_FILES_TO_COPY).map(([src, dest]) => [src, builtPath(dest)]));
 /**
  * 写入启动脚本和 package.json 文件到构建目录
  */
-function writeScriptFiles() {
+function writeScriptFiles(serverPath, config) {
     // 写入 Windows 批处理启动脚本
-    FS.outputFileSync(builtPath("start.bat"), `powershell -ExecutionPolicy ByPass -File ./start.ps1`);
+    FS.outputFileSync(Path.resolve(serverPath, "start.bat"), `powershell -ExecutionPolicy ByPass -File ./start.ps1`);
     // 写入 PowerShell 启动脚本
-    FS.outputFileSync(builtPath("start.ps1"), `./server-production.exe`);
+    FS.outputFileSync(Path.resolve(serverPath, "start.ps1"), `./server-production.exe`);
     // 写入 Linux/macOS 启动脚本
-    FS.outputFileSync(builtPath("start.sh"), `./server-production.exe`);
+    FS.outputFileSync(Path.resolve(serverPath, "start.sh"), `./server-production.exe`);
     // 写入 package.json 文件，使用 2 个空格缩进
-    FS.outputJSONSync(builtPath("package.json"), exports.PACKAGE_JSON_CONTENT, { spaces: 2 });
+    const mergedPackageJson = mergePackageJson(exports.PACKAGE_JSON_CONTENT, config === null || config === void 0 ? void 0 : config.packageJson);
+    FS.outputJSONSync(Path.resolve(serverPath, "package.json"), mergedPackageJson, { spaces: 2 });
 }
 /**
  * 将配置的源文件复制到构建目录
  */
-function copyGeneratedFiles() {
+function copyGeneratedFiles(serverPath, config) {
+    var _a;
+    const copyOptions = {
+        overwrite: (config === null || config === void 0 ? void 0 : config.overwrite) !== false,
+        errorOnExist: (config === null || config === void 0 ? void 0 : config.overwrite) === false,
+    };
     // 遍历文件映射，将每个源文件复制到目标位置
-    for (const [src, dest] of Object.entries(exports.FILES_TO_COPY)) {
-        FS.copySync(Path.resolve(process.cwd(), src), dest);
+    for (const [src, dest] of Object.entries(DEFAULT_FILES_TO_COPY)) {
+        const resolvedDest = Path.resolve(serverPath, dest);
+        FS.copySync(Path.resolve(process.cwd(), src), resolvedDest, copyOptions);
+    }
+    if (config === null || config === void 0 ? void 0 : config.extraFiles) {
+        for (const [src, dest] of Object.entries(config.extraFiles)) {
+            const resolvedSrc = Path.resolve(process.cwd(), src);
+            const resolvedDest = Path.isAbsolute(dest) ? dest : Path.resolve(serverPath, dest);
+            FS.copySync(resolvedSrc, resolvedDest, copyOptions);
+        }
+    }
+    if ((_a = config === null || config === void 0 ? void 0 : config.extraFilesGlobs) === null || _a === void 0 ? void 0 : _a.length) {
+        const matchedFiles = fast_glob_1.default.sync(config.extraFilesGlobs, {
+            cwd: process.cwd(),
+            onlyFiles: true,
+            dot: true,
+            ignore: config.exclude,
+        });
+        for (const file of matchedFiles) {
+            const resolvedSrc = Path.resolve(process.cwd(), file);
+            const resolvedDest = Path.resolve(serverPath, file);
+            FS.copySync(resolvedSrc, resolvedDest, copyOptions);
+        }
+    }
+}
+function mergePackageJson(base, override) {
+    if (!override) {
+        return base;
+    }
+    const baseScripts = typeof base.scripts === "object" && base.scripts ? base.scripts : {};
+    const overrideScripts = typeof override.scripts === "object" && override.scripts ? override.scripts : {};
+    return Object.assign(Object.assign(Object.assign({}, base), override), { scripts: Object.assign(Object.assign({}, baseScripts), overrideScripts) });
+}
+function readPackConfigFromCwd() {
+    if (!FS.existsSync(exports.PACK_CONFIG_PATH)) {
+        return undefined;
+    }
+    return FS.readJSONSync(exports.PACK_CONFIG_PATH);
+}
+function resolveServerPath(config) {
+    if (!(config === null || config === void 0 ? void 0 : config.serverPath)) {
+        return exports.SERVER_PATH;
     }
+    return Path.isAbsolute(config.serverPath)
+        ? config.serverPath
+        : Path.resolve(process.cwd(), config.serverPath);
+}
+function resolveZipPath(config) {
+    if (config === null || config === void 0 ? void 0 : config.zipPath) {
+        return Path.isAbsolute(config.zipPath)
+            ? config.zipPath
+            : Path.resolve(process.cwd(), config.zipPath);
+    }
+    if (config === null || config === void 0 ? void 0 : config.zipName) {
+        return Path.resolve(Path.dirname(exports.ZIP_PATH), config.zipName);
+    }
+    return exports.ZIP_PATH;
 }
 /**
  * 打包文件为7z格式
  */
-function makeZip() {
+function makeZip(serverPath, zipPath) {
     return new Promise((resolve, reject) => {
         // 使用 7zip 将服务器构建目录打包为 7z 文件
-        Zip.pack(exports.SERVER_PATH, exports.ZIP_PATH, (error) => {
+        Zip.pack(serverPath, zipPath, (error) => {
             if (error) {
                 console.error("打包失败:", error);
                 reject(error);
             }
-            console.log("打包成功:", exports.ZIP_PATH);
-            resolve(exports.ZIP_PATH);
+            console.log("打包成功:", zipPath);
+            resolve(zipPath);
         });
     });
 }
 /**
  * 清理原始 dist 目录
  */
-function cleanUp() {
+function cleanUp(config) {
+    if ((config === null || config === void 0 ? void 0 : config.cleanDist) === false) {
+        return;
+    }
     // 检查原始 dist 目录是否存在，存在则删除
     if (FS.existsSync(exports.ORIGINAL_DIST_PATH)) {
         FS.removeSync(exports.ORIGINAL_DIST_PATH);
@@ -140,13 +207,24 @@ function cleanUp() {
  * 4. 打包文件为 7z 格式
  * 5. 清理原始 dist 目录
  */
-function buildAndPack() {
+function buildAndPack(config) {
     return __awaiter(this, void 0, void 0, function* () {
+        const resolvedConfig = config !== null && config !== void 0 ? config : readPackConfigFromCwd();
+        const serverPath = resolveServerPath(resolvedConfig);
+        const zipPath = resolveZipPath(resolvedConfig);
         yield (0, builder_1.default)(); // 执行项目构建
-        copyGeneratedFiles(); // 复制相关文件
-        writeScriptFiles(); // 写入脚本文件
-        yield makeZip(); // 打包文件
-        cleanUp(); // 清理临时文件
+        if (resolvedConfig === null || resolvedConfig === void 0 ? void 0 : resolvedConfig.beforePack) {
+            yield resolvedConfig.beforePack();
+        }
+        copyGeneratedFiles(serverPath, resolvedConfig); // 复制相关文件
+        if ((resolvedConfig === null || resolvedConfig === void 0 ? void 0 : resolvedConfig.writeScripts) !== false) {
+            writeScriptFiles(serverPath, resolvedConfig); // 写入脚本文件
+        }
+        yield makeZip(serverPath, zipPath); // 打包文件
+        if (resolvedConfig === null || resolvedConfig === void 0 ? void 0 : resolvedConfig.afterPack) {
+            yield resolvedConfig.afterPack(zipPath);
+        }
+        cleanUp(resolvedConfig); // 清理临时文件
     });
 }
 exports.default = buildAndPack;

package/src/postinstall.js

@@ -9,7 +9,7 @@ function postInstall() {
     // 执行并发命令
     return (0, concurrently_1.default)([
         {
-            command: "go mod download && go mod tidy",
+            command: "go mod download && go mod tidy && go install github.com/cosmtrek/air@latest",
             name: "go",
             prefixColor: "green",
         },

package/dev.d.ts

@@ -1 +0,0 @@
-export {};

package/dev.go

@@ -1,32 +0,0 @@
-package main
-
-import (
-	"log"
-	"os"
-	"os/exec"
-	"runtime"
-)
-
-func main() {
-	// 构建命令
-	cmd := exec.Command("~/go/bin/air", "-c", "node_modules/nuxt-gin-tools/.air.toml")
-
-	// 如果是windows，运行air
-	if runtime.GOOS == "windows" {
-		cmd = exec.Command("air", "-c", "node_modules/nuxt-gin-tools/.air.toml")
-	}
-
-	// 设置标准输出和错误输出
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-
-	// 启动命令
-	if err := cmd.Start(); err != nil {
-		log.Fatalf("Failed to start air: %v", err)
-	}
-
-	// 等待命令完成
-	if err := cmd.Wait(); err != nil {
-		log.Fatalf("Air command finished with error: %v", err)
-	}
-}

package/dev.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const concurrently_1 = __importDefault(require("concurrently"));
-const fs_extra_1 = require("fs-extra");
-const path_1 = require("path");
-const cwd = process.cwd();
-const serverConfig = (0, fs_extra_1.readJSONSync)((0, path_1.join)(cwd, "server.config.json"));
-(0, concurrently_1.default)([
-    {
-        command: `nuxt dev --port ${serverConfig.port}`,
-        name: "nuxt",
-        prefixColor: "yellow",
-    },
-]);

package/go.mod

@@ -1,3 +0,0 @@
-module nuxt-gin
-
-go 1.24.3