fix(config): include root argument in deserialization (#704)

Author: mattsse

cli/tests/cmd.rs

@@ -135,7 +135,7 @@ forgetest_init!(can_override_config, |prj: TestProject, mut cmd: TestCommand| {
     assert_eq!(foundry_toml, file);
 
     let config = forge_utils::load_config();
-    let profile = Config::load();
+    let profile = Config::load_with_root(prj.root());
     assert_eq!(config, profile.clone().sanitized());
 
     // ensure remappings contain test
@@ -154,7 +154,6 @@ forgetest_init!(can_override_config, |prj: TestProject, mut cmd: TestCommand| {
     // remappings work
     let remappings_txt = prj.create_file("remappings.txt", "ds-test/=lib/ds-test/from-file/");
     let config = forge_utils::load_config();
-    println!("{:?}", config.remappings);
     assert_eq!(
         format!("ds-test/={}/", prj.root().join("lib/ds-test/from-file").display()),
         Remapping::from(config.remappings[0].clone()).to_string()

config/src/lib.rs

@@ -22,7 +22,7 @@ use ethers_solc::{
     remappings::{RelativeRemapping, Remapping},
     EvmVersion, Project, ProjectPathsConfig, SolcConfig,
 };
-use figment::providers::Data;
+use figment::{providers::Data, value::Value};
 use inflector::Inflector;
 
 // Macros useful for creating a figment.
@@ -166,11 +166,11 @@ pub struct Config {
     // "#
     pub solc_settings: Option<String>,
     /// The root path where the config detection started from, `Config::with_root`
-    ///
-    /// **Note:** This field is never serialized nor deserialized. This is merely used to provided
-    /// additional context.
     #[doc(hidden)]
-    #[serde(skip)]
+    //  We're skipping serialization here, so it won't be included in the [`Config::to_string()`]
+    // representation, but will be deserialized from the `Figment` so that forge commands can
+    // override it.
+    #[serde(rename = "root", default, skip_serializing)]
     pub __root: RootPath,
     /// PRIVATE: This structure may grow, As such, constructing this structure should
     /// _always_ be done using a public constructor or update syntax:
@@ -637,7 +637,8 @@ impl From<Config> for Figment {
 }
 
 /// A helper wrapper around the root path used during Config detection
-#[derive(Debug, PartialEq, Eq, Hash, Clone, PartialOrd, Ord)]
+#[derive(Debug, PartialEq, Eq, Hash, Clone, PartialOrd, Ord, Deserialize, Serialize)]
+#[serde(transparent)]
 pub struct RootPath(pub PathBuf);
 
 impl Default for RootPath {
@@ -676,7 +677,11 @@ impl Provider for Config {
 
     #[track_caller]
     fn data(&self) -> Result<Map<Profile, Dict>, figment::Error> {
-        Serialized::defaults(self).data()
+        let mut data = Serialized::defaults(self).data()?;
+        if let Some(entry) = data.get_mut(&self.profile) {
+            entry.insert("root".to_string(), Value::serialize(self.__root.clone())?);
+        }
+        Ok(data)
     }
 
     fn profile(&self) -> Option<Profile> {
@@ -1461,6 +1466,7 @@ mod tests {
     fn can_use_impl_figment_macro() {
         #[derive(Default, Serialize)]
         struct MyArgs {
+            #[serde(skip_serializing_if = "Option::is_none")]
             root: Option<PathBuf>,
         }
         impl_figment_convert!(MyArgs);

config/src/macros.rs

@@ -20,6 +20,7 @@
 /// use foundry_config::figment::value::*;
 /// #[derive(Default, Serialize)]
 /// struct MyArgs {
+///     #[serde(skip_serializing_if = "Option::is_none")]
 ///     root: Option<PathBuf>,
 /// }
 /// impl_figment_convert!(MyArgs);