nuxt-gin-tools 0.2.6 → 0.2.8

package/index.js

@@ -1,5 +1,38 @@
 #!/usr/bin/env node
 "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;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // 导入构建和打包功能
 const pack_1 = __importDefault(require("./src/pack"));
 // 导入开发模式功能
-const develop_1 = __importDefault(require("./src/develop"));
+const develop_1 = __importStar(require("./src/develop"));
 // 导入API生成功能
 const api_generate_1 = __importDefault(require("./src/api-generate"));
 // 导入安装后处理功能
@@ -30,6 +63,14 @@ switch (args[0]) {
         // 启动开发模式
         (0, develop_1.default)();
         break;
+    case "dev:nuxt":
+        // 仅启动 Nuxt 开发模式
+        (0, develop_1.developNuxt)();
+        break;
+    case "dev:go":
+        // 仅启动 Go 开发模式
+        (0, develop_1.developGo)();
+        break;
     case "build":
         // 执行构建和打包操作
         (0, pack_1.default)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-gin-tools",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "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"

package/src/develop.d.ts

@@ -6,4 +6,16 @@
  * @returns {Promise<void>} 仅在开发进程退出或出现异常时返回。
  */
 export declare function develop(): Promise<void>;
+/**
+ * 仅启动 Nuxt 开发服务（带 nuxt 标签输出）。
+ *
+ * @returns {Promise<void>} 仅在开发进程退出或出现异常时返回。
+ */
+export declare function developNuxt(): Promise<void>;
+/**
+ * 仅启动 Go 开发监听流程。
+ *
+ * @returns {Promise<void>} 仅在开发进程退出或出现异常时返回。
+ */
+export declare function developGo(): Promise<void>;
 export default develop;

package/src/develop.js

@@ -13,6 +13,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.develop = develop;
+exports.developNuxt = developNuxt;
+exports.developGo = developGo;
 const concurrently_1 = __importDefault(require("concurrently"));
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
@@ -22,6 +24,37 @@ const dev_go_1 = require("./dev-go");
 const utils_1 = require("./utils");
 const cwd = process.cwd();
 const serverConfig = (0, fs_extra_1.readJSONSync)((0, path_1.join)(cwd, "server.config.json"));
+function prepareDevelop() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cleanupBeforeDevelop = serverConfig.cleanupBeforeDevelop === true;
+        if (cleanupBeforeDevelop) {
+            yield (0, cleanup_1.default)();
+            yield (0, postinstall_1.default)();
+            return;
+        }
+        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)();
+        }
+    });
+}
+function runNuxtDev() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, concurrently_1.default)([
+            {
+                command: `npx nuxt dev --port=${serverConfig.nuxtPort} --host`,
+                name: "nuxt",
+                prefixColor: "blue",
+            },
+        ]).result;
+    });
+}
+function runGoDev() {
+    return __awaiter(this, void 0, void 0, function* () {
+        (0, fs_extra_1.ensureDirSync)((0, path_1.join)(cwd, ".build/.server"));
+        yield (0, dev_go_1.startGoDev)();
+    });
+}
 /**
  * 启动本地开发环境。
  *
@@ -31,35 +64,43 @@ const serverConfig = (0, fs_extra_1.readJSONSync)((0, path_1.join)(cwd, "server.
  */
 function develop() {
     return __awaiter(this, void 0, void 0, function* () {
-        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)();
-            }
-        }
+        yield prepareDevelop();
         // 在开发前确保占用端口被释放
         if (killPortBeforeDevelop) {
             (0, utils_1.killPorts)([serverConfig.ginPort, serverConfig.nuxtPort]);
         }
-        (0, fs_extra_1.ensureDirSync)((0, path_1.join)(cwd, ".build/.server"));
-        // Nuxt 保持在 concurrently 中运行，统一复用 nuxt 标签输出。
-        const nuxtTask = (0, concurrently_1.default)([
-            {
-                command: `npx nuxt dev --port=${serverConfig.nuxtPort} --host`,
-                name: "nuxt",
-                prefixColor: "blue",
-            },
-        ]).result;
-        // Go 侧直接调用本地 dev-go 逻辑，避免额外 shell 路径和引号问题。
-        yield Promise.all([(0, dev_go_1.startGoDev)(), nuxtTask]);
+        yield Promise.all([runGoDev(), runNuxtDev()]);
+    });
+}
+/**
+ * 仅启动 Nuxt 开发服务（带 nuxt 标签输出）。
+ *
+ * @returns {Promise<void>} 仅在开发进程退出或出现异常时返回。
+ */
+function developNuxt() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const killPortBeforeDevelop = serverConfig.killPortBeforeDevelop !== false;
+        yield prepareDevelop();
+        if (killPortBeforeDevelop) {
+            (0, utils_1.killPorts)([serverConfig.nuxtPort]);
+        }
+        yield runNuxtDev();
+    });
+}
+/**
+ * 仅启动 Go 开发监听流程。
+ *
+ * @returns {Promise<void>} 仅在开发进程退出或出现异常时返回。
+ */
+function developGo() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const killPortBeforeDevelop = serverConfig.killPortBeforeDevelop !== false;
+        yield prepareDevelop();
+        if (killPortBeforeDevelop) {
+            (0, utils_1.killPorts)([serverConfig.ginPort]);
+        }
+        yield runGoDev();
     });
 }
 exports.default = develop;

package/src/nuxt-config.d.ts

@@ -25,6 +25,12 @@ export interface MyNuxtConfig {
      * 例如，如果服务器端路由为 /api，则 serverBasePath 为 /api
      */
     apiBasePath: string;
+    /**
+     * WebSocket 代理基础路径列表（可选）
+     * 例如：["/ws-go", "/socket"]
+     * 会同时注入 Nitro devProxy 与 Vite proxy，默认启用 ws。
+     */
+    wsProxyBasePaths?: string[];
     /**
      * 服务器配置
      * 包含服务器端的相关配置，如端口号、基础路径等
@@ -54,4 +60,67 @@ export interface MyNuxtConfig {
  * });
  * ```
  */
-export function createDefaultConfig({ serverConfig, apiBasePath }: MyNuxtConfig): NuxtConfig;
+export function createDefaultConfig(config: MyNuxtConfig): NuxtConfig;
+    srcDir: string;
+    ssr: boolean;
+    /**
+     * 配置实验性功能
+     * 禁用 payloadExtraction 功能，该功能可能用于提取页面的有效负载数据
+     * 这里禁用它可能是为了避免某些兼容性问题或特定的项目需求
+     */
+    experimental: {
+        payloadExtraction: boolean;
+    };
+    devtools: {
+        timeline: {
+            enabled: boolean;
+        };
+    };
+    /**
+     * 配置应用的基础 URL
+     * 从 server.config.json 文件中获取 baseUrl 作为应用的基础 URL
+     * 这个基础 URL 将用于构建应用的路由和请求地址
+     */
+    app: {
+        baseURL: string;
+    };
+    /**
+     * 配置开发服务器的端口号
+     * 从 server.config.json 文件中获取 nuxtPort 作为开发服务器的端口号
+     * 启动开发服务器时，将使用该端口号进行监听
+     */
+    devServer: {
+        port: number;
+        cors: {
+            origin: string;
+            methods: string[];
+            allowHeaders: string[];
+            credentials: boolean;
+            maxAge: string;
+        };
+    };
+    nitro: {
+        output: {
+            dir: string;
+        };
+        devProxy: Record<string, {
+            target: string;
+            changeOrigin: boolean;
+            ws: boolean;
+        }>;
+    };
+    vite: {
+        server: {
+            proxy: Record<string, {
+                target: string;
+                changeOrigin: boolean;
+                ws: boolean;
+            }>;
+        };
+        plugins: never[];
+        esbuild: {
+            jsxFactory: string;
+            jsxFragment: string;
+        };
+    };
+};

package/src/nuxt-config.js

@@ -24,19 +24,46 @@ exports.createDefaultConfig = createDefaultConfig;
  * });
  * ```
  */
-function createDefaultConfig({ serverConfig, apiBasePath }) {
+function createDefaultConfig({ serverConfig, apiBasePath, wsProxyBasePaths = [], }) {
     /**
      * 处理基础路径，去除协议和域名部分，只保留路径部分
      * 例如，将 "https://example.com/api-go" 转换为 "/api-go"
      */
     const thisBasePath = apiBasePath.replace(/^https?:[/]{2}[^/]+/, "");
+    const normalizedProxyBasePath = thisBasePath.endsWith("/")
+        ? thisBasePath.slice(0, -1)
+        : thisBasePath;
+    const normalizeBasePath = (rawPath) => {
+        const trimmed = rawPath.replace(/^https?:[/]{2}[^/]+/, "");
+        if (!trimmed)
+            return "/";
+        if (trimmed === "/")
+            return "/";
+        return trimmed.endsWith("/") ? trimmed.slice(0, -1) : trimmed;
+    };
+    const buildTarget = (basePath) => `http://localhost:${serverConfig.ginPort}${basePath}`;
     /**
      * 目标服务器的 URL
      * 格式为：http://localhost:ginPort/serverBasePath
      * 其中，ginPort 是从 serverConfig 中获取的 Gin 服务器的端口号
      * serverBasePath 是从 MyNuxtConfig 中获取的服务器基础路径
      */
-    const target = `http://localhost:${serverConfig.ginPort}${thisBasePath}`;
+    const target = buildTarget(normalizedProxyBasePath);
+    const proxyEntries = {
+        [normalizedProxyBasePath]: {
+            target,
+            changeOrigin: true,
+            ws: true,
+        },
+    };
+    for (const rawPath of wsProxyBasePaths) {
+        const normalizedPath = normalizeBasePath(rawPath);
+        proxyEntries[normalizedPath] = {
+            target: buildTarget(normalizedPath),
+            changeOrigin: true,
+            ws: true,
+        };
+    }
     return {
         buildDir: "vue/.nuxt", // 设置构建目录为 "vue/.nuxt"，表示 Nuxt 项目的构建输出将存放在该目录下
         srcDir: "vue", // 设置源代码目录为 "vue"，表示 Nuxt 项目的源代码将存放在该目录下
@@ -83,17 +110,13 @@ function createDefaultConfig({ serverConfig, apiBasePath }) {
                 // 设置输出目录为 "vue/.nuxt", 表示 Nitro 的构建输出
                 dir: "vue/.output",
             },
-            devProxy: {
-                // 定义代理规则，将匹配 thisBasePath 的请求代理到目标服务器
-                [thisBasePath]: {
-                    // 目标服务器的 URL
-                    target: target,
-                    // 是否改变请求的源，设置为 true 可以避免跨域问题
-                    changeOrigin: true,
-                },
-            },
+            // 定义代理规则，将匹配基础路径的请求代理到目标服务器
+            devProxy: proxyEntries,
         },
         vite: {
+            server: {
+                proxy: proxyEntries,
+            },
             // 配置 Vite 插件
             plugins: [],
             // 配置 esbuild 编译器的选项