Use numeric version and commit to compute build dir (#3424)

janmasrovira · web-flow · commit 037865f367e0 · 2025-06-04T12:28:36.000+02:00
- Closes #3416 # New command `juvix version` ``` juvix version --help Usage: juvix version [COMMAND] Print the Juvix version in different formats Available options: -h,--help Show this help text Available commands: human [Default] Print a human-readable version with detailed information numeric Print the version in the form x.y.z numeric-commit Print the version in the form x.y.z-commit ``` 1. `juvix version` is the same as `juvix --version`. 1. `juvix version human` is the same as `juvix --version`. 2. `juvix version numeric` is the same as `juvix --numeric-version`. 3. `juvix-version numeric-commit` is new. In my opinion, we should deprecate `juvix --numeric-version` in favour of `juvix version numeric`. I would still keep `juvix --version` because it follows a widespread convention. # New command `juvix dev build-dir` ``` juvix dev build-dir --help Usage: juvix dev build-dir [--relative] Print the absolute path of the build directory for the current project Available options: --relative Print the relative path wrt the project root -h,--help Show this help text ``` # Changes in internal directories ## Global ``` $HOME/.config/juvix/0.6.10 ``` becomes ``` $HOME/.config/juvix/0.6.10-ce9240d409ae32f313bc7a16f696669a8df3158a ``` ## Local ``` my-project/.juvix-build/0.6.10 ``` becomes ``` my-project/.juvix-build/0.6.10-ce9240d409ae32f313bc7a16f696669a8df3158a ``` # Other changes To avoid potential confusion. We now always use the full lenght commit rather than sometimes using the short form.
diff --git a/app/Commands/Clean/Options.hs b/app/Commands/Clean/Options.hs
@@ -17,11 +17,11 @@ parseCleanOptions = do
     switch
       ( long "global"
           <> short 'g'
-          <> help ("Remove also $XDG_CONFIG_HOME/juvix/" <> unpack versionDoc)
+          <> help ("Remove also $XDG_CONFIG_HOME/juvix/" <> unpack fullVersionDoc)
       )
   _cleanOptionsOnlyGlobal <-
     switch
       ( long "global-only"
-          <> help ("Remove only $XDG_CONFIG_HOME/juvix/" <> unpack versionDoc)
+          <> help ("Remove only $XDG_CONFIG_HOME/juvix/" <> unpack fullVersionDoc)
       )
   pure CleanOptions {..}
diff --git a/app/Commands/Dev.hs b/app/Commands/Dev.hs
@@ -10,6 +10,7 @@ import Commands.Dev.Asm qualified as Asm
 import Commands.Dev.Casm qualified as Casm
 import Commands.Dev.Core qualified as Core
 import Commands.Dev.DevCompile qualified as DevCompile
+import Commands.Dev.DisplayBuildDir qualified as DisplayBuildDir
 import Commands.Dev.DisplayRoot qualified as DisplayRoot
 import Commands.Dev.Highlight qualified as Highlight
 import Commands.Dev.ImportTree qualified as ImportTree
@@ -43,6 +44,7 @@ runCommand = \case
   Casm opts -> Casm.runCommand opts
   Runtime opts -> Runtime.runCommand opts
   DisplayRoot opts -> DisplayRoot.runCommand opts
+  DisplayBuildDir opts -> DisplayBuildDir.runCommand opts
   JuvixDevRepl opts -> Repl.runCommand opts
   MigrateJuvixYaml opts -> runFilesIO $ MigrateJuvixYaml.runCommand opts
   Nockma opts -> Nockma.runCommand opts
diff --git a/app/Commands/Dev/DisplayBuildDir.hs b/app/Commands/Dev/DisplayBuildDir.hs
@@ -0,0 +1,15 @@
+module Commands.Dev.DisplayBuildDir where
+
+import Commands.Base
+import Commands.Dev.DisplayBuildDir.Options
+import Juvix.Extra.Paths.Base qualified as Paths
+
+runCommand :: forall r. (Members AppEffects r) => BuildDirOptions -> Sem r ()
+runCommand opts = do
+  fp :: String <-
+    if
+        | opts ^. buildDirRelative -> return (toFilePath Paths.relBuildDir)
+        | otherwise -> do
+            root <- askPkgDir
+            return (toFilePath (Paths.rootBuildDir root))
+  renderStdOutLn fp
diff --git a/app/Commands/Dev/DisplayBuildDir/Options.hs b/app/Commands/Dev/DisplayBuildDir/Options.hs
@@ -0,0 +1,20 @@
+module Commands.Dev.DisplayBuildDir.Options where
+
+import CommonOptions
+
+data BuildDirOptions = BuildDirOptions
+  { _buildDirRelative :: Bool
+  }
+  deriving stock (Data)
+
+makeLenses ''BuildDirOptions
+
+parseBuildDir :: Parser BuildDirOptions
+parseBuildDir = do
+  _buildDirRelative <-
+    switch
+      ( long "relative"
+          <> help "Print the relative path wrt the project root"
+      )
+
+  pure BuildDirOptions {..}
diff --git a/app/Commands/Dev/Options.hs b/app/Commands/Dev/Options.hs
@@ -17,6 +17,7 @@ import Commands.Dev.Asm.Options hiding (Compile)
 import Commands.Dev.Casm.Options
 import Commands.Dev.Core.Options
 import Commands.Dev.DevCompile.Options (DevCompileCommand, parseDevCompileCommand)
+import Commands.Dev.DisplayBuildDir.Options
 import Commands.Dev.DisplayRoot.Options
 import Commands.Dev.Highlight.Options
 import Commands.Dev.ImportTree.Options
@@ -36,6 +37,7 @@ import CommonOptions
 
 data DevCommand
   = DisplayRoot RootOptions
+  | DisplayBuildDir BuildDirOptions
   | ImportTree ImportTreeCommand
   | Latex LatexCommand
   | Highlight HighlightOptions
@@ -73,6 +75,7 @@ parseDevCommand =
           commandParse,
           commandScope,
           commandShowRoot,
+          commandDisplayBuildDir,
           commandTermination,
           commandJuvixDevRepl,
           commandMigrateJuvixYaml,
@@ -173,6 +176,13 @@ commandScope =
       (Scope <$> parseScope)
       (progDesc "Parse and scope a Juvix file")
 
+commandDisplayBuildDir :: Mod CommandFields DevCommand
+commandDisplayBuildDir =
+  command "build-dir" $
+    info
+      (DisplayBuildDir <$> parseBuildDir)
+      (progDesc "Print the absolute path of the build directory for the current project")
+
 commandShowRoot :: Mod CommandFields DevCommand
 commandShowRoot =
   command "root" $
diff --git a/app/Commands/Doctor.hs b/app/Commands/Doctor.hs
@@ -56,7 +56,7 @@ documentedMessage w = uncurry DocumentedMessage (first (baseUrl <>) warningInfo)
       NoWasmer -> ("could-not-find-the-wasmer-command", "Could not find the wasmer command")
 
     baseUrl :: Text
-    baseUrl = "https://docs.juvix.org/" <> V.versionDoc <> "/reference/tooling/doctor/#"
+    baseUrl = "https://docs.juvix.org/" <> V.numericVersionDoc <> "/reference/tooling/doctor/#"
 
 logDoctor :: (Member Logger r) => Text -> Sem r ()
 logDoctor = logInfo . mkAnsiText
@@ -113,7 +113,7 @@ getLatestRelease = do
 checkVersion :: (Members DoctorEff r) => Sem r ()
 checkVersion = do
   heading "Checking latest Juvix release on Github..."
-  let tagName = "v" <> V.versionDoc
+  let tagName = "v" <> V.numericVersionDoc
   response <- runFail getLatestRelease
   case response of
     Just release' -> case release' ^. githubReleaseTagName of
diff --git a/app/Commands/Repl.hs b/app/Commands/Repl.hs
@@ -98,7 +98,7 @@ noFileLoadedErr :: Repl a
 noFileLoadedErr = replError (mkAnsiText @Text "No file loaded. Load a file using the `:load FILE` command.")
 
 welcomeMsg :: (MonadIO m) => m ()
-welcomeMsg = liftIO (putStrLn [i|Juvix REPL version #{versionTag}: https://juvix.org. Run :help for help|])
+welcomeMsg = liftIO (putStrLn [i|Juvix REPL version #{fullVersionDoc}: https://juvix.org. Run :help for help|])
 
 multilineCmd :: String
 multilineCmd = "multiline"
@@ -154,7 +154,7 @@ getReplEntryPointFromPath :: Path Abs File -> Repl EntryPoint
 getReplEntryPointFromPath = getReplEntryPoint (\r a -> runM . runTaggedLockPermissive . entryPointFromGlobalOptions r (Just a))
 
 displayVersion :: String -> Repl ()
-displayVersion _ = liftIO (putStrLn versionTag)
+displayVersion _ = liftIO (putStrLn fullVersionDoc)
 
 replCommand :: ReplOptions -> String -> Repl ()
 replCommand opts input_ = catchAll $ do
diff --git a/app/Commands/Version.hs b/app/Commands/Version.hs
@@ -0,0 +1,11 @@
+module Commands.Version where
+
+import Commands.Base
+import Commands.Version.Options
+import Juvix.Extra.Version
+
+runCommand :: (Members AppEffects r) => VersionCommand -> Sem r ()
+runCommand = \case
+  VersionHuman -> runDisplayVersion
+  VersionNumeric -> runDisplayNumericVersion
+  VersionCommit -> runDisplayFullVersion
diff --git a/app/Commands/Version/Options.hs b/app/Commands/Version/Options.hs
@@ -0,0 +1,29 @@
+module Commands.Version.Options where
+
+import CommonOptions
+
+data VersionCommand
+  = VersionHuman
+  | VersionNumeric
+  | VersionCommit
+  deriving stock (Data)
+
+parseVersionCommand :: Parser VersionCommand
+parseVersionCommand =
+  fromMaybe VersionHuman <$> optional parseVersionCommand'
+
+parseVersionCommand' :: Parser VersionCommand
+parseVersionCommand' =
+  hsubparser $
+    mconcat
+      ( [ command
+            "human"
+            (info (pure VersionHuman) (progDesc "[Default] Print a human-readable version with detailed information")),
+          command
+            "numeric"
+            (info (pure VersionNumeric) (progDesc "Print the version in the form x.y.z")),
+          command
+            "numeric-commit"
+            (info (pure VersionCommit) (progDesc "Print the version in the form x.y.z-commit"))
+        ]
+      )
diff --git a/app/TopCommand.hs b/app/TopCommand.hs
@@ -14,6 +14,7 @@ import Commands.Isabelle qualified as Isabelle
 import Commands.Markdown qualified as Markdown
 import Commands.Repl qualified as Repl
 import Commands.Typecheck qualified as Typecheck
+import Commands.Version qualified as Version
 import Juvix.Extra.Version
 import System.Environment qualified as E
 import TopCommand.Options
@@ -34,6 +35,7 @@ runTopCommand ::
 runTopCommand = \case
   DisplayVersion -> runDisplayVersion
   DisplayNumericVersion -> runDisplayNumericVersion
+  JuvixVersion opts -> Version.runCommand opts
   DisplayHelp -> showHelpText
   Doctor opts -> Doctor.runCommand opts
   Isabelle opts -> Isabelle.runCommand opts
diff --git a/app/TopCommand/Options.hs b/app/TopCommand/Options.hs
@@ -13,13 +13,15 @@ import Commands.Isabelle.Options
 import Commands.Markdown.Options
 import Commands.Repl.Options
 import Commands.Typecheck.Options
+import Commands.Version.Options
 import CommonOptions hiding (Doc)
 import Data.Generics.Uniplate.Data
 import GlobalOptions
 
 data TopCommand
   = DisplayVersion
   | DisplayNumericVersion
+  | JuvixVersion VersionCommand
   | DisplayHelp
   | Typecheck TypecheckOptions
   | Compile CompileCommand
@@ -97,6 +99,7 @@ parseUtility =
           commandInit,
           commandRepl,
           commandFormat,
+          commandVersion,
           commandClean,
           commandDependencies,
           commandDoctor,
@@ -129,6 +132,14 @@ parseUtility =
             (progDesc "Run the Juvix REPL")
         )
 
+    commandVersion :: Mod CommandFields TopCommand
+    commandVersion =
+      command "version" $
+        info
+          (JuvixVersion <$> parseVersionCommand)
+          ( progDesc "Print the Juvix version in different formats"
+          )
+
     commandFormat :: Mod CommandFields TopCommand
     commandFormat =
       command "format" $
diff --git a/src/Juvix/Compiler/Backend/Html/Extra.hs b/src/Juvix/Compiler/Backend/Html/Extra.hs
@@ -141,8 +141,8 @@ htmlJuvixFooter = do
               commitInfo =
                 a
                   ! Attr.href
-                    (textValue ("https://github.com/anoma/juvix/commit/" <> shortHash))
-                  $ toHtml versionTag
+                    (textValue ("https://github.com/anoma/juvix/commit/" <> commit))
+                  $ toHtml fullVersionDoc
 
               juvixVersion :: Html
               juvixVersion =
diff --git a/src/Juvix/Compiler/Pipeline/Lockfile.hs b/src/Juvix/Compiler/Pipeline/Lockfile.hs
@@ -209,7 +209,7 @@ writeLockfile lockfilePath checksum' lf = do
   writeFileBS lockfilePath (header <> encodePretty lockfileEncodeConfig v2lf)
   where
     header :: ByteString
-    header = [i|\# This file was autogenerated by Juvix version #{versionDoc}.\n\# Do not edit this file manually.\n\n|]
+    header = [i|\# This file was autogenerated by Juvix version #{fullVersionDoc}.\n\# Do not edit this file manually.\n\n|]
 
 -- | Extract a lockfileInfo associated with an immediate dependency. Returns Nothing
 -- if the dependency is not specified at the root of the lockfile.
diff --git a/src/Juvix/Extra/Files.hs b/src/Juvix/Extra/Files.hs
@@ -45,7 +45,7 @@ writeVersion :: forall r. (Members '[Reader OutputRoot, Files] r) => Sem r ()
 writeVersion = do
   vf <- versionFile
   ensureDir' (parent vf)
-  writeFileEnsureLn' vf versionTag
+  writeFileEnsureLn' vf fullVersionDoc
 
 readVersion :: (Members '[Reader OutputRoot, Files] r) => Sem r (Maybe Text)
 readVersion = do
@@ -66,5 +66,5 @@ updateFiles action = do
     shouldUpdate =
       orM
         [ not <$> (ask @OutputRoot >>= directoryExists'),
-          (Just versionTag /=) <$> readVersion
+          (Just fullVersionDoc /=) <$> readVersion
         ]
diff --git a/src/Juvix/Extra/Version.hs b/src/Juvix/Extra/Version.hs
@@ -1,6 +1,6 @@
 module Juvix.Extra.Version where
 
-import Data.Version (showVersion)
+import Data.Version (Version, showVersion)
 import GitHash
 import Juvix.Prelude.Base hiding (Doc)
 import Juvix.Prelude.Path
@@ -10,16 +10,24 @@ import Prettyprinter.Render.Text (renderIO)
 import System.Environment qualified as E
 
 versionDir :: Path Rel Dir
-versionDir = relDir (unpack versionDoc)
+versionDir = relDir (unpack fullVersionDoc)
 
 gitInfo :: Maybe GitInfo
 gitInfo = eitherToMaybe $$tGitInfoCwdTry
 
 projectOrUnknown :: (GitInfo -> String) -> Text
 projectOrUnknown p = maybe "UNKNOWN" (pack . p) gitInfo
 
-versionDoc :: Text
-versionDoc = pack (showVersion Paths_juvix.version)
+version :: Version
+version = Paths_juvix.version
+
+-- | Numeric version: x.y.z
+numericVersionDoc :: Text
+numericVersionDoc = pack (showVersion version)
+
+-- | Numeric version plus the commit
+fullVersionDoc :: Text
+fullVersionDoc = pack (showVersion version) <> "-" <> commit
 
 branch :: Text
 branch = projectOrUnknown giBranch
@@ -30,28 +38,22 @@ commit = projectOrUnknown giHash
 commitDate :: Text
 commitDate = projectOrUnknown giCommitDate
 
-shortHash :: Text
-shortHash = projectOrUnknown (take 7 . giHash)
-
-versionTag :: Text
-versionTag = versionDoc <> "-" <> shortHash
-
 progName :: (MonadIO m) => m Text
 progName = pack . toUpperFirst <$> liftIO E.getProgName
 
-progNameVersion :: (MonadIO m) => m Text
-progNameVersion = do
+progNameNumericVersion :: (MonadIO m) => m Text
+progNameNumericVersion = do
   pName <- progName
-  return (pName <> " version " <> versionDoc)
+  return (pName <> " version " <> numericVersionDoc)
 
-progNameVersionTag :: (MonadIO m) => m Text
-progNameVersionTag = do
-  progNameV <- progNameVersion
-  return (progNameV <> "-" <> shortHash)
+progNamePreciseVersion :: (MonadIO m) => m Text
+progNamePreciseVersion = do
+  progNameV <- progNameNumericVersion
+  return (progNameV <> "-" <> commit)
 
 infoVersionRepo :: (MonadIO m) => m (Doc a)
 infoVersionRepo = do
-  pNameTag <- progNameVersionTag
+  pNameTag <- progNamePreciseVersion
   return
     ( PP.pretty pNameTag
         <> line
@@ -75,4 +77,7 @@ runDisplayVersion = do
   liftIO (renderIO stdout v)
 
 runDisplayNumericVersion :: (MonadIO m) => m ()
-runDisplayNumericVersion = putStrLn versionDoc
+runDisplayNumericVersion = putStrLn numericVersionDoc
+
+runDisplayFullVersion :: (MonadIO m) => m ()
+runDisplayFullVersion = putStrLn fullVersionDoc
diff --git a/tests/smoke/Commands/clean.smoke.yaml b/tests/smoke/Commands/clean.smoke.yaml
@@ -38,7 +38,7 @@ tests:
         trap 'rm -rf -- "$temp"' EXIT
         config=$(mktemp -d)
         export XDG_CONFIG_HOME=$config
-        version=$(juvix --numeric-version)
+        version=$(juvix version numeric-commit)
         configDir="$config/juvix/$version"
         cd $temp
         cp "$baseDir/examples/milestone/HelloWorld/HelloWorld.juvix" .
diff --git a/tests/smoke/Commands/compile-dependencies-package-juvix.smoke.yaml b/tests/smoke/Commands/compile-dependencies-package-juvix.smoke.yaml
diff --git a/tests/smoke/Commands/compile-dependencies.smoke.yaml b/tests/smoke/Commands/compile-dependencies.smoke.yaml
diff --git a/tests/smoke/Commands/compile.smoke.yaml b/tests/smoke/Commands/compile.smoke.yaml

Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,11 @@ parseCleanOptions = do`
`17`	`17`	`switch`
`18`	`18`	`( long "global"`
`19`	`19`	`<> short 'g'`
`20`		`- <> help ("Remove also $XDG_CONFIG_HOME/juvix/" <> unpack versionDoc)`
	`20`	`+ <> help ("Remove also $XDG_CONFIG_HOME/juvix/" <> unpack fullVersionDoc)`
`21`	`21`	`)`
`22`	`22`	`_cleanOptionsOnlyGlobal <-`
`23`	`23`	`switch`
`24`	`24`	`( long "global-only"`
`25`		`- <> help ("Remove only $XDG_CONFIG_HOME/juvix/" <> unpack versionDoc)`
	`25`	`+ <> help ("Remove only $XDG_CONFIG_HOME/juvix/" <> unpack fullVersionDoc)`
`26`	`26`	`)`
`27`	`27`	`pure CleanOptions {..}`