replace rustfmt with prettyplease for codegen (#971)

yoshuawuyts · web-flow · commit 58ade720598f · 2024-06-09T02:09:18.000Z
* replace `rustfmt` with `prettyplease` for codegen

* rename the `rustfmt` cli option to `format`
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -27,6 +27,8 @@ heck = { version = "0.5" }
 pulldown-cmark = { version = "0.9", default-features = false }
 clap = { version = "4.3.19", features = ["derive"] }
 indexmap = "2.0.0"
+prettyplease = "0.2.20"
+syn = { version = "2.0", features = ["printing"] }
 
 wasmparser = "0.209.0"
 wasm-encoder = "0.209.0"
diff --git a/crates/core/src/source.rs b/crates/core/src/source.rs
@@ -118,6 +118,10 @@ impl Source {
     pub fn as_mut_string(&mut self) -> &mut String {
         &mut self.s
     }
+
+    pub fn as_str(&self) -> &str {
+        &self.s
+    }
 }
 
 impl Write for Source {
diff --git a/crates/guest-rust/macro/Cargo.toml b/crates/guest-rust/macro/Cargo.toml
@@ -17,8 +17,10 @@ test = false
 
 [dependencies]
 proc-macro2 = "1.0"
-syn = { version = "2.0", features = ["printing"] }
 quote = "1"
 wit-bindgen-core = { workspace = true }
 wit-bindgen-rust = { workspace = true }
 anyhow = { workspace = true }
+syn = { workspace = true }
+prettyplease = { workspace = true }
+
diff --git a/crates/guest-rust/macro/src/lib.rs b/crates/guest-rust/macro/src/lib.rs
@@ -191,15 +191,12 @@ impl Config {
             let n = INVOCATION.fetch_add(1, Relaxed);
             let path = root.join(format!("{world_name}{n}.rs"));
 
-            std::fs::write(&path, &src).unwrap();
-
             // optimistically format the code but don't require success
-            drop(
-                std::process::Command::new("rustfmt")
-                    .arg(&path)
-                    .arg("--edition=2021")
-                    .output(),
-            );
+            let contents = match fmt(&src) {
+                Ok(formatted) => formatted,
+                Err(_) => src.clone(),
+            };
+            std::fs::write(&path, contents.as_bytes()).unwrap();
 
             src = format!("include!({path:?});");
         }
@@ -472,3 +469,9 @@ fn with_field_parse(input: ParseStream<'_>) -> Result<(String, String)> {
 
     Ok((interface, buf))
 }
+
+/// Format a valid Rust string
+fn fmt(input: &str) -> Result<String> {
+    let syntax_tree = syn::parse_file(&input)?;
+    Ok(prettyplease::unparse(&syntax_tree))
+}
diff --git a/crates/rust/Cargo.toml b/crates/rust/Cargo.toml
@@ -23,6 +23,8 @@ wasm-metadata = { workspace = true }
 heck = { workspace = true }
 clap = { workspace = true, optional = true }
 indexmap = { workspace = true }
+syn = { workspace = true }
+prettyplease = { workspace = true }
 
 [dev-dependencies]
 wit-bindgen = { path = '../guest-rust' }
diff --git a/crates/rust/src/lib.rs b/crates/rust/src/lib.rs
@@ -4,9 +4,7 @@ use heck::*;
 use indexmap::IndexSet;
 use std::collections::{BTreeMap, HashMap, HashSet};
 use std::fmt::{self, Write as _};
-use std::io::{Read, Write};
 use std::mem;
-use std::process::{Command, Stdio};
 use std::str::FromStr;
 use wit_bindgen_core::abi::{Bitcast, WasmType};
 use wit_bindgen_core::{
@@ -86,9 +84,9 @@ fn parse_with(s: &str) -> Result<(String, String), String> {
 #[derive(Default, Debug, Clone)]
 #[cfg_attr(feature = "clap", derive(clap::Args))]
 pub struct Opts {
-    /// Whether or not `rustfmt` is executed to format generated code.
+    /// Whether or not a formatter is executed to format generated code.
     #[cfg_attr(feature = "clap", arg(long))]
-    pub rustfmt: bool,
+    pub format: bool,
 
     /// If true, code generation should qualify any features that depend on
     /// `std` with `cfg(feature = "std")`.
@@ -1022,28 +1020,9 @@ impl WorldGenerator for RustWasm {
         }
 
         let mut src = mem::take(&mut self.src);
-        if self.opts.rustfmt {
-            let mut child = Command::new("rustfmt")
-                .arg("--edition=2018")
-                .stdin(Stdio::piped())
-                .stdout(Stdio::piped())
-                .spawn()
-                .expect("failed to spawn `rustfmt`");
-            child
-                .stdin
-                .take()
-                .unwrap()
-                .write_all(src.as_bytes())
-                .unwrap();
-            src.as_mut_string().truncate(0);
-            child
-                .stdout
-                .take()
-                .unwrap()
-                .read_to_string(src.as_mut_string())
-                .unwrap();
-            let status = child.wait().unwrap();
-            assert!(status.success());
+        if self.opts.format {
+            let syntax_tree = syn::parse_file(src.as_str()).unwrap();
+            *src.as_mut_string() = prettyplease::unparse(&syntax_tree);
         }
 
         let module_name = name.to_snake_case();

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,10 @@ impl Source {`
`118`	`118`	`pub fn as_mut_string(&mut self) -> &mut String {`
`119`	`119`	`&mut self.s`
`120`	`120`	`}`
	`121`	`+`
	`122`	`+ pub fn as_str(&self) -> &str {`
	`123`	`+ &self.s`
	`124`	`+ }`
`121`	`125`	`}`
`122`	`126`
`123`	`127`	`impl Write for Source {`