nuxt-gin-tools 0.2.23 → 0.3.1

package/src/services/go-dev-service.js

@@ -0,0 +1,356 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startGoDev = startGoDev;
+const child_process_1 = require("child_process");
+const chokidar_1 = __importDefault(require("chokidar"));
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const nuxt_gin_1 = require("../nuxt-gin");
+const ports_1 = require("../system/ports");
+const terminal_ui_1 = require("../cli/terminal-ui");
+const cwd = process.cwd();
+const RESTART_DEBOUNCE_MS = 150;
+const SHUTDOWN_TIMEOUT_MS = 2000;
+const LOG_TAG = "go-watch";
+const GO_WATCH_PREFIX = `[${LOG_TAG}]`;
+const DEFAULT_GO_WATCH_CONFIG = {
+    includeExt: ["go", "tpl", "html"],
+    includeDir: [],
+    includeFile: [],
+    excludeDir: [
+        "assets",
+        ".build/.server",
+        "vendor",
+        "testdata",
+        "node_modules",
+        "vue",
+        "api",
+        ".vscode",
+        ".git",
+    ],
+    excludeFile: [],
+    excludeRegex: ["_test.go"],
+    tmpDir: ".build/.server",
+    testDataDir: "testdata",
+};
+function toDefaultGoWatchOptions() {
+    return {
+        include: {
+            ext: [...DEFAULT_GO_WATCH_CONFIG.includeExt],
+            dir: [...DEFAULT_GO_WATCH_CONFIG.includeDir],
+            file: [...DEFAULT_GO_WATCH_CONFIG.includeFile],
+        },
+        exclude: {
+            dir: [...DEFAULT_GO_WATCH_CONFIG.excludeDir],
+            file: [...DEFAULT_GO_WATCH_CONFIG.excludeFile],
+            regex: [...DEFAULT_GO_WATCH_CONFIG.excludeRegex],
+        },
+        tmpDir: DEFAULT_GO_WATCH_CONFIG.tmpDir,
+        testDataDir: DEFAULT_GO_WATCH_CONFIG.testDataDir,
+    };
+}
+function normalizeConfiguredGoWatchOptions(config) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+    const include = config === null || config === void 0 ? void 0 : config.include;
+    const exclude = config === null || config === void 0 ? void 0 : config.exclude;
+    return {
+        includeExt: (_b = (_a = include === null || include === void 0 ? void 0 : include.ext) !== null && _a !== void 0 ? _a : config === null || config === void 0 ? void 0 : config.includeExt) !== null && _b !== void 0 ? _b : [],
+        includeDir: (_d = (_c = include === null || include === void 0 ? void 0 : include.dir) !== null && _c !== void 0 ? _c : config === null || config === void 0 ? void 0 : config.includeDir) !== null && _d !== void 0 ? _d : [],
+        includeFile: (_f = (_e = include === null || include === void 0 ? void 0 : include.file) !== null && _e !== void 0 ? _e : config === null || config === void 0 ? void 0 : config.includeFile) !== null && _f !== void 0 ? _f : [],
+        excludeDir: (_h = (_g = exclude === null || exclude === void 0 ? void 0 : exclude.dir) !== null && _g !== void 0 ? _g : config === null || config === void 0 ? void 0 : config.excludeDir) !== null && _h !== void 0 ? _h : [],
+        excludeFile: (_k = (_j = exclude === null || exclude === void 0 ? void 0 : exclude.file) !== null && _j !== void 0 ? _j : config === null || config === void 0 ? void 0 : config.excludeFile) !== null && _k !== void 0 ? _k : [],
+        excludeRegex: (_m = (_l = exclude === null || exclude === void 0 ? void 0 : exclude.regex) !== null && _l !== void 0 ? _l : config === null || config === void 0 ? void 0 : config.excludeRegex) !== null && _m !== void 0 ? _m : [],
+        tmpDir: (_o = config === null || config === void 0 ? void 0 : config.tmpDir) !== null && _o !== void 0 ? _o : DEFAULT_GO_WATCH_CONFIG.tmpDir,
+        testDataDir: (_p = config === null || config === void 0 ? void 0 : config.testDataDir) !== null && _p !== void 0 ? _p : DEFAULT_GO_WATCH_CONFIG.testDataDir,
+    };
+}
+function getGinPort() {
+    var _a;
+    const ginPort = (_a = (0, nuxt_gin_1.readLegacyServerConfig)()) === null || _a === void 0 ? void 0 : _a.ginPort;
+    if (Number.isInteger(ginPort) && ginPort > 0) {
+        return ginPort;
+    }
+    if (!(0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "server.config.json"))) {
+        (0, terminal_ui_1.printCommandWarn)("[config] server.config.json not found; Go watcher will start without port cleanup");
+    }
+    return null;
+}
+function killGinPortIfNeeded(ginPort) {
+    if (!ginPort) {
+        return;
+    }
+    (0, ports_1.killPort)(ginPort, { logPrefix: LOG_TAG, portLabel: "ginPort" });
+}
+function normalizePath(filePath) {
+    return filePath.replace(/\\/g, "/").replace(/^\.\//, "");
+}
+function toProjectRelative(filePath) {
+    const abs = (0, path_1.isAbsolute)(filePath) ? filePath : (0, path_1.resolve)(cwd, filePath);
+    return normalizePath((0, path_1.relative)(cwd, abs));
+}
+function toStringArray(value) {
+    if (!Array.isArray(value)) {
+        return [];
+    }
+    return value
+        .filter((item) => typeof item === "string")
+        .map((item) => item.trim())
+        .filter(Boolean);
+}
+function toStringValue(value) {
+    if (typeof value !== "string") {
+        return "";
+    }
+    return value.trim();
+}
+function loadWatchConfig() {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const projectConfig = (0, nuxt_gin_1.resolveNuxtGinProjectConfig)();
+    for (const warning of projectConfig.warnings) {
+        (0, terminal_ui_1.printCommandWarn)(`[config] ${warning}`);
+    }
+    const configuredDefaults = (0, nuxt_gin_1.mergeDefined)(toDefaultGoWatchOptions(), projectConfig.config.goWatch);
+    const normalizedDefaults = normalizeConfiguredGoWatchOptions(configuredDefaults);
+    const defaultConfig = {
+        includeExt: new Set(normalizedDefaults.includeExt),
+        includeDir: [...normalizedDefaults.includeDir],
+        includeFile: new Set(normalizedDefaults.includeFile),
+        excludeDir: [...normalizedDefaults.excludeDir],
+        excludeFile: new Set(normalizedDefaults.excludeFile),
+        excludeRegex: normalizedDefaults.excludeRegex.map((item) => new RegExp(item)),
+        tmpDir: normalizedDefaults.tmpDir,
+        testDataDir: normalizedDefaults.testDataDir,
+    };
+    const candidates = [
+        process.env.NUXT_GIN_WATCH_CONFIG,
+        (0, path_1.join)(cwd, ".go-watch.json"),
+    ].filter((item) => Boolean(item));
+    const configPath = candidates.find((item) => (0, fs_extra_1.existsSync)(item));
+    if (!configPath) {
+        return defaultConfig;
+    }
+    let parsedConfig = {};
+    try {
+        parsedConfig = JSON.parse((0, fs_extra_1.readFileSync)(configPath, "utf-8"));
+    }
+    catch (_j) {
+        (0, terminal_ui_1.printCommandWarn)(`${GO_WATCH_PREFIX} invalid watch config JSON, fallback to defaults: ${configPath}`);
+        return defaultConfig;
+    }
+    const includeExt = toStringArray((_a = parsedConfig.includeExt) !== null && _a !== void 0 ? _a : parsedConfig.include_ext)
+        .map((item) => item.replace(/^\./, ""))
+        .filter((item) => /^[a-zA-Z0-9]+$/.test(item));
+    const includeDir = toStringArray((_b = parsedConfig.includeDir) !== null && _b !== void 0 ? _b : parsedConfig.include_dir)
+        .map((item) => normalizePath(item))
+        .filter(Boolean);
+    const includeFile = toStringArray((_c = parsedConfig.includeFile) !== null && _c !== void 0 ? _c : parsedConfig.include_file)
+        .map((item) => normalizePath(item))
+        .filter(Boolean);
+    const excludeDir = toStringArray((_d = parsedConfig.excludeDir) !== null && _d !== void 0 ? _d : parsedConfig.exclude_dir)
+        .map((item) => normalizePath(item))
+        .filter(Boolean);
+    const excludeFile = toStringArray((_e = parsedConfig.excludeFile) !== null && _e !== void 0 ? _e : parsedConfig.exclude_file)
+        .map((item) => normalizePath(item))
+        .filter(Boolean);
+    const excludeRegex = toStringArray((_f = parsedConfig.excludeRegex) !== null && _f !== void 0 ? _f : parsedConfig.exclude_regex)
+        .map((item) => {
+        try {
+            return new RegExp(item);
+        }
+        catch (_a) {
+            return null;
+        }
+    })
+        .filter((item) => item instanceof RegExp);
+    const tmpDir = normalizePath(toStringValue((_g = parsedConfig.tmpDir) !== null && _g !== void 0 ? _g : parsedConfig.tmp_dir) || defaultConfig.tmpDir);
+    const testdataDir = normalizePath(toStringValue((_h = parsedConfig.testDataDir) !== null && _h !== void 0 ? _h : parsedConfig.testdata_dir) ||
+        defaultConfig.testDataDir);
+    return {
+        includeExt: new Set(includeExt.length ? includeExt : [...defaultConfig.includeExt]),
+        includeDir,
+        includeFile: new Set(includeFile),
+        excludeDir: [...new Set([...defaultConfig.excludeDir, ...excludeDir, tmpDir, testdataDir])],
+        excludeFile: new Set(excludeFile),
+        excludeRegex: excludeRegex.length ? excludeRegex : defaultConfig.excludeRegex,
+        tmpDir,
+        testDataDir: testdataDir,
+    };
+}
+function pathInDir(relPath, dir) {
+    const normalizedDir = normalizePath(dir).replace(/\/+$/, "");
+    return relPath === normalizedDir || relPath.startsWith(`${normalizedDir}/`);
+}
+function shouldIgnore(relPath, config) {
+    if (!relPath || relPath === ".") {
+        return false;
+    }
+    if (config.excludeFile.has(relPath)) {
+        return true;
+    }
+    if (config.excludeDir.some((dir) => pathInDir(relPath, dir))) {
+        return true;
+    }
+    return config.excludeRegex.some((reg) => reg.test(relPath));
+}
+function shouldTrigger(relPath, config) {
+    if (shouldIgnore(relPath, config)) {
+        return false;
+    }
+    const ext = (0, path_1.extname)(relPath).replace(/^\./, "");
+    const inIncludedFile = config.includeFile.has(relPath);
+    if (config.includeDir.length > 0) {
+        const inIncludedDir = config.includeDir.some((dir) => pathInDir(relPath, dir));
+        if (!inIncludedDir && !inIncludedFile) {
+            return false;
+        }
+    }
+    if (inIncludedFile) {
+        return true;
+    }
+    if (!ext) {
+        return false;
+    }
+    return config.includeExt.has(ext);
+}
+function quote(arg) {
+    if (/\s/.test(arg)) {
+        return `"${arg.replace(/"/g, '\\"')}"`;
+    }
+    return arg;
+}
+function runGoProcess(ginPort) {
+    const command = `go run ${quote("main.go")}`;
+    killGinPortIfNeeded(ginPort);
+    (0, terminal_ui_1.printCommandLog)(GO_WATCH_PREFIX, `start: ${command}`);
+    return (0, child_process_1.spawn)(command, {
+        cwd,
+        shell: true,
+        stdio: "inherit",
+    });
+}
+function stopGoProcess(proc) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!proc || proc.killed || proc.exitCode !== null) {
+            return;
+        }
+        yield new Promise((resolveStop) => {
+            let finished = false;
+            const done = () => {
+                if (finished) {
+                    return;
+                }
+                finished = true;
+                resolveStop();
+            };
+            const timer = setTimeout(() => {
+                try {
+                    proc.kill("SIGKILL");
+                }
+                catch (_a) {
+                    // best effort
+                }
+                done();
+            }, SHUTDOWN_TIMEOUT_MS);
+            proc.once("exit", () => {
+                clearTimeout(timer);
+                done();
+            });
+            try {
+                proc.kill("SIGTERM");
+            }
+            catch (_a) {
+                clearTimeout(timer);
+                done();
+            }
+        });
+    });
+}
+/**
+ * 启动 Go 开发监听流程：执行 `go run main.go`，并在文件变更后自动重启。
+ *
+ * 该函数通常由 `develop()` 调用；执行后会持续监听，直到收到退出信号。
+ *
+ * @returns {Promise<void>} 仅在监听流程被中断并完成清理后返回。
+ */
+function startGoDev(ginPortOverride) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const watchConfig = loadWatchConfig();
+        const ginPort = ginPortOverride !== null && ginPortOverride !== void 0 ? ginPortOverride : getGinPort();
+        const watchRoots = watchConfig.includeDir.length
+            ? watchConfig.includeDir.map((dir) => (0, path_1.join)(cwd, dir))
+            : [cwd];
+        (0, terminal_ui_1.printCommandLog)(GO_WATCH_PREFIX, `watching: ${watchRoots.map((item) => toProjectRelative(item)).join(", ")}`);
+        let restarting = false;
+        let goProc = runGoProcess(ginPort);
+        let restartTimer = null;
+        const watcher = chokidar_1.default.watch(watchRoots, {
+            ignoreInitial: true,
+            ignored: (pathName) => shouldIgnore(toProjectRelative(pathName), watchConfig),
+            awaitWriteFinish: {
+                stabilityThreshold: 120,
+                pollInterval: 20,
+            },
+        });
+        const triggerRestart = (eventName, changedPath) => {
+            const relPath = toProjectRelative(changedPath);
+            if (!shouldTrigger(relPath, watchConfig)) {
+                return;
+            }
+            if (restartTimer) {
+                clearTimeout(restartTimer);
+            }
+            restartTimer = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                if (restarting) {
+                    return;
+                }
+                restarting = true;
+                (0, terminal_ui_1.printCommandLog)(GO_WATCH_PREFIX, `${eventName}: ${relPath}, restarting...`);
+                yield stopGoProcess(goProc);
+                goProc = runGoProcess(ginPort);
+                restarting = false;
+            }), RESTART_DEBOUNCE_MS);
+        };
+        watcher
+            .on("add", (filePath) => triggerRestart("add", filePath))
+            .on("change", (filePath) => triggerRestart("change", filePath))
+            .on("unlink", (filePath) => triggerRestart("unlink", filePath))
+            .on("error", (error) => {
+            (0, terminal_ui_1.printCommandError)(`${GO_WATCH_PREFIX} watcher error`, error);
+        });
+        const shutdown = () => __awaiter(this, void 0, void 0, function* () {
+            if (restartTimer) {
+                clearTimeout(restartTimer);
+                restartTimer = null;
+            }
+            yield watcher.close();
+            yield stopGoProcess(goProc);
+        });
+        process.on("SIGINT", () => __awaiter(this, void 0, void 0, function* () {
+            yield shutdown();
+            process.exit(0);
+        }));
+        process.on("SIGTERM", () => __awaiter(this, void 0, void 0, function* () {
+            yield shutdown();
+            process.exit(0);
+        }));
+    });
+}
+if (require.main === module) {
+    // 兼容直接执行该文件（例如 node src/dev-go.js）。
+    startGoDev().catch((error) => {
+        (0, terminal_ui_1.printCommandError)(`${GO_WATCH_PREFIX} failed to start`, error);
+        process.exit(1);
+    });
+}

package/src/services/pack-service.d.ts

@@ -0,0 +1,23 @@
+import type { PackConfig } from "../pack";
+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 LEGACY_PACK_CONFIG_PATH: string;
+export declare const LEGACY_PACK_CONFIG_TS_PATH: string;
+export declare const LEGACY_PACK_CONFIG_JS_PATH: string;
+export declare const LEGACY_PACK_CONFIG_CJS_PATH: string;
+export declare const LEGACY_PACK_CONFIG_MJS_PATH: string;
+export declare const BUILD_EXECUTABLE: string;
+export declare const SERVER_EXECUTABLE: string;
+export declare const PACKAGE_JSON_CONTENT: {
+    private: boolean;
+    scripts: {
+        start: string;
+    };
+};
+export declare const FILES_TO_COPY: {
+    [k: string]: string;
+};
+export declare function buildAndPack(config?: PackConfig): Promise<void>;
+export default buildAndPack;