Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx committed Feb 1, 2024
1 parent 6cf4b18 commit 3a193a5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
12 changes: 9 additions & 3 deletions configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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.

Expand Down
8 changes: 2 additions & 6 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 3a193a5

Please sign in to comment.