Add docs on using mise

This commit is contained in:
Dave Rolsky 2025-02-09 17:55:51 -06:00
parent e10d0dcde7
commit c04b5a0b3e
No known key found for this signature in database

View File

@ -161,3 +161,29 @@ you can avoid this issue by structuring your workflow as follows:
4. Run the release steps for crate B.
When structured this way, it does not matter if the output of crate A is deleted in step 3.
## Linting and Tidying this Code
The code in this repo is linted and tidied with
[`precious`](https://github.com/houseabsolute/precious). This repo contains a `mise.toml` file.
[Mise](https://mise.jdx.dev/) is a tool for managing dev tools with per-repo configuration. You can
install `mise` and use it to run `precious` as follows:
```
# Installs mise
curl https://mise.run | sh
# Installs precious and other dev tools
mise install
```
Once this is done, you can run `precious` via `mise`:
```
# Lints all code
mise exec -- precious lint -a
# Tidies all code
mise exec -- precious tidy -a
```
If you want to use `mise` for other projects, see [its documentation](https://mise.jdx.dev/) for
more details on how you can configure your shell to always activate `mise`.