.blerc vi-mode template

[stefan-hacks]

I am absolutely loving ble.sh with vi-mode

Would be awesome if you provided a full vi-mode template for .blerc with all the features that are available that setup ble.sh like vim/nvim. What do you guys think? I checked out the wiki but having a full file with all configs like how kitty does and just commented out sections would be amazing.

I have only scratched the surface but am loving the work you guys achieved for vi-mode editing this is freaking amazing. Really appreciate it. Keep it up.

so far only set:

# blerc

function blerc/vim-mode-hook {

  # Write your settings for vi/vim mode here

  bleopt keymap_vi_mode_string_nmap=$'\e[1m-- NORMAL --\e[m'
  ble-import vim-surround

}
blehook/eval-after-load keymap_vi blerc/vim-mode-hook
# ble-0.3 and before
# ble/array#push _ble_keymap_vi_load_hook blerc/vim-load-hook

[akinomyoga]

Would be awesome if you provided a full vi-mode template for .blerc with all the features that are available that setup ble.sh like vim/nvim.

That is already a part of blerc.template, though it is opt-in, i.e., one can comment in the settings to enable features that one likes:

ble.sh/blerc.template

Lines 1158 to 1377 in 32bb63d

	## Settings for Vim mode
	function blerc/vim-load-hook {
	((_ble_bash>=40300)) && builtin bind 'set keyseq-timeout 1'
	#----------------------------------------------------------------------------
	# Settings for the mode indicator
	## The following option specifies the content of the mode indicator shown in
	## the info line as a prompt sequence.
	#bleopt prompt_vi_mode_indicator='\q{keymap:vi/mode-indicator}'
	## The following option controls whether the prompt sequence
	## \q{keymap:vi/mode-indicator} is activated. When this option has a
	## non-empty value, \q{keymap:vi/mode-indicator} is expanded to the mode
	## indicator. Otherwise, \q{keymap:vi/mode-indicator} is expanded to the
	## empty string.
	#bleopt keymap_vi_mode_show=1
	## The following options specify the name of modes in
	## \q{keymap:vi/mode-indicator}.
	#bleopt keymap_vi_mode_name_insert=INSERT
	#bleopt keymap_vi_mode_name_replace=REPLACE
	#bleopt keymap_vi_mode_name_vreplace=VREPLACE
	#bleopt keymap_vi_mode_name_visual=VISUAL
	#bleopt keymap_vi_mode_name_select=SELECT
	#bleopt keymap_vi_mode_name_linewise=LINE
	#bleopt keymap_vi_mode_name_blockwise=BLOCK
	## This option specifies the result of \q{keymap:vi/mode-indicator} in the
	## normal mode. For example, if you want to show an explicit name of the
	## normal mode like in other modes, please use the following setting:
	#bleopt keymap_vi_mode_string_nmap:=$'\e[1m-- NORMAL --\e[m'
	## This option specifies that all the prompts should be recalculated on the
	## mode change. When this option has a non-empty value, the prompt will be
	## recalculated.
	#bleopt keymap_vi_mode_update_prompt=
	#----------------------------------------------------------------------------
	# Keybindings
	## The following setting sets up the keymap settings with Meta modifiers.
	## With this setting, M-RET can be used to insert a newline in the
	## commandline.
	#ble-decode/keymap:vi_imap/define-meta-bindings
	## In this case, C-RET can be optionally configured so that it forcibly
	## executes the command.
	#ble-bind -m vi_imap -f 'C-RET' 'accept-line'
	## The default mapping of <M-backspace> (whose actual key sequence depends on
	## your terminal) copies the previous shell word in the kill ring. Instead,
	## the following settings will kill the backward word as in the default
	## readline.
	#ble-bind -m vi_imap -f 'M-C-?' kill-backward-cword
	#ble-bind -m vi_imap -f 'M-DEL' kill-backward-cword
	#ble-bind -m vi_imap -f 'M-C-h' kill-backward-cword
	#ble-bind -m vi_imap -f 'M-BS' kill-backward-cword
	## The default mapping of RET and C-m in the insert mode inserts newline with
	## multiline commands or incomplete commands. They moves the cursor position
	## to the next line in the normal mode. Instead, with the following setting,
	## RET and C-m always causes the execution of the command even in the
	## multiline mode or when the command is not syntactically completed.
	#ble-bind -m vi_imap -f 'C-m' accept-line
	#ble-bind -m vi_imap -f 'RET' accept-line
	#ble-bind -m vi_nmap -f 'C-m' accept-line
	#ble-bind -m vi_nmap -f 'RET' accept-line
	## The default mapping of C-o is vi_imap/single-command-mode. If you want to
	## execute the current command line and load the next history entry with
	## <C-o>, use the following setting:
	#ble-bind -m vi_imap -f 'C-o' 'accept-and-next'
	## The default mapping of C-k is kill-forward-line. If you want to input
	## digraphs with <C-k>{char1}{char2}, use the following setting:
	#ble-bind -m vi_imap -f 'C-k' 'vi_imap/insert-digraph'
	## The default mapping of C-c is vi_imap/normal-mode-without-insert-leave
	## (imap), vi-command/cancel (nmap). If you instead want to discard the
	## current line and go to the next line, you can bind C-c to 'discard-line':
	#ble-bind -m vi_imap -f 'C-c' discard-line
	#ble-bind -m vi_nmap -f 'C-c' discard-line
	## The default mapping of 'g g' and G moves the current position in the
	## command history. If you would like to move the cursor position in the
	## current command entry, you can overwrite the bindings as follows.
	#ble-bind -m vi_nmap -f 'g g' vi-command/first-nol
	#ble-bind -m vi_omap -f 'g g' vi-command/first-nol
	#ble-bind -m vi_xmap -f 'g g' vi-command/first-nol
	#ble-bind -m vi_nmap -f 'G' vi-command/last-line
	#ble-bind -m vi_omap -f 'G' vi-command/last-line
	#ble-bind -m vi_xmap -f 'G' vi-command/last-line
	## The default mapping of 'C-r' in the normal mode is "vi_nmap/redo". If you
	## want to use the incremental search mode from Emacs in the Vim mode (as in
	## Readline), please use the following keybinding.
	#ble-bind -m vi_nmap -f 'C-r' history-isearch-backward
	#----------------------------------------------------------------------------
	# Cursor shapes and other terminal settings
	## Cursor settings
	#ble-bind -m vi_nmap --cursor 2
	#ble-bind -m vi_imap --cursor 5
	#ble-bind -m vi_omap --cursor 4
	#ble-bind -m vi_xmap --cursor 2
	#ble-bind -m vi_smap --cursor 2
	#ble-bind -m vi_cmap --cursor 0
	## DECSCUSR setting
	##
	## If you don't have the entry Ss in terminfo, yet your terminal supports
	## DECSCUSR, please comment out the following line to enable DECSCUSR.
	##
	#_ble_term_Ss=$'\e[@1 q'
	## Control sequences that will be output on entering each mode
	#bleopt term_vi_nmap=
	#bleopt term_vi_imap=
	#bleopt term_vi_omap=
	#bleopt term_vi_xmap=
	#bleopt term_vi_smap=
	#bleopt term_vi_cmap=
	#----------------------------------------------------------------------------
	# Miscellaneous settings
	## This option controls the frequency of recording "undo". When the value
	## "more" is specified, "undo" will be recorded for various operations in
	## "vi_imap".
	#bleopt keymap_vi_imap_undo=
	## This option controls the behavior of motion in select mode. The value is
	## a list of words separated by commas. When the word "stopsel" is contained
	## in this option, ble.sh exits the select mode with a motion in select mode.
	#bleopt keymap_vi_keymodel=
	## This option sets the upper limit of the maximal depth of recurrence of
	## replaying keyboard macros.
	#bleopt keymap_vi_macro_depth=64
	## This option specifies the operator name when the user input "g@" in normal
	## mode. The function "ble/keymap:vi/operator:$value", where "$value" is the
	## value of this setting, is used as the implementation of the operator.
	#bleopt keymap_vi_operatorfunc=
	## When this option has a non-empty value, "/", "?", "n", "N" search the word
	## on the current position. When this option has the empty value, these keys
	## follows the behavior of `vim`.
	#bleopt keymap_vi_search_match_current=
	#----------------------------------------------------------------------------
	# plugins
	## vim-surround
	#ble-import vim-surround
	#bleopt vim_surround_45:=$'$( \r )'
	#bleopt vim_surround_61:=$'$(( \r ))'
	## vim-arpeggio
	#ble-import vim-arpeggio
	#bleopt vim_arpeggio_timeoutlen=10
	#ble/lib/vim-arpeggio.sh/bind -s jk 'hello'
	## vim-airline
	#ble-import vim-airline
	#bleopt vim_airline_theme=light
	#bleopt vim_airline_section_a='\e[1m\q{lib/vim-airline/mode}'
	#bleopt vim_airline_section_b='\q{lib/vim-airline/gitstatus}'
	#bleopt vim_airline_section_c='\w'
	#bleopt vim_airline_section_x='bash'
	#bleopt vim_airline_section_y='$_ble_util_locale_encoding[unix]'
	#bleopt vim_airline_section_z=' \q{history-percentile} \e[1m!\q{history-index}/\!\e[22m \q{position}'
	#bleopt vim_airline_left_sep=$'\uE0B0'
	#bleopt vim_airline_left_alt_sep=$'\uE0B1'
	#bleopt vim_airline_right_sep=$'\uE0B2'
	#bleopt vim_airline_right_alt_sep=$'\uE0B3'
	#bleopt vim_airline_symbol_branch=$'\uE0A0'
	#bleopt vim_airline_symbol_dirty=$'\u26A1'
	}
	blehook/eval-after-load keymap_vi blerc/vim-load-hook

If one wants a ready-to-use configuration with all useful features enabled, I can accept a PR to add a file in contrib/config so that one can load it by ble-import config/<name>.

ble-import vim-arpeggio and ble-import vim-airline are also recommended.

[akinomyoga]

Also, don't forget to set ((_ble_bash>=40300)) && builtin bind 'set keyseq-timeout 1' for the vi editing mode.

[stefan-hacks]

You sir are a legend. I absolutely love this project. Will be donating soon thanks keep up the amazing work.

PS - using the default name for --NORMAL-- for the normal mode makes sense. Hence why I didn't get the ~ character so I had to change that.

This project is so insanely good. Best discovery for me. Thanks guys. I wondered if it would be possible to implement the drop-down features from https://github.com/carapace-sh/carapace and also lsp support like in vim so syntax help when writing on the command line in a drop down or something like that.

[akinomyoga]

PS - using the default name for --NORMAL-- for the normal mode makes sense. Hence why I didn't get the ~ character so I had to change that.

This was already repeatedly discussed in many places #57, #85 (comment), #114 (comment), #205 (comment), and #616. I'd appreciate it if you could search the issues and discussions before asking.

ble.sh tries to implement behaviors of vi/Vim. Vim doesn't show --NORMAL-- or anything as the mode indicator in the normal mode because it doesn't fit the complex rule of the mode indicator for different combinations and states in Vim. Unlike other shells' imitation of Vim, ble.sh faithfully implements the behaviors and states of Vim, so ble.sh has a similar reason as Vim for not showing NORMAL. Simply showing NORMAL doesn't seem to make much sense if you know the details of Vim behaviors. At least, one needs to reconsider what to show in the mode indicator in the situations where Vim shows -- (insert) --, -- (replace) --, and -- (vreplace) -- for consistency, but there isn't a unique way, and it would largely depend on each user's preferences. So I'd rather follow Vim's behavior as the default behavior rather than implementing something strange; ble.sh doesn't show anything as the mode string. However, with that behavior, one cannot tell the position of the end of the multi-line command line by appearance. Vim shows ~ to make the end of the file visible, and ble.sh follows that behavior to show the end of the command line in the normal mode.

It is noted that some custom Vim settings exist to show NORMAL, but they do break some consistency in some advanced modes of Vim.

At the end of the day, this is just a matter of appearance, and I don't think it actually affects the usefulness. It's just whether you've already gotten used to it or haven't yet, and ble.sh provides multiple ways to configure it. If you don't like it, as I recommended in the first reply, you can switch to e.g. vim-airline. Or you may check Item 3 of Prompt - Q&A. Or you may use or customize ble-import prompt-vim-mode.

I wondered if it would be possible to implement the drop-down features from https://github.com/carapace-sh/carapace

What do you specifically mean by the drop-down menu? The feature to allow selecting the candidates from the menu, as in Carapace, is already implemented.

If you talk about a small drop-down menu box like the one in Inshellisense, that was a part of the initial consideration for the implementation of auto-complete and menu-complete in #5 (in Japanese text), whose summary can be found in #645 (comment) in English. Supporting dynamic menus overlapping with texts in the full multiline editor would require dedicated data structures, which are hard to implement or very tedious to realize in the shell language (without any significant data structures). On the other hand, there doesn't seem to be many benefits in such a behavior. The area to show the candidates becomes limited by confining the candidates in a small box; the left and right areas of the drop-down menu become dead space.

My conclusion is that a drop-down menu box complicates the shell implementation and limits the area to show the options. The drop-down menu would be something that looks cool initially, but what people would turn off after one week in order to go back to the original full-width menu. This project doesn't aim for hype with psychedelic features, but I intend to provide a practical daily driver that can be used for decades until the tool becomes a part of unconcious background. Is there any actual practical effect other than it looks cool?

lsp support like in vim so syntax help when writing on the command line in a drop down or something like that.

That would be an appealing idea. Communications with background processes implemented in shell can be in general fragile and unstable, and I didn't like any fragile setup. However, we now have an infrastructure util.bgproc.sh to set up channels to a background process and handle errors gracefully.

[akinomyoga]

I wondered if it would be possible to implement the drop-down features from https://github.com/carapace-sh/carapace

What do you specifically mean by the drop-down menu?

I should also note that Carapace supports ble.sh. Within Bash, Carapace automatically detects ble.sh and turns on the integration. I helped the Carapace author implement it at carapace-sh/carapace#431. So if you like Carapace, you can just turn on Carapace inside a ble.sh session.