nuxt-gin-tools 0.2.7 → 0.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-gin-tools",
-  "version": "0.2.7",
+  "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/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,7 +24,7 @@ exports.createDefaultConfig = createDefaultConfig;
  * });
  * ```
  */
-function createDefaultConfig({ serverConfig, apiBasePath }) {
+function createDefaultConfig({ serverConfig, apiBasePath, wsProxyBasePaths = [], }) {
     /**
      * 处理基础路径，去除协议和域名部分，只保留路径部分
      * 例如，将 "https://example.com/api-go" 转换为 "/api-go"
@@ -33,13 +33,37 @@ function createDefaultConfig({ serverConfig, apiBasePath }) {
     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}${normalizedProxyBasePath}`;
+    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 项目的源代码将存放在该目录下
@@ -86,27 +110,12 @@ function createDefaultConfig({ serverConfig, apiBasePath }) {
                 // 设置输出目录为 "vue/.nuxt", 表示 Nitro 的构建输出
                 dir: "vue/.output",
             },
-            devProxy: {
-                // 定义代理规则，将匹配 thisBasePath 的请求代理到目标服务器
-                [normalizedProxyBasePath]: {
-                    // 目标服务器的 URL
-                    target: target,
-                    // 是否改变请求的源，设置为 true 可以避免跨域问题
-                    changeOrigin: true,
-                    // 启用 WebSocket 代理
-                    ws: true,
-                },
-            },
+            // 定义代理规则，将匹配基础路径的请求代理到目标服务器
+            devProxy: proxyEntries,
         },
         vite: {
             server: {
-                proxy: {
-                    [normalizedProxyBasePath]: {
-                        target,
-                        changeOrigin: true,
-                        ws: true,
-                    },
-                },
+                proxy: proxyEntries,
             },
             // 配置 Vite 插件
             plugins: [],