chore: ran prettier on project (#2732)

jdx · Oct 12, 2024 · 504271c · 504271c
1 parent 7d1b6ac
commit 504271c
Show file tree

Hide file tree

Showing 37 changed files with 140 additions and 120 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,10 @@
 CHANGELOG.md
 .venv
 registry/
+docs/cli
+docs/environments.md
+docs/registry.md
+docs/.vitepress/dist
+docs/public/site.webmanifest
+schema/mise.json.hbs
+tasks.md
diff --git a/docs/cli/activate.md b/docs/cli/activate.md
@@ -35,6 +35,7 @@ Shell type to generate the script for
 
 Use shims instead of modifying PATH
 Effectively the same as:
+
     PATH="$HOME/.local/share/mise/shims:$PATH"
 
 ### `-q --quiet`

diff --git a/docs/cli/alias/get.md b/docs/cli/alias/get.md
@@ -17,5 +17,6 @@ The plugin to show the alias for
 The alias to show
 
 Examples:
+
    $ mise alias get node lts-hydrogen
    20.0.0
diff --git a/docs/cli/plugins/install.md b/docs/cli/plugins/install.md
@@ -40,6 +40,7 @@ i.e.: they don't need the full git repo url
 Show installation output
 
 Examples:
+
     # install the node via shorthand
     $ mise plugins install node
 

diff --git a/docs/cli/plugins/link.md b/docs/cli/plugins/link.md
@@ -27,6 +27,7 @@ e.g.: ./mise-node
 Overwrite existing plugin
 
 Examples:
+
     # essentially just `ln -s ./mise-node ~/.local/share/mise/plugins/node`
     $ mise plugins link node ./mise-node
 

diff --git a/docs/cli/plugins/ls-remote.md b/docs/cli/plugins/ls-remote.md
@@ -9,7 +9,8 @@ List all available remote plugins
 The full list is here: <https://github.com/jdx/mise/blob/main/src/default_shorthands.rs>
 
 Examples:
-  $ mise plugins ls-remote
+
+    mise plugins ls-remote
 
 ## Flags
 

diff --git a/docs/cli/uninstall.md b/docs/cli/uninstall.md
@@ -27,7 +27,7 @@ Do not actually delete anything
 Examples:
 
     # will uninstall specific version
-    $ mise uninstall [email protected] 
+    $ mise uninstall [email protected]
 
     # will uninstall the current node version (if only one version is installed)
     $ mise uninstall node

diff --git a/docs/cli/unset.md b/docs/cli/unset.md
@@ -27,6 +27,6 @@ Examples:
 
     # Remove NODE_ENV from the current directory's config
     $ mise unset NODE_ENV
-    
+
     # Remove NODE_ENV from the global config
     $ mise unset NODE_ENV -g
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -219,7 +219,7 @@ They support aliases, which means you can have an `.nvmrc` file with `lts/hydrog
 in mise and nvm. Here are some of the supported legacy version files:
 
 | Plugin    | "Legacy" (Idiomatic) Files                         |
-|-----------|----------------------------------------------------|
+| --------- | -------------------------------------------------- |
 | crystal   | `.crystal-version`                                 |
 | elixir    | `.exenv-version`                                   |
 | go        | `.go-version`, `go.mod`                            |

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -66,24 +66,24 @@ Mise uses mise itself to run tasks. See available tasks with `mise tasks`:
 
 ```sh
 ~/src/mise ❯ mise tasks
-build                                                        ~/src/mise/.mise.toml          
-clean                                                        ~/src/mise/.mise.toml          
-docker:cargo        run cargo inside of development docker … ~/src/mise/.mise.toml          
-docker:e2e          run e2e tests inside of development doc… ~/src/mise/.mise.toml          
-docker:image        build docker image from Dockerfile       ~/src/mise/.mise.toml          
-docker:mise         run mise inside of development docker c… ~/src/mise/.mise.toml          
-format                                                       ~/src/mise/.mise.toml          
-lint                                                         ~/src/mise/.mise/config.toml   
-lint:fix                                                     ~/src/mise/.mise.toml          
-release                                                      ~/src/mise/.mise.toml          
-render                                                       ~/src/mise/.mise.toml          
-render:completions                                           ~/src/mise/.mise.toml          
-render:help                                                  ~/src/mise/.mise.toml          
-render:mangen                                                ~/src/mise/.mise.toml          
-signal-test                                                  ~/src/mise/.mise.toml          
-snapshots           Update test snapshots                    ~/src/mise/.mise.toml          
-test                                                         ~/src/mise/.mise.toml          
-test:e2e                                                     ~/src/mise/.mise.toml          
+build                                                        ~/src/mise/.mise.toml
+clean                                                        ~/src/mise/.mise.toml
+docker:cargo        run cargo inside of development docker … ~/src/mise/.mise.toml
+docker:e2e          run e2e tests inside of development doc… ~/src/mise/.mise.toml
+docker:image        build docker image from Dockerfile       ~/src/mise/.mise.toml
+docker:mise         run mise inside of development docker c… ~/src/mise/.mise.toml
+format                                                       ~/src/mise/.mise.toml
+lint                                                         ~/src/mise/.mise/config.toml
+lint:fix                                                     ~/src/mise/.mise.toml
+release                                                      ~/src/mise/.mise.toml
+render                                                       ~/src/mise/.mise.toml
+render:completions                                           ~/src/mise/.mise.toml
+render:help                                                  ~/src/mise/.mise.toml
+render:mangen                                                ~/src/mise/.mise.toml
+signal-test                                                  ~/src/mise/.mise.toml
+snapshots           Update test snapshots                    ~/src/mise/.mise.toml
+test                                                         ~/src/mise/.mise.toml
+test:e2e                                                     ~/src/mise/.mise.toml
 ```
 
 ## Setup

diff --git a/docs/dev-tools/backends/cargo.md b/docs/dev-tools/backends/cargo.md
@@ -63,9 +63,9 @@ Set these with `mise settings set [VARIABLE] [VALUE]` or by setting the environm
 
 ### `cargo_binstall`
 
-* Type: `bool`
-* Env: `MISE_CARGO_BINSTALL`
-* Default: `true`
+- Type: `bool`
+- Env: `MISE_CARGO_BINSTALL`
+- Default: `true`
 
 If true, mise will use `cargo binstall` instead of `cargo install` if
 [`cargo-binstall`](https://crates.io/crates/cargo-binstall) is installed and on PATH.

diff --git a/docs/dev-tools/backends/index.md b/docs/dev-tools/backends/index.md
@@ -2,15 +2,15 @@
 
 In addition to asdf plugins, you can also directly install CLIs with some package managers.
 
-* [asdf](/dev-tools/backends/asdf)
-* [Cargo](/dev-tools/backends/cargo)
-* [Go](/dev-tools/backends/go) <Badge type="warning" text="experimental" />
-* [NPM](/dev-tools/backends/npm)
-* [Pipx](/dev-tools/backends/pipx) <Badge type="warning" text="experimental" />
-* [SPM](/dev-tools/backends/spm) <Badge type="warning" text="experimental" />
-* [Ubi](/dev-tools/backends/ubi) <Badge type="warning" text="experimental" />
-* [Vfox](/dev-tools/backends/vfox) <Badge type="warning" text="experimental" />
-* [More coming soon!](https://github.com/jdx/mise/discussions/1250)
+- [asdf](/dev-tools/backends/asdf)
+- [Cargo](/dev-tools/backends/cargo)
+- [Go](/dev-tools/backends/go) <Badge type="warning" text="experimental" />
+- [NPM](/dev-tools/backends/npm)
+- [Pipx](/dev-tools/backends/pipx) <Badge type="warning" text="experimental" />
+- [SPM](/dev-tools/backends/spm) <Badge type="warning" text="experimental" />
+- [Ubi](/dev-tools/backends/ubi) <Badge type="warning" text="experimental" />
+- [Vfox](/dev-tools/backends/vfox) <Badge type="warning" text="experimental" />
+- [More coming soon!](https://github.com/jdx/mise/discussions/1250)
 
 ::: tip
 If you'd like to contribute a new backend to mise, they're not difficult to write.

diff --git a/docs/dev-tools/backends/pipx.md b/docs/dev-tools/backends/pipx.md
@@ -59,9 +59,9 @@ Set these with `mise settings set [VARIABLE] [VALUE]` or by setting the environm
 
 ### `pipx_uvx`
 
-* Type: `bool`
-* Env: `MISE_PIPX_UVX`
-* Default: `false`
+- Type: `bool`
+- Env: `MISE_PIPX_UVX`
+- Default: `false`
 
 If true, mise will use `uvx` instead of `pipx` if
 [`uv`](https://docs.astral.sh/uv/) is installed and on PATH.

diff --git a/docs/dev-tools/backends/spm.md b/docs/dev-tools/backends/spm.md
@@ -34,11 +34,11 @@ The version will be set in `~/.config/mise/config.toml` with the following forma
 
 ### Supported Syntax
 
-| Description                                   | Usage                                                     |
-| --------------------------------------------- | --------------------------------------------------------- |
-| GitHub shorthand for latest release version   | `spm:tuist/tuist`                                         |
-| GitHub shorthand for specific release version | `spm:tuist/[email protected]`                                  |
-| GitHub url for latest release version         | `spm:https://github.com/tuist/tuist.git`                  |
-| GitHub url for specific release version       | `spm:https://github.com/tuist/[email protected]`           |
+| Description                                   | Usage                                           |
+| --------------------------------------------- | ----------------------------------------------- |
+| GitHub shorthand for latest release version   | `spm:tuist/tuist`                               |
+| GitHub shorthand for specific release version | `spm:tuist/[email protected]`                        |
+| GitHub url for latest release version         | `spm:https://github.com/tuist/tuist.git`        |
+| GitHub url for specific release version       | `spm:https://github.com/tuist/[email protected]` |
 
 Other syntax may work but is unsupported and untested.
diff --git a/docs/dev-tools/index.md b/docs/dev-tools/index.md
@@ -25,10 +25,10 @@ mise can be configured in many ways. The most typical is by `.mise.toml`, but it
 with asdf `.tool-versions` files. It can also use idiomatic version files like `.node-version` and
 `.ruby-version`. See [Configuration](/configuration) for more.
 
-* Like [direnv](https://github.com/direnv/direnv) it
+- Like [direnv](https://github.com/direnv/direnv) it
   manages [environment variables](/configuration#env---arbitrary-environment-variables) for
   different project directories.
-* Like [make](https://www.gnu.org/software/make/manual/make.html) it manages [tasks](/tasks/) used
+- Like [make](https://www.gnu.org/software/make/manual/make.html) it manages [tasks](/tasks/) used
   to build and test projects.
 
 ## How it works
@@ -97,11 +97,11 @@ if you wish or you want to use a plugin not in the default registry.
 
 There are many ways it can be used:
 
-* `mise install [email protected]` - install a specific version
-* `mise install node@20` - install the latest version matching this prefix
-* `mise install node` - install whatever version of node currently specified in
+- `mise install [email protected]` - install a specific version
+- `mise install node@20` - install the latest version matching this prefix
+- `mise install node` - install whatever version of node currently specified in
   .tool-versions/.mise.toml
-* `mise install` - install all plugins and tools
+- `mise install` - install all plugins and tools
 
 ### `mise local|global` <Badge type="danger" text="not recommended" />
 

diff --git a/docs/directories.md b/docs/directories.md
@@ -8,16 +8,16 @@ If you often find yourself using these directories (as I do), I suggest setting
 
 ## `~/.config/mise`
 
-* Override: `$MISE_CONFIG_DIR`
-* Default: `${XDG_CONFIG_HOME:-$HOME/.config}/mise`
+- Override: `$MISE_CONFIG_DIR`
+- Default: `${XDG_CONFIG_HOME:-$HOME/.config}/mise`
 
 This directory stores the global configuration file `~/.config/mise/config.toml`. This is intended to go into your
 dotfiles repo to share across machines.
 
 ## `~/.cache/mise`
 
-* Override: `$MISE_CACHE_DIR`
-* Default: `${XDG_CACHE_HOME:-$HOME/.cache}/mise`, _macOS: `~/Library/Caches/mise`._
+- Override: `$MISE_CACHE_DIR`
+- Default: `${XDG_CACHE_HOME:-$HOME/.cache}/mise`, _macOS: `~/Library/Caches/mise`._
 
 Stores internal cache that mise uses for things like the list of all available versions of a
 plugin. Do not share this across machines. You may delete this directory any time mise isn't actively installing something.
@@ -26,16 +26,16 @@ See [Cache Behavior](/cache-behavior) for more information.
 
 ## `~/.local/state/mise`
 
-* Override: `$MISE_STATE_DIR`
-* Default: `${XDG_STATE_HOME:-$HOME/.local/state}/mise`
+- Override: `$MISE_STATE_DIR`
+- Default: `${XDG_STATE_HOME:-$HOME/.local/state}/mise`
 
 Used for storing state local to the machine such as which config files are trusted. These should not be shared across
 machines.
 
 ## `~/.local/share/mise`
 
-* Override: `$MISE_DATA_DIR`
-* Default: `${XDG_DATA_HOME:-$HOME/.local/share}/mise`
+- Override: `$MISE_DATA_DIR`
+- Default: `${XDG_DATA_HOME:-$HOME/.local/share}/mise`
 
 This is the main directory that mise uses and is where plugins and tools are installed into.
 It is nearly identical to `~/.asdf` in asdf, so much so that you may be able to get by

diff --git a/docs/environments.md b/docs/environments.md
@@ -31,7 +31,7 @@ $ mise unset NODE_ENV
 
 `env._.*` define special behavior for setting environment variables. (e.g.: reading env vars
 from a file). Since nested environment variables do not make sense,
-we make use of this fact by creating a key named "_" which is a
+we make use of this fact by creating a key named "\_" which is a
 TOML table for the configuration of these directives.
 
 ### `env._.file`

diff --git a/docs/ide-integration.md b/docs/ide-integration.md
@@ -6,8 +6,8 @@ to add the mise shim directory to PATH.
 For IntelliJ and VSCode—and likely others, you can modify your default shell's profile
 script. Your default shell can be found with:
 
-* macos – `dscl . -read /Users/$USER UserShell`
-* linux – `getent passwd $USER | cut -d: -f7`
+- macos – `dscl . -read /Users/$USER UserShell`
+- linux – `getent passwd $USER | cut -d: -f7`
 
 You can change your default shell with `chsh -s /path/to/shell` but you may need
 to first add it to `/etc/shells`.
@@ -90,7 +90,7 @@ add `$(SRCROOT)/.mise.toml` to the list of **Input files**. This is necessary fo
 reads to that file. Then, you can use `mise activate` to activate the tools you need:
 
 ```bash
-# -C ensures that Mise loads the configuration from the Mise configuration 
+# -C ensures that Mise loads the configuration from the Mise configuration
 # file in the project's root directory.
 eval "$($HOME/.local/bin/mise activate -C $SRCROOT bash --shims)"
 
@@ -135,11 +135,7 @@ the tools in `launch.json`:
       "linux": {
         "runtimeExecutable": "mise"
       },
-      "runtimeArgs": [
-        "x",
-        "--",
-        "node"
-      ]
+      "runtimeArgs": ["x", "--", "node"]
     }
   ]
 }

diff --git a/docs/index.md b/docs/index.md
@@ -6,8 +6,8 @@ title: Home
 hero:
   name: mise-en-place
   tagline: |
-      The front-end to your dev env
-      <span class="formerly">Pronounced "MEEZ ahn plahs"</span>
+    The front-end to your dev env
+    <span class="formerly">Pronounced "MEEZ ahn plahs"</span>
   actions:
     - theme: brand
       text: Getting Started

diff --git a/docs/lang/go.md b/docs/lang/go.md
@@ -31,33 +31,33 @@ Set these with `mise settings set [VARIABLE] [VALUE]` or by setting the environm
 
 ### `go_default_packages_file`
 
-* Type: `string`
-* Env: `MISE_GO_DEFAULT_PACKAGES_FILE`
-* Default: `~/.default-go-packages`
+- Type: `string`
+- Env: `MISE_GO_DEFAULT_PACKAGES_FILE`
+- Default: `~/.default-go-packages`
 
 Packages list to install with `go install` after installing a Go version.
 
 ### `go_download_mirror`
 
-* Type: `string`
-* Env: `MISE_GO_DOWNLOAD_MIRROR`
-* Default: `https://dl.google.com/go`
+- Type: `string`
+- Env: `MISE_GO_DOWNLOAD_MIRROR`
+- Default: `https://dl.google.com/go`
 
 URL to download go sdk tarballs from.
 
 ### `go_repo`
 
-* Type: `string`
-* Env: `MISE_GO_REPO`
-* Default: `https://github.com/golang/go`
+- Type: `string`
+- Env: `MISE_GO_REPO`
+- Default: `https://github.com/golang/go`
 
 Used to get latest go version from GitHub releases.
 
 ### `go_set_gobin`
 
-* Type: `bool | null`
-* Env: `MISE_GO_SET_GOBIN`
-* Default: `null`
+- Type: `bool | null`
+- Env: `MISE_GO_SET_GOBIN`
+- Default: `null`
 
 Sets `GOBIN` to `~/.local/share/mise/go/installs/[VERSION]/bin`. This causes CLIs installed via
 `go install` to have shims created for it which will have env vars from mise such as GOROOT set.
@@ -68,19 +68,19 @@ method to install Go CLIs.
 
 ### `go_set_gopath` <Badge type="warning" text="deprecated" />
 
-* Type: `bool`
-* Env: `MISE_GO_SET_GOPATH`
-* Default: `false`
+- Type: `bool`
+- Env: `MISE_GO_SET_GOPATH`
+- Default: `false`
 
 Sets `GOPATH` to `~/.local/share/mise/go/installs/[VERSION]/packages`. This retains behavior from
 asdf and older mise versions. There is no known reason for this to be enabled but it is available
 (for now) just in case anyone relies on it.
 
 ### `go_skip_checksum`
 
-* Type: `bool`
-* Env: `MISE_GO_SKIP_CHECKSUM`
-* Default: `false`
+- Type: `bool`
+- Env: `MISE_GO_SKIP_CHECKSUM`
+- Default: `false`
 
 Skips checksum verification of downloaded go tarballs.
 

diff --git a/docs/lang/java.md b/docs/lang/java.md
@@ -69,8 +69,7 @@ ln -s ~/.sdkman/candidates/java/21.0.1-open ~/.local/share/mise/installs/java/21
 cp ~/.local/share/mise/installs/java/21.0.1-open/lib/libjli.dylib ~/.local/share/mise/installs/java/21.0.1-open/Contents/MacOS/libjli.dylib
 ```
 
-4. Don't forget to make sure the cache is blocked and valid, by making sure an **empty** directory *
-   *exists** for your version in the [mise cache](https://mise.jdx.dev/directories.html#cache-mise):
+4. Don't forget to make sure the cache is blocked and valid, by making sure an **empty** directory **exists** for your version in the [mise cache](https://mise.jdx.dev/directories.html#cache-mise):
    e.g.
 
 ```sh