Merge pull request #31 from EmbarkStudios/specify-edition

Specify edition in CLI

Author: Jake-Shadle

proto-gen/CHANGELOG.md

@@ -9,13 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
+### Changed
+- [PR#31](https://github.com/EmbarkStudios/proto-gen/pull/31) changed the `--format` flag to take a rust edition as an argument, as previously the 2021 edition was hardcoded.
+
 ## [0.2.11] - 2025-01-23
 ### Fixed
 - [PR#30](https://github.com/EmbarkStudios/proto-gen/pull/30) Improvements and fixes to the readme.
+
 ## [0.2.10] - 2025-01-16
 ### Fixed
 - Update dependency `anstream` to `0.6.15` for advisory: <https://rustsec.org/advisories/RUSTSEC-2024-0404>
 - Build fixes that prevented v `0.2.9` from being fully released
+
 ## [0.2.9] - 2025-01-16
 ### Added
 - [PR#27](https://github.com/EmbarkStudios/proto-gen/pull/27) Added `--prepend-header-file` option for specifying a file which will be prepended as a header in generated source files.

proto-gen/src/gen.rs

@@ -27,9 +27,9 @@ pub fn run_generation(
     })?;
     let old = &proto_ws.output_dir;
     let new = &proto_ws.tmp_dir;
-    if gen_opts.format {
-        recurse_fmt(new)?;
-        top_mod_content = fmt(&top_mod_content)?;
+    if let Some(edition) = gen_opts.format.as_deref() {
+        recurse_fmt(new, edition)?;
+        top_mod_content = fmt(&top_mod_content, edition)?;
     }
     let diff = run_diff(old, new, &top_mod_content)?;
     if diff > 0 {
@@ -65,7 +65,7 @@ pub struct ProtoWorkspace {
 #[derive(Debug)]
 pub struct GenOptions {
     pub commit: bool,
-    pub format: bool,
+    pub format: Option<String>,
     pub prepend_header: Option<String>,
     pub toplevel_attribute: Option<String>,
 }
@@ -506,7 +506,7 @@ fn path_from_starts_with(root: &str, path: impl AsRef<Path> + Debug) -> Result<P
     Ok(pb)
 }
 
-fn recurse_fmt(base: impl AsRef<Path>) -> Result<(), String> {
+fn recurse_fmt(base: impl AsRef<Path>, edition: &str) -> Result<(), String> {
     let path = base.as_ref();
     for file in
         fs::read_dir(path).map_err(|e| format!("failed to read_dir for path {path:?} \n{e}"))?
@@ -520,7 +520,7 @@ fn recurse_fmt(base: impl AsRef<Path>) -> Result<(), String> {
             let out = std::process::Command::new("rustfmt")
                 .arg(&path)
                 .arg("--edition")
-                .arg("2021")
+                .arg(edition)
                 .output()
                 .map_err(|e| format!("Failed to format generated code \n{e}"))?;
             if !out.status.success() {
@@ -531,19 +531,19 @@ fn recurse_fmt(base: impl AsRef<Path>) -> Result<(), String> {
                 ));
             }
         } else if metadata.is_dir() {
-            recurse_fmt(path)?;
+            recurse_fmt(path, edition)?;
         }
     }
     Ok(())
 }
 
-fn fmt(code: &str) -> Result<String, String> {
+fn fmt(code: &str, edition: &str) -> Result<String, String> {
     use std::io::Write;
     use std::process::Stdio;
 
     let mut child = std::process::Command::new("rustfmt")
         .arg("--edition")
-        .arg("2021")
+        .arg(edition)
         .stdin(Stdio::piped())
         .stdout(Stdio::piped())
         .spawn()

proto-gen/src/main.rs

@@ -27,9 +27,9 @@ struct Opts {
     #[clap(flatten)]
     tonic: TonicOpts,
 
-    /// Use `rustfmt` on the code after generation, `rustfmt` needs to be on the path.
-    #[clap(short, long)]
-    format: bool,
+    /// Run rustfmt on the generated code with the specified edition
+    #[clap(short, long, value_name = "EDITION")]
+    format: Option<String>,
 
     /// Prepend header indicating tool version in generated source files.
     #[clap(short, long, default_value_t = false)]
@@ -301,7 +301,7 @@ message TestMessage {
         let test_cfg = create_simple_test_cfg(None);
         let opts = Opts {
             tonic: test_cfg.tonic.clone(),
-            format: true,
+            format: Some("2021".into()),
             routine: Routine::Generate {
                 workspace: test_cfg.workspace.clone(),
             },
@@ -313,7 +313,7 @@ message TestMessage {
         run_with_opts(opts).unwrap();
         let opts = Opts {
             tonic: test_cfg.tonic.clone(),
-            format: true,
+            format: Some("2021".into()),
             routine: Routine::Validate {
                 workspace: test_cfg.workspace.clone(),
             },
@@ -325,7 +325,7 @@ message TestMessage {
         run_with_opts(opts).unwrap();
         let opts = Opts {
             tonic: test_cfg.tonic.clone(),
-            format: false,
+            format: None,
             routine: Routine::Validate {
                 workspace: test_cfg.workspace,
             },
@@ -348,7 +348,7 @@ message TestMessage {
         let test_cfg = create_simple_test_cfg(Some(my_output_tmp.path().to_path_buf()));
         let opts = Opts {
             tonic: test_cfg.tonic.clone(),
-            format: false,
+            format: None,
             routine: Routine::Generate {
                 workspace: test_cfg.workspace,
             },
@@ -444,7 +444,7 @@ message NestedTransitiveMsg {
         };
         let opts = Opts {
             tonic,
-            format: false,
+            format: None,
             routine: Routine::Generate { workspace },
             prepend_header: true,
             prepend_header_file: None,