foundry_config/
warning.rs

Help
1use figment::Profile;
2use serde::{Deserialize, Serialize};
3use std::{fmt, path::PathBuf};
4
5/// Warnings emitted during loading or managing Configuration
6#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
7#[serde(tag = "type")]
8pub enum Warning {
9    /// An unknown section was encountered in a TOML file
10    UnknownSection {
11        /// The unknown key
12        unknown_section: Profile,
13        /// The source where the key was found
14        source: Option<String>,
15    },
16    /// No local TOML file found, with location tried
17    NoLocalToml(PathBuf),
18    /// Could not read TOML
19    CouldNotReadToml {
20        /// The path of the TOML file
21        path: PathBuf,
22        /// The error message that occurred
23        err: String,
24    },
25    /// Could not write TOML
26    CouldNotWriteToml {
27        /// The path of the TOML file
28        path: PathBuf,
29        /// The error message that occurred
30        err: String,
31    },
32    /// Invalid profile. Profile should be a table
33    CouldNotFixProfile {
34        /// The path of the TOML file
35        path: PathBuf,
36        /// The profile to be fixed
37        profile: String,
38        /// The error message that occurred
39        err: String,
40    },
41    /// Deprecated key.
42    DeprecatedKey {
43        /// The key being deprecated
44        old: String,
45        /// The new key replacing the deprecated one if not empty, otherwise, meaning the old one
46        /// is being removed completely without replacement
47        new: String,
48    },
49}
50
51impl fmt::Display for Warning {
52    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
53        match self {
54            Self::UnknownSection { unknown_section, source } => {
55                let source = source.as_ref().map(|src| format!(" in {src}")).unwrap_or_default();
56                write!(
57                    f,
58                    "Found unknown config section{source}: [{unknown_section}]\n\
59                     This notation for profiles has been deprecated and may result in the profile \
60                     not being registered in future versions.\n\
61                     Please use [profile.{unknown_section}] instead or run `forge config --fix`."
62                )
63            }
64            Self::NoLocalToml(path) => write!(
65                f,
66                "No local TOML found to fix at {}.\n\
67                 Change the current directory to a project path or set the foundry.toml path with \
68                 the `FOUNDRY_CONFIG` environment variable",
69                path.display()
70            ),
71
72            Self::CouldNotReadToml { path, err } => {
73                write!(f, "Could not read TOML at {}: {err}", path.display())
74            }
75            Self::CouldNotWriteToml { path, err } => {
76                write!(f, "Could not write TOML to {}: {err}", path.display())
77            }
78            Self::CouldNotFixProfile { path, profile, err } => {
79                write!(f, "Could not fix [{profile}] in TOML at {}: {err}", path.display())
80            }
81            Self::DeprecatedKey { old, new } if new.is_empty() => {
82                write!(f, "Key `{old}` is being deprecated and will be removed in future versions.")
83            }
84            Self::DeprecatedKey { old, new } => {
85                write!(f, "Key `{old}` is being deprecated in favor of `{new}`. It will be removed in future versions.")
86            }
87        }
88    }
89}
90
91impl std::error::Error for Warning {}
foundry_config/warning.rs

foundry_config/
warning.rs
