Make GHCComponent match the command name and improve the error message

haskell · Jul 30, 2024 · 8ffd58b · 8ffd58b
1 parent b3b9e82
commit 8ffd58b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/code/hsec-core/src/Security/Advisories/Core/Advisory.hs b/code/hsec-core/src/Security/Advisories/Core/Advisory.hs
@@ -57,25 +57,25 @@ data GHCComponent = GHCCompiler | GHCi | GHCRTS | GHCPkg | RunGHC | IServ | HP2P
 
 ghcComponentToText :: GHCComponent -> Text
 ghcComponentToText c = case c of
-  GHCCompiler -> "compiler"
+  GHCCompiler -> "ghc"
   GHCi -> "ghci"
   GHCRTS -> "rts"
   GHCPkg -> "ghc-pkg"
   RunGHC -> "runghc"
-  IServ -> "iserv"
+  IServ -> "ghc-iserv"
   HP2PS -> "hp2ps"
   HPC -> "hpc"
   HSC2HS -> "hsc2hs"
   Haddock -> "haddock"
 
 ghcComponentFromText :: Text -> Maybe GHCComponent
 ghcComponentFromText c = case c of
-  "compiler" -> Just GHCCompiler
+  "ghc" -> Just GHCCompiler
   "ghci" -> Just GHCi
   "rts" -> Just GHCRTS
   "ghc-pkg" -> Just GHCPkg
   "runghc" -> Just RunGHC
-  "iserv" -> Just IServ
+  "ghc-iserv" -> Just IServ
   "hp2ps" -> Just HP2PS
   "hpc" -> Just HPC
   "hsc2hs" -> Just HSC2HS

diff --git a/code/hsec-tools/src/Security/Advisories/Format.hs b/code/hsec-tools/src/Security/Advisories/Format.hs
@@ -140,7 +140,9 @@ instance Toml.FromValue GHCComponent where
   fromValue v = case v of
     Toml.Text' _ n
       | Just c <- ghcComponentFromText n -> pure c
-    _ -> Toml.failAt (Toml.valueAnn v) "Invalid component, expected compiler|ghci|rts"
+    _ -> Toml.failAt (Toml.valueAnn v) $ T.unpack $ "Invalid component, expected " <> T.intercalate "|" componentNames
+   where
+     componentNames = map ghcComponentToText [minBound..maxBound]
 
 instance Toml.ToValue GHCComponent where
   toValue = Toml.Text' () . ghcComponentToText