fix: Support for parser errors.

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+#### 🚀 Updates
+
+- Updated help text to also apply for parser errors.
+
 ## 0.12.11
 
 #### 🚀 Updates

crates/config/src/config/errors.rs

@@ -84,6 +84,9 @@ pub enum ConfigError {
         #[diagnostic_source]
         #[source]
         error: ParserError,
+
+        #[help]
+        help: Option<String>,
     },
 
     // Validator

crates/config/src/config/loader.rs

@@ -253,7 +253,7 @@ impl<T: Config> ConfigLoader<T> {
             let partial: T::Partial = {
                 let mut cacher = self.cacher.lock().unwrap();
 
-                source.parse(location, &mut cacher)?
+                source.parse(location, &mut cacher, self.help.as_deref())?
             };
 
             // Validate before continuing so we ensure the values are correct

crates/config/src/config/source.rs

@@ -98,13 +98,19 @@ impl Source {
     }
 
     /// Parse the source contents according to the required format.
-    pub fn parse<D>(&self, location: &str, cacher: &mut BoxedCacher) -> Result<D, ConfigError>
+    pub fn parse<D>(
+        &self,
+        location: &str,
+        cacher: &mut BoxedCacher,
+        help: Option<&str>,
+    ) -> Result<D, ConfigError>
     where
         D: DeserializeOwned,
     {
         let handle_error = |error: crate::config::ParserError| ConfigError::Parser {
             config: location.to_owned(),
             error,
+            help: help.map(|h| h.to_owned()),
         };
 
         match self {