f6a2925950
Level out the builtin commands loaded at startup in terms of format and expressiveness. The following convention was followed: * commands that take more than one argument have to be described along with their parameters prior to the actual documentation, otherwise the docstring consists in a capitalized sentence e.g. `command <arg1>: do something` * optional arguments are enclosed in square brackets, to comply with the format used for hardcoded commands e.g. `cd [<directory>]` * describe the effects of the command in the documentation string and omit implementation details unless they are relevant. Usually command names include the name of the tool they use, so they don't need to be redundantly mentioned e.g. `tmux-new-pane <arguments>: open a new pane` * document the format the parameters to the commands, or list them if they are to be chosen among a list of static values (c.f. `spell.kak`)
74 lines
2.4 KiB
Plaintext
74 lines
2.4 KiB
Plaintext
decl str grepcmd 'grep -RHn'
|
|
decl str toolsclient
|
|
decl -hidden int _grep_current_line 0
|
|
|
|
def -params .. -file-completion \
|
|
-docstring %{grep [<arguments>]: grep utility wrapper
|
|
All the optional arguments are forwarded to the grep utility} \
|
|
grep %{ %sh{
|
|
output=$(mktemp -d -t kak-grep.XXXXXXXX)/fifo
|
|
mkfifo ${output}
|
|
if [ $# -gt 0 ]; then
|
|
( ${kak_opt_grepcmd} "$@" | tr -d '\r' > ${output} 2>&1 ) > /dev/null 2>&1 < /dev/null &
|
|
else
|
|
( ${kak_opt_grepcmd} "${kak_selection}" | tr -d '\r' > ${output} 2>&1 ) > /dev/null 2>&1 < /dev/null &
|
|
fi
|
|
|
|
printf %s\\n "eval -try-client '$kak_opt_toolsclient' %{
|
|
edit! -fifo ${output} -scroll *grep*
|
|
set buffer filetype grep
|
|
set buffer _grep_current_line 0
|
|
hook -group fifo buffer BufCloseFifo .* %{
|
|
nop %sh{ rm -r $(dirname ${output}) }
|
|
rmhooks buffer fifo
|
|
}
|
|
}"
|
|
}}
|
|
|
|
hook -group grep-highlight global WinSetOption filetype=grep %{
|
|
addhl group grep
|
|
addhl -group grep regex "^((?:\w:)?[^:]+):(\d+):(\d+)?" 1:cyan 2:green 3:green
|
|
addhl -group grep line %{%opt{_grep_current_line}} default+b
|
|
}
|
|
|
|
hook global WinSetOption filetype=grep %{
|
|
hook buffer -group grep-hooks NormalKey <ret> grep-jump
|
|
}
|
|
|
|
hook -group grep-highlight global WinSetOption filetype=(?!grep).* %{ rmhl grep }
|
|
|
|
hook global WinSetOption filetype=(?!grep).* %{
|
|
rmhooks buffer grep-hooks
|
|
}
|
|
|
|
decl str jumpclient
|
|
|
|
def -hidden grep-jump %{
|
|
eval -collapse-jumps %{
|
|
try %{
|
|
exec 'xs^((?:\w:)?[^:]+):(\d+):(\d+)?<ret>'
|
|
set buffer _grep_current_line %val{cursor_line}
|
|
eval -try-client %opt{jumpclient} edit -existing %reg{1} %reg{2} %reg{3}
|
|
try %{ focus %opt{jumpclient} }
|
|
}
|
|
}
|
|
}
|
|
|
|
def grep-next -docstring 'Jump to the next grep match' %{
|
|
eval -collapse-jumps -try-client %opt{jumpclient} %{
|
|
buffer '*grep*'
|
|
exec "%opt{_grep_current_line}g<a-l>/^[^:]+:\d+:<ret>"
|
|
grep-jump
|
|
}
|
|
try %{ eval -client %opt{toolsclient} %{ exec %opt{_grep_current_line}g } }
|
|
}
|
|
|
|
def grep-prev -docstring 'Jump to the previous grep match' %{
|
|
eval -collapse-jumps -try-client %opt{jumpclient} %{
|
|
buffer '*grep*'
|
|
exec "%opt{_grep_current_line}g<a-/>^[^:]+:\d+:<ret>"
|
|
grep-jump
|
|
}
|
|
try %{ eval -client %opt{toolsclient} %{ exec %opt{_grep_current_line}g } }
|
|
}
|