nuxt-gin-tools 0.2.16 → 0.2.17

package/.go-watch.json

@@ -1,20 +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"]
-}
+{
+  "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/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 AlbertGao
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 AlbertGao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,150 +1,150 @@
-# nuxt-gin-tools
-
-`nuxt-gin-tools` 是 `nuxt-gin-starter` 的配套开发工具包，提供 Nuxt + Gin 项目的统一命令入口。
-
-核心目标：
-- 一条命令启动前后端开发环境
-- 自动处理 Go 侧依赖和文件监听重启
-- 提供 OpenAPI 代码生成与构建打包辅助
-
-## 功能概览
-
-- `nuxt-gin dev`
-  - 启动 Nuxt 开发服务
-  - 启动 Go 文件监听（基于 `chokidar`）
-  - Go 文件变化后自动重启 `go run main.go`
-- `nuxt-gin install`
-  - 执行 Nuxt prepare
-  - 如果检测到 Go，则执行 `go mod download && go mod tidy`
-- `nuxt-gin gen`
-  - 基于 `openapi.yaml` 生成 Go / TS API 代码
-- `nuxt-gin build`
-  - 执行项目构建与打包流程
-- `nuxt-gin cleanup`
-  - 清理开发产物
-- `nuxt-gin update`
-  - 执行依赖更新流程
-
-## 安装
-
-在 `nuxt-gin-starter` 项目中作为依赖安装：
-
-```bash
-pnpm add nuxt-gin-tools
-```
-
-## 快速开始
-
-```bash
-# 初始化依赖（可选）
-nuxt-gin install
-
-# 启动开发
-nuxt-gin dev
-```
-
-## 命令说明
-
-### `nuxt-gin dev`
-
-开发模式下会并行运行：
-- Nuxt：`npx nuxt dev --port=<nuxtPort> --host`
-- Go：监听变更并运行 `go run main.go`
-
-Go 监听规则来自 `.go-watch.json`（见下文）。
-
-### `nuxt-gin install`
-
-- 总是执行：`npx nuxt prepare`
-- 检测到 Go 时额外执行：`go mod download && go mod tidy`
-
-### `nuxt-gin gen`
-
-依赖 `openapi-generator-cli`，默认会：
-- 生成 Go Gin server 相关代码
-- 生成 TypeScript axios 客户端代码
-
-### `nuxt-gin build`
-
-执行工具链内置的构建与打包逻辑。
-
-### `nuxt-gin cleanup`
-
-清理由工具链生成的临时目录和产物。
-
-### `nuxt-gin update`
-
-执行项目约定的更新逻辑。
-
-## 配置
-
-### 1) `server.config.json`
-
-`dev` 命令会读取该文件，常用字段：
-
-- `ginPort`: Gin 服务端口
-- `nuxtPort`: Nuxt 开发端口
-- `baseUrl`: Nuxt baseUrl
-- `killPortBeforeDevelop`: 开发前是否释放端口（默认 `true`）
-- `cleanupBeforeDevelop`: 开发前是否执行 cleanup（默认 `false`）
-
-### 3) 开发环境向前端暴露 `ginPort`
-
-`createDefaultConfig` 会在 Nuxt `runtimeConfig.public` 中注入 `ginPort`：
-
-- 开发环境：`useRuntimeConfig().public.ginPort` 为 `server.config.json` 的 `ginPort`
-- 生产环境：`useRuntimeConfig().public.ginPort` 为 `null`
-- 所有环境：`useRuntimeConfig().public.isDevelopment` 直接暴露当前是否开发环境
-
-前端示例：
-
-```ts
-const config = useRuntimeConfig();
-const ginPort = config.public.ginPort;
-const isDevelopment = config.public.isDevelopment;
-```
-
-### 2) `.go-watch.json`
-
-Go 监听配置文件，示例：
-
-```json
-{
-  "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"]
-}
-```
-
-也支持环境变量指定路径：
-
-```bash
-NUXT_GIN_WATCH_CONFIG=/path/to/.go-watch.json
-```
-
-## 环境依赖
-
-- Node.js
-- pnpm
-- Go（需要运行 Gin 侧开发与依赖下载时）
-- `openapi-generator-cli`（仅 `nuxt-gin gen` 需要）
-
-## 说明
-
-- Go 侧热更新已不再依赖 Air。
-- 当前方案为：`chokidar` 监听文件变化 + 重启 `go run main.go`。
+# nuxt-gin-tools
+
+`nuxt-gin-tools` 是 `nuxt-gin-starter` 的配套开发工具包，提供 Nuxt + Gin 项目的统一命令入口。
+
+核心目标：
+- 一条命令启动前后端开发环境
+- 自动处理 Go 侧依赖和文件监听重启
+- 提供 OpenAPI 代码生成与构建打包辅助
+
+## 功能概览
+
+- `nuxt-gin dev`
+  - 启动 Nuxt 开发服务
+  - 启动 Go 文件监听（基于 `chokidar`）
+  - Go 文件变化后自动重启 `go run main.go`
+- `nuxt-gin install`
+  - 执行 Nuxt prepare
+  - 如果检测到 Go，则执行 `go mod download && go mod tidy`
+- `nuxt-gin gen`
+  - 基于 `openapi.yaml` 生成 Go / TS API 代码
+- `nuxt-gin build`
+  - 执行项目构建与打包流程
+- `nuxt-gin cleanup`
+  - 清理开发产物
+- `nuxt-gin update`
+  - 执行依赖更新流程
+
+## 安装
+
+在 `nuxt-gin-starter` 项目中作为依赖安装：
+
+```bash
+pnpm add nuxt-gin-tools
+```
+
+## 快速开始
+
+```bash
+# 初始化依赖（可选）
+nuxt-gin install
+
+# 启动开发
+nuxt-gin dev
+```
+
+## 命令说明
+
+### `nuxt-gin dev`
+
+开发模式下会并行运行：
+- Nuxt：`npx nuxt dev --port=<nuxtPort> --host`
+- Go：监听变更并运行 `go run main.go`
+
+Go 监听规则来自 `.go-watch.json`（见下文）。
+
+### `nuxt-gin install`
+
+- 总是执行：`npx nuxt prepare`
+- 检测到 Go 时额外执行：`go mod download && go mod tidy`
+
+### `nuxt-gin gen`
+
+依赖 `openapi-generator-cli`，默认会：
+- 生成 Go Gin server 相关代码
+- 生成 TypeScript axios 客户端代码
+
+### `nuxt-gin build`
+
+执行工具链内置的构建与打包逻辑。
+
+### `nuxt-gin cleanup`
+
+清理由工具链生成的临时目录和产物。
+
+### `nuxt-gin update`
+
+执行项目约定的更新逻辑。
+
+## 配置
+
+### 1) `server.config.json`
+
+`dev` 命令会读取该文件，常用字段：
+
+- `ginPort`: Gin 服务端口
+- `nuxtPort`: Nuxt 开发端口
+- `baseUrl`: Nuxt baseUrl
+- `killPortBeforeDevelop`: 开发前是否释放端口（默认 `true`）
+- `cleanupBeforeDevelop`: 开发前是否执行 cleanup（默认 `false`）
+
+### 3) 开发环境向前端暴露 `ginPort`
+
+`createDefaultConfig` 会在 Nuxt `runtimeConfig.public` 中注入 `ginPort`：
+
+- 开发环境：`useRuntimeConfig().public.ginPort` 为 `server.config.json` 的 `ginPort`
+- 生产环境：`useRuntimeConfig().public.ginPort` 为 `null`
+- 所有环境：`useRuntimeConfig().public.isDevelopment` 直接暴露当前是否开发环境
+
+前端示例：
+
+```ts
+const config = useRuntimeConfig();
+const ginPort = config.public.ginPort;
+const isDevelopment = config.public.isDevelopment;
+```
+
+### 2) `.go-watch.json`
+
+Go 监听配置文件，示例：
+
+```json
+{
+  "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"]
+}
+```
+
+也支持环境变量指定路径：
+
+```bash
+NUXT_GIN_WATCH_CONFIG=/path/to/.go-watch.json
+```
+
+## 环境依赖
+
+- Node.js
+- pnpm
+- Go（需要运行 Gin 侧开发与依赖下载时）
+- `openapi-generator-cli`（仅 `nuxt-gin gen` 需要）
+
+## 说明
+
+- Go 侧热更新已不再依赖 Air。
+- 当前方案为：`chokidar` 监听文件变化 + 重启 `go run main.go`。

package/package.json

@@ -1,30 +1,30 @@
-{
-  "name": "nuxt-gin-tools",
-  "version": "0.2.16",
-  "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"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "scripts": {
-    "build": "ts-node build.ts",
-    "publish": "npm publish --access public"
-  },
-  "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"
-  },
-  "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24.0.15",
-    "nuxt": "^4.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.8.3"
-  }
-}
+{
+  "name": "nuxt-gin-tools",
+  "version": "0.2.17",
+  "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"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "scripts": {
+    "build": "ts-node build.ts",
+    "publish": "npm publish --access public"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^24.0.15",
+    "nuxt": "^4.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}

package/src/go-gin-server.json

@@ -1,5 +1,5 @@
-{
-    "apiPath": "server/api",
-    "packageName": "api",
-    "serverPort": "8099"
+{
+    "apiPath": "server/api",
+    "packageName": "api",
+    "serverPort": "8099"
 }

package/src/nuxt-config.js

@@ -85,7 +85,7 @@ function forwardWebSocketToGin(ginPort, req, clientSocket, clientHead) {
 /**
  * 创建默认的 Nuxt 配置。
  */
-function createDefaultConfig({ serverConfig, }) {
+function createDefaultConfig({ serverConfig }) {
     const development = isDevEnvironment();
     const baseUrl = normalizeBaseUrl(serverConfig.baseUrl);
     const publicGinPort = development ? serverConfig.ginPort : null;
@@ -127,6 +127,9 @@ function createDefaultConfig({ serverConfig, }) {
         },
         vite: {
             server: {},
+            optimizeDeps: {
+                include: ["@vue/devtools-core", "@vue/devtools-kit"],
+            },
             plugins: [
                 {
                     name: "nuxt-gin-base-url-proxy",
@@ -134,7 +137,8 @@ function createDefaultConfig({ serverConfig, }) {
                         server.middlewares.use((req, res, next) => {
                             var _a;
                             const requestPath = ((_a = req.url) !== null && _a !== void 0 ? _a : "/").split("?")[0] || "/";
-                            const shouldForward = !isViteInternalRequest(requestPath) && !isBaseUrlRequest(baseUrl, requestPath);
+                            const shouldForward = !isViteInternalRequest(requestPath) &&
+                                !isBaseUrlRequest(baseUrl, requestPath);
                             if (shouldForward) {
                                 forwardToGin(serverConfig.ginPort, req, res);
                                 return;
@@ -145,7 +149,8 @@ function createDefaultConfig({ serverConfig, }) {
                             server.httpServer.on("upgrade", (req, socket, head) => {
                                 var _a;
                                 const requestPath = ((_a = req.url) !== null && _a !== void 0 ? _a : "/").split("?")[0] || "/";
-                                const shouldForward = !isViteInternalRequest(requestPath) && !isBaseUrlRequest(baseUrl, requestPath);
+                                const shouldForward = !isViteInternalRequest(requestPath) &&
+                                    !isBaseUrlRequest(baseUrl, requestPath);
                                 if (shouldForward) {
                                     forwardWebSocketToGin(serverConfig.ginPort, req, socket, head);
                                 }

package/src/pack-config.schema.json

@@ -1,62 +1,62 @@
-{
-  "title": "Nuxt Gin Tools Pack Config",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "extraFiles": {
-      "type": "object",
-      "description": "额外需要打包的文件映射（key: 源文件路径，value: 打包后对应位置）",
-      "additionalProperties": {
-        "type": "string"
-      }
-    },
-    "extraFilesGlobs": {
-      "type": "array",
-      "description": "额外需要打包的文件 Glob（相对于项目根目录）",
-      "items": {
-        "type": "string"
-      }
-    },
-    "exclude": {
-      "type": "array",
-      "description": "排除文件/目录 Glob（相对于项目根目录）",
-      "items": {
-        "type": "string"
-      }
-    },
-    "zipName": {
-      "type": "string",
-      "description": "打包输出 zip 名称（相对于默认 zip 目录）"
-    },
-    "zipPath": {
-      "type": "string",
-      "description": "打包输出 zip 路径（相对于项目根目录或绝对路径）"
-    },
-    "serverPath": {
-      "type": "string",
-      "description": "服务器构建输出目录（相对于项目根目录或绝对路径）"
-    },
-    "beforePack": {
-      "description": "打包前钩子（仅在代码调用传入时生效）"
-    },
-    "afterPack": {
-      "description": "打包后钩子（仅在代码调用传入时生效）"
-    },
-    "cleanDist": {
-      "type": "boolean",
-      "description": "是否清理 dist"
-    },
-    "writeScripts": {
-      "type": "boolean",
-      "description": "是否写入启动脚本和 package.json"
-    },
-    "packageJson": {
-      "type": "object",
-      "description": "写入/覆盖 package.json 内容"
-    },
-    "overwrite": {
-      "type": "boolean",
-      "description": "复制时是否覆盖同名文件"
-    }
-  }
-}
+{
+  "title": "Nuxt Gin Tools Pack Config",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "extraFiles": {
+      "type": "object",
+      "description": "额外需要打包的文件映射（key: 源文件路径，value: 打包后对应位置）",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "extraFilesGlobs": {
+      "type": "array",
+      "description": "额外需要打包的文件 Glob（相对于项目根目录）",
+      "items": {
+        "type": "string"
+      }
+    },
+    "exclude": {
+      "type": "array",
+      "description": "排除文件/目录 Glob（相对于项目根目录）",
+      "items": {
+        "type": "string"
+      }
+    },
+    "zipName": {
+      "type": "string",
+      "description": "打包输出 zip 名称（相对于默认 zip 目录）"
+    },
+    "zipPath": {
+      "type": "string",
+      "description": "打包输出 zip 路径（相对于项目根目录或绝对路径）"
+    },
+    "serverPath": {
+      "type": "string",
+      "description": "服务器构建输出目录（相对于项目根目录或绝对路径）"
+    },
+    "beforePack": {
+      "description": "打包前钩子（仅在代码调用传入时生效）"
+    },
+    "afterPack": {
+      "description": "打包后钩子（仅在代码调用传入时生效）"
+    },
+    "cleanDist": {
+      "type": "boolean",
+      "description": "是否清理 dist"
+    },
+    "writeScripts": {
+      "type": "boolean",
+      "description": "是否写入启动脚本和 package.json"
+    },
+    "packageJson": {
+      "type": "object",
+      "description": "写入/覆盖 package.json 内容"
+    },
+    "overwrite": {
+      "type": "boolean",
+      "description": "复制时是否覆盖同名文件"
+    }
+  }
+}