如何自定义命令行补全

在UC就职时养成了一个习惯,就是将自己所参与的项目的源代码都存放在一个名为uc的目录下。换了工作之后这个习惯仍然保留下来了,只不过原本名为uc的目录现在改名了(假设这个目录叫做work)。在新公司参与的项目比较多,因此在这个work目录下有许多的子目录,大致上的结构如下

1
2
3
work/
|-- A/
|-- B/

其中A和B分别表示一个项目的源代码目录。在work目录下存放的直接是A和B两个项目的目录。work目录本身是放置在~/src/这个目录下的,因此项目A和B的完整根目录路径是~/src/work/A/~/src/work/B/。由于参与的项目比较多,经常需要在几个项目间交替着编码,因此经常会在终端键入下面的指令

1
2
cd ~/src/work/A/ # 或者
cd ~/src/work/B/

不得不说这样确实是非常的麻烦,因此我很快就定义了一个shell函数来简化这串命令,这个shell函数的定义如下

1
2
3
4
5
6
7
8
function she() {
dir=${1}
target="/home/liutos/src/work/${dir}"
if [ -d "${target}" ]; then
cd "${target}"
return
fi
}

有了这个辅助工具后,要切换到项目A和B中就简单多了,只需要输入

1
2
she A # 或者
she B

即可。但一使用起来就会发现,原本直接使用cd命令时所能享用的目录名补全功能没有了!绝大多数情况下补全功能是非常有用的,为此打算动手为she函数配备一个目录名的补全功能。显然自定义命令行补全的想法已经有前人实践过了,略加搜索就可以找到这么一篇指南。模仿文章中的方法,我先是写了下面的代码骨架

1
2
3
4
5
_she() {
local cur
_get_comp_words_by_ref cur
}
complete -F _she she

我的想法是只要当前的输入能够作为work下的一个目录名字的前缀,那么就认为这个子目录是本次补全的目标。为此,我需要先获取到work目录下的所有子目录的名称。利用ls命令可以做到这一点,同时为了便于处理,在这里将ls返回的文件名列表作为数组保存起来。修改后的_she函数的代码如下

1
2
3
4
5
6
_she() {
local cur
local dirs
_get_comp_words_by_ref cur
dirs=($(ls ~/src/work/))
}

现在,只要遍历${dirs}并找出第一个以用户输入的${cur}为名字前缀的目录即可。最终_she函数的定义如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
_she() {
local cur
local dirs
_get_comp_words_by_ref cur
dirs=($(ls ~/src/work/))
for dir in ${dirs[@]}
do
case ${dir} in
${cur}*)
COMPREPLY="${dir}"
return 0
;;
esac
done
}