Improved completions [for #145] #128
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,197 +10,196 @@ | |
| # | ||
| # ------------------------------------------------------------------------------ | ||
|
|
||
| _abbr (){ | ||
| local state line | ||
|
|
||
| local -i ret | ||
|
|
||
| ret=1 | ||
|
|
||
| _arguments -C \ | ||
| '--help[Show the manpage.]' \ | ||
| '(-v --version)'{-v,--version}'[Show the current version.]' \ | ||
| '1: :->cmds' \ | ||
| '*:: :->args' && ret=0 | ||
|
|
||
| case $state in | ||
| cmds) | ||
| local commands; commands=( | ||
olets marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 'a:Add a new abbreviation.' | ||
| 'add:Add a new abbreviation.' | ||
| 'c:Erase all session abbreviations.' | ||
| 'clear-session:Erase all session abbreviations.' | ||
| 'e:Erase an abbreviation.' | ||
| 'erase:Erase an abbreviation.' | ||
| "x:Output the ABBREVIATION's EXPANSION." | ||
| "expand:Output the ABBREVIATION's EXPANSION." | ||
| 'export-aliases:Export abbreviations as alias commands.' | ||
| 'g:Add a regular abbreviation, the expansion of which is prefixed with git; and add a global abbreviation, the abbreviation and expansion of which are prefixed with git.' | ||
| 'git:Add a regular abbreviation, the expansion of which is prefixed with git; and add a global abbreviation, the abbreviation and expansion of which are prefixed with git.' | ||
| 'help:Show the manpage.' | ||
| 'import-aliases:Add regular abbreviations for every regular alias in the session, and global abbreviations for every global alias in the session.' | ||
| 'import-fish:Import fish abbr-syntax abbreviations.' | ||
| 'import-git-aliases:Add regular abbreviations for every Git alias in the current session. The EXPANSION is prefixed with git[Space].' | ||
| 'list:List the abbreviations with their expansions.' | ||
| 'l:List the abbreviations only.' | ||
| 'list-abbreviations:List the abbreviations only.' | ||
| 'list-commands:List as commands suitable for export.' | ||
| 'profile:Log profile information for debugging.' | ||
| 'R:Rename an abbreviation.' | ||
| 'rename:Rename an abbreviation.' | ||
| 'version:Show the current version.' | ||
| ) | ||
| _describe 'abbr commands' commands | ||
olets marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ret=0 | ||
| ;; | ||
| args) | ||
| case $line[1] in | ||
| a|\ | ||
| add) | ||
| # [<SCOPE>] [<TYPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] ABBREVIATION=EXPANSION | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' | ||
olets marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ret=0 | ||
| ;; | ||
| e|\ | ||
| erase) | ||
| # [<SCOPE>] [<TYPE>] [--dry-run] [--quiet] ABBREVIATION | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet)'{-q,--quiet}'[silence success output]' \ | ||
| '1: :__abbr_abbreviations' | ||
| ret=0 | ||
| ;; | ||
| export-aliases|\ | ||
| list|\ | ||
| l|\ | ||
| list-abbreviations|\ | ||
| L|\ | ||
| list-commands) | ||
| # [<SCOPE>] [<TYPE>] | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' | ||
| ret=0 | ||
| ;; | ||
Farid-NL marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| git) | ||
| # [<SCOPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] ABBREVIATION=EXPANSION | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' | ||
| ret=0 | ||
| ;; | ||
| import-aliases) | ||
| # [<TYPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] | ||
| _arguments \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' | ||
| ret=0 | ||
| ;; | ||
| import-fish) | ||
| # [<SCOPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] FILE | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' | ||
| ret=0 | ||
| ;; | ||
| import-git-aliases) | ||
| # [<SCOPE>] [<TYPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] [--file <config-file>] [--prefix <ABBREVIATION prefix>] | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' \ | ||
| '(--file)--file[path to a Git config file]:filename:_files -/' \ | ||
| '(--prefix)--prefix[prefix added to the ABBREVIATIONs]' | ||
| ret=0 | ||
| ;; | ||
| R|\ | ||
| rename) | ||
| # [<SCOPE>] [<TYPE>] [--dry-run] [(--quiet | --quieter)] [(-f | --force)] OLD NEW | ||
| _arguments \ | ||
| '(-S --session -U --user)'{-S,--session}'[available in this session]' \ | ||
| '(-U --user -S --session)'{-U,--user}'[available in all sessions]' \ | ||
| '(-r --regular -g --global)'{-r,--regular}'[expand at the start of the line]' \ | ||
| '(-g --global -r --regular)'{-g,--global}'[expand everywhere]' \ | ||
| '(--dry-run)--dry-run[see what would result, without making any actual changes]' \ | ||
| '(-q --quiet -qq --quieter)'{-q,--quiet}'[silence success output]' \ | ||
| '(-qq --quieter -q --quiet)'{-qq,--quieter}'[silence success output and warnings]' \ | ||
| '(-f --force)'{-f,--force}'[ignore warnings]' \ | ||
| '1: :__abbr_abbreviations' | ||
| ret=0 | ||
| ;; | ||
| esac | ||
| ;; | ||
| esac | ||
|
|
||
| return ret | ||
| } | ||
|
|
||
| (( $+functions[__abbr_extract_abbreviations] )) || | ||
| __abbr_extract_abbreviations() { | ||
| local -a tmp_abbr tmp_expd | ||
| local scope type | ||
|
|
||
| if (( $words[(Ie)-U] || $words[(Ie)--user] )); then | ||
| scope='-U' | ||
| elif (( $words[(Ie)-S] || $words[(I)--session] )); then | ||
| scope='-S' | ||
| elif (( $words[(Ie)-r] || $words[(Ie)--regular] )); then | ||
| type='-r' | ||
| elif (( $words[(Ie)-g] || $words[(Ie)--global] )); then | ||
| type='-g' | ||
| fi | ||
|
|
||
| tmp_abbr=(${${(f)"$(_call_program abbreviations abbr list-abbreviations $scope $type 2>/dev/null)"}//\"/}) | ||
| tmp_expd=(${${${${(f)"$(_call_program abbreviations abbr list $scope $type 2>/dev/null)"}#*=}#\"}%\"}) | ||
|
|
||
| if (( ${#ABBR_REGULAR_USER_ABBREVIATIONS} )); then | ||
| local len=${#tmp_abbr} | ||
| for (( i = 1; i <= len; i++ )); do | ||
| abbreviations+=(${tmp_abbr[$i]}:${tmp_expd[$i]}) | ||
| done | ||
| else | ||
| abbreviations=() | ||
| fi | ||
| } | ||
olets marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| (( $+functions[__abbr_abbreviations] )) || | ||
| __abbr_abbreviations() { | ||
| local -a abbreviations | ||
| __abbr_extract_abbreviations | ||
olets marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| _describe -t abbreviations 'abbr abbreviations' abbreviations | ||
| } | ||
|
|
||
| _abbr | ||
|
There was a problem hiding this comment. Is there precedent for wrapping this in a function? (it's been a while since I studied others' completion files) Is it advantageous? Any risk of confusing the shell by giving it the same name as the file? at one point I had a function in zsh-abbr.zsh called _abbr, and that tripped up the completion system. There was a problem hiding this comment.
There's a lot of discrepancies for the structure of completions as far as I can see. So my reasoning was that I've read mainly these completions:
In some of those files they don't even return anything or wrap the logic in a main function
None as far as I know if it's only used in the completion file with a wrapper function, this is used by git and docker completions (from the examples above) There was a problem hiding this comment. I unwrapped the main logic and place the helper functions above it. It seems to work fine. If you want we can do this. There was a problem hiding this comment. Undecided. I feel like zsh completions files are already so opaque, simplify as much as possible so give the dev community examples that aren't impossible to understand. And it's been a while since I looked, but I'm pretty sure I've seen a bunch of others that don't wrap. On the other hand, my convention is to wrap shell script file contents in a function! Let's come back to it after everything else is finalized. There was a problem hiding this comment. I think we can click resolve on this. If you agree @Farid-NL, go ahead and do it |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
revert pls. I hear your UX expectation, as well as the implicit "these aren't commands so they shouldn't be in
cmds". But in the special cases of help and version I prefer to eagerly surface their existence, instead of only after-There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotcha, I will revert it.
Since
_valueshas a similar syntax to_arguments, we could group the related commands the same way, but this may be unnecessary?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 1164090
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Say more?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, an example would be:
{a,add}"[Add a new abbreviation.]" \ {c,clear-session}"[Erase all session abbreviations.]" \ # ... {R,rename}"[Rename an abbreviation.]" \ {version,-v,--version}"[Show the current version.]"In this case I don't think it would ne needed to use the parentheses syntax, i.e.
for excluding related commands/options, since in this context only one can be used and suggested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can click resolve on this. If you agree @Farid-NL, go ahead and do it