ts-proto-client 1.0.0 → 1.0.2

package/README.md

@@ -1,14 +1,14 @@
 # ts-proto-client
 
-基于 Proto 文件自动生成 TypeScript 类型、请求接口及 Hooks 的 CLI 工具。
+基于 Proto 文件自动生成 TypeScript 类型和 API 请求代码的 CLI 工具。
 
 ## 功能
 
-- 自动解析 Proto 文件
-- 生成 TypeScript 类型定义
-- 生成 API 请求方法
-- 生成 React Hooks（规划中）
-- 支持远程 Proto 仓库同步（规划中）
+* 根据 `.proto` 文件生成 TypeScript 类型
+* 根据 Service 定义生成 API 请求方法
+* 支持自定义 Proto 根目录
+* 支持自定义类型输出目录
+* 支持自定义 API 输出目录
 
 ---
 
@@ -40,11 +40,11 @@ libprotoc 35.1
 
 ### Windows
 
-1. 打开 Protocol Buffers Releases 页面：
+1. 打开 Protocol Buffers Releases 页面
 
 https://github.com/protocolbuffers/protobuf/releases
 
-2. 下载对应版本：
+2. 下载对应版本
 
 ```text
 protoc-35.1-win64.zip
@@ -66,7 +66,7 @@ D:\protoc
 └─ readme.txt
 ```
 
-4. 将以下目录添加到系统环境变量 `Path`：
+4. 将以下目录添加到系统环境变量：
 
 ```text
 D:\protoc\bin
@@ -88,109 +88,130 @@ libprotoc 35.1
 
 ## 使用方式
 
-### 初始化配置
-
-在项目根目录执行：
+### 生成代码
 
 ```bash
-npx proto-gen init
+npx proto-gen generate \
+  --file ./account.proto \
+  --root ../protos \
+  --type-output src/protos/type \
+  --api-output src/protos/api/account
 ```
 
-执行后会生成配置文件：
+### 参数说明
 
-```text
-proto.config.json
-```
+| 参数              | 必填 | 说明                        |
+| --------------- | -- | ------------------------- |
+| `--file`        | 是  | Proto 文件路径（相对于 Proto 根目录） |
+| `--root`        | 是  | Proto 根目录                 |
+| `--type-output` | 是  | TypeScript 类型输出目录         |
+| `--api-output`  | 是  | API 文件输出目录                |
 
-示例：
+---
 
-```json
-{
-  "ProtoRoot": "../protos",
-  "ProtoInput": "hospital/hospital.proto",
-  "ProtoTypeOutputPath": "./src/proto-type",
-  "ApiOutputPath": "./src/api"
-}
-```
+## 示例
 
----
+目录结构：
 
-### 生成 TypeScript 类型和接口
+```text
+project
+├─ src
+├─ protos
+│  ├─ hospital
+│  │  └─ account.proto
+│  └─ third_party
+└─ package.json
+```
+
+执行：
 
 ```bash
-npx proto-gen generate
+npx proto-gen generate \
+  --file hospital/account.proto \
+  --root ./protos \
+  --type-output src/protos/type \
+  --api-output src/protos/api/account
 ```
 
-执行后将根据配置自动生成：
+生成：
 
 ```text
 src
-├─ proto-type
-│  └─ *.ts
-└─ api
-    └─ *.ts
+└─ protos
+    ├─ type
+    │  └─ account.ts
+    └─ api
+        └─ account.ts
 ```
 
 ---
 
-## 配置说明
+## 本地开发
 
-| 字段 | 说明 |
-|--------|--------|
-| ProtoRoot | Proto 根目录 |
-| ProtoInput | 入口 Proto 文件 |
-| ProtoTypeOutputPath | TypeScript 类型输出目录 |
-| ApiOutputPath | API 文件输出目录 |
+启动开发模式：
 
-示例：
+```bash
+pnpm dev generate \
+  --file hospital/account.proto \
+  --root ../protos \
+  --type-output src/protos/type \
+  --api-output src/protos/api/account
+```
 
-```json
-{
-  "ProtoRoot": "../protos",
-  "ProtoInput": "hospital/hospital.proto",
-  "ProtoTypeOutputPath": "./src/proto-type",
-  "ApiOutputPath": "./src/api"
-}
+---
+
+## 常见问题
+
+### protoc: command not found
+
+请确认已经正确安装 protoc，并配置到环境变量：
+
+```bash
+protoc --version
 ```
 
+能够正常输出版本号。
+
 ---
 
-## 命令
+### File does not reside within any path specified using --proto_path
 
-### 初始化配置
+请检查：
 
 ```bash
-npx proto-gen init
+--file
 ```
 
-### 生成代码
+指定的文件是否位于：
 
 ```bash
-npx proto-gen generate
+--root
 ```
 
----
+指定的目录之下。
+
+例如：
+
+```bash
+--root ./protos
+--file hospital/account.proto
+```
 
-## 目录示例
+则实际文件应存在：
 
 ```text
-project
-├─ proto.config.json
-├─ src
-│  ├─ api
-│  └─ proto-type
-└─ protos
+./protos/hospital/account.proto
 ```
 
 ---
 
-## 版本要求
+## 环境要求
 
-- Node.js >= 18
-- Protocol Buffers (protoc) >= 35
+* Node.js >= 18
+* protoc >= 35
 
 ---
 
 ## License
 
-MIT
+MIT

package/dist/index.js

@@ -3,67 +3,18 @@
 // 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 fs4 from "fs";
 import path4 from "path";
 
 // src/generators/api.ts
-import fs3 from "fs";
+import fs2 from "fs";
 import path2 from "path";
 
 // src/utils/index.ts
 import { Root, Service } from "protobufjs";
 import path from "path";
-import fs2 from "fs";
+import fs from "fs";
 
 // src/constants.ts
 var HTTP_METHODS = [
@@ -87,7 +38,7 @@ function createRoot(rootPath) {
         includePath,
         target
       );
-      if (fs2.existsSync(filePath)) {
+      if (fs.existsSync(filePath)) {
         return filePath;
       }
     }
@@ -181,19 +132,24 @@ function generateApiCode(apis, importTypePath) {
   }
   return modules;
 }
+function getOutputPath(baseDir, protoFile) {
+  const normalized = protoFile.replace(/\\/g, "/").replace(/^\.?\//, "").replace(/\.proto$/, "");
+  return path.join(baseDir, normalized);
+}
 
 // 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 });
+function generateApi(options) {
+  const outputPath = path2.resolve(process.cwd(), options.apiOutput);
+  if (!fs2.existsSync(outputPath)) {
+    fs2.mkdirSync(outputPath, { recursive: true });
   }
-  const apis = parseProto(config.ProtoRoot, config.ProtoInput);
-  const codes = generateApiCode(apis, config.ImportTypePath);
+  const apis = parseProto(options.root, options.file);
+  const result = getOutputPath(options.typeOutput, options.file);
+  const relativePath = path2.relative(options.apiOutput, result).replace(/\\/g, "/");
+  const codes = generateApiCode(apis, relativePath);
   for (const code of codes) {
     for (const [name, content] of Object.entries(code)) {
-      fs3.writeFileSync(`${outputPath}/${name}.ts`, content, "utf8");
+      fs2.writeFileSync(`${outputPath}/${name}.ts`, content, "utf8");
     }
   }
   console.log("\u2705 Generate Success");
@@ -202,20 +158,19 @@ function generateApi() {
 // src/generators/type.ts
 import { execSync } from "child_process";
 import { createRequire } from "module";
-import fs4 from "fs";
+import fs3 from "fs";
 import path3 from "path";
-function generateTypes() {
+function generateTypes(options) {
   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 outputPath = path3.resolve(process.cwd(), options.typeOutput);
+  if (!fs3.existsSync(outputPath)) {
+    fs3.mkdirSync(outputPath, { recursive: true });
   }
-  const rootPath = path3.resolve(process.cwd(), config.ProtoRoot);
+  const rootPath = path3.resolve(process.cwd(), options.root);
   const configs = [
     "protoc",
     `--plugin=protoc-gen-ts_proto=${pluginPath}`,
@@ -226,44 +181,50 @@ function generateTypes() {
     // 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)
+    path3.join(rootPath, options.file)
   ];
   execSync(configs.join(" "), { stdio: "inherit" });
-  fs4.rmSync(
+  fs3.rmSync(
     path3.join(outputPath, "google"),
     { recursive: true, force: true }
   );
-  fs4.rmSync(
+  fs3.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})`);
+async function generate(options) {
+  if (!fs4.existsSync(path4.resolve(process.cwd(), options.root))) {
+    console.log(`proto \u9879\u76EE\u4E0D\u5B58\u5728(${options.root})`);
     return;
   }
-  generateTypes();
-  generateApi();
+  generateTypes(options);
+  generateApi(options);
 }
 
 // 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.command("generate").option("--file, --file <path>").option("--root, --root <path>").option("--type-output, --typeOutput <path>").option("--api-output, --apiOutput <path>").action((options) => {
+  if (options.file === void 0) {
+    console.log("proto file \u4E0D\u80FD\u4E3A\u7A7A, \u8BF7\u8F93\u5165 --file ./account.proto");
+    return;
+  }
+  if (options.root === void 0) {
+    console.log("proto \u6587\u4EF6\u7684\u6839\u8DEF\u5F84\u4E0D\u80FD\u4E3A\u7A7A, \u8BF7\u8F93\u5165 --root ../protos");
+    return;
+  }
+  if (options.typeOutput === void 0) {
+    options.typeOutput = "src/protos/type";
+  }
+  if (options.apiOutput === void 0) {
+    options.apiOutput = "src/protos/api";
+  }
+  generate(options);
+});
 program.parse();

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "ts-proto-client",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "",
   "scripts": {
     "dev": "tsx src/index.ts",
-    "build": "tsup src/index.ts --format esm --clean"
+    "build": "tsup src/index.ts --format esm --clean",
+    "release": "pnpm build && npm publish"
   },
   "bin": {
     "proto-gen": "./dist/index.js"