jshaver
/
ale
forked from github-mirrors/ale
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Allow customization of all floating window borders (#4215) 

* Allow customization of all floating window borders

Users may not necessarily want the same border character for top+bottom
or left+right, so allow all eight border characters to be configured in
g:ale_floating_window_border.

For backwards compatibility, the old rules are still applied if only six
elements are given.

* Reorder popup border array for compatibility
This commit is contained in:
Devin J. Pohly 2022-05-26 23:41:06 -05:00 committed by GitHub
parent 3d7b3a6541
commit ae44f05600
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 36 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -931,14 +931,14 @@ If the terminal supports Unicode, you might try setting the value like below, to
make it look nicer. make it look nicer.
```vim ```vim
let g:ale_floating_window_border = ['│', '─', '╭', '╮', '╯', '╰'] let g:ale_floating_window_border = ['│', '─', '╭', '╮', '╯', '╰', '│', '─']
``` ```
Since vim's default uses nice unicode characters when possible, you can trick Since vim's default uses nice unicode characters when possible, you can trick
ale into using that default with ale into using that default with
```vim ```vim
let g:ale_floating_window_border = repeat([''], 6) let g:ale_floating_window_border = repeat([''], 8)
``` ```
<a name="faq-vim-lsp"></a> <a name="faq-vim-lsp"></a>

34
autoload/ale/floating_preview.vim
View File

@ -106,18 +106,20 @@ function! s:NvimPrepareWindowContent(lines) abort
let l:width += 2 let l:width += 2
let l:height += 2 let l:height += 2
let l:hor = g:ale_floating_window_border[0] let l:left = get(g:ale_floating_window_border, 0, '|')
let l:top = g:ale_floating_window_border[1] let l:top = get(g:ale_floating_window_border, 1, '-')
let l:top_left = g:ale_floating_window_border[2] let l:top_left = get(g:ale_floating_window_border, 2, '+')
let l:top_right = g:ale_floating_window_border[3] let l:top_right = get(g:ale_floating_window_border, 3, '+')
let l:bottom_right = g:ale_floating_window_border[4] let l:bottom_right = get(g:ale_floating_window_border, 4, '+')
let l:bottom_left = g:ale_floating_window_border[5] let l:bottom_left = get(g:ale_floating_window_border, 5, '+')
let l:right = get(g:ale_floating_window_border, 6, l:left)
let l:bottom = get(g:ale_floating_window_border, 7, l:top)
let l:lines = [l:top_left . repeat(l:top, l:width - 2) . l:top_right] let l:lines = [l:top_left . repeat(l:top, l:width - 2) . l:top_right]
for l:line in a:lines for l:line in a:lines
let l:line_width = strchars(l:line) let l:line_width = strchars(l:line)
let l:lines = add(l:lines, l:hor . l:line . repeat(' ', l:width - l:line_width - 2). l:hor) let l:lines = add(l:lines, l:left . l:line . repeat(' ', l:width - l:line_width - 2). l:right)
endfor endfor
" Truncate the lines " Truncate the lines
@ -125,7 +127,7 @@ function! s:NvimPrepareWindowContent(lines) abort
let l:lines = l:lines[0:l:max_height] let l:lines = l:lines[0:l:max_height]
endif endif
let l:lines = add(l:lines, l:bottom_left . repeat(l:top, l:width - 2) . l:bottom_right) let l:lines = add(l:lines, l:bottom_left . repeat(l:bottom, l:width - 2) . l:bottom_right)
return [l:lines, l:width, l:height] return [l:lines, l:width, l:height]
endfunction endfunction
@ -158,14 +160,14 @@ function! s:VimCreate(options) abort
\ 'padding': [0, 1, 0, 1], \ 'padding': [0, 1, 0, 1],
\ 'border': [], \ 'border': [],
\ 'borderchars': empty(g:ale_floating_window_border) ? [' '] : [ \ 'borderchars': empty(g:ale_floating_window_border) ? [' '] : [
\ g:ale_floating_window_border[1], \ get(g:ale_floating_window_border, 1, '-'),
\ g:ale_floating_window_border[0], \ get(g:ale_floating_window_border, 6, '|'),
\ g:ale_floating_window_border[1], \ get(g:ale_floating_window_border, 7, '-'),
\ g:ale_floating_window_border[0], \ get(g:ale_floating_window_border, 0, '|'),
\ g:ale_floating_window_border[2], \ get(g:ale_floating_window_border, 2, '+'),
\ g:ale_floating_window_border[3], \ get(g:ale_floating_window_border, 3, '+'),
\ g:ale_floating_window_border[4], \ get(g:ale_floating_window_border, 4, '+'),
\ g:ale_floating_window_border[5], \ get(g:ale_floating_window_border, 5, '+'),
\ ], \ ],
\ 'moved': 'any', \ 'moved': 'any',
\ }) \ })

16
doc/ale.txt
View File

@ -676,7 +676,8 @@ Hover information can be displayed in the preview window instead by setting
When using Neovim or Vim with |popupwin|, if |g:ale_hover_to_floating_preview| When using Neovim or Vim with |popupwin|, if |g:ale_hover_to_floating_preview|
or |g:ale_floating_preview| is set to 1, the hover information will show in a or |g:ale_floating_preview| is set to 1, the hover information will show in a
floating window. And |g:ale_floating_window_border| for the border setting. floating window. The borders of the floating preview window can be customized
by setting |g:ale_floating_window_border|.
For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|balloonexpr| commands in terminals can cause scrolling issues in terminals, |balloonexpr| commands in terminals can cause scrolling issues in terminals,
@ -1236,14 +1237,19 @@ g:ale_floating_preview *g:ale_floating_preview*
g:ale_floating_window_border *g:ale_floating_window_border* g:ale_floating_window_border *g:ale_floating_window_border*
Type: |List| Type: |List|
Default: `['|', '-', '+', '+', '+', '+']` Default: `['|', '-', '+', '+', '+', '+', '|', '-']`
When set to `[]`, window borders are disabled. The elements in the list set When set to `[]`, window borders are disabled. The elements in the list set
the horizontal, top, top-left, top-right, bottom-right and bottom-left the the characters for the left side, top, top-left corner, top-right
border characters, respectively. corner, bottom-right corner, bottom-left corner, right side, and bottom of
the floating window, respectively.
If the terminal supports Unicode, you might try setting the value to If the terminal supports Unicode, you might try setting the value to
` ['│', '─', '╭', '╮', '╯', '╰']`, to make it look nicer. ` ['│', '─', '╭', '╮', '╯', '╰', '│', '─']`, to make it look nicer.
NOTE: For compatibility with previous versions, if the list does not have
elements for the right side and bottom, the left side and top will be used
instead.
g:ale_history_enabled *g:ale_history_enabled* g:ale_history_enabled *g:ale_history_enabled*

9
plugin/ale.vim
View File

@ -152,10 +152,11 @@ let g:ale_hover_to_floating_preview = get(g:, 'ale_hover_to_floating_preview', 0
" Detail uses floating windows in Neovim " Detail uses floating windows in Neovim
let g:ale_detail_to_floating_preview = get(g:, 'ale_detail_to_floating_preview', 0) let g:ale_detail_to_floating_preview = get(g:, 'ale_detail_to_floating_preview', 0)
" Border setting for floating preview windows in Neovim " Border setting for floating preview windows
" The element in the list presents - horizontal, top, top-left, top-right, " The elements in the list set the characters for the left, top, top-left,
" bottom-right and bottom-left " top-right, bottom-right, bottom-left, right, and bottom of the border
let g:ale_floating_window_border = get(g:, 'ale_floating_window_border', ['|', '-', '+', '+', '+', '+']) " respectively
let g:ale_floating_window_border = get(g:, 'ale_floating_window_border', ['|', '-', '+', '+', '+', '+', '|', '-'])
" This flag can be set to 0 to disable warnings for trailing whitespace " This flag can be set to 0 to disable warnings for trailing whitespace
let g:ale_warn_about_trailing_whitespace = get(g:, 'ale_warn_about_trailing_whitespace', 1) let g:ale_warn_about_trailing_whitespace = get(g:, 'ale_warn_about_trailing_whitespace', 1)