feat(volo-build): add with_comments option for codegen builder (#631)

* feat(volo-build): add with_comments option for codegen builder

* chore(volo-grpc): allow large result to avoid breaking change

Author: Ggiggle

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "volo-build"
-version = "0.12.0"
+version = "0.12.1"
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true

volo-build/Cargo.toml

@@ -178,6 +178,15 @@ impl InnerBuilder {
             }
         }
     }
+
+    pub fn with_comments(self, with_comments: bool) -> Self {
+        match self {
+            InnerBuilder::Protobuf(inner) => {
+                InnerBuilder::Protobuf(inner.with_comments(with_comments))
+            }
+            InnerBuilder::Thrift(inner) => InnerBuilder::Thrift(inner.with_comments(with_comments)),
+        }
+    }
 }
 
 impl ConfigBuilder {
@@ -229,6 +238,7 @@ impl ConfigBuilder {
                     .dedup(entry.common_option.dedups)
                     .with_descriptor(entry.common_option.with_descriptor)
                     .with_field_mask(entry.common_option.with_field_mask)
+                    .with_comments(entry.common_option.with_comments)
                     .write()?;
 
                 Ok(())

volo-build/src/config_builder.rs

@@ -153,6 +153,11 @@ impl<MkB, Parser> Builder<MkB, Parser> {
         self.pilota_builder = self.pilota_builder.with_field_mask(with_field_mask);
         self
     }
+
+    pub fn with_comments(mut self, with_comments: bool) -> Self {
+        self.pilota_builder = self.pilota_builder.with_comments(with_comments);
+        self
+    }
 }
 
 impl<MkB, P> Builder<MkB, P>

volo-build/src/lib.rs

@@ -28,6 +28,8 @@ pub struct CommonOption {
     pub with_descriptor: bool,
     #[serde(default, skip_serializing_if = "is_false")]
     pub with_field_mask: bool,
+    #[serde(default, skip_serializing_if = "is_false")]
+    pub with_comments: bool,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone)]

volo-build/src/model.rs

@@ -939,6 +939,7 @@ mod tests {
             false,
             false,
             false,
+            false,
         )
     }
 

volo-build/src/thrift_backend.rs

@@ -109,6 +109,7 @@ where
             .split_generated_files(config.common_option.split_generated_files)
             .with_descriptor(config.common_option.with_descriptor)
             .with_field_mask(config.common_option.with_field_mask)
+            .with_comments(config.common_option.with_comments)
             .pilota_builder
             .compile_with_config(idl_services, pilota_build::Output::Workspace(work_dir));
     }
@@ -175,4 +176,9 @@ where
         self.pilota_builder = self.pilota_builder.with_field_mask(with_field_mask);
         self
     }
+
+    pub fn with_comments(mut self, with_comments: bool) -> Self {
+        self.pilota_builder = self.pilota_builder.with_comments(with_comments);
+        self
+    }
 }

volo-build/src/workspace.rs

@@ -1,6 +1,6 @@
 [package]
 name = "volo-cli"
-version = "0.12.0"
+version = "0.12.1"
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true

volo-cli/Cargo.toml

@@ -52,6 +52,7 @@ impl CliCommand for Migrate {
                             split_generated_files: false,
                             with_descriptor: false,
                             with_field_mask: false,
+                            with_comments: false,
                         },
                     };
 

volo-cli/src/migrate.rs

@@ -4,6 +4,7 @@
 #![cfg_attr(not(doctest), doc = include_str!("../README.md"))]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![allow(clippy::result_large_err)]
 
 pub mod body;
 pub mod client;