nuxt-gin-tools 0.0.1

package/LICENSE

@@ -0,0 +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.

package/README.md

@@ -0,0 +1,19 @@
+# nuxt-gin-tools
+
+This project is used as a dependency for [nuxt-gin-starter](https://github.com/RapboyGao/nuxt3-gin-starter.git)
+
+## Command: nuxt-gin dev
+
+- Starting the develop server.
+
+## Command: nuxt-gin build
+
+- Build script
+
+## Command: nuxt-gin gen
+
+- Generate API based on openapi.yaml
+
+## Command: nuxt-gin install
+
+- Postinstall script.

package/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/index.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// index.ts - 入口文件，用于处理命令行参数并调用相应的功能模块
+// 导入构建和打包功能
+const pack_1 = __importDefault(require("./src/pack"));
+// 导入开发模式功能
+const develop_1 = __importDefault(require("./src/develop"));
+// 导入API生成功能
+const generate_1 = __importDefault(require("./src/generate"));
+// 导入安装后处理功能
+const postinstall_1 = __importDefault(require("./src/postinstall"));
+// 获取命令行参数（去除前两个默认参数）
+const args = process.argv.slice(2);
+// 检查是否提供了命令
+if (args.length === 0) {
+    console.error("未提供命令。请指定要运行的命令。");
+    process.exit(1);
+}
+// 根据第一个参数执行对应的命令
+switch (args[0]) {
+    case "dev":
+        // 启动开发模式
+        (0, develop_1.default)();
+        break;
+    case "build":
+        // 执行构建和打包操作
+        (0, pack_1.default)();
+        break;
+    case "gen":
+        // 生成API代码（注：此处命令可能拼写错误，应为generate）
+        (0, generate_1.default)();
+        break;
+    case "install":
+        // 执行安装后的初始化操作
+        (0, postinstall_1.default)();
+        break;
+    default:
+        console.error(`未知命令: ${args[0]}`);
+        process.exit(1);
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "nuxt-gin-tools",
+  "version": "0.0.1",
+  "description": "",
+  "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",
+    "concurrently": "^9.2.0",
+    "fs-extra": "^11.3.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^24.0.14",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}

package/src/builder.d.ts

@@ -0,0 +1,2 @@
+export declare function build(): Promise<import("concurrently").CloseEvent[]>;
+export default build;

package/src/builder.js

@@ -0,0 +1,27 @@
+"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 cwd = process.cwd();
+function build() {
+    (0, fs_extra_1.ensureDirSync)((0, path_1.join)(cwd, "vue/.output"));
+    (0, fs_extra_1.ensureFileSync)((0, path_1.join)(cwd, "tmp/production.exe"));
+    return (0, concurrently_1.default)([
+        {
+            command: "go build -o ./tmp/production.exe .",
+            name: "go",
+            prefixColor: "green",
+        },
+        {
+            command: "nuxt generate",
+            name: "nuxt",
+            prefixColor: "blue",
+        },
+    ]).result;
+}
+exports.default = build;

package/src/develop.d.ts

@@ -0,0 +1,2 @@
+export declare function develop(): void;
+export default develop;

package/src/develop.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.develop = develop;
+const concurrently_1 = __importDefault(require("concurrently"));
+const fs_extra_1 = require("fs-extra");
+const os_1 = __importDefault(require("os"));
+const path_1 = require("path");
+const cwd = process.cwd();
+const serverConfig = (0, fs_extra_1.readJSONSync)((0, path_1.join)(cwd, "server.config.json"));
+/**
+ *
+ * @returns {string} 返回air命令的路径
+ * 根据操作系统不同，返回不同的路径
+ * 如果是macOS，返回~/go/bin/air
+ * 如果是其他操作系统，返回air
+ */
+function getAirCommand() {
+    if (os_1.default.platform() === "darwin") {
+        return "~/go/bin/air";
+    }
+    else {
+        return "air";
+    }
+}
+function develop() {
+    (0, concurrently_1.default)([
+        {
+            command: getAirCommand(),
+            name: "go",
+            prefixColor: "green",
+        },
+        {
+            command: `nuxt dev --port=${serverConfig.nuxtPort}`,
+            name: "nuxt",
+            prefixColor: "blue",
+        },
+    ]);
+}
+exports.default = develop;

package/src/generate.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 警告：本文件是API生成框架的一部分，请勿手动修改！
+ * 任何修改可能会被自动化流程覆盖。
+ * 如需调整生成逻辑，请修改相关配置文件或脚本。
+ */
+/**
+ * 主函数
+ * 协调执行所有任务：生成代码、删除路径、配置Vue API
+ */
+export declare function apiGenerate(): Promise<void>;
+export default apiGenerate;

package/src/generate.js

@@ -0,0 +1,121 @@
+"use strict";
+/**
+ * 警告：本文件是API生成框架的一部分，请勿手动修改！
+ * 任何修改可能会被自动化流程覆盖。
+ * 如需调整生成逻辑，请修改相关配置文件或脚本。
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiGenerate = apiGenerate;
+const chalk_1 = __importDefault(require("chalk"));
+const concurrently_1 = __importDefault(require("concurrently")); // 用于并发执行命令的工具
+const fs_extra_1 = __importDefault(require("fs-extra")); // 文件系统操作工具，提供更便捷的API
+const path_1 = __importDefault(require("path")); // 处理和转换文件路径的工具
+const cwd = process.cwd(); // 获取当前工作目录
+/**
+ * 要执行的命令列表
+ * 包含OpenAPI代码生成命令：
+ * 1. 生成Go Gin服务器代码
+ * 2. 生成TypeScript Axios客户端代码
+ */
+let commands = [
+    {
+        command: "openapi-generator-cli generate -i openapi.yaml -g go-gin-server -c node_modules/nuxt3-gin-tools/src/go-gin-server.json -o .",
+        name: "go",
+        prefixColor: "green",
+    },
+    {
+        command: "openapi-generator-cli generate -i openapi.yaml -g typescript-axios -o vue/composables/api ",
+        name: "vue",
+        prefixColor: "blue",
+    },
+];
+/**
+ * 执行完成后需要删除的路径列表
+ */
+const pathsToDelete = ["api"];
+/**
+ * 设置Vue API客户端的基础URL
+ * 修改TypeScript axios生成的base.ts文件，将BASE_PATH设置为相对路径
+ * @returns {Promise<string>} 返回原始文件内容的Promise
+ */
+function setVueBaseUrl() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // 构建Vue API运行时配置文件的完整路径
+            const VUE_API_RUNTIME_PATH = path_1.default.join(cwd, "vue/composables/api/base.ts");
+            // 读取原始文件内容
+            const originalContent = yield fs_extra_1.default.readFile(VUE_API_RUNTIME_PATH, "utf-8");
+            // 使用正则表达式替换BASE_PATH常量，移除协议和域名部分，使其成为相对路径
+            // 匹配类似 "export const BASE_PATH = "https://example.com"" 这样的行
+            const updatedContent = originalContent.replace(/export\s+const\s+BASE_PATH = "https?:\/\/[^/]+/, `export const BASE_PATH = "`);
+            // 将修改后的内容写回文件
+            yield fs_extra_1.default.outputFile(VUE_API_RUNTIME_PATH, updatedContent, "utf-8");
+            console.log("成功更新Vue API基础URL为相对路径");
+            return originalContent;
+        }
+        catch (error) {
+            console.error("更新Vue API基础URL失败:", error);
+            throw error; // 将错误继续抛出，以便上层处理
+        }
+    });
+}
+/**
+ * 删除指定的路径
+ * 用于清理生成过程中产生的临时或不需要的文件和目录
+ */
+function removePaths() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // 遍历要删除的路径列表
+            for (const path of pathsToDelete) {
+                // 构建完整路径
+                const fullPath = path_1.default.join(cwd, path);
+                // 删除路径（文件或目录）
+                yield fs_extra_1.default.remove(fullPath);
+                console.log(`成功删除路径: ${fullPath}`);
+            }
+        }
+        catch (error) {
+            console.error("删除路径失败:", error);
+            throw error; // 将错误继续抛出
+        }
+    });
+}
+/**
+ * 主函数
+ * 协调执行所有任务：生成代码、删除路径、配置Vue API
+ */
+function apiGenerate() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // 输出开始信息
+            console.log(chalk_1.default.bgGreen("开始生成API代码..."));
+            // 并发执行命令列表中的所有命令，等待所有命令完成
+            yield (0, concurrently_1.default)(commands).result;
+            // 按顺序执行清理和配置任务
+            yield removePaths();
+            yield setVueBaseUrl();
+            console.log(chalk_1.default.bgGreen("API代码生成和配置完成!"));
+        }
+        catch (error) {
+            // 捕获并处理任何阶段发生的错误
+            console.error(chalk_1.default.red("执行过程中发生错误:"), error);
+            // 以错误码1退出进程，表示执行失败
+            process.exit(1);
+        }
+    });
+}
+// 执行主函数
+exports.default = apiGenerate;

package/src/go-gin-server.json

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

package/src/pack.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 先generate，让后打包
+ */
+export declare function buildAndPack(): Promise<void>;
+export default buildAndPack;

package/src/pack.js

@@ -0,0 +1,82 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAndPack = buildAndPack;
+const _7zip_min_1 = __importDefault(require("7zip-min"));
+const chalk_1 = __importDefault(require("chalk"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const builder_1 = __importDefault(require("./builder"));
+const cwd = process.cwd();
+/**
+ * @param  {...string} names 路径名称
+ * @returns 相对于Workspace位置的路径名称
+ */
+function p(...names) {
+    return path_1.default.join(cwd, ...names);
+}
+/** 打包文件夹相对于Workspace位置 */
+const DIST_PACKAGE = "dist/package";
+/** 需要打包的文件相对位置列表 */
+const FILE_LIST = ["vue/.output", "tmp/production.exe", "ecosystem.config.js", "server.config.json"];
+/** package.json 文件夹相对于Workspace位置 */
+const PACKAGE_JSON = DIST_PACKAGE + "/package.json";
+/** 打包package.7z位置 */
+const _7Z_PATH = DIST_PACKAGE + "/../package.7z";
+/** package.json 内容 */
+const PACKAGE_JSON_CONTENT = {
+    private: true,
+    scripts: {
+        start: "./tmp/production.exe",
+    },
+};
+/**
+ * 把FILE_LIST中的文件拷贝到DIST_PACKAGE的对应位置
+ */
+function copyFiles() {
+    for (const path of FILE_LIST) {
+        fs_extra_1.default.copySync(p(path), p(DIST_PACKAGE, path));
+    }
+}
+function writeScriptFiles() {
+    fs_extra_1.default.outputFileSync(p(DIST_PACKAGE, "start.bat"), `powershell -ExecutionPolicy ByPass -File ./start.ps1`);
+    fs_extra_1.default.outputFileSync(p(DIST_PACKAGE, "start.ps1"), `./tmp/production.exe`);
+    fs_extra_1.default.outputFileSync(p(DIST_PACKAGE, "start.sh"), `./tmp/production.exe`);
+}
+/**
+ * 打包文件为7z格式
+ */
+function pack() {
+    return __awaiter(this, void 0, void 0, function* () {
+        fs_extra_1.default.removeSync(p(DIST_PACKAGE));
+        fs_extra_1.default.removeSync(p(_7Z_PATH));
+        copyFiles();
+        writeScriptFiles();
+        fs_extra_1.default.outputJSONSync(p(PACKAGE_JSON), PACKAGE_JSON_CONTENT, { spaces: 2 });
+        _7zip_min_1.default.pack(p(DIST_PACKAGE), p(_7Z_PATH), () => {
+            fs_extra_1.default.removeSync(p(DIST_PACKAGE));
+        });
+    });
+}
+/**
+ * 先generate，让后打包
+ */
+function buildAndPack() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, builder_1.default)();
+        yield pack();
+        console.log(chalk_1.default.bgGreen("打包完成!", _7Z_PATH));
+    });
+}
+exports.default = buildAndPack;

package/src/postinstall.d.ts

@@ -0,0 +1,2 @@
+export declare function postInstall(): Promise<import("concurrently").CloseEvent[]>;
+export default postInstall;

package/src/postinstall.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postInstall = postInstall;
+const concurrently_1 = __importDefault(require("concurrently"));
+function postInstall() {
+    // 执行并发命令
+    return (0, concurrently_1.default)([
+        {
+            command: "go mod download && go mod tidy",
+            name: "go",
+            prefixColor: "green",
+        },
+        {
+            command: "nuxt prepare",
+            name: "nuxt",
+            prefixColor: "blue",
+        },
+    ]).result;
+}
+exports.default = postInstall;