feat(fmt): rewrite formatter using Solar and a structured algorithm

.gitignore

@@ -1,5 +1,6 @@
 .DS_STORE
 /target*
+/*.sol
 out/
 snapshots/
 out.json
@@ -18,4 +19,4 @@ _
 .vite
 .wrangler
 build
-*.zip
+*.zip

Cargo.toml

@@ -266,7 +266,6 @@ op-alloy-flz = "0.13.1"
 revm = { version = "29.0.0", default-features = false }
 revm-inspectors = { version = "0.29.0", features = ["serde"] }
 op-revm = { version = "10.0.0", default-features = false }
-
 ## alloy-evm
 alloy-evm = "0.20.1"
 alloy-op-evm = "0.20.1"
@@ -353,10 +352,12 @@ jiff = "0.2"
 heck = "0.5"
 uuid = "1.17.0"
 flate2 = "1.1"
-snapbox = { version = "0.6", features = ["json", "regex", "term-svg"] }
 
 ## Pinned dependencies. Enabled for the workspace in crates/test-utils.
 
+# testing
+snapbox = { version = "0.6", features = ["json", "regex", "term-svg"] }
+
 # Use unicode-rs which has a smaller binary size than the default ICU4X as the IDNA backend, used
 # by the `url` crate.
 # See the `idna_adapter` README.md for more details: https://docs.rs/crate/idna_adapter/latest

crates/chisel/Cargo.toml

@@ -19,6 +19,7 @@ path = "bin/main.rs"
 
 [dependencies]
 # forge
+forge-doc.workspace = true
 forge-fmt.workspace = true
 foundry-cli.workspace = true
 foundry-common.workspace = true

crates/chisel/src/dispatcher.rs

@@ -9,8 +9,7 @@ use crate::{
 };
 use alloy_primitives::{Address, hex};
 use eyre::{Context, Result};
-use forge_fmt::FormatterConfig;
-use foundry_config::RpcEndpointUrl;
+use foundry_config::{FormatterConfig, RpcEndpointUrl};
 use foundry_evm::{
     decode::decode_console_logs,
     traces::{
@@ -66,18 +65,8 @@ pub struct EtherscanABIResponse {
 
 /// Helper function that formats solidity source with the given [FormatterConfig]
 pub fn format_source(source: &str, config: FormatterConfig) -> eyre::Result<String> {
-    match forge_fmt::parse(source) {
-        Ok(parsed) => {
-            let mut formatted_source = String::default();
-
-            if forge_fmt::format_to(&mut formatted_source, parsed, config).is_err() {
-                eyre::bail!("Could not format source!");
-            }
-
-            Ok(formatted_source)
-        }
-        Err(_) => eyre::bail!("Formatter could not parse source!"),
-    }
+    let formatted = forge_fmt::format(source, config).into_result()?;
+    Ok(formatted)
 }
 
 impl ChiselDispatcher {

crates/chisel/src/source.rs

@@ -5,7 +5,7 @@
 //! execution helpers.
 
 use eyre::Result;
-use forge_fmt::solang_ext::{CodeLocationExt, SafeUnwrap};
+use forge_doc::solang_ext::{CodeLocationExt, SafeUnwrap};
 use foundry_common::fs;
 use foundry_compilers::{
     Artifact, ProjectCompileOutput,

crates/cli/src/utils/mod.rs

@@ -2,6 +2,7 @@ use alloy_json_abi::JsonAbi;
 use alloy_primitives::{U256, map::HashMap};
 use alloy_provider::{Provider, network::AnyNetwork};
 use eyre::{ContextCompat, Result};
+use forge_fmt::FormatterConfig;
 use foundry_common::{
     provider::{ProviderBuilder, RetryProvider},
     shell,
@@ -100,7 +101,7 @@ fn env_filter() -> tracing_subscriber::EnvFilter {
 
 pub fn abi_to_solidity(abi: &JsonAbi, name: &str) -> Result<String> {
     let s = abi.to_sol(name, None);
-    let s = forge_fmt::format(&s)?;
+    let s = forge_fmt::format(&s, FormatterConfig::default()).into_result()?;
     Ok(s)
 }
 

crates/common/src/comments/comment.rs

@@ -17,6 +17,21 @@ pub enum CommentStyle {
     BlankLine,
 }
 
+impl CommentStyle {
+    pub fn is_mixed(&self) -> bool {
+        matches!(self, Self::Mixed)
+    }
+    pub fn is_trailing(&self) -> bool {
+        matches!(self, Self::Trailing)
+    }
+    pub fn is_isolated(&self) -> bool {
+        matches!(self, Self::Isolated)
+    }
+    pub fn is_blank(&self) -> bool {
+        matches!(self, Self::BlankLine)
+    }
+}
+
 #[derive(Clone, Debug)]
 pub struct Comment {
     pub lines: Vec<String>,