nuxt-gin-tools 0.1.21 → 0.2.0

package/.go-watch.json

@@ -0,0 +1,20 @@
+{
+  "tmpDir": ".build/.server",
+  "testDataDir": "testdata",
+  "includeExt": ["go", "tpl", "html"],
+  "includeDir": [],
+  "includeFile": [],
+  "excludeDir": [
+    "assets",
+    ".build/.server",
+    "vendor",
+    "testdata",
+    "node_modules",
+    "vue",
+    "api",
+    ".vscode",
+    ".git"
+  ],
+  "excludeFile": [],
+  "excludeRegex": ["_test.go"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-gin-tools",
-  "version": "0.1.21",
+  "version": "0.2.0",
   "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"
@@ -15,6 +15,7 @@
   "dependencies": {
     "7zip-min": "^2.1.0",
     "chalk": "^5.4.1",
+    "chokidar": "^3.6.0",
     "concurrently": "^9.2.0",
     "fast-glob": "^3.3.3",
     "fs-extra": "^11.3.0"

package/src/dev-go.d.ts

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

package/src/dev-go.js

@@ -0,0 +1,374 @@
+"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 });
+const child_process_1 = require("child_process");
+const child_process_2 = require("child_process");
+const chokidar_1 = __importDefault(require("chokidar"));
+const chalk_1 = __importDefault(require("chalk"));
+const fs_extra_1 = require("fs-extra");
+const os_1 = __importDefault(require("os"));
+const path_1 = require("path");
+const cwd = process.cwd();
+const RESTART_DEBOUNCE_MS = 150;
+const SHUTDOWN_TIMEOUT_MS = 2000;
+const LOG_TAG = "go-watch";
+const serverConfigPath = (0, path_1.join)(cwd, "server.config.json");
+const ginPort = getGinPort();
+function getGinPort() {
+    if (!(0, fs_extra_1.existsSync)(serverConfigPath)) {
+        return null;
+    }
+    try {
+        const serverConfig = (0, fs_extra_1.readJSONSync)(serverConfigPath);
+        if (Number.isInteger(serverConfig.ginPort) && serverConfig.ginPort > 0) {
+            return serverConfig.ginPort;
+        }
+    }
+    catch (_a) {
+        // best effort
+    }
+    return null;
+}
+function killPortUnix(port) {
+    try {
+        const output = (0, child_process_2.execSync)(`lsof -ti tcp:${port}`, {
+            stdio: ["ignore", "pipe", "ignore"],
+        })
+            .toString()
+            .trim();
+        if (!output) {
+            return;
+        }
+        const pids = output
+            .split("\n")
+            .map((pid) => Number(pid.trim()))
+            .filter((pid) => Number.isInteger(pid) && pid > 0);
+        for (const pid of pids) {
+            try {
+                process.kill(pid, "SIGKILL");
+                console.log(chalk_1.default.yellow(`[${LOG_TAG}] killed process ${pid} on ginPort ${port} (unix)`));
+            }
+            catch (_a) {
+                // best effort
+            }
+        }
+    }
+    catch (_b) {
+        // best effort
+    }
+}
+function killPortWindows(port) {
+    try {
+        const output = (0, child_process_2.execSync)(`netstat -ano -p tcp`, {
+            stdio: ["ignore", "pipe", "ignore"],
+        })
+            .toString()
+            .trim();
+        if (!output) {
+            return;
+        }
+        const pids = new Set();
+        for (const line of output.split("\n")) {
+            const trimmed = line.trim();
+            if (!trimmed || !trimmed.startsWith("TCP")) {
+                continue;
+            }
+            const parts = trimmed.split(/\s+/);
+            if (parts.length < 5) {
+                continue;
+            }
+            const localAddress = parts[1];
+            const pid = Number(parts[parts.length - 1]);
+            const match = localAddress.match(/:(\d+)$/);
+            if (!match) {
+                continue;
+            }
+            const localPort = Number(match[1]);
+            if (localPort === port && Number.isInteger(pid) && pid > 0) {
+                pids.add(pid);
+            }
+        }
+        for (const pid of pids) {
+            try {
+                (0, child_process_2.execSync)(`taskkill /PID ${pid} /F`, {
+                    stdio: ["ignore", "ignore", "ignore"],
+                });
+                console.log(chalk_1.default.yellow(`[${LOG_TAG}] killed process ${pid} on ginPort ${port} (win32)`));
+            }
+            catch (_a) {
+                // best effort
+            }
+        }
+    }
+    catch (_b) {
+        // best effort
+    }
+}
+function killGinPortIfNeeded() {
+    if (!ginPort) {
+        return;
+    }
+    if (os_1.default.platform() === "win32") {
+        killPortWindows(ginPort);
+        return;
+    }
+    killPortUnix(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 defaultConfig = {
+        includeExt: new Set(["go"]),
+        includeDir: [],
+        includeFile: new Set(),
+        excludeDir: [".git", "node_modules", "vendor", "vue"],
+        excludeFile: new Set(),
+        excludeRegex: [/_test\.go$/],
+        tmpDir: ".build/.server",
+        testDataDir: "testdata",
+    };
+    const candidates = [
+        process.env.NUXT_GIN_WATCH_CONFIG,
+        (0, path_1.join)(cwd, "node_modules/nuxt-gin-tools/.go-watch.json"),
+        (0, path_1.join)(cwd, ".go-watch.json"),
+        (0, path_1.join)(__dirname, "..", ".go-watch.json"),
+        (0, path_1.join)(__dirname, "..", "..", ".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) {
+        console.warn(chalk_1.default.yellow(`[${LOG_TAG}] 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() {
+    const command = `go run ${quote("main.go")}`;
+    killGinPortIfNeeded();
+    console.log(chalk_1.default.green(`[${LOG_TAG}] 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();
+            }
+        });
+    });
+}
+function start() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const watchConfig = loadWatchConfig();
+        const watchRoots = watchConfig.includeDir.length
+            ? watchConfig.includeDir.map((dir) => (0, path_1.join)(cwd, dir))
+            : [cwd];
+        console.log(chalk_1.default.cyan(`[${LOG_TAG}] watching: ${watchRoots.map((item) => toProjectRelative(item)).join(", ")}`));
+        let restarting = false;
+        let goProc = runGoProcess();
+        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;
+                console.log(chalk_1.default.yellow(`[${LOG_TAG}] ${eventName}: ${relPath}, restarting...`));
+                yield stopGoProcess(goProc);
+                goProc = runGoProcess();
+                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) => {
+            console.error(chalk_1.default.red(`[${LOG_TAG}] watcher error: ${String(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);
+        }));
+    });
+}
+start().catch((error) => {
+    console.error(chalk_1.default.red(`[${LOG_TAG}] failed to start: ${String(error)}`));
+    process.exit(1);
+});

package/src/develop.js

@@ -17,37 +17,134 @@ const concurrently_1 = __importDefault(require("concurrently"));
 const fs_extra_1 = require("fs-extra");
 const os_1 = __importDefault(require("os"));
 const path_1 = require("path");
+const child_process_1 = require("child_process");
+const chalk_1 = __importDefault(require("chalk"));
 const cleanup_1 = __importDefault(require("./cleanup"));
 const postinstall_1 = __importDefault(require("./postinstall"));
 const cwd = process.cwd();
 const serverConfig = (0, fs_extra_1.readJSONSync)((0, path_1.join)(cwd, "server.config.json"));
-/**
- *
- * @returns {string} 返回air命令的路径
- * 根据操作系统不同，返回不同的路径
- * 如果是macOS，返回~/go/bin/air
- * 如果是其他操作系统，返回air
- */
-function getAirCommand() {
-    if (os_1.default.platform() === "darwin") {
-        return "~/go/bin/air -c node_modules/nuxt-gin-tools/.air.toml";
+function getGoDevCommand() {
+    const scriptPath = (0, path_1.join)(__dirname, "dev-go.js");
+    return `"${process.execPath}" "${scriptPath}"`;
+}
+function killPort(port) {
+    if (!Number.isInteger(port)) {
+        return;
     }
-    else {
-        return "air -c node_modules/nuxt-gin-tools/.air.toml";
+    try {
+        const output = (0, child_process_1.execSync)(`lsof -ti tcp:${port}`, {
+            stdio: ["ignore", "pipe", "ignore"],
+        })
+            .toString()
+            .trim();
+        if (!output) {
+            return;
+        }
+        const pids = output
+            .split("\n")
+            .map((pid) => Number(pid.trim()))
+            .filter((pid) => Number.isInteger(pid) && pid > 0);
+        for (const pid of pids) {
+            try {
+                process.kill(pid, "SIGKILL");
+                console.log(chalk_1.default.yellow(`Killed process ${pid} on port ${port} (unix)`));
+            }
+            catch (_a) {
+                // Best-effort: if the process is already gone, ignore.
+            }
+        }
+    }
+    catch (_b) {
+        // Best-effort: lsof might be missing or no process is listening on the port.
+    }
+}
+function killPortWindows(port) {
+    if (!Number.isInteger(port)) {
+        return;
+    }
+    try {
+        const output = (0, child_process_1.execSync)(`netstat -ano -p tcp`, {
+            stdio: ["ignore", "pipe", "ignore"],
+        })
+            .toString()
+            .trim();
+        if (!output) {
+            return;
+        }
+        const pids = new Set();
+        for (const line of output.split("\n")) {
+            const trimmed = line.trim();
+            if (!trimmed || !trimmed.startsWith("TCP")) {
+                continue;
+            }
+            const parts = trimmed.split(/\s+/);
+            if (parts.length < 5) {
+                continue;
+            }
+            const localAddress = parts[1];
+            const pid = Number(parts[parts.length - 1]);
+            const match = localAddress.match(/:(\d+)$/);
+            if (!match) {
+                continue;
+            }
+            const localPort = Number(match[1]);
+            if (localPort === port && Number.isInteger(pid) && pid > 0) {
+                pids.add(pid);
+            }
+        }
+        for (const pid of pids) {
+            try {
+                (0, child_process_1.execSync)(`taskkill /PID ${pid} /F`, {
+                    stdio: ["ignore", "ignore", "ignore"],
+                });
+                console.log(chalk_1.default.yellow(`Killed process ${pid} on port ${port} (win32)`));
+            }
+            catch (_a) {
+                // Best-effort: if the process is already gone, ignore.
+            }
+        }
+    }
+    catch (_b) {
+        // Best-effort: netstat might be missing or no process is listening on the port.
+    }
+}
+function killPortsFromConfig() {
+    const ports = [serverConfig.ginPort, serverConfig.nuxtPort]
+        .filter((port) => Number.isInteger(port) && port > 0)
+        .filter((port, index, list) => list.indexOf(port) === index);
+    for (const port of ports) {
+        if (os_1.default.platform() === "win32") {
+            killPortWindows(port);
+        }
+        else {
+            killPort(port);
+        }
     }
 }
 function develop() {
     return __awaiter(this, void 0, void 0, function* () {
-        // 如果不存在 .nuxt 目录或 go.sum 文件，则执行清理和安装后处理
-        // 这可以确保开发环境干净且依赖正确
-        if (!(0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "vue/.nuxt")) || !(0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "go.sum"))) {
+        const cleanupBeforeDevelop = serverConfig.cleanupBeforeDevelop === true;
+        const killPortBeforeDevelop = serverConfig.killPortBeforeDevelop !== false;
+        // 如果配置为开发前清理，则直接执行清理和安装后处理
+        if (cleanupBeforeDevelop) {
             yield (0, cleanup_1.default)();
             yield (0, postinstall_1.default)();
         }
+        else {
+            // 否则仅在关键依赖缺失时执行
+            if (!(0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "vue/.nuxt")) || !(0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "go.sum"))) {
+                yield (0, cleanup_1.default)();
+                yield (0, postinstall_1.default)();
+            }
+        }
+        // 在开发前确保占用端口被释放
+        if (killPortBeforeDevelop) {
+            killPortsFromConfig();
+        }
         (0, fs_extra_1.ensureDirSync)((0, path_1.join)(cwd, ".build/.server"));
         yield (0, concurrently_1.default)([
             {
-                command: getAirCommand(),
+                command: getGoDevCommand(),
                 name: "go",
                 prefixColor: "green",
             },

package/src/postinstall.js

@@ -9,7 +9,6 @@ const node_child_process_1 = require("node:child_process");
 function postInstall() {
     const hasGo = (0, node_child_process_1.spawnSync)("go", ["version"], { stdio: "ignore", shell: true }).status ===
         0;
-    const hasAir = (0, node_child_process_1.spawnSync)("air", ["-v"], { stdio: "ignore", shell: true }).status === 0;
     const commands = [
         {
             command: "npx nuxt prepare",
@@ -27,21 +26,6 @@ function postInstall() {
     else {
         console.warn("[nuxt-gin-tools] 未检测到 Go，已跳过 Go 相关安装。请先安装 Go 后再重新运行相关命令。");
     }
-    if (!hasAir) {
-        const isWindows = process.platform === "win32";
-        const pathHint = isWindows
-            ? [
-                "PowerShell: $env:Path += \";$env:USERPROFILE\\go\\bin\"",
-                "CMD: set PATH=%PATH%;%USERPROFILE%\\go\\bin",
-            ].join(" | ")
-            : "export PATH=\"$PATH:$HOME/go/bin\"";
-        console.warn([
-            "[nuxt-gin-tools] 未检测到 air，请先安装 1.63.0 版本并加入 PATH。",
-            "安装命令: go install github.com/cosmtrek/air@v1.63.0",
-            `PATH 示例: ${pathHint}`,
-            "安装完成后请执行: air -v",
-        ].join("\n"));
-    }
     // 执行并发命令
     return (0, concurrently_1.default)(commands).result;
 }

package/src/server-config.json

@@ -15,6 +15,16 @@
       "title": "The base url for nuxt. / Nuxt的BaseUrl",
       "type": "string",
       "pattern": "^\\/\\w.+"
+    },
+    "killPortBeforeDevelop": {
+      "title": "Kill port before develop / 开发前释放端口",
+      "type": "boolean",
+      "default": true
+    },
+    "cleanupBeforeDevelop": {
+      "title": "Cleanup before develop / 开发前清理",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": [
@@ -22,4 +32,4 @@
     "nuxtPort",
     "baseUrl"
   ]
-}
+}

package/.air.toml

@@ -1,42 +0,0 @@
-root = "."
-testdata_dir = "testdata"
-tmp_dir= ".build/.server"
-
-[build]
-  args_bin = []
-  bin = "./.build/.server/development.exe"
-  cmd = "go build -o ./.build/.server/development.exe ."
-  delay = 0
-  exclude_dir = ["assets", ".build/.server", "vendor", "testdata", "node_modules", "vue", "api", ".vscode", ".git"]
-  exclude_file = []
-  exclude_regex = ["_test.go"]
-  exclude_unchanged = false
-  follow_symlink = false
-  full_bin = ""
-  include_dir = []
-  include_ext = ["go", "tpl", ".build/.server", "html"]
-  include_file = []
-  kill_delay = "0s"
-  log = "build-errors.log"
-  rerun = false
-  rerun_delay = 500
-  send_interrupt = false
-  stop_on_error = false
-
-[color]
-  app = ""
-  build = "yellow"
-  main = "magenta"
-  runner = "green"
-  watcher = "cyan"
-
-[log]
-  main_only = false
-  time = true
-
-[misc]
-  clean_on_exit = false
-
-[screen]
-  clear_on_rebuild = false
-  keep_scroll = true