chore: bump solar, warn on invalid natspec (#12540)

Author: grandizzy

Cargo.lock

@@ -451,7 +451,7 @@ op-revm = { git = "https://github.com/bluealloy/revm.git", rev = "7e59936" }
 # foundry-fork-db = { git = "https://github.com/foundry-rs/foundry-fork-db", rev = "b4299fc" }
 
 # solar
-solar = { package = "solar-compiler", git = "https://github.com/paradigmxyz/solar.git", rev = "0bea5f0" }
-solar-interface = { package = "solar-interface", git = "https://github.com/paradigmxyz/solar.git", rev = "0bea5f0" }
-solar-ast = { package = "solar-ast", git = "https://github.com/paradigmxyz/solar.git", rev = "0bea5f0" }
-solar-sema = { package = "solar-sema", git = "https://github.com/paradigmxyz/solar.git", rev = "0bea5f0" }
+solar = { package = "solar-compiler", git = "https://github.com/paradigmxyz/solar.git", rev = "1f28069" }
+solar-interface = { package = "solar-interface", git = "https://github.com/paradigmxyz/solar.git", rev = "1f28069" }
+solar-ast = { package = "solar-ast", git = "https://github.com/paradigmxyz/solar.git", rev = "1f28069" }
+solar-sema = { package = "solar-sema", git = "https://github.com/paradigmxyz/solar.git", rev = "1f28069" }

Cargo.toml

@@ -5,16 +5,14 @@ use foundry_compilers::{
     multi::{MultiCompilerLanguage, MultiCompilerParser},
     solc::{SOLC_EXTENSIONS, SolcLanguage, SolcVersionedInput},
 };
-use foundry_config::{Config, semver::Version};
+use foundry_config::Config;
 use rayon::prelude::*;
-use solar::{interface::MIN_SOLIDITY_VERSION as MSV, sema::ParsingContext};
+use solar::{interface::MIN_SOLIDITY_VERSION, sema::ParsingContext};
 use std::{
     collections::{HashSet, VecDeque},
     path::{Path, PathBuf},
 };
 
-const MIN_SUPPORTED_VERSION: Version = Version::new(MSV.0, MSV.1, MSV.2);
-
 /// Configures a [`ParsingContext`] from [`Config`].
 ///
 /// - Configures include paths, remappings
@@ -62,10 +60,10 @@ pub fn configure_pcx(
         .1
         .into_iter()
         // Filter unsupported versions
-        .filter(|(v, _, _)| v >= &MIN_SUPPORTED_VERSION)
+        .filter(|(v, _, _)| v >= &MIN_SOLIDITY_VERSION)
         // Always pick the latest version
         .max_by(|(v1, _, _), (v2, _, _)| v1.cmp(v2))
-        .map_or((MIN_SUPPORTED_VERSION, Sources::default()), |(v, s, _)| (v, s));
+        .map_or((MIN_SOLIDITY_VERSION, Sources::default()), |(v, s, _)| (v, s));
 
     if sources.is_empty() {
         sh_warn!("no files found. Solar doesn't support Solidity versions prior to 0.8.0")?;
@@ -132,12 +130,12 @@ pub fn get_solar_sources_from_compile_output(
 
     // Read all sources and find the latest version.
     let (version, sources) = {
-        let (mut max_version, mut sources) = (MIN_SUPPORTED_VERSION, Sources::new());
+        let (mut max_version, mut sources) = (MIN_SOLIDITY_VERSION, Sources::new());
         for (id, _) in output.artifact_ids() {
             if let Ok(path) = dunce::canonicalize(&id.source)
                 && source_paths.remove(&path)
             {
-                if id.version < MIN_SUPPORTED_VERSION {
+                if id.version < MIN_SOLIDITY_VERSION {
                     continue;
                 } else if max_version < id.version {
                     max_version = id.version;

crates/cli/src/opts/build/utils.rs

@@ -412,3 +412,49 @@ with remappings:
 
 "#]]);
 });
+
+// <https://github.com/foundry-rs/foundry/issues/12458>
+// <https://github.com/foundry-rs/foundry/issues/12496>
+forgetest!(build_with_invalid_natspec, |prj, cmd| {
+    prj.add_source(
+        "ContractWithInvalidNatspec.sol",
+        r#"
+contract ContractA {
+    /// @deprecated quoteExactOutputSingle and exactOutput. Use QuoterV2 instead.
+}
+
+/// Some editors highlight `@note` or `@todo`
+/// @note foo bar
+
+/// @title ContractB
+contract ContractB {
+    /**
+    some example code in a comment:
+    import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
+    */
+}
+   "#,
+    );
+
+    cmd.args(["build", "src/ContractWithInvalidNatspec.sol"]).assert_success().stderr_eq(str![[
+        r#"
+warning: invalid natspec tag '@deprecated', custom tags must use format '@custom:name'
+ [FILE]:5:5
+  |
+5 |     /// @deprecated quoteExactOutputSingle and exactOutput. Use QuoterV2 instead.
+  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  |
+...
+
+warning: invalid natspec tag '@note', custom tags must use format '@custom:name'
+ [FILE]:9:1
+  |
+9 | /// @note foo bar
+  | ^^^^^^^^^^^^^^^^^
+  |
+...
+
+
+"#
+    ]]);
+});