Improve ui layer (#4455)

2025-04-14 15:19:12 +08:00 · 2021-09-08 10:35:38 +08:00 · 2021-09-08 10:35:38 +08:00 · 05e45fc053
commit 05e45fc053
parent 2a3981acfd
6 changed files with 224 additions and 63 deletions
--- a/autoload/SpaceVim/layers/core/statusline.vim
+++ b/autoload/SpaceVim/layers/core/statusline.vim
@ -682,13 +682,17 @@ function! SpaceVim#layers#core#statusline#register_mode(mode) abort
  endif
 endfunction

+
+
+" This func is used to toggle major mode in statusline
+
 function! SpaceVim#layers#core#statusline#toggle_mode(name) abort
  if index(s:loaded_modes, a:name) != -1
    call remove(s:loaded_modes, index(s:loaded_modes, a:name))
  else
    call add(s:loaded_modes, a:name)
  endif
-  let mode = s:modes[a:name]
+  let mode = get(s:modes, a:name, {})
  call SpaceVim#logger#info('try to call func of mode:' . a:name)
  if has_key(mode, 'func')
    call call(mode.func, [])
--- a/autoload/SpaceVim/layers/edit.vim
+++ b/autoload/SpaceVim/layers/edit.vim
@ -38,7 +38,6 @@ function! SpaceVim#layers#edit#plugins() abort
        \ [g:_spacevim_root_dir . 'bundle/editorconfig-vim', { 'merged' : 0, 'if' : has('python') || has('python3')}],
        \ [g:_spacevim_root_dir . 'bundle/vim-jplus', { 'on_map' : '<Plug>(jplus' }],
        \ [g:_spacevim_root_dir . 'bundle/tabular',           { 'merged' : 0}],
-        \ [g:_spacevim_root_dir . 'bundle/vim-better-whitespace',  { 'on_cmd' : ['StripWhitespace', 'ToggleWhitespace', 'DisableWhitespace', 'EnableWhitespace']}],
        \ ['andrewradev/splitjoin.vim',{ 'on_cmd':['SplitjoinJoin', 'SplitjoinSplit'],'merged' : 0, 'loadconf' : 1}],
        \ ]
  if executable('fcitx')
--- a/autoload/SpaceVim/layers/ui.vim
+++ b/autoload/SpaceVim/layers/ui.vim
@ -10,27 +10,54 @@ scriptencoding utf-8
 ""
 " @section ui, layer-ui
 " @parentsection layers
-" ui layer provides basic ui for SpaceVim, including scrollbar, indentline,
-" and cursorword highlighting.
+" The `ui` layer defines the default interface for SpaceVim,
+" and it is loaded by default.
+" This layer includes scrollbar, indentline, and cursorword highlighting.
+" >
+"   [[layers]]
+"     name = 'ui'
+"     enable_sidebar = false
+"     enable_scrollbar = false
+"     enable_indentline = true
+"     enable_cursorword = false
+"     indentline_char = '|'
+"     conceallevel = 0
+"     concealcursor = ''
+"     cursorword_delay = 50
+"     cursorword_exclude_filetype = []
+"     indentline_exclude_filetyps = []
+" <
+"
+" if you want to disable `ui` layer, you can use:
+" >
+"   [[layers]]
+"     name = 'ui'
+"     enabled = fasle
+" <
 " @subsection options
 "
-" 1. `enable_scrollbar`: Enable/disable floating scrollbar of current buffer.
+" 1. `enable_sidebar`: Enable/disable sidebar.
+" 2. `enable_scrollbar`: Enable/disable floating scrollbar of current buffer.
 " Disabled by default. This feature requires neovim's floating window.
-" 2. `enable_indentline`: Enable/disable indentline of current buffer.
+" 3. `enable_indentline`: Enable/disable indentline of current buffer.
 " Enabled by default.
-" 3. `enable_cursorword`: Enable/disable  cursorword highlighting.
+" 4. `enable_cursorword`: Enable/disable  cursorword highlighting.
 " Disabled by default.
-" 4. `cursorword_delay`: The delay duration in milliseconds for setting the
+" 5. `indentline_char`: Set the character of indentline.
+" 6. `conceallevel`: set the conceallevel option.
+" 7. `concealcursor`: set the concealcursor option.
+" 8. `cursorword_delay`: The delay duration in milliseconds for setting the
 " word highlight after cursor motions, the default is 50.
-" 5. `cursorword_exclude_filetype`: Ignore filetypes when enable cursorword
+" 9. `cursorword_exclude_filetypes`: Ignore filetypes when enable cursorword
 " highlighting.
+" 10. `indentline_exclude_filetyps`: Ignore filetypes when enable indentline.
 "
 " @subsection key bindings
 " >
 "   Key binding     Description
 "   SPC t h         ui current buffer or selection lines
 " <
-" 
+"


 if exists('s:enable_sidebar')
@ -39,9 +66,13 @@ else
  let s:enable_sidebar = 0
  let s:enable_scrollbar = 0
  let s:enable_indentline = 1
+  let s:indentline_char = '|'
+  let s:indentline_exclude_filetyps = []
  let s:enable_cursorword = 0
+  let s:conceallevel = 0
+  let s:concealcursor = ''
  let s:cursorword_delay = 50
-  let s:cursorword_exclude_filetype = []
+  let s:cursorword_exclude_filetypes = []
 endif

 let s:NVIM_VERSION = SpaceVim#api#import('neovim#version')
@ -49,21 +80,37 @@ let s:NVIM_VERSION = SpaceVim#api#import('neovim#version')
 function! SpaceVim#layers#ui#plugins() abort
  let plugins = [
        \ [g:_spacevim_root_dir . 'bundle/vim-cursorword', {'merged' : 0}],
-        \ [g:_spacevim_root_dir . 'bundle/tagbar', {'loadconf' : 1, 'merged' : 0}],
-        \ [g:_spacevim_root_dir . 'bundle/tagbar-makefile.vim', {'merged': 0}],
+        \ [g:_spacevim_root_dir . 'bundle/tagbar',
+        \ {'loadconf' : 1, 'merged' : 0}],
+        \ [g:_spacevim_root_dir . 'bundle/tagbar-makefile.vim',
+        \ {'merged': 0}],
        \ [g:_spacevim_root_dir . 'bundle/tagbar-proto.vim', {'merged': 0}],
-        \ [g:_spacevim_root_dir . 'bundle/vim-choosewin', {'on_cmd' : 'ChooseWin', 'merged' : 0}],
-        \ [g:_spacevim_root_dir . 'bundle/vim-startify', {'loadconf' : 1, 'merged' : 0}],
+        \ [g:_spacevim_root_dir . 'bundle/vim-choosewin',
+        \ {'on_cmd' : 'ChooseWin', 'merged' : 0}],
+        \ [g:_spacevim_root_dir . 'bundle/vim-startify',
+        \ {'loadconf' : 1, 'merged' : 0}],
+        \ [g:_spacevim_root_dir . 'bundle/vim-better-whitespace',
+        \ { 'on_cmd' : [
+          \ 'StripWhitespace',
+          \ 'ToggleWhitespace',
+          \ 'DisableWhitespace',
+          \ 'EnableWhitespace'
+          \ ]}],
        \ ]
-  if (has('nvim-0.5.0') && s:NVIM_VERSION.is_release_version()) || has('nvim-0.6.0')
-    call add(plugins, [g:_spacevim_root_dir . 'bundle/indent-blankline.nvim',         { 'merged' : 0}])
+  if (has('nvim-0.5.0') && s:NVIM_VERSION.is_release_version())
+        \ || has('nvim-0.6.0')
+    call add(plugins, [g:_spacevim_root_dir . 'bundle/indent-blankline.nvim',
+          \ { 'merged' : 0}])
  else
-    call add(plugins, [g:_spacevim_root_dir . 'bundle/indentLine',         { 'merged' : 0}])
+    call add(plugins, [g:_spacevim_root_dir . 'bundle/indentLine',
+          \ { 'merged' : 0}])
  endif
  if !SpaceVim#layers#isLoaded('core#statusline')
-    call add(plugins, [g:_spacevim_root_dir . 'bundle/vim-airline',                { 'merged' : 0, 
+    call add(plugins, [g:_spacevim_root_dir . 'bundle/vim-airline',
+          \ { 'merged' : 0,
          \ 'loadconf' : 1}])
-    call add(plugins, [g:_spacevim_root_dir . 'bundle/vim-airline-themes',         { 'merged' : 0}])
+    call add(plugins, [g:_spacevim_root_dir . 'bundle/vim-airline-themes',
+          \ { 'merged' : 0}])
  endif

  return plugins
@ -78,17 +125,26 @@ function! SpaceVim#layers#ui#config() abort
    let g:indentLine_color_gui = get(g:, 'indentLine_color_gui', '#d5c4a1')
  endif

-  " indentLine config
-  let g:indentLine_char = get(g:, 'indentLine_char', '┊')
-  let g:indentLine_concealcursor = 'niv'
-  let g:indentLine_conceallevel = 2
-  let g:indentLine_enabled = s:enable_indentline
-  let g:indentLine_fileTypeExclude = get(g:, 'indentLine_fileTypeExclude', [])
-  let g:indentLine_fileTypeExclude += ['help', 'man', 'startify', 'vimfiler', 'json']
+  " indent line configuration
+  " indent_blankline for neovim, indentLine for vim and old neovim

-  " indent_blankline config
+  " indent line character
+  let g:indent_blankline_char = s:indentline_char
+  let g:indentLine_char = s:indentline_char
+
+  " indent line conceal setting, only for indentLine
+  let g:indentLine_concealcursor = s:concealcursor
+  let g:indentLine_conceallevel = s:conceallevel
+
+
+  " enable/disable indentline
+  let g:indentLine_enabled = s:enable_indentline
  let g:indent_blankline_enabled = s:enable_indentline

+  " exclude filetypes for indentline
+  let g:indentLine_fileTypeExclude = s:indentline_exclude_filetyps
+  let g:indent_blankline_buftype_exclude = s:indentline_exclude_filetyps
+
  let g:better_whitespace_filetypes_blacklist = ['diff', 'gitcommit', 'unite',
        \ 'qf', 'help', 'markdown', 'leaderGuide',
        \ 'startify'
@ -108,20 +164,25 @@ function! SpaceVim#layers#ui#config() abort
  augroup spacevim_layer_ui
    autocmd!
    if s:enable_scrollbar && has('nvim')
-      autocmd BufEnter,CursorMoved,VimResized,FocusGained    * call SpaceVim#plugins#scrollbar#show()
-      autocmd BufLeave,FocusLost,QuitPre    * call SpaceVim#plugins#scrollbar#clear()
+      autocmd BufEnter,CursorMoved,VimResized,FocusGained
+            \ * call SpaceVim#plugins#scrollbar#show()
+      autocmd BufLeave,FocusLost,QuitPre
+            \ * call SpaceVim#plugins#scrollbar#clear()
      " why this autocmd is needed?
      "
      " because the startify use noautocmd enew
      autocmd User Startified call s:clear_previous_scrollbar()
    endif
-    if !empty(s:cursorword_exclude_filetype)
-      exe printf('autocmd FileType %s let b:cursorword = 0', join(s:cursorword_exclude_filetype, ','))
+    if !empty(s:cursorword_exclude_filetypes)
+      exe printf('autocmd FileType %s let b:cursorword = 0',
+            \ join(s:cursorword_exclude_filetypes, ','))
    endif
  augroup end

  if !empty(g:spacevim_windows_smartclose)
-    call SpaceVim#mapping#def('nnoremap <silent>', g:spacevim_windows_smartclose, ':<C-u>call SpaceVim#mapping#SmartClose()<cr>',
+    call SpaceVim#mapping#def('nnoremap <silent>',
+          \ g:spacevim_windows_smartclose,
+          \ ':<C-u>call SpaceVim#mapping#SmartClose()<cr>',
          \ 'smart-close-windows',
          \ 'call SpaceVim#mapping#SmartClose()')
  endif
@ -181,20 +242,26 @@ function! SpaceVim#layers#ui#config() abort
  call SpaceVim#mapping#space#def('nnoremap', ['T', '~'], 'call call('
        \ . string(s:_function('s:toggle_end_of_buffer')) . ', [])',
        \ 'display ~ in the fringe on empty lines', 1)
-  call SpaceVim#mapping#space#def('nnoremap', ['t', 'S'], 'call SpaceVim#layers#core#statusline#toggle_mode("spell-checking")',
-        \ 'toggle-spell-checker', 1)
-
  call SpaceVim#layers#core#statusline#register_mode(
        \ {
          \ 'key' : 'spell-checking',
          \ 'func' : s:_function('s:toggle_spell_check'),
          \ }
          \ )
-
-  call SpaceVim#mapping#space#def('nnoremap', ['t', 'p'], 'call call('
-        \ . string(s:_function('s:toggle_paste')) . ', [])',
+  call SpaceVim#mapping#space#def('nnoremap', ['t', 'S'],
+        \ 'call SpaceVim#layers#core#statusline#toggle_mode("spell-checking")',
+        \ 'toggle-spell-checker', 1)
+  call SpaceVim#layers#core#statusline#register_mode(
+        \ {
+          \ 'key' : 'paste-mode',
+          \ 'func' : s:_function('s:toggle_paste'),
+          \ }
+          \ )
+  call SpaceVim#mapping#space#def('nnoremap', ['t', 'p'],
+        \ 'call SpaceVim#layers#core#statusline#toggle_mode("paste-mode")',
        \ 'toggle-paste-mode', 1)

+
  call SpaceVim#mapping#space#def('nnoremap', ['t', 'l'], 'setlocal list!',
        \ 'toggle-hidden-listchars', 1)
  call SpaceVim#mapping#space#def('nnoremap', ['t', 'W'], 'setlocal wrap!',
@ -369,13 +436,11 @@ function! s:toggle_paste() abort
  else
    let &l:paste = 1
  endif
-  call SpaceVim#layers#core#statusline#toggle_mode('paste-mode')
  if &l:paste == 1
    echo 'paste-mode enabled.'
  else
    echo 'paste-mode disabled.'
  endif
-
 endfunction

 let s:whitespace_enable = 0
@ -392,7 +457,7 @@ function! s:toggle_whitespace() abort
 endfunction

 function! s:toggle_conceallevel() abort
-  if &conceallevel == 0 
+  if &conceallevel == 0
    setlocal conceallevel=2
  else
    setlocal conceallevel=0
@ -411,7 +476,7 @@ endfunction


 function! s:win_resize_transient_state() abort
-  let state = SpaceVim#api#import('transient_state') 
+  let state = SpaceVim#api#import('transient_state')
  call state.set_title('Windows Resize Transient State')
  call state.defind_keys(
        \ {
@ -493,16 +558,32 @@ function! SpaceVim#layers#ui#set_variable(var) abort
  let s:enable_indentline = get(a:var,
        \ 'enable_indentline',
        \ 1)
+  let s:indentline_char = get(a:var,
+        \ 'indentline_char',
+        \ s:indentline_char)
+  let s:indentline_exclude_filetyps = get(a:var,
+        \ 'indentline_exclude_filetyps',
+        \ s:indentline_exclude_filetyps)
  let s:enable_cursorword = get(a:var,
        \ 'enable_cursorword',
        \ s:enable_cursorword)
+  let s:conceallevel = get(a:var,
+        \ 'conceallevel',
+        \ s:conceallevel)
+  let s:concealcursor = get(a:var,
+        \ 'concealcursor',
+        \ s:concealcursor)
  let s:cursorword_delay = get(a:var,
        \ 'cursorword_delay',
        \ s:cursorword_delay)
-  let s:cursorword_exclude_filetype = get(a:var,
+  " The old layer option is cursorword_exclude_filetype
+  let s:cursorword_exclude_filetypes =
+        \ get(a:var,
+        \ 'cursorword_exclude_filetypes',
+        \ get(a:var,
        \ 'cursorword_exclude_filetype',
-        \ s:cursorword_exclude_filetype)
-
+        \ s:cursorword_exclude_filetypes
+        \ ))
 endfunction

 function! s:clear_previous_scrollbar() abort
@ -523,6 +604,10 @@ function! SpaceVim#layers#ui#get_options() abort
        \ 'enable_indentline',
        \ 'enable_cursorword',
        \ 'cursorword_delay',
-        \ 'cursorword_exclude_filetype']
+        \ 'concealcursor',
+        \ 'conceallevel',
+        \ 'indentline_exclude_filetyps',
+        \ 'indentline_char',
+        \ 'cursorword_exclude_filetypes']

 endfunction
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@ -4089,20 +4089,47 @@ This layer provides Zeal integration for SpaceVim
 ==============================================================================
 UI                                                         *SpaceVim-layer-ui*

-ui layer provides basic ui for SpaceVim, including scrollbar, indentline, and
-cursorword highlighting.
+The `ui` layer defines the default interface for SpaceVim, and it is loaded by
+default. This layer includes scrollbar, indentline, and cursorword
+highlighting.
+>
+  [[layers]]
+    name = 'ui'
+    enable_sidebar = false
+    enable_scrollbar = false
+    enable_indentline = true
+    enable_cursorword = false
+    indentline_char = '|'
+    conceallevel = 0
+    concealcursor = ''
+    cursorword_delay = 50
+    cursorword_exclude_filetype = []
+    indentline_exclude_filetyps = []
+<
+
+if you want to disable `ui` layer, you can use:
+>
+  [[layers]]
+    name = 'ui'
+    enabled = fasle
+<
 OPTIONS

-  1. `enable_scrollbar`: Enable/disable floating scrollbar of current buffer.
+  1. `enable_sidebar`: Enable/disable sidebar.
+  2. `enable_scrollbar`: Enable/disable floating scrollbar of current buffer.
 Disabled by default. This feature requires neovim's floating window.
-  2. `enable_indentline`: Enable/disable indentline of current buffer.
+  3. `enable_indentline`: Enable/disable indentline of current buffer.
 Enabled by default.
-  3. `enable_cursorword`: Enable/disable  cursorword highlighting.
+  4. `enable_cursorword`: Enable/disable  cursorword highlighting.
 Disabled by default.
-  4. `cursorword_delay`: The delay duration in milliseconds for setting the
+  5. `indentline_char`: Set the character of indentline.
+  6. `conceallevel`: set the conceallevel option.
+  7. `concealcursor`: set the concealcursor option.
+  8. `cursorword_delay`: The delay duration in milliseconds for setting the
 word highlight after cursor motions, the default is 50.
-  5. `cursorword_exclude_filetype`: Ignore filetypes when enable cursorword
+  9. `cursorword_exclude_filetypes`: Ignore filetypes when enable cursorword
 highlighting.
+  10. `indentline_exclude_filetyps`: Ignore filetypes when enable indentline.

 KEY BINDINGS

--- a/docs/cn/layers/ui.md
+++ b/docs/cn/layers/ui.md
@ -16,7 +16,23 @@ lang: zh

 ## 模块描述

-SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件树、语法数等等特性。
+`ui` 模块为 SpaceVim 提供了一些界面元素，包括对齐线、滚动条等等。
+该模块默认已载入，默认的模块选项如下：
+
+```toml
+[[layers]]
+  name = "ui"
+    enable_sidebar = false
+    enable_scrollbar = false
+    enable_indentline = true
+    enable_cursorword = false
+    indentline_char = '|'
+    conceallevel = 0
+    concealcursor = ''
+    cursorword_delay = 50
+    cursorword_exclude_filetype = []
+    indentline_exclude_filetyps = []
+```

 ## 启用模块

@ -29,8 +45,13 @@ SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件

 ## 模块选项

+- `enable_sidebar`: 启用/禁用侧栏。
 - `enable_scrollbar`：启用/禁用悬浮滚动条，默认为禁用的，该功能需要 Neovim 的悬浮窗口支持。
 - `enable_indentline`: 启用/禁用对齐线，默认为启用的。
 - `enable_cursorword`: 启用/禁用高亮光标下的词，默认为禁用状态。需要禁用的话，可设为 `false`。
 - `cursorword_delay`: 设置高亮光标下词的延迟时间，默认为 50 毫秒。
- `cursorword_exclude_filetype`: 设置哪些文件类型需要禁用高亮光标下的词。
+- `cursorword_exclude_filetypes`: 设置哪些文件类型需要禁用高亮光标下的词。
+- `indentline_char`: 设置对齐线的字符。
+- `conceallevel`: 设置 conceallevel 选项。
+- `concealcursor`: 设置 concealcursor 选项。
+- `indentline_exclude_filetyps`: 设置禁用对齐线的文件类型。
--- a/docs/layers/ui.md
+++ b/docs/layers/ui.md
@ -15,7 +15,23 @@ description: "Awesome UI layer for SpaceVim, provide IDE-like UI for neovim and

 ## Description

-This is UI layer for SpaceVim, and it is loaded by default.
+The `ui` layer defines the default interface for SpaceVim,
+and this layer is enabled by default with following options:
+
+```toml
+[[layers]]
+  name = "ui"
+    enable_sidebar = false
+    enable_scrollbar = false
+    enable_indentline = true
+    enable_cursorword = false
+    indentline_char = '|'
+    conceallevel = 0
+    concealcursor = ''
+    cursorword_delay = 50
+    cursorword_exclude_filetype = []
+    indentline_exclude_filetyps = []
+```

 ## Install

@ -28,9 +44,18 @@ To use this configuration layer, update custom configuration file with:

 ## Layer Options

- `enable_scrollbar`: Enable/disable floating scrollbar of current buffer. Disabled by default.
-  This feature requires neovim's floating window.
- `enable_indentline`: Enable/disable indentline of current buffer. Enabled by default.
- `enable_cursorword`: Enable/disable  cursorword highlighting, enabled by default.
- `cursorword_delay`: The delay duration in milliseconds for setting the word highlight after cursor motions, the default is 50.
- `cursorword_exclude_filetype`: Ignore filetypes when enable cursorword highlighting. 
+- `enable_sidebar`: Enable/disable sidebar.
+- `enable_scrollbar`: Enable/disable floating scrollbar of current buffer.
+  Disabled by default. This feature requires neovim's floating window.
+- `enable_indentline`: Enable/disable indentline of current buffer.
+  Enabled by default.
+- `enable_cursorword`: Enable/disable cursorword highlighting.
+  Disabled by default.
+- `indentline_char`: Set the character of indentline.
+- `conceallevel`: set the conceallevel option.
+- `concealcursor`: set the concealcursor option.
+- `cursorword_delay`: The delay duration in milliseconds for setting the
+  word highlight after cursor motions, the default is 50.
+- `cursorword_exclude_filetypes`: Ignore filetypes when enable cursorword
+  highlighting.
+- `indentline_exclude_filetyps`: Ignore filetypes when enable indentline.