feat: lockfiles

.gitignore

@@ -2,6 +2,7 @@
 /dist/
 /node_modules/
 package-lock.json
+.mise.lock
 
 *.log
 *.profraw

docs/.vitepress/cli_commands.ts

@@ -74,7 +74,7 @@ export const commands: { [key: string]: Command } = {
     },
   },
   current: {
-    hide: false,
+    hide: true,
   },
   deactivate: {
     hide: false,

docs/cli/index.md

@@ -46,7 +46,6 @@ Answer yes to all confirmation prompts
 * [`mise config get [-f --file <FILE>] [KEY]`](/cli/config/get.md)
 * [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md)
 * [`mise config set [-f --file <FILE>] [-t --type <TYPE>] <KEY> <VALUE>`](/cli/config/set.md)
-* [`mise current [PLUGIN]`](/cli/current.md)
 * [`mise deactivate`](/cli/deactivate.md)
 * [`mise direnv <SUBCOMMAND>`](/cli/direnv.md)
 * [`mise direnv activate`](/cli/direnv/activate.md)

docs/cli/upgrade.md

@@ -10,6 +10,8 @@ By default, this keeps the range specified in mise.toml. So if you have node@20
 upgrade to the latest 20.x.x version available. See the `--bump` flag to use the latest version
 and bump the version in mise.toml.
 
+This will update mise.lock if it is enabled, see <https://mise.jdx.dev/configuration/settings.html#lockfile>
+
 ## Arguments
 
 ### `[TOOL@VERSION]...`

e2e/lockfile/test_lockfile_exec

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+export MISE_LOCKFILE=1
+export MISE_EXPERIMENTAL=1
+
+mise install [email protected]
+mise use tiny@1
+mise install [email protected]
+assert "mise x -- rtx-tiny" "rtx-tiny: v1.0.0 args:"
+#TODO: assert "mise x tiny -- rtx-tiny" "rtx-tiny: v1.0.0 args:"
+assert "mise x [email protected] -- rtx-tiny" "rtx-tiny: v1.0.1 args:"
+assert "mise x -- rtx-tiny" "rtx-tiny: v1.0.0 args:"
+assert "mise x [email protected] -- rtx-tiny" "rtx-tiny: v3.0.0 args:"

e2e/lockfile/test_lockfile_use

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+export MISE_LOCKFILE=1
+export MISE_EXPERIMENTAL=1
+
+mise install [email protected]
+mise use tiny@1
+mise install [email protected]
+assert "mise config get -f .mise.toml tools.tiny" "1"
+assert "mise where tiny" "$MISE_DATA_DIR/installs/tiny/1.0.0"
+assert "mise ls tiny --json --current | jq -r '.[0].requested_version'" "1"
+assert "mise ls tiny --json --current | jq -r '.[0].version'" "1.0.0"
+assert "cat .mise.lock" '[tools]
+tiny = "1.0.0"'
+
+mise use tiny@1
+assert "cat .mise.lock" '[tools]
+tiny = "1.0.1"'
+assert "mise ls tiny --json --current | jq -r '.[0].requested_version'" "1"
+assert "mise ls tiny --json --current | jq -r '.[0].version'" "1.0.1"
+
+mise up tiny
+assert "cat .mise.lock" '[tools]
+tiny = "1.1.0"'
+assert "mise ls tiny --json --current | jq -r '.[0].requested_version'" "1"
+assert "mise ls tiny --json --current | jq -r '.[0].version'" "1.1.0"
+
+mise up tiny --bump
+assert "cat .mise.lock" '[tools]
+tiny = "3.1.0"'
+assert "mise ls tiny --json --current | jq -r '.[0].requested_version'" "3"
+assert "mise ls tiny --json --current | jq -r '.[0].version'" "3.1.0"

man/man1/mise.1

@@ -59,9 +59,6 @@ Generate shell completions
 mise\-config(1)
 Manage config files
 .TP
-mise\-current(1)
-Shows current active and installed runtime versions
-.TP
 mise\-deactivate(1)
 Disable mise for current shell session
 .TP

mise.usage.kdl

@@ -248,7 +248,7 @@ cmd "config" help="Manage config files" {
         arg "<VALUE>" help="The value to set the key to"
     }
 }
-cmd "current" help="Shows current active and installed runtime versions" {
+cmd "current" hide=true help="Shows current active and installed runtime versions" {
     long_help r"Shows current active and installed runtime versions
 
 This is similar to `mise ls --current`, but this only shows the runtime
@@ -1333,7 +1333,9 @@ cmd "upgrade" help="Upgrades outdated tools" {
 
 By default, this keeps the range specified in mise.toml. So if you have node@20 set, it will
 upgrade to the latest 20.x.x version available. See the `--bump` flag to use the latest version
-and bump the version in mise.toml."
+and bump the version in mise.toml.
+
+This will update mise.lock if it is enabled, see https://mise.jdx.dev/configuration/settings.html#lockfile"
     after_long_help r"Examples:
 
     # Upgrades node to the latest version matching the range in mise.toml

schema/mise.json

@@ -284,6 +284,11 @@
           "description": "Use libgit2 for git operations, set to false to shell out to git.",
           "type": "boolean"
         },
+        "lockfile": {
+          "default": false,
+          "description": "Create and read lockfiles for tool versions.",
+          "type": "boolean"
+        },
         "log_level": {
           "default": "info",
           "description": "Show more/less output.",

settings.toml

@@ -323,6 +323,25 @@ Use libgit2 for git operations. This is generally faster but may not be as compa
 system's libgit2 is not the same version as the one used by mise.
 """
 
+[lockfile]
+env = "MISE_LOCKFILE"
+type = "Bool"
+default = false
+description = "Create and read lockfiles for tool versions."
+docs = """
+Create and read lockfiles for tool versions. This is useful when you'd like to have loose versions in mise.toml like this:
+
+```toml
+[tools]
+node = "22"
+gh = "latest"
+```
+
+But you'd like the versions installed to be consistent within a project. When this is enabled, mise will automatically
+create mise.lock files next to mise.toml files containing pinned versions.
+When installing tools, mise will reference this lockfile if it exists and this setting is enabled to resolve versions.
+"""
+
 [log_level]
 env = "MISE_LOG_LEVEL"
 type = "String"

src/backend/asdf.rs

@@ -383,7 +383,7 @@ impl Backend for AsdfBackend {
             .cache
             .list_bin_paths(self, tv, || self.fetch_bin_paths(tv))?
             .into_iter()
-            .map(|path| tv.install_short_path().join(path))
+            .map(|path| tv.install_path().join(path))
             .collect())
     }
 

src/backend/mod.rs

@@ -491,7 +491,7 @@ pub trait Backend: Debug + Send + Sync {
     fn list_bin_paths(&self, tv: &ToolVersion) -> eyre::Result<Vec<PathBuf>> {
         match tv.request {
             ToolRequest::System(..) => Ok(vec![]),
-            _ => Ok(vec![tv.install_short_path().join("bin")]),
+            _ => Ok(vec![tv.install_path().join("bin")]),
         }
     }
 

src/cli/current.rs

@@ -12,7 +12,7 @@ use crate::toolset::{Toolset, ToolsetBuilder};
 /// This is similar to `mise ls --current`, but this only shows the runtime
 /// and/or version. It's designed to fit into scripts more easily.
 #[derive(Debug, clap::Args)]
-#[clap(verbatim_doc_comment, after_long_help = AFTER_LONG_HELP)]
+#[clap(verbatim_doc_comment, hide = true, after_long_help = AFTER_LONG_HELP)]
 pub struct Current {
     /// Plugin to show versions of
     /// e.g.: ruby, node, cargo:eza, npm:prettier, etc.

src/cli/install.rs

@@ -1,8 +1,9 @@
 use crate::cli::args::{BackendArg, ToolArg};
 use crate::config::Config;
+use crate::lockfile;
 use crate::toolset::{InstallOptions, ToolRequest, ToolSource, ToolVersion, Toolset};
 use crate::ui::multi_progress_report::MultiProgressReport;
-use eyre::Result;
+use eyre::{Result, WrapErr};
 use itertools::Itertools;
 use std::collections::HashSet;
 
@@ -64,7 +65,9 @@ impl Install {
             warn!("specify a version with `mise install <PLUGIN>@<VERSION>`");
             return Ok(vec![]);
         }
-        ts.install_versions(config, tool_versions, &mpr, &self.install_opts())
+        let versions = ts.install_versions(config, tool_versions, &mpr, &self.install_opts())?;
+        lockfile::update_lockfiles(&versions).wrap_err("failed to update lockfiles")?;
+        Ok(versions)
     }
 
     fn install_opts(&self) -> InstallOptions {
@@ -125,7 +128,9 @@ impl Install {
         }
         let mpr = MultiProgressReport::get();
         let mut ts = Toolset::from(trs.clone());
-        ts.install_versions(config, versions, &mpr, &self.install_opts())
+        let versions = ts.install_versions(config, versions, &mpr, &self.install_opts())?;
+        lockfile::update_lockfiles(&versions).wrap_err("failed to update lockfiles")?;
+        Ok(versions)
     }
 }
 

src/cli/settings/ls.rs

@@ -84,6 +84,7 @@ mod tests {
         legacy_version_file = true
         legacy_version_file_disable_tools = []
         libgit2 = true
+        lockfile = false
         not_found_auto_install = true
         paranoid = false
         pin = false
@@ -153,6 +154,7 @@ mod tests {
         legacy_version_file
         legacy_version_file_disable_tools
         libgit2
+        lockfile
         node
         not_found_auto_install
         paranoid

src/cli/settings/set.rs

@@ -150,6 +150,7 @@ pub mod tests {
         legacy_version_file = false
         legacy_version_file_disable_tools = []
         libgit2 = true
+        lockfile = false
         not_found_auto_install = true
         paranoid = false
         pin = false

src/cli/settings/unset.rs

@@ -75,6 +75,7 @@ mod tests {
         legacy_version_file = true
         legacy_version_file_disable_tools = []
         libgit2 = true
+        lockfile = false
         not_found_auto_install = true
         paranoid = false
         pin = false

src/cli/uninstall.rs

@@ -10,7 +10,7 @@ use crate::cli::args::ToolArg;
 use crate::config::Config;
 use crate::toolset::{ToolRequest, ToolSource, ToolVersion, ToolsetBuilder};
 use crate::ui::multi_progress_report::MultiProgressReport;
-use crate::{backend, runtime_symlinks, shims};
+use crate::{backend, lockfile, runtime_symlinks, shims};
 
 /// Removes installed tool versions
 ///
@@ -67,6 +67,7 @@ impl Uninstall {
             }
         }
 
+        lockfile::update_lockfiles(&[]).wrap_err("failed to update lockfiles")?;
         let ts = ToolsetBuilder::new().build(&config)?;
         shims::reshim(&ts, false).wrap_err("failed to reshim")?;
         runtime_symlinks::rebuild(&config)?;

src/cli/upgrade.rs

@@ -4,7 +4,7 @@ use crate::file::display_path;
 use crate::toolset::{InstallOptions, OutdatedInfo, ToolVersion, ToolsetBuilder};
 use crate::ui::multi_progress_report::MultiProgressReport;
 use crate::ui::progress_report::SingleReport;
-use crate::{runtime_symlinks, shims, ui};
+use crate::{lockfile, runtime_symlinks, shims, ui};
 use demand::DemandOption;
 use eyre::{Context, Result};
 
@@ -13,6 +13,8 @@ use eyre::{Context, Result};
 /// By default, this keeps the range specified in mise.toml. So if you have node@20 set, it will
 /// upgrade to the latest 20.x.x version available. See the `--bump` flag to use the latest version
 /// and bump the version in mise.toml.
+///
+/// This will update mise.lock if it is enabled, see https://mise.jdx.dev/configuration/settings.html#lockfile
 #[derive(Debug, clap::Args)]
 #[clap(visible_alias = "up", verbatim_doc_comment, after_long_help = AFTER_LONG_HELP)]
 pub struct Upgrade {
@@ -142,7 +144,7 @@ impl Upgrade {
             latest_versions: true,
         };
         let new_versions = outdated.iter().map(|o| o.tool_request.clone()).collect();
-        ts.install_versions(config, new_versions, &mpr, &opts)?;
+        let versions = ts.install_versions(config, new_versions, &mpr, &opts)?;
 
         for (o, bump, mut cf) in config_file_updates {
             cf.replace_versions(o.tool_request.backend(), &[bump])?;
@@ -154,6 +156,7 @@ impl Upgrade {
             self.uninstall_old_version(&o.tool_version, pr.as_ref())?;
         }
 
+        lockfile::update_lockfiles(&versions).wrap_err("failed to update lockfiles")?;
         let ts = ToolsetBuilder::new().with_args(&self.tool).build(config)?;
         shims::reshim(&ts, false).wrap_err("failed to reshim")?;
         runtime_symlinks::rebuild(config)?;

src/cli/use.rs

@@ -1,7 +1,7 @@
 use std::path::{Path, PathBuf};
 
 use console::style;
-use eyre::Result;
+use eyre::{Result, WrapErr};
 use itertools::Itertools;
 
 use crate::cli::args::{BackendArg, ToolArg};
@@ -13,7 +13,7 @@ use crate::env::{
 use crate::file::display_path;
 use crate::toolset::{InstallOptions, ToolRequest, ToolSource, ToolVersion, ToolsetBuilder};
 use crate::ui::multi_progress_report::MultiProgressReport;
-use crate::{env, file};
+use crate::{env, file, lockfile};
 
 /// Installs a tool and adds the version it to mise.toml.
 ///
@@ -97,7 +97,7 @@ impl Use {
                 None => ToolRequest::new(t.backend, "latest", ToolSource::Argument),
             })
             .collect::<Result<_>>()?;
-        let versions = ts.install_versions(
+        let mut versions = ts.install_versions(
             &config,
             versions.clone(),
             &mpr,
@@ -133,6 +133,14 @@ impl Use {
             cf.remove_plugin(plugin_name)?;
         }
         cf.save()?;
+
+        for tv in &mut versions {
+            // update the source so the lockfile is updated correctly
+            tv.request.set_source(cf.source());
+        }
+
+        lockfile::update_lockfiles(&versions).wrap_err("failed to update lockfiles")?;
+
         self.render_success_message(cf.as_ref(), &versions)?;
         Ok(())
     }

src/cli/where.rs

@@ -30,39 +30,29 @@ pub struct Where {
 impl Where {
     pub fn run(self) -> Result<()> {
         let config = Config::try_get()?;
-        let runtime = match self.tool.tvr {
+        let tvr = match self.tool.tvr {
+            Some(tvr) => tvr,
             None => match self.asdf_version {
-                Some(version) => self.tool.with_version(&version),
+                Some(version) => self.tool.with_version(&version).tvr.unwrap(),
                 None => {
-                    let ts = ToolsetBuilder::new()
-                        .with_args(&[self.tool.clone()])
-                        .build(&config)?;
-                    let v = ts
-                        .versions
+                    let ts = ToolsetBuilder::new().build(&config)?;
+                    ts.versions
                         .get(&self.tool.backend)
-                        .and_then(|v| v.requests.first())
-                        .map(|r| r.version());
-                    self.tool.with_version(&v.unwrap_or(String::from("latest")))
+                        .and_then(|tvr| tvr.requests.first().cloned())
+                        .unwrap_or_else(|| self.tool.with_version("latest").tvr.unwrap())
                 }
             },
-            _ => self.tool,
         };
 
-        let plugin = backend::get(&runtime.backend);
+        let ba = tvr.backend();
+        let backend = backend::get(ba);
+        let tv = tvr.resolve(backend.as_ref(), false)?;
 
-        match runtime
-            .tvr
-            .as_ref()
-            .map(|tvr| tvr.resolve(plugin.as_ref(), false))
-        {
-            Some(Ok(tv)) if plugin.is_version_installed(&tv, true) => {
-                miseprintln!("{}", tv.install_path().to_string_lossy());
-                Ok(())
-            }
-            _ => Err(VersionNotInstalled(
-                runtime.backend.to_string(),
-                runtime.tvr.map(|tvr| tvr.version()).unwrap_or_default(),
-            ))?,
+        if backend.is_version_installed(&tv, true) {
+            miseprintln!("{}", tv.install_path().to_string_lossy());
+            Ok(())
+        } else {
+            Err(VersionNotInstalled(ba.to_string(), tvr.version()))?
         }
     }
 }