首页 > 解决方案 > Bash:如何通过使用已经可用的 bash 完成函数来简化自定义创建函数的自动完成?

问题描述

如何将内部已经存在的完成函数重用/usr/share/bash-completion/completions到我自己的自定义函数中,而不必编写另一个函数来构建可能的完成列表?


如果问题不清楚,请看这个例子:

• 我在我的.bashrc

function gitdelbranch {
    git branch --delete ${1} && git push origin --delete ${1}
}

• 我已经在采购. /usr/share/bash-completion/bash_completion我的.bashrc

• 现在,我希望能够使用提供给我gitdelbranch的相同选项来自动完成我的功能git branch -d

• 往里 /usr/share/bash-completion/completions/git:599看,我可以看到已经有一个完成本地分支的函数,叫做__git_heads()

[...]
# Lists branches from the local repository.
# 1: A prefix to be added to each listed branch (optional).
# 2: List only branches matching this word (optional; list all branches if
#    unset or empty).
# 3: A suffix to be appended to each listed branch (optional).
__git_heads ()
[...]

另外,我在研究这个时学到的另一个技巧:如果我在我的 shell 上键入git branch -d,按<Tab>,然后运行complete -p git,我可以看到用于该操作的整个完整命令(在它工作之前你真的必须运行一次)

complete -o bashdefault -o default -o nospace -F __git_wrap__git_main git


但是,无论我尝试什么,我都无法使用单个命令(例如complete -o [...] -F __[...] gitdelbranch.

问题是:为什么会这样?有没有办法解决它,或者我真的必须编写一个新的自定义完成函数,构建选项列表和 COMMREPLY,以获得我想要的行为?在我看来,这必须是可能的,因为我的系统上已经有一个写得很好的完成文件。


作为一个额外的问题:为什么甚至 complete -o bashdefault -o default -o nospace -F __git_wrap__git_main gitdelbranch 不起作用,因为它正在外壳中使用并且可以正常工作git branch -d

标签: bashautocomplete

解决方案


Git 补全实际上很容易添加到您自己的 bash 函数中,例如,这个小脚本会自动补全您的 git 分支:

my_func () { return; }
source /usr/share/bash-completion/completions/git
__git_complete my_func __git_complete_refs

现在my_func具有分支名称的自动完成功能。

g或者像这样,您可以git使用自动完成的别名:

source /usr/share/bash-completion/completions/git
alias g=git
__git_complete g __git_main

/usr/share/bash-completion/completions/git文件中查找所有可能的完成。源代码中的原始文件:https ://github.com/git/git/blob/master/contrib/completion/git-completion.bash

有一堆默认的完整函数,但它们可能并不总是做你想要的,因为它们是专门为 git 命令制作的。在某些情况下,您可能想要自定义自动完成功能。查看源代码,git-completion.bash您可以弄清楚。例如,此自动完成功能仅完成本地分支名称:

source /usr/share/bash-completion/completions/git
git_local_branches () {
    __gitcomp_direct "$(__git_heads "" "$cur" " ")"
}
my_func () { return; }
__git_complete my_func git_local_branches

另请参阅此答案以获取有关一般 bash 完成如何工作的更多信息。通常你会使用complete命令,但 Git 创建了自己的完整函数__git_complete,你应该使用它来完成 git。


推荐阅读