From a2bf5c7b99ef1c10d335ed79236dacbb78dd0639 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Tue, 23 Jul 2024 15:59:38 +0200 Subject: refactor(gem): favor built-in zsh completion for `gem` (#12576) Completion for `gem` was included in zsh 5.5 and newer. This change only uses the Oh My Zsh one if running an older version. Reference: https://github.com/zsh-users/zsh/commit/9881778d48caf842f794d986bc9befebf0fb01c2 --- plugins/gem/_gem | 72 -------------------------------------------- plugins/gem/completions/_gem | 72 ++++++++++++++++++++++++++++++++++++++++++++ plugins/gem/gem.plugin.zsh | 27 ++++++++++++++++- 3 files changed, 98 insertions(+), 73 deletions(-) delete mode 100644 plugins/gem/_gem create mode 100644 plugins/gem/completions/_gem (limited to 'plugins/gem') diff --git a/plugins/gem/_gem b/plugins/gem/_gem deleted file mode 100644 index 92feebe95..000000000 --- a/plugins/gem/_gem +++ /dev/null @@ -1,72 +0,0 @@ -#compdef gem -#autoload - -# gem zsh completion, based on homebrew completion - -_gem_installed() { - installed_gems=(${(f)"$(gem list --local --no-versions)"}) -} - -local -a _1st_arguments - -_1st_arguments=( - 'build:Build a gem from a gemspec' - 'cert:Manage RubyGems certificates and signing settings' - 'check:Check a gem repository for added or missing files' - 'cleanup:Clean up old versions of installed gems in the local repository' - 'contents:Display the contents of the installed gems' - 'dependency:Show the dependencies of an installed gem' - 'environment:Display information about the RubyGems environment' - 'fetch:Download a gem and place it in the current directory' - 'generate_index:Generates the index files for a gem server directory' - 'help:Provide help on the `gem` command' - 'install:Install a gem into the local repository' - 'list:Display gems whose name starts with STRING' - 'lock:Generate a lockdown list of gems' - 'mirror:Mirror all gem files (requires rubygems-mirror)' - 'outdated:Display all gems that need updates' - 'owner:Manage gem owners on RubyGems.org.' - 'pristine:Restores installed gems to pristine condition from files located in the gem cache' - 'push:Push a gem up to RubyGems.org' - 'query:Query gem information in local or remote repositories' - 'rdoc:Generates RDoc for pre-installed gems' - 'search:Display all gems whose name contains STRING' - 'server:Documentation and gem repository HTTP server' - 'sources:Manage the sources and cache file RubyGems uses to search for gems' - 'specification:Display gem specification (in yaml)' - 'stale:List gems along with access times' - 'uninstall:Uninstall gems from the local repository' - 'unpack:Unpack an installed gem to the current directory' - 'update:Update installed gems to the latest version' - 'which:Find the location of a library file you can require' - 'yank:Remove a specific gem version release from RubyGems.org' -) - -local expl -local -a gems installed_gems - -_arguments \ - '(-v --version)'{-v,--version}'[show version]' \ - '(-h --help)'{-h,--help}'[show help]' \ - '*:: :->subcmds' && return 0 - -if (( CURRENT == 1 )); then - _describe -t commands "gem subcommand" _1st_arguments - return -fi - -case "$words[1]" in - build) - _files -g "*.gemspec" - ;; - install) - _files ;; - list) - if [[ "$state" == forms ]]; then - _gem_installed - _requested installed_gems expl 'installed gems' compadd -a installed_gems - fi ;; - uninstall|update) - _gem_installed - _wanted installed_gems expl 'installed gems' compadd -a installed_gems ;; -esac diff --git a/plugins/gem/completions/_gem b/plugins/gem/completions/_gem new file mode 100644 index 000000000..92feebe95 --- /dev/null +++ b/plugins/gem/completions/_gem @@ -0,0 +1,72 @@ +#compdef gem +#autoload + +# gem zsh completion, based on homebrew completion + +_gem_installed() { + installed_gems=(${(f)"$(gem list --local --no-versions)"}) +} + +local -a _1st_arguments + +_1st_arguments=( + 'build:Build a gem from a gemspec' + 'cert:Manage RubyGems certificates and signing settings' + 'check:Check a gem repository for added or missing files' + 'cleanup:Clean up old versions of installed gems in the local repository' + 'contents:Display the contents of the installed gems' + 'dependency:Show the dependencies of an installed gem' + 'environment:Display information about the RubyGems environment' + 'fetch:Download a gem and place it in the current directory' + 'generate_index:Generates the index files for a gem server directory' + 'help:Provide help on the `gem` command' + 'install:Install a gem into the local repository' + 'list:Display gems whose name starts with STRING' + 'lock:Generate a lockdown list of gems' + 'mirror:Mirror all gem files (requires rubygems-mirror)' + 'outdated:Display all gems that need updates' + 'owner:Manage gem owners on RubyGems.org.' + 'pristine:Restores installed gems to pristine condition from files located in the gem cache' + 'push:Push a gem up to RubyGems.org' + 'query:Query gem information in local or remote repositories' + 'rdoc:Generates RDoc for pre-installed gems' + 'search:Display all gems whose name contains STRING' + 'server:Documentation and gem repository HTTP server' + 'sources:Manage the sources and cache file RubyGems uses to search for gems' + 'specification:Display gem specification (in yaml)' + 'stale:List gems along with access times' + 'uninstall:Uninstall gems from the local repository' + 'unpack:Unpack an installed gem to the current directory' + 'update:Update installed gems to the latest version' + 'which:Find the location of a library file you can require' + 'yank:Remove a specific gem version release from RubyGems.org' +) + +local expl +local -a gems installed_gems + +_arguments \ + '(-v --version)'{-v,--version}'[show version]' \ + '(-h --help)'{-h,--help}'[show help]' \ + '*:: :->subcmds' && return 0 + +if (( CURRENT == 1 )); then + _describe -t commands "gem subcommand" _1st_arguments + return +fi + +case "$words[1]" in + build) + _files -g "*.gemspec" + ;; + install) + _files ;; + list) + if [[ "$state" == forms ]]; then + _gem_installed + _requested installed_gems expl 'installed gems' compadd -a installed_gems + fi ;; + uninstall|update) + _gem_installed + _wanted installed_gems expl 'installed gems' compadd -a installed_gems ;; +esac diff --git a/plugins/gem/gem.plugin.zsh b/plugins/gem/gem.plugin.zsh index 938f5c993..b8a49fb56 100644 --- a/plugins/gem/gem.plugin.zsh +++ b/plugins/gem/gem.plugin.zsh @@ -4,4 +4,29 @@ alias gemp="gem push *.gem" # gemy GEM 0.0.0 = gem yank GEM -v 0.0.0 function gemy { gem yank $1 -v $2 -} \ No newline at end of file +} + +# If the completion file doesn't exist yet, we need to autoload it and +# bind it to `gem`. Otherwise, compinit will have already done that. +if [[ ! -f "$ZSH_CACHE_DIR/completions/_gem" ]]; then + typeset -g -A _comps + autoload -Uz _gem + _comps[docker]=_gem +fi + +# zsh 5.5 already provides completion for `_gem`. With this we ensure that +# our provided completion (which is not optimal but is enough in most cases) +# is used for older versions +autoload -Uz is-at-least +if is-at-least 5.5; then + return 0 +fi + +{ + # Standarized $0 handling + # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html + 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}" + 0="${${(M)0:#/*}:-$PWD/$0}" + + command cp -f "${0:h}/completions/_gem" "$ZSH_CACHE_DIR/completions/_gem" +} &| -- cgit v1.3.1 From d78275fdbb876cee9c55f5c2731b8c1fac7be6d2 Mon Sep 17 00:00:00 2001 From: Alexander Cyon Date: Sun, 1 Sep 2024 21:01:27 +0200 Subject: chore: fix typos (#12647) --- plugins/bedtools/_bedtools | 2 +- plugins/brew/brew.plugin.zsh | 2 +- plugins/docker/docker.plugin.zsh | 2 +- plugins/emoji/update_emoji.py | 4 ++-- plugins/gem/gem.plugin.zsh | 2 +- plugins/history-substring-search/history-substring-search.zsh | 4 ++-- plugins/hitchhiker/fortunes/hitchhiker | 2 +- plugins/lpass/_lpass | 2 +- plugins/python/python.plugin.zsh | 2 +- plugins/rails/_rails | 4 ++-- plugins/swiftpm/_swift | 2 +- plugins/zsh-navigation-tools/README.md | 2 +- plugins/zsh-navigation-tools/doc/n-preview | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) (limited to 'plugins/gem') diff --git a/plugins/bedtools/_bedtools b/plugins/bedtools/_bedtools index ef6c4179a..15e3dc2ff 100644 --- a/plugins/bedtools/_bedtools +++ b/plugins/bedtools/_bedtools @@ -47,7 +47,7 @@ case $state in "random[Generate random intervals in a genome.]" \ "reldist[Calculate the distribution of relative distances b/w two files.]" \ "sample[Sample random records from file using reservoir sampling.]" \ - "shuffle[Randomly redistrubute intervals in a genome.]" \ + "shuffle[Randomly redistribute intervals in a genome.]" \ "slop[Adjust the size of intervals.]" \ "sort[Order the intervals in a file.]" \ "subtract[Remove intervals based on overlaps b/w two files.]" \ diff --git a/plugins/brew/brew.plugin.zsh b/plugins/brew/brew.plugin.zsh index a138a4827..4dab6f413 100644 --- a/plugins/brew/brew.plugin.zsh +++ b/plugins/brew/brew.plugin.zsh @@ -24,7 +24,7 @@ if (( ! $+commands[brew] )); then fi if [[ -z "$HOMEBREW_PREFIX" ]]; then - # Maintain compatability with potential custom user profiles, where we had + # Maintain compatibility with potential custom user profiles, where we had # previously relied on always sourcing shellenv. OMZ plugins should not rely # on this to be defined due to out of order processing. export HOMEBREW_PREFIX="$(brew --prefix)" diff --git a/plugins/docker/docker.plugin.zsh b/plugins/docker/docker.plugin.zsh index 19269427e..16db77df6 100644 --- a/plugins/docker/docker.plugin.zsh +++ b/plugins/docker/docker.plugin.zsh @@ -39,7 +39,7 @@ if (( ! $+commands[docker] )); then return fi -# Standarized $0 handling +# Standardized $0 handling # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}" 0="${${(M)0:#/*}:-$PWD/$0}" diff --git a/plugins/emoji/update_emoji.py b/plugins/emoji/update_emoji.py index 18b3c060d..9e115a7fa 100644 --- a/plugins/emoji/update_emoji.py +++ b/plugins/emoji/update_emoji.py @@ -1,6 +1,6 @@ """ Update Emoji.py -Refeshes OMZ emoji database based on the latest Unicode spec +Refreshes OMZ emoji database based on the latest Unicode spec """ import re import json @@ -95,7 +95,7 @@ def name_to_omz(_name, _group, _subgroup, _status): shortname = snake_case(_name) # Special treatment by status # Enables us to have every emoji combination, - # even the one that are not officially sanctionned + # even the one that are not officially sanctioned # and are implemented by, say, only one vendor if _status == "unqualified": shortname += "_unqualified" diff --git a/plugins/gem/gem.plugin.zsh b/plugins/gem/gem.plugin.zsh index b8a49fb56..58716594d 100644 --- a/plugins/gem/gem.plugin.zsh +++ b/plugins/gem/gem.plugin.zsh @@ -23,7 +23,7 @@ if is-at-least 5.5; then fi { - # Standarized $0 handling + # Standardized $0 handling # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}" 0="${${(M)0:#/*}:-$PWD/$0}" diff --git a/plugins/history-substring-search/history-substring-search.zsh b/plugins/history-substring-search/history-substring-search.zsh index 2137b7950..9f0e0b0d5 100644 --- a/plugins/history-substring-search/history-substring-search.zsh +++ b/plugins/history-substring-search/history-substring-search.zsh @@ -295,8 +295,8 @@ _history-substring-search-begin() { fi # - # Escape and join query parts with wildcard character '*' as seperator - # `(j:CHAR:)` join array to string with CHAR as seperator + # Escape and join query parts with wildcard character '*' as separator + # `(j:CHAR:)` join array to string with CHAR as separator # local search_pattern="${(j:*:)_history_substring_search_query_parts[@]//(#m)[\][()|\\*?#<>~^]/\\$MATCH}*" diff --git a/plugins/hitchhiker/fortunes/hitchhiker b/plugins/hitchhiker/fortunes/hitchhiker index 94cc1c835..6620a2a4f 100644 --- a/plugins/hitchhiker/fortunes/hitchhiker +++ b/plugins/hitchhiker/fortunes/hitchhiker @@ -42,7 +42,7 @@ - Zaphod. % -"`In those days spirits were brave, the stakes were high, men were REAL men, women were REAL women, and small furry creatures from Alpha Centauri were REAL small furry creatures from Aplha Centauri.'" +"`In those days spirits were brave, the stakes were high, men were REAL men, women were REAL women, and small furry creatures from Alpha Centauri were REAL small furry creatures from Alpha Centauri.'" - The Book getting all nostalgic. % diff --git a/plugins/lpass/_lpass b/plugins/lpass/_lpass index 621a7bcd7..e312fb9a3 100644 --- a/plugins/lpass/_lpass +++ b/plugins/lpass/_lpass @@ -78,7 +78,7 @@ _lpass() { has_sync=1 ;; status) - _arguments : '(-q --quiet)'{-q,--quiet}'[Supress output to stdout]' + _arguments : '(-q --quiet)'{-q,--quiet}'[Suppress output to stdout]' has_color=1 ;; sync) diff --git a/plugins/python/python.plugin.zsh b/plugins/python/python.plugin.zsh index 6d7f440aa..811745257 100644 --- a/plugins/python/python.plugin.zsh +++ b/plugins/python/python.plugin.zsh @@ -74,7 +74,7 @@ function vrun() { } # Create a new virtual environment using the specified name. -# If none specfied, use $PYTHON_VENV_NAME +# If none specified, use $PYTHON_VENV_NAME function mkv() { local name="${1:-$PYTHON_VENV_NAME}" local venvpath="${name:P}" diff --git a/plugins/rails/_rails b/plugins/rails/_rails index 48fd1909e..dbd843c80 100644 --- a/plugins/rails/_rails +++ b/plugins/rails/_rails @@ -366,10 +366,10 @@ _rails_generate() { ;| (controller|job|model|resource|scaffold) opts+=( - '--parent=[The parent class for the generated controler]:parent class' + '--parent=[The parent class for the generated controller]:parent class' ) ;| - (controler|mailer|resource|scaffold|scaffold_controller) + (controller|mailer|resource|scaffold|scaffold_controller) opts+=( '(-e --template-engine)'{-e,--template-engine=}'[Template engine to be invoked]:engine:(erb)' ) diff --git a/plugins/swiftpm/_swift b/plugins/swiftpm/_swift index f9a603f58..358d1dcae 100644 --- a/plugins/swiftpm/_swift +++ b/plugins/swiftpm/_swift @@ -634,7 +634,7 @@ _swift_package_unedit() { integer ret=1 local -a args args+=( - '--force[Unedit the package even if it has uncommited and unpushed changes]' + '--force[Unedit the package even if it has uncommitted and unpushed changes]' ':package-name:' '--version[Show the version.]' '(-help -h --help)'{-help,-h,--help}'[Show help information.]' diff --git a/plugins/zsh-navigation-tools/README.md b/plugins/zsh-navigation-tools/README.md index 4dc9cdba2..6d6c22f4f 100644 --- a/plugins/zsh-navigation-tools/README.md +++ b/plugins/zsh-navigation-tools/README.md @@ -185,7 +185,7 @@ Result is stored as `$reply[REPLY]` (`$` isn't needed before `REPLY` because of arithmetic context inside `[]`). The returned array might be different from input arguments as `n-list` can process them via incremental search or uniq mode. `$REPLY` is the index in that possibly processed array. If `$REPLY` -equals `-1` it means that no selection have been made (user quitted via `q` +equals `-1` it means that no selection have been made (user quit via `q` key). To set up entries that can be jumped to with `[`,`]` keys add their indices to diff --git a/plugins/zsh-navigation-tools/doc/n-preview b/plugins/zsh-navigation-tools/doc/n-preview index 2d8eea3fb..bcbbb88c7 100644 --- a/plugins/zsh-navigation-tools/doc/n-preview +++ b/plugins/zsh-navigation-tools/doc/n-preview @@ -170,7 +170,7 @@ while (( 1 )); do elif [ -n "$keypad" ]; then final_key="$keypad" else - _vpreview_status_msg "Inproper input detected" + _vpreview_status_msg "Improper input detected" zcurses refresh status fi -- cgit v1.3.1 From 61bacd95b285a9792a05d1c818d9cee15ebe53c6 Mon Sep 17 00:00:00 2001 From: Carlo Sala Date: Tue, 8 Oct 2024 21:50:31 +0200 Subject: fix(gem): regression with gem completion (#12735) --- plugins/gem/gem.plugin.zsh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/gem') diff --git a/plugins/gem/gem.plugin.zsh b/plugins/gem/gem.plugin.zsh index 58716594d..41c434a09 100644 --- a/plugins/gem/gem.plugin.zsh +++ b/plugins/gem/gem.plugin.zsh @@ -11,7 +11,7 @@ function gemy { if [[ ! -f "$ZSH_CACHE_DIR/completions/_gem" ]]; then typeset -g -A _comps autoload -Uz _gem - _comps[docker]=_gem + _comps[gem]=_gem fi # zsh 5.5 already provides completion for `_gem`. With this we ensure that -- cgit v1.3.1