Merge pull request #625 from googlefonts/improve-error-messages

Improve error messages in fontc/fontir
googlefonts · Dec 5, 2023 · b217f65 · b217f65
2 parents b919e69 + 1d56820
commit b217f65
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 15 deletions.
diff --git a/fontc/src/error.rs b/fontc/src/error.rs
@@ -5,19 +5,19 @@ use thiserror::Error;
 
 #[derive(Debug, Error)]
 pub enum Error {
-    #[error("Unrecognized source")]
+    #[error("Unrecognized source {0}")]
     UnrecognizedSource(PathBuf),
-    #[error("yaml error")]
+    #[error("yaml error: '{0}'")]
     YamlSerError(#[from] serde_yaml::Error),
-    #[error("IO failures")]
+    #[error("IO error: '{0}'")]
     IoError(#[from] io::Error),
-    #[error("Font IR error")]
+    #[error("Font IR error: '{0}'")]
     FontIrError(#[from] fontir::error::Error),
     #[error("Unable to produce IR")]
     IrGenerationError,
-    #[error("Does not exist")]
+    #[error("Missing file '{0}'")]
     FileExpected(PathBuf),
-    #[error("At least one work item failed")]
+    #[error("Tasks failed: {0:?}")]
     TasksFailed(Vec<(AnyWorkId, String)>),
     #[error("Invalid regex")]
     BadRegex(#[from] regex::Error),

diff --git a/fontir/src/error.rs b/fontir/src/error.rs
@@ -12,23 +12,23 @@ use write_fonts::types::{InvalidTag, Tag};
 
 #[derive(Debug, Error)]
 pub enum Error {
-    #[error("Directory expected")]
+    #[error("Missing directory '{0}'")]
     DirectoryExpected(PathBuf),
-    #[error("File expected")]
+    #[error("Missing expected file '{0}'")]
     FileExpected(PathBuf),
-    #[error("IO failure")]
+    #[error("IO failure: '{0}'")]
     IoError(#[from] io::Error),
     #[error("Unable to parse {0:?}: {1}")]
     ParseError(PathBuf, String),
     #[error("Missing required axis values for {0}")]
     NoAxisDefinitions(String),
     #[error("Axis {0} has no entry in axes")]
     NoEntryInAxes(String),
-    #[error("Axis definitions are inconsistent")]
+    #[error("Axis definitions are inconsistent: '{0}'")]
     InconsistentAxisDefinitions(String),
-    #[error("Illegible source")]
+    #[error("Illegible source: '{0}'")]
     UnableToLoadSource(Box<dyn error::Error>),
-    #[error("Missing layer")]
+    #[error("Missing layer '{0}'")]
     NoSuchLayer(String),
     #[error("No files associated with glyph {0}")]
     NoStateForGlyph(GlyphName),
@@ -58,17 +58,17 @@ pub enum Error {
 /// An async work error, hence one that must be Send
 #[derive(Debug, Error)]
 pub enum WorkError {
-    #[error("IO failure")]
+    #[error("IO failure: '{0}'")]
     IoError(#[from] io::Error),
     // I can't use Box(<dyn error::Error>) here because it's not Send, but
     // if I convert error to string I lose the backtrace... What to do?
     #[error("Conversion of glyph '{0:?}' to IR failed: {1}")]
     GlyphIrWorkError(GlyphName, String),
-    #[error("yaml error")]
+    #[error("yaml error: '{0}'")]
     YamlSerError(#[from] serde_yaml::Error),
     #[error("No axes are defined")]
     NoAxisDefinitions,
-    #[error("Axis definitions are inconsistent")]
+    #[error("Axis definitions are inconsistent: '{0}'")]
     InconsistentAxisDefinitions(String),
     #[error("'{0}' has no position on {1}")]
     NoAxisPosition(GlyphName, String),