nuxt-gin-tools 0.2.23 → 0.3.0

package/src/config/package-manager.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_MANAGER_SELECTIONS = void 0;
+exports.detectPackageManager = detectPackageManager;
+exports.resolvePackageManager = resolvePackageManager;
+exports.isPackageManagerSelection = isPackageManagerSelection;
+exports.packageManagerUpdateCommand = packageManagerUpdateCommand;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+exports.PACKAGE_MANAGER_SELECTIONS = ["auto", "bun", "pnpm", "npm"];
+const cwd = process.cwd();
+function detectPackageManager() {
+    if ((0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "bun.lock")) || (0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "bun.lockb"))) {
+        return "bun";
+    }
+    if ((0, fs_extra_1.existsSync)((0, path_1.join)(cwd, "pnpm-lock.yaml"))) {
+        return "pnpm";
+    }
+    return "npm";
+}
+function resolvePackageManager(selection) {
+    if (selection === "auto") {
+        return detectPackageManager();
+    }
+    return selection;
+}
+function isPackageManagerSelection(value) {
+    return exports.PACKAGE_MANAGER_SELECTIONS.includes(value);
+}
+function packageManagerUpdateCommand(packageManager, latest) {
+    switch (packageManager) {
+        case "bun":
+            return latest ? "bun update --latest" : "bun update";
+        case "pnpm":
+            return latest ? "pnpm update --latest" : "pnpm update";
+        default:
+            return latest ? "npm update" : "npm update";
+    }
+}

package/src/nuxt-gin.d.ts

@@ -0,0 +1,103 @@
+import type { CleanupOptions } from "./cli/commands/cleanup";
+import type { DevelopOptions } from "./cli/commands/develop";
+import type { PostInstallOptions } from "./cli/commands/install";
+import type { UpdateOptions } from "./cli/commands/update";
+import type { PackConfig } from "./pack";
+import type { ServerConfigJson } from "./nuxt-config";
+/**
+ * Go watcher configurable defaults.
+ * Go watcher 的可配置默认项。
+ */
+export type GoWatchListConfig = {
+    /** File extensions. / 文件扩展名。 */
+    ext?: string[];
+    /** Directories. / 目录。 */
+    dir?: string[];
+    /** Individual files. / 单个文件。 */
+    file?: string[];
+    /** Regex patterns, mainly for exclude rules. / 正则模式，主要用于排除规则。 */
+    regex?: string[];
+};
+export type GoWatchConfigOptions = {
+    /** Include rules. / 包含规则。 */
+    include?: Omit<GoWatchListConfig, "regex">;
+    /** Exclude rules. / 排除规则。 */
+    exclude?: GoWatchListConfig;
+    /** Temporary output directory. / 临时输出目录。 */
+    tmpDir?: string;
+    /** Test data directory name. / 测试数据目录名称。 */
+    testDataDir?: string;
+    /** Deprecated flat include ext. / 兼容旧版：扁平 includeExt。 */
+    includeExt?: string[];
+    /** Deprecated flat include dir. / 兼容旧版：扁平 includeDir。 */
+    includeDir?: string[];
+    /** Deprecated flat include file. / 兼容旧版：扁平 includeFile。 */
+    includeFile?: string[];
+    /** Deprecated flat exclude dir. / 兼容旧版：扁平 excludeDir。 */
+    excludeDir?: string[];
+    /** Deprecated flat exclude file. / 兼容旧版：扁平 excludeFile。 */
+    excludeFile?: string[];
+    /** Deprecated flat exclude regex. / 兼容旧版：扁平 excludeRegex。 */
+    excludeRegex?: string[];
+};
+/**
+ * Unified project config consumed by `nuxt-gin-tools`.
+ * `nuxt-gin-tools` 使用的统一项目配置。
+ */
+export interface NuxtGinConfig {
+    /** CLI defaults for development commands. / 开发命令的默认配置。 */
+    dev?: DevelopOptions & {
+        /** Force cleanup/bootstrap before dev starts. / 开发前强制执行清理与初始化。 */
+        cleanupBeforeDevelop?: boolean;
+        /** Kill occupied ports before dev starts. / 开发前释放已占用端口。 */
+        killPortBeforeDevelop?: boolean;
+    };
+    /** Built-in Go watcher defaults. / Go watcher 的内置默认规则。 */
+    goWatch?: GoWatchConfigOptions;
+    /** CLI defaults for install/bootstrap. / install 初始化命令的默认配置。 */
+    install?: PostInstallOptions;
+    /** CLI defaults for cleanup. / cleanup 命令的默认配置。 */
+    cleanup?: CleanupOptions;
+    /** CLI defaults for dependency updates. / 依赖更新命令的默认配置。 */
+    update?: Partial<UpdateOptions>;
+    /** CLI defaults for build/pack. / build 与 pack 的默认配置。 */
+    pack?: PackConfig;
+}
+/**
+ * Result of resolving `nuxt-gin.config.*`.
+ * 解析 `nuxt-gin.config.*` 后得到的结果。
+ */
+export type LoadedNuxtGinConfig = {
+    /** Parsed config object. / 解析后的配置对象。 */
+    config: NuxtGinConfig;
+    /** Selected config file path. / 实际选中的配置文件路径。 */
+    sourcePath?: string;
+    /** Non-fatal warnings collected during resolution. / 解析过程中收集到的非致命警告。 */
+    warnings: string[];
+};
+/**
+ * Identity helper for typed config authoring in `nuxt-gin.config.ts`.
+ * 用于 `nuxt-gin.config.ts` 的类型化配置 helper。
+ */
+export declare function createNuxtGinConfig(config: NuxtGinConfig): NuxtGinConfig;
+/**
+ * Load `nuxt-gin.config.*` from the current project root.
+ * 从当前项目根目录加载 `nuxt-gin.config.*`。
+ */
+export declare function loadNuxtGinConfig(): LoadedNuxtGinConfig | undefined;
+/**
+ * Read and validate legacy runtime server config from `server.config.json`.
+ * 从 `server.config.json` 读取并校验运行时服务配置。
+ */
+export declare function readLegacyServerConfig(): ServerConfigJson | undefined;
+/**
+ * Resolve the project config and always return a stable object shape.
+ * 解析项目配置，并始终返回稳定的对象结构。
+ */
+export declare function resolveNuxtGinProjectConfig(): LoadedNuxtGinConfig;
+/**
+ * Merge objects while ignoring `undefined` from the override side.
+ * 合并对象时忽略 override 侧的 `undefined` 值。
+ */
+export declare function mergeDefined<T extends object>(base?: Partial<T>, override?: Partial<T>): T;
+export default createNuxtGinConfig;

package/src/nuxt-gin.js

@@ -0,0 +1,178 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNuxtGinConfig = createNuxtGinConfig;
+exports.loadNuxtGinConfig = loadNuxtGinConfig;
+exports.readLegacyServerConfig = readLegacyServerConfig;
+exports.resolveNuxtGinProjectConfig = resolveNuxtGinProjectConfig;
+exports.mergeDefined = mergeDefined;
+const FS = __importStar(require("fs-extra"));
+const Path = __importStar(require("path"));
+const { createJiti } = require("jiti");
+const NUXT_GIN_CONFIG_PATH = Path.resolve(process.cwd(), "nuxt-gin.config.json");
+const NUXT_GIN_CONFIG_TS_PATH = Path.resolve(process.cwd(), "nuxt-gin.config.ts");
+const NUXT_GIN_CONFIG_JS_PATH = Path.resolve(process.cwd(), "nuxt-gin.config.js");
+const NUXT_GIN_CONFIG_CJS_PATH = Path.resolve(process.cwd(), "nuxt-gin.config.cjs");
+const NUXT_GIN_CONFIG_MJS_PATH = Path.resolve(process.cwd(), "nuxt-gin.config.mjs");
+const LEGACY_SERVER_CONFIG_PATH = Path.resolve(process.cwd(), "server.config.json");
+/**
+ * Identity helper for typed config authoring in `nuxt-gin.config.ts`.
+ * 用于 `nuxt-gin.config.ts` 的类型化配置 helper。
+ */
+function createNuxtGinConfig(config) {
+    return config;
+}
+/**
+ * Narrow an unknown value to a plain object.
+ * 将未知值收窄为普通对象。
+ */
+function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Unwrap default export from CJS/ESM loaded modules.
+ * 解包通过 CJS/ESM 加载后的默认导出。
+ */
+function normalizeModuleExport(moduleValue) {
+    if (isPlainObject(moduleValue) && "default" in moduleValue) {
+        return moduleValue.default;
+    }
+    return moduleValue;
+}
+/**
+ * Load config from JSON or executable module files.
+ * 从 JSON 或可执行模块文件中加载配置。
+ */
+function loadConfigModule(configPath) {
+    if (configPath.endsWith(".json")) {
+        return FS.readJSONSync(configPath);
+    }
+    const jiti = createJiti(__filename, { moduleCache: false, interopDefault: true });
+    return jiti(configPath);
+}
+/**
+ * Validate runtime server config that still lives in `server.config.json`.
+ * 校验仍然保存在 `server.config.json` 中的运行时服务配置。
+ */
+function validateServerConfig(serverConfig, sourceLabel) {
+    if (!isPlainObject(serverConfig)) {
+        throw new Error(`${sourceLabel}: serverConfig must be an object`);
+    }
+    const { baseUrl, nuxtPort, ginPort } = serverConfig;
+    if (typeof baseUrl !== "string" || baseUrl.trim().length === 0) {
+        throw new Error(`${sourceLabel}: serverConfig.baseUrl must be a non-empty string`);
+    }
+    if (!Number.isInteger(nuxtPort) || nuxtPort <= 0) {
+        throw new Error(`${sourceLabel}: serverConfig.nuxtPort must be a positive integer`);
+    }
+    if (!Number.isInteger(ginPort) || ginPort <= 0) {
+        throw new Error(`${sourceLabel}: serverConfig.ginPort must be a positive integer`);
+    }
+    return serverConfig;
+}
+/**
+ * Validate the top-level `nuxt-gin.config.*` shape.
+ * 校验顶层 `nuxt-gin.config.*` 的结构。
+ */
+function validateNuxtGinConfig(config, sourcePath) {
+    if (!isPlainObject(config)) {
+        throw new Error(`${Path.basename(sourcePath)} must export an object`);
+    }
+    return config;
+}
+/**
+ * Load `nuxt-gin.config.*` from the current project root.
+ * 从当前项目根目录加载 `nuxt-gin.config.*`。
+ */
+function loadNuxtGinConfig() {
+    const candidates = [
+        NUXT_GIN_CONFIG_TS_PATH,
+        NUXT_GIN_CONFIG_JS_PATH,
+        NUXT_GIN_CONFIG_CJS_PATH,
+        NUXT_GIN_CONFIG_MJS_PATH,
+        NUXT_GIN_CONFIG_PATH,
+    ].filter((configPath) => FS.existsSync(configPath));
+    if (candidates.length === 0) {
+        return undefined;
+    }
+    const warnings = [];
+    if (candidates.length > 1) {
+        warnings.push(`multiple nuxt-gin config files found (${candidates.map((item) => Path.basename(item)).join(", ")}); using ${Path.basename(candidates[0])}`);
+    }
+    const selectedPath = candidates[0];
+    const loadedConfig = normalizeModuleExport(loadConfigModule(selectedPath));
+    return {
+        config: validateNuxtGinConfig(loadedConfig, selectedPath),
+        sourcePath: selectedPath,
+        warnings,
+    };
+}
+/**
+ * Read and validate legacy runtime server config from `server.config.json`.
+ * 从 `server.config.json` 读取并校验运行时服务配置。
+ */
+function readLegacyServerConfig() {
+    if (!FS.existsSync(LEGACY_SERVER_CONFIG_PATH)) {
+        return undefined;
+    }
+    return validateServerConfig(FS.readJSONSync(LEGACY_SERVER_CONFIG_PATH), Path.basename(LEGACY_SERVER_CONFIG_PATH));
+}
+/**
+ * Resolve the project config and always return a stable object shape.
+ * 解析项目配置，并始终返回稳定的对象结构。
+ */
+function resolveNuxtGinProjectConfig() {
+    var _a, _b;
+    const loaded = loadNuxtGinConfig();
+    return {
+        config: (_a = loaded === null || loaded === void 0 ? void 0 : loaded.config) !== null && _a !== void 0 ? _a : {},
+        sourcePath: loaded === null || loaded === void 0 ? void 0 : loaded.sourcePath,
+        warnings: (_b = loaded === null || loaded === void 0 ? void 0 : loaded.warnings) !== null && _b !== void 0 ? _b : [],
+    };
+}
+/**
+ * Merge objects while ignoring `undefined` from the override side.
+ * 合并对象时忽略 override 侧的 `undefined` 值。
+ */
+function mergeDefined(base, override) {
+    const merged = Object.assign({}, (base !== null && base !== void 0 ? base : {}));
+    for (const [key, value] of Object.entries(override !== null && override !== void 0 ? override : {})) {
+        if (value !== undefined) {
+            merged[key] = value;
+        }
+    }
+    return merged;
+}
+exports.default = createNuxtGinConfig;

package/src/pack.d.ts

@@ -1,4 +1,4 @@
-import type { BuildOptions } from "../commands/builder";
+import type { BuildOptions } from "./services/build-service";
 export interface PackConfig extends BuildOptions {
     /**
      * 是否跳过构建步骤

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

@@ -0,0 +1,7 @@
+export type BuildOptions = {
+    binaryName?: string;
+    skipGo?: boolean;
+    skipNuxt?: boolean;
+};
+export declare function build(options?: BuildOptions): Promise<void> | Promise<import("concurrently").CloseEvent[]>;
+export default build;

package/src/services/build-service.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.build = build;
+const concurrently_1 = __importDefault(require("concurrently"));
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const os_1 = __importDefault(require("os"));
+const cwd = process.cwd();
+const defaultBinaryName = os_1.default.platform() === "win32" ? "production.exe" : "production";
+function build(options = {}) {
+    (0, fs_extra_1.ensureDirSync)((0, path_1.join)(cwd, "vue/.output"));
+    const commands = [];
+    if (!options.skipGo) {
+        commands.push({
+            command: `go build -o ./.build/.server/${options.binaryName || defaultBinaryName} .`,
+            name: "go",
+            prefixColor: "green",
+        });
+    }
+    if (!options.skipNuxt) {
+        commands.push({
+            command: "npx nuxt generate",
+            name: "nuxt",
+            prefixColor: "blue",
+        });
+    }
+    if (commands.length === 0) {
+        return Promise.resolve();
+    }
+    return (0, concurrently_1.default)(commands).result;
+}
+exports.default = build;

package/src/services/go-dev-service.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 启动 Go 开发监听流程：执行 `go run main.go`，并在文件变更后自动重启。
+ *
+ * 该函数通常由 `develop()` 调用；执行后会持续监听，直到收到退出信号。
+ *
+ * @returns {Promise<void>} 仅在监听流程被中断并完成清理后返回。
+ */
+export declare function startGoDev(ginPortOverride?: number | null): Promise<void>;