Merge branch 'main' into matt/typos

Author: mattsse

CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.1](https://github.com/foundry-rs/compilers/releases/tag/v0.13.1) - 2025-02-02
+
+### Dependencies
+
+- [deps] Bump dirs ([#243](https://github.com/foundry-rs/compilers/issues/243))
+
+### Miscellaneous Tasks
+
+- Clippy + winnow 0.7 ([#244](https://github.com/foundry-rs/compilers/issues/244))
+- Call shrink_to_fit afte parsing source maps ([#242](https://github.com/foundry-rs/compilers/issues/242))
+
+## [0.13.0](https://github.com/foundry-rs/compilers/releases/tag/v0.13.0) - 2025-01-21
+
+### Features
+
+- Better artifact filenames for different profiles ([#241](https://github.com/foundry-rs/compilers/issues/241))
+- Add more features to reduce dependencies ([#239](https://github.com/foundry-rs/compilers/issues/239))
+
+### Miscellaneous Tasks
+
+- More lints ([#238](https://github.com/foundry-rs/compilers/issues/238))
+
 ## [0.12.9](https://github.com/foundry-rs/compilers/releases/tag/v0.12.9) - 2025-01-05
 
 ### Dependencies

Cargo.toml

@@ -4,7 +4,7 @@ resolver = "2"
 
 [workspace.package]
 authors = ["Foundry Maintainers"]
-version = "0.12.9"
+version = "0.13.1"
 rust-version = "1.83"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
@@ -35,11 +35,11 @@ redundant-lifetimes = "warn"
 all = "warn"
 
 [workspace.dependencies]
-foundry-compilers = { path = "crates/compilers", version = "0.12.9" }
-foundry-compilers-artifacts = { path = "crates/artifacts/artifacts", version = "0.12.9" }
-foundry-compilers-artifacts-solc = { path = "crates/artifacts/solc", version = "0.12.9" }
-foundry-compilers-artifacts-vyper = { path = "crates/artifacts/vyper", version = "0.12.9" }
-foundry-compilers-core = { path = "crates/core", version = "0.12.9" }
+foundry-compilers = { path = "crates/compilers", version = "0.13.1" }
+foundry-compilers-artifacts = { path = "crates/artifacts/artifacts", version = "0.13.1" }
+foundry-compilers-artifacts-solc = { path = "crates/artifacts/solc", version = "0.13.1" }
+foundry-compilers-artifacts-vyper = { path = "crates/artifacts/vyper", version = "0.13.1" }
+foundry-compilers-core = { path = "crates/core", version = "0.13.1" }
 
 alloy-json-abi = { version = "0.8", features = ["serde_json"] }
 alloy-primitives = { version = "0.8", features = ["serde", "rand"] }

crates/artifacts/solc/src/error.rs

@@ -3,6 +3,8 @@ use serde::{Deserialize, Serialize};
 use std::{fmt, ops::Range, str::FromStr};
 use yansi::{Color, Style};
 
+const ARROW: &str = "-->";
+
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct SourceLocation {
     pub file: String,
@@ -146,22 +148,30 @@ impl fmt::Display for Error {
 
         let mut lines = fmtd_msg.lines();
 
-        // skip the first line if it contains the same message as the one we just formatted,
-        // unless it also contains a source location, in which case the entire error message is an
-        // old style error message, like:
-        //     path/to/file:line:column: ErrorType: message
-        if lines
-            .clone()
-            .next()
-            .is_some_and(|l| l.contains(short_msg) && l.bytes().filter(|b| *b == b':').count() < 3)
-        {
-            let _ = lines.next();
+        if let Some(l) = lines.clone().next() {
+            if l.bytes().filter(|&b| b == b':').count() >= 3
+                && (l.contains(['/', '\\']) || l.contains(".sol"))
+            {
+                // This is an old style error message, like:
+                //     path/to/file:line:column: ErrorType: message
+                // We want to display this as-is.
+            } else {
+                // Otherwise, assume that the messages are the same until we find a source
+                // location.
+                lines.next();
+                while let Some(line) = lines.clone().next() {
+                    if line.contains(ARROW) {
+                        break;
+                    }
+                    lines.next();
+                }
+            }
         }
 
-        // format the main source location
+        // Format the main source location.
         fmt_source_location(f, &mut lines)?;
 
-        // format remaining lines as secondary locations
+        // Format remaining lines as secondary locations.
         while let Some(line) = lines.next() {
             f.write_str("\n")?;
 
@@ -260,11 +270,9 @@ fn fmt_source_location(f: &mut fmt::Formatter<'_>, lines: &mut std::str::Lines<'
     // --> source
     if let Some(line) = lines.next() {
         f.write_str("\n")?;
-
-        let arrow = "-->";
-        if let Some((left, loc)) = line.split_once(arrow) {
+        if let Some((left, loc)) = line.split_once(ARROW) {
             f.write_str(left)?;
-            styled(f, Error::frame_style(), |f| f.write_str(arrow))?;
+            styled(f, Error::frame_style(), |f| f.write_str(ARROW))?;
             f.write_str(loc)?;
         } else {
             f.write_str(line)?;
@@ -404,7 +412,7 @@ mod tests {
     }
 
     #[test]
-    fn solc_not_formatting_the_message1() {
+    fn no_source_location() {
         let error = r#"{"component":"general","errorCode":"6553","formattedMessage":"SyntaxError: The msize instruction cannot be used when the Yul optimizer is activated because it can change its semantics. Either disable the Yul optimizer or do not use the instruction.\n\n","message":"The msize instruction cannot be used when the Yul optimizer is activated because it can change its semantics. Either disable the Yul optimizer or do not use the instruction.","severity":"error","sourceLocation":{"end":173,"file":"","start":114},"type":"SyntaxError"}"#;
         let error = serde_json::from_str::<Error>(error).unwrap();
         let s = error.to_string();
@@ -414,12 +422,31 @@ mod tests {
     }
 
     #[test]
-    fn solc_not_formatting_the_message2() {
+    fn no_source_location2() {
         let error = r#"{"component":"general","errorCode":"5667","formattedMessage":"Warning: Unused function parameter. Remove or comment out the variable name to silence this warning.\n\n","message":"Unused function parameter. Remove or comment out the variable name to silence this warning.","severity":"warning","sourceLocation":{"end":104,"file":"","start":95},"type":"Warning"}"#;
         let error = serde_json::from_str::<Error>(error).unwrap();
         let s = error.to_string();
         eprintln!("{s}");
         assert!(s.contains("Warning (5667)"), "\n{s}");
         assert!(s.contains("Unused function parameter. Remove or comment out the variable name to silence this warning."), "\n{s}");
     }
+
+    #[test]
+    fn stack_too_deep_multiline() {
+        let error = r#"{"sourceLocation":{"file":"test/LibMap.t.sol","start":15084,"end":15113},"type":"YulException","component":"general","severity":"error","errorCode":null,"message":"Yul exception:Cannot swap Variable _23 with Slot RET[fun_assertEq]: too deep in the stack by 1 slots in [ var_136614_mpos RET _23 _21 _23 var_map_136608_slot _34 _34 _29 _33 _33 _39 expr_48 var_bitWidth var_map_136608_slot _26 _29 var_bitWidth TMP[eq, 0] RET[fun_assertEq] ]\nmemoryguard was present.","formattedMessage":"YulException: Cannot swap Variable _23 with Slot RET[fun_assertEq]: too deep in the stack by 1 slots in [ var_136614_mpos RET _23 _21 _23 var_map_136608_slot _34 _34 _29 _33 _33 _39 expr_48 var_bitWidth var_map_136608_slot _26 _29 var_bitWidth TMP[eq, 0] RET[fun_assertEq] ]\nmemoryguard was present.\n   --> test/LibMap.t.sol:461:34:\n    |\n461 |             uint256 end = t.o - (t.o > 0 ? _random() % t.o : 0);\n    |                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n"}"#;
+        let error = serde_json::from_str::<Error>(error).unwrap();
+        let s = error.to_string();
+        eprintln!("{s}");
+        assert_eq!(s.match_indices("Cannot swap Variable _23").count(), 1, "\n{s}");
+        assert!(s.contains("-->"), "\n{s}");
+    }
+
+    #[test]
+    fn stack_too_deep_no_source_location() {
+        let error = r#"{"type":"CompilerError","component":"general","severity":"error","errorCode":null,"message":"Compiler error (/solidity/libyul/backends/evm/AsmCodeGen.cpp:63):Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables. When compiling inline assembly: Variable key_ is 2 slot(s) too deep inside the stack. Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables.","formattedMessage":"CompilerError: Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables. When compiling inline assembly: Variable key_ is 2 slot(s) too deep inside the stack. Stack too deep. Try compiling with `--via-ir` (cli) or the equivalent `viaIR: true` (standard JSON) while enabling the optimizer. Otherwise, try removing local variables.\n\n"}"#;
+        let error = serde_json::from_str::<Error>(error).unwrap();
+        let s = error.to_string();
+        eprintln!("{s}");
+        assert_eq!(s.match_indices("too deep inside the stack.").count(), 1, "\n{s}");
+    }
 }

crates/artifacts/solc/src/sourcemap.rs

@@ -556,20 +556,23 @@ enum State {
 
 impl State {
     fn advance(&mut self, pos: usize) -> Result<(), SyntaxError> {
-        match self {
-            Self::Offset => *self = Self::Length,
-            Self::Length => *self = Self::Index,
-            Self::Index => *self = Self::Jmp,
-            Self::Jmp => *self = Self::Modifier,
+        *self = match self {
+            Self::Offset => Self::Length,
+            Self::Length => Self::Index,
+            Self::Index => Self::Jmp,
+            Self::Jmp => Self::Modifier,
             Self::Modifier => return Err(SyntaxError::new(pos, "unexpected colon")),
-        }
+        };
         Ok(())
     }
 }
 
-/// Parses a source map
+/// Parses a source map.
 pub fn parse(input: &str) -> Result<SourceMap, SyntaxError> {
-    Parser::new(input).collect()
+    Parser::new(input).collect::<Result<SourceMap, SyntaxError>>().map(|mut v| {
+        v.shrink_to_fit();
+        v
+    })
 }
 
 #[cfg(test)]

crates/compilers/Cargo.toml

@@ -37,11 +37,11 @@ futures-util = { workspace = true, optional = true }
 tokio = { workspace = true, optional = true }
 
 auto_impl = "1"
-winnow = "0.6"
+winnow = "0.7"
 dyn-clone = "1"
 derive_more = { version = "1", features = ["debug"] }
 home = "0.5"
-dirs = "5.0"
+dirs = "6.0"
 itertools = ">=0.13, <=0.14"
 
 # project-util

crates/compilers/src/artifact_output/mod.rs

@@ -17,7 +17,7 @@ use semver::Version;
 use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use std::{
     borrow::Cow,
-    collections::{btree_map::BTreeMap, HashSet},
+    collections::{btree_map::BTreeMap, HashMap, HashSet},
     ffi::OsString,
     fmt, fs,
     hash::Hash,
@@ -621,8 +621,10 @@ pub trait ArtifactOutput {
         sources: &VersionedSourceFiles,
         layout: &ProjectPathsConfig<L>,
         ctx: OutputContext<'_>,
+        primary_profiles: &HashMap<PathBuf, &str>,
     ) -> Result<Artifacts<Self::Artifact>> {
-        let mut artifacts = self.output_to_artifacts(contracts, sources, ctx, layout);
+        let mut artifacts =
+            self.output_to_artifacts(contracts, sources, ctx, layout, primary_profiles);
         fs::create_dir_all(&layout.artifacts).map_err(|err| {
             error!(dir=?layout.artifacts, "Failed to create artifacts folder");
             SolcIoError::new(err, &layout.artifacts)
@@ -850,6 +852,7 @@ pub trait ArtifactOutput {
         sources: &VersionedSourceFiles,
         ctx: OutputContext<'_>,
         layout: &ProjectPathsConfig<C>,
+        primary_profiles: &HashMap<PathBuf, &str>,
     ) -> Artifacts<Self::Artifact> {
         let mut artifacts = ArtifactsMap::new();
 
@@ -877,6 +880,8 @@ pub trait ArtifactOutput {
                     versioned_contracts.iter().map(|c| &c.version).collect::<HashSet<_>>();
                 let unique_profiles =
                     versioned_contracts.iter().map(|c| &c.profile).collect::<HashSet<_>>();
+                let primary_profile = primary_profiles.get(file);
+
                 for contract in versioned_contracts {
                     non_standalone_sources.insert(file);
 
@@ -892,7 +897,8 @@ pub trait ArtifactOutput {
                         &contract.version,
                         &contract.profile,
                         unique_versions.len() > 1,
-                        unique_profiles.len() > 1,
+                        unique_profiles.len() > 1
+                            && primary_profile.is_none_or(|p| p != &contract.profile),
                     );
 
                     taken_paths_lowercase.insert(artifact_path.to_slash_lossy().to_lowercase());
@@ -1122,8 +1128,15 @@ impl ArtifactOutput for MinimalCombinedArtifactsHardhatFallback {
         sources: &VersionedSourceFiles,
         layout: &ProjectPathsConfig<C>,
         ctx: OutputContext<'_>,
+        primary_profiles: &HashMap<PathBuf, &str>,
     ) -> Result<Artifacts<Self::Artifact>> {
-        MinimalCombinedArtifacts::default().on_output(output, sources, layout, ctx)
+        MinimalCombinedArtifacts::default().on_output(
+            output,
+            sources,
+            layout,
+            ctx,
+            primary_profiles,
+        )
     }
 
     fn read_cached_artifact(path: &Path) -> Result<Self::Artifact> {

crates/compilers/src/compile/project.rs

@@ -108,7 +108,7 @@ use crate::{
     filter::SparseOutputFilter,
     output::{AggregatedCompilerOutput, Builds},
     report,
-    resolver::GraphEdges,
+    resolver::{GraphEdges, ResolvedSources},
     ArtifactOutput, CompilerSettings, Graph, Project, ProjectCompileOutput, Sources,
 };
 use foundry_compilers_core::error::Result;
@@ -128,6 +128,8 @@ pub struct ProjectCompiler<
     /// Contains the relationship of the source files and their imports
     edges: GraphEdges<C::ParsedSource>,
     project: &'a Project<C, T>,
+    /// A mapping from a source file path to the primary profile name selected for it.
+    primary_profiles: HashMap<PathBuf, &'a str>,
     /// how to compile all the sources
     sources: CompilerSources<'a, C::Language, C::Settings>,
 }
@@ -152,7 +154,8 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
             sources.retain(|f, _| filter.is_match(f))
         }
         let graph = Graph::resolve_sources(&project.paths, sources)?;
-        let (sources, edges) = graph.into_sources_by_version(project)?;
+        let ResolvedSources { sources, primary_profiles, edges } =
+            graph.into_sources_by_version(project)?;
 
         // If there are multiple different versions, and we can use multiple jobs we can compile
         // them in parallel.
@@ -162,7 +165,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
             sources,
         };
 
-        Ok(Self { edges, project, sources })
+        Ok(Self { edges, primary_profiles, project, sources })
     }
 
     /// Compiles all the sources of the `Project` in the appropriate mode
@@ -199,7 +202,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
     ///   - check cache
     fn preprocess(self) -> Result<PreprocessedState<'a, T, C>> {
         trace!("preprocessing");
-        let Self { edges, project, mut sources } = self;
+        let Self { edges, project, mut sources, primary_profiles } = self;
 
         // convert paths on windows to ensure consistency with the `CompilerOutput` `solc` emits,
         // which is unix style `/`
@@ -209,7 +212,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
         // retain and compile only dirty sources and all their imports
         sources.filter(&mut cache);
 
-        Ok(PreprocessedState { sources, cache })
+        Ok(PreprocessedState { sources, cache, primary_profiles })
     }
 }
 
@@ -224,6 +227,9 @@ struct PreprocessedState<'a, T: ArtifactOutput<CompilerContract = C::CompilerCon
 
     /// Cache that holds `CacheEntry` objects if caching is enabled and the project is recompiled
     cache: ArtifactsCache<'a, T, C>,
+
+    /// A mapping from a source file path to the primary profile name selected for it.
+    primary_profiles: HashMap<PathBuf, &'a str>,
 }
 
 impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
@@ -232,7 +238,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
     /// advance to the next state by compiling all sources
     fn compile(self) -> Result<CompiledState<'a, T, C>> {
         trace!("compiling");
-        let PreprocessedState { sources, mut cache } = self;
+        let PreprocessedState { sources, mut cache, primary_profiles } = self;
 
         let mut output = sources.compile(&mut cache)?;
 
@@ -243,7 +249,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
         // contracts again
         output.join_all(cache.project().root());
 
-        Ok(CompiledState { output, cache })
+        Ok(CompiledState { output, cache, primary_profiles })
     }
 }
 
@@ -252,6 +258,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
 struct CompiledState<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler> {
     output: AggregatedCompilerOutput<C>,
     cache: ArtifactsCache<'a, T, C>,
+    primary_profiles: HashMap<PathBuf, &'a str>,
 }
 
 impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
@@ -263,7 +270,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
     /// successful
     #[instrument(skip_all, name = "write-artifacts")]
     fn write_artifacts(self) -> Result<ArtifactsState<'a, T, C>> {
-        let CompiledState { output, cache } = self;
+        let CompiledState { output, cache, primary_profiles } = self;
 
         let project = cache.project();
         let ctx = cache.output_ctx();
@@ -275,6 +282,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
                 &output.sources,
                 ctx,
                 &project.paths,
+                &primary_profiles,
             )
         } else if output.has_error(
             &project.ignored_error_codes,
@@ -287,6 +295,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
                 &output.sources,
                 ctx,
                 &project.paths,
+                &primary_profiles,
             )
         } else {
             trace!(
@@ -300,6 +309,7 @@ impl<'a, T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler>
                 &output.sources,
                 &project.paths,
                 ctx,
+                &primary_profiles,
             )?;
 
             // emits all the build infos, if they exist