xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
56bc1750cc
kakoune/rc/extra/ranger.kak

60 lines
2.5 KiB
Plaintext
Raw Normal View History

add ranger.kak
2016-08-30 13:20:12 +02:00
# http://ranger.nongnu.org
# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
rc: Don't use command aliases to highlight keywords properly
2017-11-03 08:34:41 +01:00
define-command ranger-open-on-edit-directory \
Fix, complete and add docstring documentation to builtin commands 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`)
2016-10-11 09:03:41 +02:00
-docstring 'Start the ranger file system explorer when trying to edit a directory' %{
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
hook global RuntimeError "\d+:\d+: '\w+' (.*): is a directory" %{ evaluate-commands %sh{
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
directory=$kak_hook_param_capture_1
echo ranger $directory
Do not automatically enable ranger on directory open errors Use an explicit command that does that 'ranger-open-on-edit-directory' and remove the file_manager option that is not needed anymore.
2016-09-28 20:34:16 +02:00
}}
}
add ranger.kak
2016-08-30 13:20:12 +02:00
rc: Don't use command aliases to highlight keywords properly
2017-11-03 08:34:41 +01:00
define-command \
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
-params .. -file-completion \
-docstring %{ranger [<arguments>]: open the file system explorer to select buffers to open
All the optional arguments are forwarded to the ranger utility} \
Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used..
2018-05-06 23:29:52 +02:00
ranger %{ evaluate-commands %sh{
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
if [ -n "${TMUX}" ]; then
tmux split-window -h \
ranger $@ --cmd " \
map <return> eval \
fm.execute_console('shell \
echo evaluate-commands -client ' + ranger.ext.shell_escape.shell_escape('$kak_client') + ' edit {file} | \
kak -p '.format(file=fm.thisfile.path) + ranger.ext.shell_escape.shell_escape('$kak_session') + '; \
tmux select-pane -t $kak_client_env_TMUX_PANE') \
if fm.thisfile.is_file else fm.execute_console('move right=1')"
* Integrate ranger with GNU Screen. - Ensure ranger opens with the currently focused client tty if multiple screen clients are connected to the same session. - Ensure args are passed to ranger correctly. - Ensure command-line args are passed to ranger correctly. (Only strict long format works e.g. `ranger --cmd="echo foo"`) - Change the current directory because `screen -X` uses screen's cwd not kakoune's. - Use heredoc to make escaping and quoting easier to debug and slightly less unpredictable. - Use ranger's `--choosefiles` option instead of mapping keys and having to do multiple levels of escaping and quoting of args esp. command-line args which were unusable in `screen -X eval`. - Remove screen region when user quits ranger.
2017-11-17 20:40:42 +01:00
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
elif [ -n "${STY}" ]; then
* Integrate ranger with GNU Screen. - Ensure ranger opens with the currently focused client tty if multiple screen clients are connected to the same session. - Ensure args are passed to ranger correctly. - Ensure command-line args are passed to ranger correctly. (Only strict long format works e.g. `ranger --cmd="echo foo"`) - Change the current directory because `screen -X` uses screen's cwd not kakoune's. - Use heredoc to make escaping and quoting easier to debug and slightly less unpredictable. - Use ranger's `--choosefiles` option instead of mapping keys and having to do multiple levels of escaping and quoting of args esp. command-line args which were unusable in `screen -X eval`. - Remove screen region when user quits ranger.
2017-11-17 20:40:42 +01:00
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
script="/tmp/kak-ranger-${kak_client}-${kak_session}.sh"
selections="/tmp/kak-ranger-${kak_client}-${kak_session}.txt"
cat > "$script" << EOF
* Integrate ranger with GNU Screen. - Ensure ranger opens with the currently focused client tty if multiple screen clients are connected to the same session. - Ensure args are passed to ranger correctly. - Ensure command-line args are passed to ranger correctly. (Only strict long format works e.g. `ranger --cmd="echo foo"`) - Change the current directory because `screen -X` uses screen's cwd not kakoune's. - Use heredoc to make escaping and quoting easier to debug and slightly less unpredictable. - Use ranger's `--choosefiles` option instead of mapping keys and having to do multiple levels of escaping and quoting of args esp. command-line args which were unusable in `screen -X eval`. - Remove screen region when user quits ranger.
2017-11-17 20:40:42 +01:00
#! /usr/bin/env sh
cd "$PWD"
ranger --choosefiles="$selections" $@
while read -r f; do
printf %s "evaluate-commands -client '${kak_client}' edit '\"\$f\"'" | kak -p '${kak_session}'
done < "$selections"
screen -X remove
rm -f "$selections" "$script"
EOF
tty="$(ps -o tty ${kak_client_pid} | tail -n 1)"
screen -X eval \
'split -h' \
'focus down' \
"screen sh '$script'" \
< "/dev/$tty"
- Fix: proper escaping of kak_{session, client}
2017-11-29 18:17:45 +01:00
elif [ -n "$WINDOWID" ]; then
setsid $kak_opt_termcmd " \
ranger $@ --cmd "'"'" \
map <return> eval \
fm.execute_console('shell \
echo evaluate-commands -client ' + ranger.ext.shell_escape.shell_escape('$kak_client') + ' edit {file} | \
kak -p '.format(file=fm.thisfile.path) + ranger.ext.shell_escape.shell_escape('$kak_session') + '; \
xdotool windowactivate $kak_client_env_WINDOWID') \
if fm.thisfile.is_file else fm.execute_console('move right=1')"'"' < /dev/null > /dev/null 2>&1 &
fi
add ranger.kak
2016-08-30 13:20:12 +02:00
}}
Reference in New Issue Copy Permalink