Error instance for FileError instead of Pretty

IntersectMBO · Nov 17, 2023 · 926215b · 926215b
1 parent b801e3b
commit 926215b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/cardano-api/internal/Cardano/Api/Error.hs b/cardano-api/internal/Cardano/Api/Error.hs
@@ -67,8 +67,8 @@ data FileError e = FileError FilePath e
                  | FileIOError FilePath IOException
   deriving (Show, Eq, Functor)
 
-instance Error e => Pretty (FileError e) where
-  pretty = \case
+instance Error e => Error (FileError e) where
+  prettyError = \case
     FileErrorTempFile targetPath tempPath h ->
       vsep
         [ "Error creating temporary file at: " <> pretty tempPath

diff --git a/cardano-api/internal/Cardano/Api/Pretty.hs b/cardano-api/internal/Cardano/Api/Pretty.hs
@@ -24,6 +24,8 @@ import qualified Data.Text.Lazy as TextLazy
 import           Prettyprinter
 import           Prettyprinter.Render.Terminal
 
+-- | 'Ann' is the prettyprinter annotation for cardano-api and cardano-cli to enable the printing
+-- of colored output. This is a type alias for AnsiStyle.
 type Ann = AnsiStyle
 
 newtype ShowOf a = ShowOf a

diff --git a/cardano-api/test/cardano-api-test/Test/Cardano/Api/IO.hs b/cardano-api/test/cardano-api-test/Test/Cardano/Api/IO.hs
@@ -26,7 +26,7 @@ prop_createVrfFileWithOwnerPermissions =
     result <- liftIO $ writeLazyByteStringFileWithOwnerPermissions (File file) ""
 
     case result of
-      Left err -> failWith Nothing $ prettyToString $ pretty @(FileError ()) err
+      Left err -> failWith Nothing $ prettyToString $ prettyError @(FileError ()) err
       Right () -> return ()
 
     fResult <- liftIO . runExceptT $ checkVrfFilePermissions (File file)