foundry-rs
diff --git a/‎.gitignore‎
Lines changed: 1 addition & 0 deletions b/‎.gitignore‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎Cargo.lock‎
Lines changed: 6 additions & 15 deletions b/‎Cargo.lock‎
Lines changed: 6 additions & 15 deletions
diff --git a/‎Cargo.toml‎
Lines changed: 4 additions & 2 deletions b/‎Cargo.toml‎
Lines changed: 4 additions & 2 deletions
diff --git a/‎crates/chisel/Cargo.toml‎
Lines changed: 1 addition & 0 deletions b/‎crates/chisel/Cargo.toml‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎crates/chisel/src/dispatcher.rs‎
Lines changed: 2 additions & 12 deletions b/‎crates/chisel/src/dispatcher.rs‎
Lines changed: 2 additions & 12 deletions
diff --git a/‎crates/chisel/src/source.rs‎
Lines changed: 1 addition & 1 deletion b/‎crates/chisel/src/source.rs‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎crates/cli/src/utils/mod.rs‎
Lines changed: 2 additions & 1 deletion b/‎crates/cli/src/utils/mod.rs‎
Lines changed: 2 additions & 1 deletion
diff --git a/‎crates/common/src/comments/mod.rs‎
Lines changed: 24 additions & 11 deletions b/‎crates/common/src/comments/mod.rs‎
Lines changed: 24 additions & 11 deletions
@@ -1,5 +1,6 @@
 .DS_STORE
 /target*
+/*.sol
 out/
 snapshots/
 out.json
 
@@ -109,6 +109,7 @@ serde.opt-level = 3
 foundry-solang-parser.opt-level = 3
 lalrpop-util.opt-level = 3
 
+solar.opt-level = 3
 solar-ast.opt-level = 3
 solar-data-structures.opt-level = 3
 solar-interface.opt-level = 3
@@ -272,7 +273,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"
@@ -360,10 +360,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
 
@@ -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
 
@@ -69,18 +69,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 {
 
@@ -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,
 
@@ -2,6 +2,7 @@ use alloy_json_abi::JsonAbi;
 use alloy_primitives::{Address, 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)
 }
 
 
@@ -15,7 +15,7 @@ pub const DISABLE_START: &str = "forgefmt: disable-start";
 pub const DISABLE_END: &str = "forgefmt: disable-end";
 
 pub struct Comments {
-    comments: std::vec::IntoIter<Comment>,
+    comments: std::collections::VecDeque<Comment>,
 }
 
 impl fmt::Debug for Comments {
@@ -36,25 +36,32 @@ impl Comments {
         let gatherer = CommentGatherer::new(sf, sm, normalize_cmnts, tab_width).gather();
 
         Self {
-            comments: if group_cmnts {
-                gatherer.group().into_iter()
-            } else {
-                gatherer.comments.into_iter()
-            },
+            comments: if group_cmnts { gatherer.group().into() } else { gatherer.comments.into() },
         }
     }
 
     pub fn peek(&self) -> Option<&Comment> {
-        self.comments.as_slice().first()
+        self.comments.front()
     }
 
     #[allow(clippy::should_implement_trait)]
     pub fn next(&mut self) -> Option<Comment> {
-        self.comments.next()
+        self.comments.pop_front()
     }
 
     pub fn iter(&self) -> impl Iterator<Item = &Comment> {
-        self.comments.as_slice().iter()
+        self.comments.iter()
+    }
+
+    /// Adds a new comment at the beginning of the list.
+    ///
+    /// Should only be used when comments are gathered scattered, and must be manually sorted.
+    ///
+    /// **WARNING:** This struct works under the assumption that comments are always sorted by
+    /// ascending span position. It is the caller's responsibility to ensure that this premise
+    /// always holds true.
+    pub fn push_front(&mut self, cmnt: Comment) {
+        self.comments.push_front(cmnt)
     }
 
     /// Finds the first trailing comment on the same line as `span_pos`, allowing for `Mixed`
@@ -270,7 +277,7 @@ impl<'ast> CommentGatherer<'ast> {
         if let Some(line) = lines.next() {
             let line = line.trim_end();
             // Ensure first line of a doc comment only has the `/**` decorator
-            if let Some((_, second)) = line.split_once("/**") {
+            if is_doc && let Some((_, second)) = line.split_once("/**") {
                 res.push("/**".to_string());
                 if !second.trim().is_empty() {
                     let line = normalize_block_comment_ws(second, col).trim_end();
@@ -298,10 +305,11 @@ impl<'ast> CommentGatherer<'ast> {
             if !pos.is_last {
                 res.push(format_doc_block_comment(&line, self.tab_width));
             } else {
+                // Ensure last line of a doc comment only has the `*/` decorator
                 if let Some((first, _)) = line.split_once("*/")
                     && !first.trim().is_empty()
                 {
-                    res.push(format_doc_block_comment(first, self.tab_width));
+                    res.push(format_doc_block_comment(first.trim_end(), self.tab_width));
                 }
                 res.push(" */".to_string());
             }
@@ -428,6 +436,11 @@ pub fn line_with_tabs(
     output.push_str(rest_of_line);
 }
 
+/// Estimates the display width of a string, accounting for tabs.
+pub fn estimate_line_width(line: &str, tab_width: usize) -> usize {
+    line.chars().fold(0, |width, c| width + if c == '\t' { tab_width } else { 1 })
+}
+
 /// Returns the `BytePos` of the beginning of the current line.
 fn line_begin_pos(sf: &SourceFile, pos: BytePos) -> BytePos {
     let pos = sf.relative_position(pos);