ts-proto-client 1.0.0

package/README.md

@@ -0,0 +1,196 @@
+# ts-proto-client
+
+基于 Proto 文件自动生成 TypeScript 类型、请求接口及 Hooks 的 CLI 工具。
+
+## 功能
+
+- 自动解析 Proto 文件
+- 生成 TypeScript 类型定义
+- 生成 API 请求方法
+- 生成 React Hooks（规划中）
+- 支持远程 Proto 仓库同步（规划中）
+
+---
+
+## 安装前准备
+
+本工具依赖 `protoc`，请先安装 Protocol Buffers 编译器。
+
+### macOS
+
+安装：
+
+```bash
+brew install protobuf
+```
+
+验证：
+
+```bash
+protoc --version
+```
+
+输出示例：
+
+```text
+libprotoc 35.1
+```
+
+---
+
+### Windows
+
+1. 打开 Protocol Buffers Releases 页面：
+
+https://github.com/protocolbuffers/protobuf/releases
+
+2. 下载对应版本：
+
+```text
+protoc-35.1-win64.zip
+```
+
+3. 解压到目录，例如：
+
+```text
+D:\protoc
+```
+
+目录结构：
+
+```text
+D:\protoc
+├─ bin
+│  └─ protoc.exe
+├─ include
+└─ readme.txt
+```
+
+4. 将以下目录添加到系统环境变量 `Path`：
+
+```text
+D:\protoc\bin
+```
+
+5. 打开新的终端验证：
+
+```bash
+protoc --version
+```
+
+输出示例：
+
+```text
+libprotoc 35.1
+```
+
+---
+
+## 使用方式
+
+### 初始化配置
+
+在项目根目录执行：
+
+```bash
+npx proto-gen init
+```
+
+执行后会生成配置文件：
+
+```text
+proto.config.json
+```
+
+示例：
+
+```json
+{
+  "ProtoRoot": "../protos",
+  "ProtoInput": "hospital/hospital.proto",
+  "ProtoTypeOutputPath": "./src/proto-type",
+  "ApiOutputPath": "./src/api"
+}
+```
+
+---
+
+### 生成 TypeScript 类型和接口
+
+```bash
+npx proto-gen generate
+```
+
+执行后将根据配置自动生成：
+
+```text
+src
+├─ proto-type
+│  └─ *.ts
+└─ api
+    └─ *.ts
+```
+
+---
+
+## 配置说明
+
+| 字段 | 说明 |
+|--------|--------|
+| ProtoRoot | Proto 根目录 |
+| ProtoInput | 入口 Proto 文件 |
+| ProtoTypeOutputPath | TypeScript 类型输出目录 |
+| ApiOutputPath | API 文件输出目录 |
+
+示例：
+
+```json
+{
+  "ProtoRoot": "../protos",
+  "ProtoInput": "hospital/hospital.proto",
+  "ProtoTypeOutputPath": "./src/proto-type",
+  "ApiOutputPath": "./src/api"
+}
+```
+
+---
+
+## 命令
+
+### 初始化配置
+
+```bash
+npx proto-gen init
+```
+
+### 生成代码
+
+```bash
+npx proto-gen generate
+```
+
+---
+
+## 目录示例
+
+```text
+project
+├─ proto.config.json
+├─ src
+│  ├─ api
+│  └─ proto-type
+└─ protos
+```
+
+---
+
+## 版本要求
+
+- Node.js >= 18
+- Protocol Buffers (protoc) >= 35
+
+---
+
+## License
+
+MIT

package/dist/index.js

@@ -0,0 +1,269 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import { Command } from "commander";
+
+// src/commands/init.ts
+import prompts from "prompts";
+import fs from "fs";
+var ConfigFilePath = "proto.config.json";
+async function init() {
+  const answers = await prompts([
+    {
+      type: "text",
+      name: "ProtoRoot",
+      message: "proto \u8F93\u5165\u6587\u4EF6",
+      initial: "../protos"
+    },
+    {
+      type: "text",
+      name: "ProtoInputPath",
+      message: "proto \u8F93\u5165\u6587\u4EF6",
+      initial: "hospital/hospital.proto"
+    },
+    {
+      type: "text",
+      name: "ProtoTypeOutputPath",
+      message: "\u7C7B\u578B\u8F93\u51FA\u8DEF\u5F84",
+      initial: "dist/proto-type"
+    },
+    {
+      type: "text",
+      name: "ProtoApiOutputPath",
+      message: "\u63A5\u53E3\u8F93\u51FA\u8DEF\u5F84",
+      initial: "dist/proto-api"
+    },
+    {
+      type: "text",
+      name: "ImportTypePath",
+      message: "\u7C7B\u578B\u6587\u4EF6\u5BFC\u5165\u63A5\u53E3\u7684\u8DEF\u5F84",
+      initial: "../proto-type/hospital/hospital"
+    }
+  ]);
+  const content = [
+    "{",
+    `  "ProtoRoot": "${answers.ProtoRoot}",`,
+    `  "ProtoInput": "${answers.ProtoInputPath}",`,
+    `  "ProtoTypeOutputPath": "${answers.ProtoTypeOutputPath}",`,
+    `  "ProtoApiOutputPath": "${answers.ProtoApiOutputPath}",`,
+    `  "ImportTypePath": "${answers.ImportTypePath}"`,
+    "}"
+  ].join("\n");
+  fs.writeFileSync(ConfigFilePath, content);
+}
+
+// src/commands/generate.ts
+import fs5 from "fs";
+import path4 from "path";
+
+// src/generators/api.ts
+import fs3 from "fs";
+import path2 from "path";
+
+// src/utils/index.ts
+import { Root, Service } from "protobufjs";
+import path from "path";
+import fs2 from "fs";
+
+// src/constants.ts
+var HTTP_METHODS = [
+  "get",
+  "post",
+  "put",
+  "delete",
+  "patch"
+];
+
+// src/utils/index.ts
+function createRoot(rootPath) {
+  const INCLUDE_PATHS = [
+    rootPath,
+    path.join(rootPath, "/third_party/googleapis")
+  ];
+  const root = new Root();
+  root.resolvePath = (_, target) => {
+    for (const includePath of INCLUDE_PATHS) {
+      const filePath = path.join(
+        includePath,
+        target
+      );
+      if (fs2.existsSync(filePath)) {
+        return filePath;
+      }
+    }
+    return target;
+  };
+  return root;
+}
+function findServices(namespace, result = []) {
+  if (!namespace.nested) return result;
+  for (const item of Object.values(namespace.nested)) {
+    if (item instanceof Service) {
+      result.push(item);
+    }
+    findServices(item, result);
+  }
+  return result;
+}
+function getHttpInfo(method) {
+  const http = method.parsedOptions?.find(
+    (item) => item["(google.api.http)"]
+  )?.["(google.api.http)"];
+  if (!http) return null;
+  const methodName = HTTP_METHODS.find(
+    (key) => http[key]
+  );
+  if (!methodName) return null;
+  return {
+    method: methodName,
+    url: http[methodName],
+    summary: method.options?.["(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation).summary"]
+  };
+}
+function parseProto(protosPath, protoFilePath) {
+  const rootPath = path.resolve(process.cwd(), protosPath);
+  const root = createRoot(rootPath);
+  root.loadSync(path.join(rootPath, protoFilePath));
+  const services = findServices(root);
+  const apis = {};
+  for (const service of services) {
+    const api = [];
+    for (const method of Object.values(service.methods)) {
+      const httpInfo = getHttpInfo(method);
+      if (!httpInfo) continue;
+      api.push({
+        name: method.name,
+        requestType: method.requestType,
+        responseType: method.responseType,
+        ...httpInfo
+      });
+    }
+    apis[service.name] = api;
+  }
+  return apis;
+}
+function generateApiCode(apis, importTypePath) {
+  const modules = [];
+  for (const [key, api] of Object.entries(apis)) {
+    const types = /* @__PURE__ */ new Set();
+    const functions = [];
+    for (const data of api) {
+      types.add(data.requestType);
+      types.add(data.responseType);
+      const requestField = data.method === "get" ? "params: data" : "data";
+      const lines = [];
+      if (data.summary) lines.push(`// ${data.summary}`);
+      lines.push(
+        `export function ${data.name}(data: ${data.requestType}) {`,
+        `  return service<${data.responseType}>({`,
+        `    url: "${data.url.replace("/api", "")}",`,
+        `    method: "${data.method}",`,
+        `    ${requestField}`,
+        `  })`,
+        `}`
+      );
+      functions.push(
+        lines.join("\n")
+      );
+    }
+    const imports = [...types].sort();
+    modules.push({
+      [key]: [
+        `import { service } from "@/plugins";`,
+        "",
+        "import type {",
+        `  ${imports.join(",\n  ")}`,
+        `} from "${importTypePath}";`,
+        "",
+        functions.join("\n\n")
+      ].join("\n")
+    });
+  }
+  return modules;
+}
+
+// src/generators/api.ts
+function generateApi() {
+  const config = JSON.parse(fs3.readFileSync("proto.config.json", "utf8"));
+  const outputPath = path2.resolve(process.cwd(), config.ProtoApiOutputPath);
+  if (!fs3.existsSync(outputPath)) {
+    fs3.mkdirSync(outputPath, { recursive: true });
+  }
+  const apis = parseProto(config.ProtoRoot, config.ProtoInput);
+  const codes = generateApiCode(apis, config.ImportTypePath);
+  for (const code of codes) {
+    for (const [name, content] of Object.entries(code)) {
+      fs3.writeFileSync(`${outputPath}/${name}.ts`, content, "utf8");
+    }
+  }
+  console.log("\u2705 Generate Success");
+}
+
+// src/generators/type.ts
+import { execSync } from "child_process";
+import { createRequire } from "module";
+import fs4 from "fs";
+import path3 from "path";
+function generateTypes() {
+  const require2 = createRequire(import.meta.url);
+  const tsProtoPkg = require2.resolve("ts-proto/package.json");
+  const tsProtoRoot = path3.dirname(tsProtoPkg);
+  const pluginName = process.platform === "win32" ? "protoc-gen-ts_proto.cmd" : "protoc-gen-ts_proto";
+  const pluginPath = path3.resolve(tsProtoRoot, `./node_modules/.bin/${pluginName}`);
+  const config = JSON.parse(fs4.readFileSync("proto.config.json", "utf8"));
+  const outputPath = path3.resolve(process.cwd(), config.ProtoTypeOutputPath);
+  if (!fs4.existsSync(outputPath)) {
+    fs4.mkdirSync(outputPath, { recursive: true });
+  }
+  const rootPath = path3.resolve(process.cwd(), config.ProtoRoot);
+  const configs = [
+    "protoc",
+    `--plugin=protoc-gen-ts_proto=${pluginPath}`,
+    `--ts_proto_out=${outputPath}`,
+    "--ts_proto_opt=onlyTypes=true",
+    // 仅生成 TypeScript
+    "--ts_proto_opt=useOptionals=messages",
+    // message 字段生成可选属性
+    "--ts_proto_opt=esModuleInterop=true",
+    // 使用 ES Module 风格导入
+    "--ts_proto_opt=comments=false",
+    // 去掉注释
+    `--proto_path=${rootPath}`,
+    `--proto_path=${path3.join(rootPath, "/third_party/googleapis")}`,
+    // protos 中的 google 依赖
+    path3.join(rootPath, config.ProtoInput)
+  ];
+  execSync(configs.join(" "), { stdio: "inherit" });
+  fs4.rmSync(
+    path3.join(outputPath, "google"),
+    { recursive: true, force: true }
+  );
+  fs4.rmSync(
+    path3.join(outputPath, "common.ts"),
+    { force: true }
+  );
+}
+
+// src/commands/generate.ts
+async function generate() {
+  if (!fs5.existsSync("proto.config.json")) {
+    console.log("\u8BF7\u521D\u59CB\u5316\u914D\u7F6E");
+    return;
+  }
+  const config = JSON.parse(
+    fs5.readFileSync("proto.config.json", "utf8")
+  );
+  if (!fs5.existsSync(path4.resolve(process.cwd(), config.ProtoRoot))) {
+    console.log(`proto \u9879\u76EE\u4E0D\u5B58\u5728(${config.ProtoRoot})`);
+    return;
+  }
+  generateTypes();
+  generateApi();
+}
+
+// src/index.ts
+var program = new Command();
+program.name("proto-gen").description("proto code generator").version("1.0.0");
+program.command("init").action(init);
+program.command("generate").action(generate);
+program.parse();

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "ts-proto-client",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "",
+  "scripts": {
+    "dev": "tsx src/index.ts",
+    "build": "tsup src/index.ts --format esm --clean"
+  },
+  "bin": {
+    "proto-gen": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "packageManager": "pnpm@10.14.0",
+  "dependencies": {
+    "commander": "^15.0.0",
+    "prompts": "^2.4.2",
+    "protobufjs": "^8.6.3",
+    "ts-proto": "^2.11.8"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.3",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.5.1",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3"
+  }
+}