slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lib: Hledger.Cli.Version: rename PackageVersionString, more helpers

Browse Source
This commit is contained in:
Simon Michael 2025-04-21 15:14:12 -10:00
parent 50a85fc5ca
commit 5334e7924b
3 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-ui/Hledger/UI/UIOptions.hs
View File

@ -16,7 +16,7 @@ import Hledger.UI.Theme (themes, themeNames)
-- cf Hledger.Cli.Version -- cf Hledger.Cli.Version
packageversion :: PackageVersion packageversion :: PackageVersionString
packageversion = packageversion =
#ifdef VERSION #ifdef VERSION
VERSION VERSION

2
hledger-web/Hledger/Web/WebOptions.hs
View File

@ -26,7 +26,7 @@ import Data.List (isPrefixOf)
-- cf Hledger.Cli.Version -- cf Hledger.Cli.Version
packageversion :: PackageVersion packageversion :: PackageVersionString
packageversion = packageversion =
#ifdef VERSION #ifdef VERSION
VERSION VERSION

32
hledger/Hledger/Cli/Version.hs
View File

@ -5,8 +5,10 @@ Version number-related utilities. See also the Makefile.
module Hledger.Cli.Version ( module Hledger.Cli.Version (
ProgramName, ProgramName,
PackageVersion, PackageVersionString,
VersionString, Version,
DetailedVersionString,
toVersion,
packageversion, packageversion,
packagemajorversion, packagemajorversion,
versionStringWith, versionStringWith,
@ -16,17 +18,31 @@ where
import GitHash (GitInfo, giHash, giCommitDate) -- giDirty import GitHash (GitInfo, giHash, giCommitDate) -- giDirty
import System.Info (os, arch) import System.Info (os, arch)
import Data.List (intercalate) import Data.List (intercalate)
import Data.Maybe (fromMaybe) import Data.List.NonEmpty (NonEmpty, nonEmpty)
import Data.List.Split (splitOn)
import Data.Maybe
import Text.Read (readMaybe)
import Hledger.Utils (ghcDebugSupportedInLib, splitAtElement) import Hledger.Utils (ghcDebugSupportedInLib, splitAtElement)
type ProgramName = String type ProgramName = String
type PackageVersion = String
type VersionString = String type PackageVersionString = String -- ^ A Cabal/Hackage-compatible package version string: one or more dot-separated integers.
type Version = NonEmpty Int -- ^ The number parts parsed from a PackageVersionString.
type DetailedVersionString = String -- ^ A hledger version string, including a package version and other info like a git hash.
-- | Parse a valid Cabal/Hackage-compatible package version.
toVersion :: PackageVersionString -> Maybe Version
toVersion s =
let parts = map readMaybe $ splitOn "." s :: [Maybe Int]
in
if null parts || any isNothing parts
then Nothing
else nonEmpty $ catMaybes parts
-- | The VERSION string defined with -D in this package's package.yaml/.cabal file -- | The VERSION string defined with -D in this package's package.yaml/.cabal file
-- (by Shake setversion), if any. Normally a dotted number string with 1-3 components. -- (by Shake setversion), if any. Normally a dotted number string with 1-3 components.
packageversion :: PackageVersion packageversion :: PackageVersionString
packageversion = packageversion =
#ifdef VERSION #ifdef VERSION
VERSION VERSION
@ -35,7 +51,7 @@ packageversion =
#endif #endif
-- | Just the first 1-2 components of packageversion. -- | Just the first 1-2 components of packageversion.
packagemajorversion :: PackageVersion packagemajorversion :: PackageVersionString
packagemajorversion = intercalate "." $ take 2 $ splitAtElement '.' packageversion packagemajorversion = intercalate "." $ take 2 $ splitAtElement '.' packageversion
-- | Given possible git state info from the build directory (or a git error, which is ignored), -- | Given possible git state info from the build directory (or a git error, which is ignored),
@ -70,7 +86,7 @@ packagemajorversion = intercalate "." $ take 2 $ splitAtElement '.' packageversi
-- This is used indirectly by at least hledger, hledger-ui, and hledger-web, -- This is used indirectly by at least hledger, hledger-ui, and hledger-web,
-- so output should be suitable for all of those. -- so output should be suitable for all of those.
-- --
versionStringWith :: Either String GitInfo -> Bool -> ProgramName -> PackageVersion -> VersionString versionStringWith :: Either String GitInfo -> Bool -> ProgramName -> PackageVersionString -> DetailedVersionString
versionStringWith egitinfo ghcDebugSupportedInThisPackage progname packagever = versionStringWith egitinfo ghcDebugSupportedInThisPackage progname packagever =
concat $ concat $
[ progname , " " , version , ", " , os' , "-" , arch ] [ progname , " " , version , ", " , os' , "-" , arch ]