home/rc/extra/ranger.kak

# http://ranger.nongnu.org
# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾

def ranger-open-on-edit-directory \
    -docstring 'Start the ranger file system explorer when trying to edit a directory' %{
        hook global RuntimeError "\d+:\d+: '\w+' (.*): is a directory" %{ %sh{
          directory=$kak_hook_param_capture_1
          echo ranger $directory
    }}
}

def \
  -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} \
  ranger %{ %sh{
  if [ -n "$TMUX" ]; then
    tmux split-window -h \
      ranger $@ --cmd " \
        map <return> eval \
          fm.execute_console('shell \
            echo eval -client $kak_client edit {file} | \
            kak -p $kak_session; \
            tmux select-pane -t $kak_client_env_TMUX_PANE'.format(file=fm.thisfile.path)) \
          if fm.thisfile.is_file else fm.execute_console('move right=1')"
  elif [ -n "$WINDOWID" ]; then
    setsid $kak_opt_termcmd " \
      ranger $@ --cmd "'"'" \
        map <return> eval \
          fm.execute_console('shell \
            echo eval -client $kak_client edit {file} | \
            kak -p $kak_session; \
            xdotool windowactivate $kak_client_env_WINDOWID'.format(file=fm.thisfile.path)) \
          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			`# http://ranger.nongnu.org`
			`# ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾`

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			`def 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 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			`hook global RuntimeError "\d+:\d+: '\w+' (.*): is a directory" %{ %sh{`
rc/ranger: use $kak_hook_param_capture_N 2017-04-01 22:46:31 +02:00			`directory=$kak_hook_param_capture_1`
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			`echo ranger $directory`
			`}}`
			`}`
add ranger.kak 2016-08-30 13:20:12 +02:00
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			`def \`
			`-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} \`
			`ranger %{ %sh{`
add ranger.kak 2016-08-30 13:20:12 +02:00			`if [ -n "$TMUX" ]; then`
add ranger.kak 2016-09-26 11:51:53 +02:00			`tmux split-window -h \`
			`ranger $@ --cmd " \`
			`map <return> eval \`
			`fm.execute_console('shell \`
			`echo eval -client $kak_client edit {file} \| \`
			`kak -p $kak_session; \`
			`tmux select-pane -t $kak_client_env_TMUX_PANE'.format(file=fm.thisfile.path)) \`
			`if fm.thisfile.is_file else fm.execute_console('move right=1')"`
add ranger.kak 2016-08-30 13:20:12 +02:00			`elif [ -n "$WINDOWID" ]; then`
add ranger.kak 2016-09-26 11:51:53 +02:00			`setsid $kak_opt_termcmd " \`
			`ranger $@ --cmd "'"'" \`
			`map <return> eval \`
			`fm.execute_console('shell \`
			`echo eval -client $kak_client edit {file} \| \`
			`kak -p $kak_session; \`
			`xdotool windowactivate $kak_client_env_WINDOWID'.format(file=fm.thisfile.path)) \`
			`if fm.thisfile.is_file else fm.execute_console('move right=1')"'"' < /dev/null > /dev/null 2>&1 &`
add ranger.kak 2016-08-30 13:20:12 +02:00			`fi`
			`}}`