update readme

README.md

@@ -44,13 +44,13 @@ $ export PATH=~/go/bin:$PATH # Add this to your `~/.bashrc`.
 
 ### Dependencies
 
- <!-- by using one of the following methods.
+Use one of the following methods to download:
 
 #### Using trpc setup
 
 After installation of trpc-cmdline, simply running `trpc setup` will automatically install all the dependencies. 
 
-#### Install separately -->
+#### Install separately
 
 <details><summary>Install protoc </summary><br><pre>
 $ # Reference: https://grpc.io/docs/protoc-installation/
@@ -85,6 +85,9 @@ $ # Reference: https://github.com/uber-go/mock
 $ go install go.uber.org/mock/mockgen@latest
 </pre></details>
 
+<details><summary>Install protoc-gen-validate</summary><br><pre>
+$ Please download the binaries in https://github.com/bufbuild/protoc-gen-validate/releases
+</pre></details>
 
 ## Quick Start
 

README.zh_CN.md

@@ -44,13 +44,13 @@ $ export PATH=~/go/bin:$PATH # Add this to your `~/.bashrc`.
 
 ### 安装依赖
 
- <!-- by using one of the following methods.
+ by using one of the following methods.
 
-#### Using trpc setup
+#### 使用 trpc setup 一键安装所有依赖
 
-After installation of trpc-cmdline, simply running `trpc setup` will automatically install all the dependencies. 
+只需要运行 `trpc setup` 便可安装所有依赖。假如有些依赖安装不成功，可以参考下一节进行手动安装。
 
-#### Install separately -->
+#### 手动安装各种依赖
 
 <details><summary>Install protoc </summary><br><pre>
 $ # Reference: https://grpc.io/docs/protoc-installation/
@@ -85,6 +85,9 @@ $ # Reference: https://github.com/uber-go/mock
 $ go install go.uber.org/mock/mockgen@latest
 </pre></details>
 
+<details><summary>Install protoc-gen-validate</summary><br><pre>
+$ Please download the binaries in https://github.com/bufbuild/protoc-gen-validate/releases
+</pre></details>
 
 ## 快速上手
 

cmd/create/create_test.go

@@ -54,6 +54,7 @@ type testcase struct {
 	alias         bool
 	lang          string
 	wantErr       bool
+	opts          []string
 }
 
 func Test_CreateCmd(t *testing.T) {
@@ -130,6 +131,11 @@ func Test_CreateCmd(t *testing.T) {
 			pbdir:   "9-restful",
 			pbfile:  "helloworld.proto",
 			rpconly: true,
+		}, {
+			name:   "10-validate-pgv",
+			pbdir:  "10-validate-pgv",
+			pbfile: "helloworld.proto",
+			opts:   []string{"--validate"},
 		},
 	}
 
@@ -161,7 +167,7 @@ func Test_CreateCmd(t *testing.T) {
 				panic("walk testcase error")
 			}
 
-			opts := []string{}
+			opts := tt.opts
 			for _, d := range dirs {
 				opts = append(opts, "--protodir", d)
 			}

docs/README.md

@@ -49,4 +49,5 @@ The same applies to other languages such as C++, you need to specify `--lang=cpp
 * [example2](examples/example-2/README.md) shows how to use pb option extension features, such as
   * How to add aliases for service names
   * How to add custom tags for fields
+  * How to generate validate.pb.go file
   * How to generate swagger/openapi documentation

docs/README.zh_CN.md

@@ -49,5 +49,6 @@ trpc create -p hello.proto --assetdir=~/.trpc-cmdline-assets/protobuf/asset_go
 * [example2](examples/example-2/README.zh_CN.md) 展示了如何使用 pb option 扩展功能，例如
   * 如何为服务名添加别名
   * 如何为字段添加自定义 tag
+  * 如何生成 validate.pb.go 文件
   * 如何生成 swagger/openapi 文档
   * ...

docs/examples/example-2/README.md

@@ -58,6 +58,49 @@ And when executing `trpc create`, you need to specify the `--gotag` option:
 trpc create -p helloworld.proto -o out --gotag
 ```
 
+## Generating validate.pb.go File
+
+For a complete example, see [/testcase/create/10-validate-pgv/helloworld.proto](/testcase/create/10-validate-pgv/helloworld.proto).
+
+This feature requires the installation of [protoc-gen-validate](https://github.com/bufbuild/protoc-gen-validate). Typically, `trpc setup` can automatically install these dependencies.
+
+Here is an example of a proto file:
+
+```proto
+syntax = "proto3";
+package helloworld;
+
+option go_package="trpc.group/some-example/helloworld";
+
+import "validate/validate.proto";
+
+service HelloSvr {
+    rpc Hello(HelloRequest) returns(HelloResponse);
+}
+
+message HelloRequest {
+    string msg = 1 [(validate.rules).string.email=true];
+}
+
+message HelloResponse {
+    int32 err_code = 1; 
+    string err_msg = 2; 
+}
+```
+
+Points to note:
+
+* The reference is `import "validate/validate.proto";`. You can download this file from the [protoc-gen-validate repository](https://github.com/bufbuild/protoc-gen-validate/blob/main/validate/validate.proto) and specify the path (download this file to `somedir/validate/validate.proto` and specify `-d somedir`). The trpc-cmdline tool has a built-in copy of this file.
+* The syntax for the validation rule `[(validate.rules).string.email=true]` can be found in the [protoc-gen-validate documentation](https://github.com/bufbuild/protoc-gen-validate/blob/v1.0.2/README.md).
+* When generating code, you need to add `--validate=true`, like this:
+  ```shell
+  trpc create -p helloworld.proto -o out --validate
+  ```
+* The generated stub code will include the `xxx.validate.pb.go` file.
+* In the generated project code, the following two locations will automatically add validate-related plugin information:
+  * All `main.go` will add an anonymous reference `import _ "trpc.group/trpc-filter/validation"`
+  * In `trpc_go.yaml`, the client/server filter configuration will include `- validation`
+
 ## Generating swagger/openapi Documentation
 
 The trpc-cmdline tool provides the `trpc apidocs` subcommand to generate documentation. Users can execute `trpc apidocs -h` to view all supported command options.

docs/examples/example-2/README.zh_CN.md

@@ -58,6 +58,49 @@ message Req{
 trpc create -p helloworld.proto -o out --gotag
 ```
 
+## 生成 validate.pb.go 文件
+
+完整示例见 [/testcase/create/10-validate-pgv/helloworld.proto](/testcase/create/10-validate-pgv/helloworld.proto)。
+
+本功能需要安装 [protoc-gen-validate](https://github.com/bufbuild/protoc-gen-validate)，通常来说 `trpc setup` 即可使这些依赖被自动安装完毕。
+
+示例 proto 文件如下：
+
+```proto
+syntax = "proto3";
+package helloworld;
+
+option go_package="trpc.group/some-example/helloworld";
+
+import "validate/validate.proto";
+
+service HelloSvr {
+    rpc Hello(HelloRequest) returns(HelloResponse);
+}
+
+message HelloRequest {
+    string msg = 1 [(validate.rules).string.email=true];
+}
+
+message HelloResponse {
+    int32 err_code = 1; 
+    string err_msg = 2; 
+}
+```
+
+注意事项：
+
+* 引用为 `import "validate/validate.proto";`，这个文件可以自行从 [protoc-gen-validate 仓库](https://github.com/bufbuild/protoc-gen-validate/blob/main/validate/validate.proto) 进行下载并指定路径（将这个文件下载到 `somedir/validate/validate.proto` 然后指定 `-d somedir`），trpc-cmdline 工具内置了一份该文件。
+* 校验规则 ` [(validate.rules).string.email=true]` 的写法可以参考 [protoc-gen-validate 文档](https://github.com/bufbuild/protoc-gen-validate/blob/v1.0.2/README.md)。
+* 在生成代码时需要加上 `--validate=true`，如
+  ```shell
+  trpc create -p helloworld.proto -o out --validate
+  ```
+* 此时生成的桩代码会包含 `xxx.validate.pb.go` 文件
+* 在生成的项目代码中，有以下两个位置会自动添加 validate 相关的插件信息
+  * 所有的 `main.go` 中会添加匿名引用 `import _ "trpc.group/trpc-filter/validation"`
+  * 在 `trpc_go.yaml` 的 client/server 的 filter 配置项会存在 `- validation` 一项
+
 ## 生成 swagger/openapi 文档
 
 trpc-cmdline 工具提供了 `trpc apidocs` 子命令以生成文档，用户可以执行 `trpc apidocs -h` 以查看所有支持的命令选项。

install/trpc.yaml

@@ -29,6 +29,20 @@ tools:
       md5: ""
       repository: "github.com/golang/protobuf/protoc-gen-go"
       fallback: ""
+    - executable: protoc-gen-validate
+      version_min: ""
+      version_cmd: ""
+      artifact_url: "https://github.com/trpc-group/trpc-cmdline/releases/download/v0.0.1-${os}/protoc-gen-validate"
+      md5: ""
+      repository: "https://github.com/bufbuild/protoc-gen-validate/releases"
+      fallback: ""
+    - executable: protoc-gen-validate-go
+      version_min: ""
+      version_cmd: ""
+      artifact_url: "https://github.com/trpc-group/trpc-cmdline/releases/download/v0.0.1-${os}/protoc-gen-validate-go"
+      md5: ""
+      repository: "https://github.com/bufbuild/protoc-gen-validate/releases"
+      fallback: ""
     - executable: goimports
       version_min: ""
       version_cmd: ""