Minor package display improvements

tbidne · tbidne · commit 18b558c45b00 · 2025-06-18T11:43:48.000+12:00
Displayed package names (stdout, log directory names) now use a hyphen
e.g. aeson-1.2.3, rather than reusing the default delimiter == e.g.
aeson ==1.2.3.
diff --git a/src/builder/CLC/Stackage/Builder/Process.hs b/src/builder/CLC/Stackage/Builder/Process.hs
@@ -115,7 +115,7 @@ buildProject env idx pkgs = do
       mconcat
         [ T.pack $ show idx,
           ": ",
-          T.intercalate ", " (Package.toTextInstalled <$> pkgsList)
+          T.intercalate ", " (Package.toDisplayName <$> pkgsList)
         ]
     pkgsList = NE.toList pkgs.unPackageGroup
     pkgsSet = Set.fromList pkgsList
diff --git a/src/parser/CLC/Stackage/Parser.hs b/src/parser/CLC/Stackage/Parser.hs
@@ -57,7 +57,7 @@ printPackageList mOs = do
 -- | Retrieves the package list formatted to text.
 getPackageListByOsFmt :: Os -> IO [Text]
 getPackageListByOsFmt =
-  (fmap . fmap) Package.toTextInstalled
+  (fmap . fmap) Package.toDisplayName
     . getPackageListByOs Logging.mkDefaultLogger Nothing
 
 -- | Helper in case we want to see what the package set for a given OS is.
diff --git a/src/parser/CLC/Stackage/Parser/API/CabalConfig.hs b/src/parser/CLC/Stackage/Parser/API/CabalConfig.hs
@@ -82,6 +82,6 @@ parseCabalConfigLine txt = do
   let s = case T.stripPrefix "constraints:" txt' of
         Nothing -> txt'
         Just rest -> T.stripStart rest
-  Package.packageParser s
+  Package.fromCabalConstraintsText s
   where
     txt' = T.stripStart txt
diff --git a/src/utils/CLC/Stackage/Utils/Package.hs b/src/utils/CLC/Stackage/Utils/Package.hs
@@ -12,13 +12,10 @@ module CLC.Stackage.Utils.Package
     toCabalDepText,
     toCabalConstraintsText,
     toDirName,
-    toTextInstalled,
+    toDisplayName,
 
     -- * Version
     PackageVersion (..),
-
-    -- * Parsers
-    packageParser,
   )
 where
 
@@ -89,7 +86,16 @@ toCabalConstraintsText = (<> ",") . toTextInstalled
 -- representation of 'toText'. Used when naming an error directory for a
 -- package that fails.
 toDirName :: Package -> IO OsPath
-toDirName = Paths.encodeUtf . T.unpack . toTextInstalled
+toDirName = Paths.encodeUtf . T.unpack . toDisplayName
+
+-- | Slightly nicer display name e.g. "mtl-installed", "aeson-1.2.3".
+toDisplayName :: Package -> Text
+toDisplayName (MkPackage name vers) = txt
+  where
+    txt = name <> "-" <> v
+    v = case vers of
+      PackageVersionText t -> t
+      PackageVersionInstalled -> "installed"
 
 -- | Text representation of the package respecting "installed" versions e.g.
 --
diff --git a/test/functional/goldens/testSmallBatch_posix.golden b/test/functional/goldens/testSmallBatch_posix.golden
@@ -1,7 +1,7 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output/cache.json
-[2020-05-31 12:00:00][Success] 3: cborg ==0.2.10.0, clock ==0.8.4
-[2020-05-31 12:00:00][Success] 2: mtl ==2.3.1, optics-core ==0.4.1.1
-[2020-05-31 12:00:00][Success] 1: profunctors ==5.6.2
+[2020-05-31 12:00:00][Success] 3: cborg-0.2.10.0, clock-0.8.4
+[2020-05-31 12:00:00][Success] 2: mtl-2.3.1, optics-core-0.4.1.1
+[2020-05-31 12:00:00][Success] 1: profunctors-5.6.2
 
 
 - Successes: 5 (100%)
diff --git a/test/functional/goldens/testSmallBatch_windows.golden b/test/functional/goldens/testSmallBatch_windows.golden
@@ -1,7 +1,7 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output\cache.json
-[2020-05-31 12:00:00][Success] 3: cborg ==0.2.10.0, clock ==0.8.4
-[2020-05-31 12:00:00][Success] 2: mtl ==2.3.1, optics-core ==0.4.1.1
-[2020-05-31 12:00:00][Success] 1: profunctors ==5.6.2
+[2020-05-31 12:00:00][Success] 3: cborg-0.2.10.0, clock-0.8.4
+[2020-05-31 12:00:00][Success] 2: mtl-2.3.1, optics-core-0.4.1.1
+[2020-05-31 12:00:00][Success] 1: profunctors-5.6.2
 
 
 - Successes: 5 (100%)
diff --git a/test/functional/goldens/testSmallSnapshotPath_posix.golden b/test/functional/goldens/testSmallSnapshotPath_posix.golden
@@ -1,6 +1,6 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output/cache.json
 [2020-05-31 12:00:00][Warn]    Only found 8 packages. Is that right?
-[2020-05-31 12:00:00][Success] 1: cborg ==0.2.10.0, clock ==0.8.4, mtl insta...
+[2020-05-31 12:00:00][Success] 1: cborg-0.2.10.0, clock-0.8.4, mtl-installed...
 
 
 - Successes: 5 (100%)
diff --git a/test/functional/goldens/testSmallSnapshotPath_windows.golden b/test/functional/goldens/testSmallSnapshotPath_windows.golden
@@ -1,6 +1,6 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output\cache.json
 [2020-05-31 12:00:00][Warn]    Only found 8 packages. Is that right?
-[2020-05-31 12:00:00][Success] 1: cborg ==0.2.10.0, clock ==0.8.4, mtl insta...
+[2020-05-31 12:00:00][Success] 1: cborg-0.2.10.0, clock-0.8.4, mtl-installed...
 
 
 - Successes: 5 (100%)
diff --git a/test/functional/goldens/testSmall_posix.golden b/test/functional/goldens/testSmall_posix.golden
@@ -1,5 +1,5 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output/cache.json
-[2020-05-31 12:00:00][Success] 1: cborg ==0.2.10.0, clock ==0.8.4, mtl ==2.3...
+[2020-05-31 12:00:00][Success] 1: cborg-0.2.10.0, clock-0.8.4, mtl-2.3.1, op...
 
 
 - Successes: 5 (100%)
diff --git a/test/functional/goldens/testSmall_windows.golden b/test/functional/goldens/testSmall_windows.golden
@@ -1,5 +1,5 @@
 [2020-05-31 12:00:00][Info]    Cached results do not exist: output\cache.json
-[2020-05-31 12:00:00][Success] 1: cborg ==0.2.10.0, clock ==0.8.4, mtl ==2.3...
+[2020-05-31 12:00:00][Success] 1: cborg-0.2.10.0, clock-0.8.4, mtl-2.3.1, op...
 
 
 - Successes: 5 (100%)

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ buildProject env idx pkgs = do`
`115`	`115`	`mconcat`
`116`	`116`	`[ T.pack $ show idx,`
`117`	`117`	`": ",`
`118`		`- T.intercalate ", " (Package.toTextInstalled <$> pkgsList)`
	`118`	`+ T.intercalate ", " (Package.toDisplayName <$> pkgsList)`
`119`	`119`	`]`
`120`	`120`	`pkgsList = NE.toList pkgs.unPackageGroup`
`121`	`121`	`pkgsSet = Set.fromList pkgsList`