nuxt-gin-tools 0.1.8 → 0.1.10

package/package.json

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

@@ -1,7 +1,44 @@
-export declare const config: {
-    ssr: boolean;
+export interface ServerConfigJson {
+    /**
+     * 前端基础 URL
+     * 用于指定前端路由的基础路径
+     */
+    baseUrl: `/${string}`;
+    /**
+     * Nuxt 端口号
+     * 用于指定 Nuxt 项目的开发服务器端口号
+     * 例如，如果 Nuxt 项目的开发服务器端口号为 3000，则 nuxtPort 为 3000
+     */
+    nuxtPort: number;
+    /**
+     * Gin 端口号
+     * 用于指定 Gin 服务器的端口号
+     * 例如，如果 Gin 服务器的端口号为 8080，则 ginPort 为 8080
+     */
+    ginPort: number;
+}
+export interface MyNuxtConfig {
+    /**
+     * 服务器基础路径
+     * 用于指定服务器端路由的基础路径
+     * 例如，如果服务器端路由为 /api，则 serverBasePath 为 /api
+     */
+    apiBasePath: `/${string}`;
+    /**
+     * 服务器配置
+     * 包含服务器端的相关配置，如端口号、基础路径等
+     */
+    serverConfig: ServerConfigJson;
+}
+/**
+ * 创建默认的 Nuxt 配置
+ * @param param0 包含服务器配置和 API 基础路径的参数对象
+ * @returns Nuxt 配置对象
+ */
+export declare function createDefaultConfig({ serverConfig, apiBasePath }: MyNuxtConfig): {
     buildDir: string;
     srcDir: string;
+    ssr: boolean;
     /**
      * 配置实验性功能
      * 禁用 payloadExtraction 功能，该功能可能用于提取页面的有效负载数据
@@ -15,5 +52,46 @@ export declare const config: {
             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: {
+            [x: string]: {
+                target: string;
+                changeOrigin: boolean;
+            };
+        };
+    };
+    vite: {
+        plugins: never[];
+        esbuild: {
+            jsxFactory: string;
+            jsxFragment: string;
+        };
+    };
 };
-export default config;
+export default createDefaultConfig;

package/src/nuxt-config.js

@@ -1,24 +1,88 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = void 0;
-exports.config = {
-    ssr: false,
-    buildDir: "vue/.nuxt", // 设置构建目录为 "vue/.nuxt"，表示 Nuxt 项目的构建输出将存放在该目录下
-    srcDir: "vue", // 设置源代码目录为 "vue"，表示 Nuxt 项目的源代码将存放在该目录下
+exports.createDefaultConfig = createDefaultConfig;
+/**
+ * 创建默认的 Nuxt 配置
+ * @param param0 包含服务器配置和 API 基础路径的参数对象
+ * @returns Nuxt 配置对象
+ */
+function createDefaultConfig({ serverConfig, apiBasePath }) {
     /**
-     * 配置实验性功能
-     * 禁用 payloadExtraction 功能，该功能可能用于提取页面的有效负载数据
-     * 这里禁用它可能是为了避免某些兼容性问题或特定的项目需求
+     * 处理基础路径，去除协议和域名部分，只保留路径部分
+     * 例如，将 "https://example.com/api-go" 转换为 "/api-go"
      */
-    experimental: {
-        payloadExtraction: false,
-    },
-    // 配置 Nuxt DevTools
-    // 启用时间线功能，可能用于调试和性能分析
-    devtools: {
-        timeline: {
-            enabled: true,
+    const thisBasePath = apiBasePath.replace(/^https?:[/]{2}[^/]+/, "");
+    /**
+     * 目标服务器的 URL
+     * 格式为：http://localhost:ginPort/serverBasePath
+     * 其中，ginPort 是从 serverConfig 中获取的 Gin 服务器的端口号
+     * serverBasePath 是从 MyNuxtConfig 中获取的服务器基础路径
+     */
+    const target = `http://localhost:${serverConfig.ginPort}${thisBasePath}`;
+    return {
+        buildDir: "vue/.nuxt", // 设置构建目录为 "vue/.nuxt"，表示 Nuxt 项目的构建输出将存放在该目录下
+        srcDir: "vue", // 设置源代码目录为 "vue"，表示 Nuxt 项目的源代码将存放在该目录下
+        // 设置服务器端代码的目录为 "vue/server"，表示服务器端的代码将存放在该目录下
+        // serverDir: "vue/server",
+        // 禁用服务器端渲染（SSR），即页面将在客户端进行渲染
+        ssr: false,
+        /**
+         * 配置实验性功能
+         * 禁用 payloadExtraction 功能，该功能可能用于提取页面的有效负载数据
+         * 这里禁用它可能是为了避免某些兼容性问题或特定的项目需求
+         */
+        experimental: {
+            payloadExtraction: false,
+        },
+        devtools: {
+            timeline: {
+                enabled: true,
+            },
+        },
+        /**
+         * 配置应用的基础 URL
+         * 从 server.config.json 文件中获取 baseUrl 作为应用的基础 URL
+         * 这个基础 URL 将用于构建应用的路由和请求地址
+         */
+        app: { baseURL: serverConfig.baseUrl },
+        /**
+         * 配置开发服务器的端口号
+         * 从 server.config.json 文件中获取 nuxtPort 作为开发服务器的端口号
+         * 启动开发服务器时，将使用该端口号进行监听
+         */
+        devServer: {
+            port: serverConfig.nuxtPort,
+            cors: {
+                origin: "*",
+                methods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
+                allowHeaders: ["X-Requested-With", "Content-Type"],
+                credentials: true,
+                maxAge: "1728000",
+            },
+        },
+        nitro: {
+            output: {
+                // 设置输出目录为 "vue/.nuxt", 表示 Nitro 的构建输出
+                dir: "vue/.output",
+            },
+            devProxy: {
+                // 定义代理规则，将匹配 thisBasePath 的请求代理到目标服务器
+                [thisBasePath]: {
+                    // 目标服务器的 URL
+                    target: target,
+                    // 是否改变请求的源，设置为 true 可以避免跨域问题
+                    changeOrigin: true,
+                },
+            },
+        },
+        vite: {
+            // 配置 Vite 插件
+            plugins: [],
+            // 配置 esbuild 编译器的选项
+            // 设置 jsxFactory 为 "h"，这是 Vue 3 中用于创建虚拟 DOM 的函数
+            // 设置 jsxFragment 为 "Fragment"，用于处理 JSX 中的片段
+            esbuild: { jsxFactory: "h", jsxFragment: "Fragment" },
         },
-    },
-};
-exports.default = exports.config;
+    };
+}
+exports.default = createDefaultConfig;