From 89a740be2d5487c96f01e4eaae7e280caf555019 Mon Sep 17 00:00:00 2001 From: Carlo Sala Date: Wed, 6 Oct 2021 22:43:09 +0200 Subject: [PATCH] refactor(rust)!: merge `cargo` and `rustup` plugins into `rust` plugin (#10270) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit BREAKING CHANGE: `cargo` and `rustup` plugins have been moved to the `rust` plugin since they're part of the Rust toolchain. If you're using these, update your .zshrc file to use `rust` instead. Closes #10270 Co-authored-by: Marc Cornellà --- plugins/cargo/README.md | 10 +--------- plugins/cargo/cargo.plugin.zsh | 27 +++++++-------------------- plugins/rust/README.md | 2 +- plugins/rust/{_rust => _rustc} | 0 plugins/rust/rust.plugin.zsh | 28 ++++++++++++++++++++++++++++ plugins/rustup/README.md | 8 +------- plugins/rustup/rustup.plugin.zsh | 27 +++++++-------------------- 7 files changed, 45 insertions(+), 57 deletions(-) rename plugins/rust/{_rust => _rustc} (100%) create mode 100644 plugins/rust/rust.plugin.zsh diff --git a/plugins/cargo/README.md b/plugins/cargo/README.md index 31bae4efe..93e69ae7f 100644 --- a/plugins/cargo/README.md +++ b/plugins/cargo/README.md @@ -1,11 +1,3 @@ # cargo -This plugin adds completion for the Rust build tool [`Cargo`](https://github.com/rust-lang/cargo). - -To use it, add `cargo` to the plugins array in your zshrc file: - -```zsh -plugins=(... cargo) -``` - -Updated on March 3rd, 2019, from [Cargo 0.34.0](https://github.com/rust-lang/cargo/releases/tag/0.34.0). +**Deprecated: use the [`rust`](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/rust) plugin instead.** diff --git a/plugins/cargo/cargo.plugin.zsh b/plugins/cargo/cargo.plugin.zsh index 9d1d23757..51a80d4f1 100644 --- a/plugins/cargo/cargo.plugin.zsh +++ b/plugins/cargo/cargo.plugin.zsh @@ -1,24 +1,11 @@ -if ! (( $+commands[rustup] && $+commands[cargo] )); then - return -fi +print ${(%):-'%F{yellow}The `cargo` plugin is deprecated and has been moved to the `rust` plugin.'} +print ${(%):-'Please update your .zshrc to use the `%Brust%b` plugin instead.%f'} # Remove old generated completion file -# TODO: 2021-09-15: remove this line +# TODO: 2021-12-28: remove this line command rm -f "${0:A:h}/_cargo" -# Add completions/ folder in $ZSH_CACHE_DIR -comp_file="$ZSH_CACHE_DIR/completions/_cargo" -command mkdir -p "${comp_file:h}" -(( ${fpath[(Ie)"$ZSH_CACHE_DIR/completions"]} )) || fpath=("$ZSH_CACHE_DIR/completions" $fpath) - -# If the completion file doesn't exist yet, we need to autoload it and -# bind it to `cargo`. Otherwise, compinit will have already done that -if [[ ! -f "$comp_file" ]]; then - autoload -Uz _cargo - declare -A _comps - _comps[cargo]=_cargo -fi - -# Generate completion file in the background -rustup completions zsh cargo >| "$comp_file" &| -unset comp_file +(( ${fpath[(Ie)$ZSH/plugins/rust]} )) || { + fpath=("$ZSH/plugins/rust" $fpath) + source "$ZSH/plugins/rust/rust.plugin.zsh" +} diff --git a/plugins/rust/README.md b/plugins/rust/README.md index 83d7d91ba..e05364474 100644 --- a/plugins/rust/README.md +++ b/plugins/rust/README.md @@ -1,6 +1,6 @@ # rust -This plugin adds completion for [`rustc`](https://doc.rust-lang.org/rustc/index.html), the compiler for the Rust programming language. +This plugin adds completion for [`rustc`](https://doc.rust-lang.org/rustc/index.html), the compiler for the Rust programming language, as well as for `rustup` and `cargo` if you have the Rust toolchain installed. To use it, add `rust` to the plugins array in your zshrc file: diff --git a/plugins/rust/_rust b/plugins/rust/_rustc similarity index 100% rename from plugins/rust/_rust rename to plugins/rust/_rustc diff --git a/plugins/rust/rust.plugin.zsh b/plugins/rust/rust.plugin.zsh new file mode 100644 index 000000000..ced6eb4aa --- /dev/null +++ b/plugins/rust/rust.plugin.zsh @@ -0,0 +1,28 @@ +if ! (( $+commands[rustup] && $+commands[cargo] )); then + return +fi + +# Add completions folder in $ZSH_CACHE_DIR +# TODO: 2021-12-28: remove this bit of code as it exists in oh-my-zsh.sh +command mkdir -p "$ZSH_CACHE_DIR/completions" +(( ${fpath[(Ie)"$ZSH_CACHE_DIR/completions"]} )) || fpath=("$ZSH_CACHE_DIR/completions" $fpath) + +# If the completion file doesn't exist yet, we need to autoload it and +# bind it to `cargo`. Otherwise, compinit will have already done that +if [[ ! -f "$ZSH_CACHE_DIR/completions/_cargo" ]]; then + autoload -Uz _cargo + declare -A _comps + _comps[cargo]=_cargo +fi + +# If the completion file doesn't exist yet, we need to autoload it and +# bind it to `rustup`. Otherwise, compinit will have already done that +if [[ ! -f "$ZSH_CACHE_DIR/completions/_rustup" ]]; then + autoload -Uz _rustup + declare -A _comps + _comps[rustup]=_rustup +fi + +# Generate completion files in the background +rustup completions zsh >| "$ZSH_CACHE_DIR/completions/_rustup" &| +rustup completions zsh cargo >| "$ZSH_CACHE_DIR/completions/_cargo" &| diff --git a/plugins/rustup/README.md b/plugins/rustup/README.md index ba037f8f6..c620e72a8 100644 --- a/plugins/rustup/README.md +++ b/plugins/rustup/README.md @@ -1,9 +1,3 @@ # rustup -This plugin adds completion for [`rustup`](https://rustup.rs/), the toolchain installer for the Rust programming language. - -To use it, add `rustup` to the plugins array in your zshrc file: - -```zsh -plugins=(... rustup) -``` +**Deprecated: use the [`rust`](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/rust) plugin instead.** diff --git a/plugins/rustup/rustup.plugin.zsh b/plugins/rustup/rustup.plugin.zsh index af8cf03a2..0ca745b7e 100644 --- a/plugins/rustup/rustup.plugin.zsh +++ b/plugins/rustup/rustup.plugin.zsh @@ -1,24 +1,11 @@ -if (( ! $+commands[rustup] )); then - return -fi +print ${(%):-'%F{yellow}The `rustup` plugin is deprecated and has been moved to the `rust` plugin.'} +print ${(%):-'Please update your .zshrc to use the `%Brust%b` plugin instead.%f'} # Remove old generated completion file -# TODO: 2021-09-15: remove this line +# TODO: 2021-12-28: remove this line command rm -f "${0:A:h}/_rustup" -# Add completions/ folder in $ZSH_CACHE_DIR -comp_file="$ZSH_CACHE_DIR/completions/_rustup" -command mkdir -p "${comp_file:h}" -(( ${fpath[(Ie)"$ZSH_CACHE_DIR/completions"]} )) || fpath=("$ZSH_CACHE_DIR/completions" $fpath) - -# If the completion file doesn't exist yet, we need to autoload it and -# bind it to `rustup`. Otherwise, compinit will have already done that -if [[ ! -f "$comp_file" ]]; then - autoload -Uz _rustup - declare -A _comps - _comps[rustup]=_rustup -fi - -# Generate completion file in the background -rustup completions zsh >| "$comp_file" &| -unset comp_file +(( ${fpath[(Ie)$ZSH/plugins/rust]} )) || { + fpath=("$ZSH/plugins/rust" $fpath) + source "$ZSH/plugins/rust/rust.plugin.zsh" +}