From 3a193a5fc545d994eeb08727480716168b01aace Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdx@users.noreply.github.com> Date: Wed, 31 Jan 2024 18:09:36 -0600 Subject: [PATCH] docs --- configuration.md | 12 +++++++++--- contributing.md | 8 ++------ 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/configuration.md b/configuration.md index bf71cb3..b658b5f 100644 --- a/configuration.md +++ b/configuration.md @@ -158,7 +158,7 @@ experimental = true # enable experimental features # configure messages displayed when entering directories with config files [settings.status] -missing_tools = true # warn if tools are not installed +missing_tools = "if_other_versions_installed" show_env = false # show configured env vars show_tools = false # show active tools ``` @@ -295,9 +295,15 @@ Disables the specified tools. Separate with `,`. Generally used for core plugins ### `status.missing_tools` -* Type: `bool` +* Type: `enum` * Env: `MISE_STATUS_MISSING_TOOLS` -* Default: `true` +* Default: `if_other_versions_installed` + +| Choice | Description | +|-----------------------------------------|----------------------------------------------------------------------------| +| `if_other_versions_installed` [default] | Show the warning only when the tool has at least 1 other version installed | +| `always` | Always show the warning | +| `never` | Never show the warning | Show a warning if tools are not installed when entering a directory with a `.mise.toml` file. diff --git a/contributing.md b/contributing.md index 6544523..57deb41 100644 --- a/contributing.md +++ b/contributing.md @@ -16,12 +16,6 @@ $ mise run docker:mise run test:e2e # run the e2e tests inside of the docker con $ mise run docker:e2e # shortcut for `mise run docker:mise run test:e2e` ``` -::: info -There used to be a "devcontainer" that was unrelated to this functionality which was compatible with vscode and -github codespaces. I removed this to avoid confusion with the new, simpler dev container that makes use of mise tasks. -I'd accept a pr to make the current dev container compatible with vscode and codespaces or something similar. -::: - ## Testing ### Unit Tests @@ -53,6 +47,8 @@ $ mise run test:e2e ``` ::: +Slow tests do not run by default or on PRs. They can be manually enabled with `TEST_ALL=1`. + ## Dependencies - [rust](https://www.rust-lang.org/) stable 1.70.0+ (I test with the beta channel locally, but CI uses stable, you can use whatever)