diff options
| author | Jared Allard <jaredallard@users.noreply.github.com> | 2024-01-03 04:02:43 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-03 13:02:43 +0100 |
| commit | b5583a321644218702c4ef588934575f46a2159b (patch) | |
| tree | 1ee62c503c0d9949d9fc756fac593d63525bd559 /plugins/mise | |
| parent | a9b6af5b231227f8ab91f922adc5e0d0a2e6fc08 (diff) | |
| download | zsh-b5583a321644218702c4ef588934575f46a2159b.tar.gz zsh-b5583a321644218702c4ef588934575f46a2159b.tar.bz2 zsh-b5583a321644218702c4ef588934575f46a2159b.zip | |
fix(rtx)!: rename `rtx` plugin to `mise` (#12143)
BREAKING CHANGE: Rename `rtx` plugin to `mise`. The project swapped name
in `v2024.1.0`. Replace references to `rtx` with `mise` while
maintaining backwards compatibility for `rtx` installations.
Co-authored-by: Carlo Sala <carlosalag@protonmail.com>
Diffstat (limited to 'plugins/mise')
| -rw-r--r-- | plugins/mise/README.md | 32 | ||||
| -rw-r--r-- | plugins/mise/mise.plugin.zsh | 23 |
2 files changed, 55 insertions, 0 deletions
diff --git a/plugins/mise/README.md b/plugins/mise/README.md new file mode 100644 index 000000000..8ec05aab9 --- /dev/null +++ b/plugins/mise/README.md @@ -0,0 +1,32 @@ +# mise + +Adds integration with [mise](https://github.com/jdx/mise) (formerly `rtx`), a runtime executor compatible with +npm, nodenv, pyenv, etc. mise is written in rust and is very fast. 20x-200x faster than asdf. With that being +said, mise is compatible with asdf plugins and .tool-versions files. It can be used as a drop-in replacement. + +## Installation + +1. [Download & install mise](https://github.com/jdx/mise#installation) by running the following: + +```bash +curl https://mise.jdx.dev/install.sh | sh +``` + +2. [Enable mise](https://github.com/jdx/mise#quickstart) by adding it to your `plugins` definition in + `~/.zshrc`. + +```bash +plugins=(mise) +``` + +## Usage + +See the [mise readme](https://github.com/jdx/mise#table-of-contents) for information on how to use mise. Here +are a few examples: + +```bash +mise install node Install the current version specified in .tool-versions/.mise.toml +mise use -g node@system Use system node as global default +mise install node@20.0.0 Install a specific version number +mise use -g node@20 Use node-20.x as global default +``` diff --git a/plugins/mise/mise.plugin.zsh b/plugins/mise/mise.plugin.zsh new file mode 100644 index 000000000..1b4d3ae81 --- /dev/null +++ b/plugins/mise/mise.plugin.zsh @@ -0,0 +1,23 @@ +# TODO: 2024-01-03 remove rtx support +local __mise=mise +if (( ! $+commands[mise] )); then + if (( $+commands[rtx] )); then + __mise=rtx + else + return + fi +fi + +# Load mise hooks +eval "$($__mise activate zsh)" + +# If the completion file doesn't exist yet, we need to autoload it and +# bind it to `mise`. Otherwise, compinit will have already done that. +if [[ ! -f "$ZSH_CACHE_DIR/completions/_$__mise" ]]; then + typeset -g -A _comps + autoload -Uz _$__mise + _comps[$__mise]=_$__mise +fi + +# Generate and load mise completion +$__mise completion zsh >| "$ZSH_CACHE_DIR/completions/_$__mise" &| |