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>master
parent
a9b6af5b23
commit
b5583a3216
4 changed files with 57 additions and 48 deletions
@ -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 |
||||
``` |
||||
@ -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" &| |
||||
@ -1,30 +0,0 @@ |
||||
## rtx |
||||
|
||||
|
||||
Adds integration with [rtx](https://github.com/jdx/rtx), a runtime executor compatible with npm, nodenv, pyenv, etc. rtx is written in rust and is very fast. 20x-200x faster than asdf. With that being said, rtx is compatible with asdf plugins and .tool-versions files. It can be used as a drop-in replacement. |
||||
|
||||
### Installation |
||||
|
||||
1. [Download & install rtx](https://github.com/jdx/rtx#installation) by running the following: |
||||
|
||||
``` |
||||
curl https://rtx.pub/install.sh | sh |
||||
``` |
||||
|
||||
|
||||
2. [Enable rtx](https://github.com/jdx/rtx#quickstart) by adding it to your `plugins` definition in `~/.zshrc`. |
||||
|
||||
``` |
||||
plugins=(rtx) |
||||
``` |
||||
|
||||
### Usage |
||||
|
||||
See the [rtx readme](https://github.com/jdx/rtx#table-of-contents) for information on how to use rtx. Here are a few examples: |
||||
|
||||
``` |
||||
rtx install node Install the current version specified in .tool-versions/.rtx.toml |
||||
rtx use -g node@system Use system node as global default |
||||
rtx install node@20.0.0 Install a specific version number |
||||
rtx use -g node@20 Use node-20.x as global default |
||||
``` |
||||
@ -1,18 +1,2 @@ |
||||
# rtx needs to be in $PATH |
||||
if (( ! ${+commands[rtx]} )); then |
||||
return |
||||
fi |
||||
|
||||
# Load rtx hooks |
||||
eval "$(rtx activate zsh)" |
||||
|
||||
# If the completion file doesn't exist yet, we need to autoload it and |
||||
# bind it to `rtx`. Otherwise, compinit will have already done that. |
||||
if [[ ! -f "$ZSH_CACHE_DIR/completions/_rtx" ]]; then |
||||
typeset -g -A _comps |
||||
autoload -Uz _rtx |
||||
_comps[rtx]=_rtx |
||||
fi |
||||
|
||||
# Generate and load rtx completion |
||||
rtx completion zsh >! "$ZSH_CACHE_DIR/completions/_rtx" &| |
||||
# TODO: 2024-01-03 remove rtx support |
||||
echo "[oh-my-zsh] 'rtx' plugin has been renamed to 'mise'" |
||||
|
||||
Loading…
Reference in new issue