Fix #825 - Downgrade signs when problems change

This commit is contained in:
w0rp 2017-08-26 16:38:27 +01:00
parent cdd1ddffdb
commit e13651c16d
6 changed files with 317 additions and 193 deletions

View File

@ -282,10 +282,6 @@ function! ale#engine#SetResults(buffer, loclist) abort
" The List could be sorted again here by SetSigns. " The List could be sorted again here by SetSigns.
if g:ale_set_signs if g:ale_set_signs
call ale#sign#SetSigns(a:buffer, a:loclist) call ale#sign#SetSigns(a:buffer, a:loclist)
if l:linting_is_done
call ale#sign#RemoveDummySignIfNeeded(a:buffer)
endif
endif endif
if g:ale_set_quickfix || g:ale_set_loclist if g:ale_set_quickfix || g:ale_set_loclist

View File

@ -2,8 +2,6 @@ scriptencoding utf8
" Author: w0rp <devw0rp@gmail.com> " Author: w0rp <devw0rp@gmail.com>
" Description: Draws error and warning signs into signcolumn " Description: Draws error and warning signs into signcolumn
let b:dummy_sign_set_map = {}
if !hlexists('ALEErrorSign') if !hlexists('ALEErrorSign')
highlight link ALEErrorSign error highlight link ALEErrorSign error
endif endif
@ -62,6 +60,62 @@ execute 'sign define ALEInfoSign text=' . g:ale_sign_info
\ . ' texthl=ALEInfoSign linehl=ALEInfoLine' \ . ' texthl=ALEInfoSign linehl=ALEInfoLine'
sign define ALEDummySign sign define ALEDummySign
let s:error_priority = 1
let s:warning_priority = 2
let s:info_priority = 3
let s:style_error_priority = 4
let s:style_warning_priority = 5
function! ale#sign#GetSignName(sublist) abort
let l:priority = s:style_warning_priority
" Determine the highest priority item for the line.
for l:item in a:sublist
if l:item.type is# 'I'
let l:item_priority = s:info_priority
elseif l:item.type is# 'W'
if get(l:item, 'sub_type', '') is# 'style'
let l:item_priority = s:style_warning_priority
else
let l:item_priority = s:warning_priority
endif
else
if get(l:item, 'sub_type', '') is# 'style'
let l:item_priority = s:style_error_priority
else
let l:item_priority = s:error_priority
endif
endif
if l:item_priority < l:priority
let l:priority = l:item_priority
endif
endfor
if l:priority is# s:error_priority
return 'ALEErrorSign'
endif
if l:priority is# s:warning_priority
return 'ALEWarningSign'
endif
if l:priority is# s:style_error_priority
return 'ALEStyleErrorSign'
endif
if l:priority is# s:style_warning_priority
return 'ALEStyleWarningSign'
endif
if l:priority is# s:info_priority
return 'ALEInfoSign'
endif
" Use the error sign for invalid severities.
return 'ALEErrorSign'
endfunction
" Read sign data for a buffer to a list of lines. " Read sign data for a buffer to a list of lines.
function! ale#sign#ReadSigns(buffer) abort function! ale#sign#ReadSigns(buffer) abort
redir => l:output redir => l:output
@ -71,7 +125,7 @@ function! ale#sign#ReadSigns(buffer) abort
return split(l:output, "\n") return split(l:output, "\n")
endfunction endfunction
" Given a list of lines for sign output, return a List of pairs [line, id] " Given a list of lines for sign output, return a List of [line, id, group]
function! ale#sign#ParseSigns(line_list) abort function! ale#sign#ParseSigns(line_list) abort
" Matches output like : " Matches output like :
" line=4 id=1 name=ALEErrorSign " line=4 id=1 name=ALEErrorSign
@ -81,20 +135,25 @@ function! ale#sign#ParseSigns(line_list) abort
" riga=1 id=1000001, nome=ALEWarningSign " riga=1 id=1000001, nome=ALEWarningSign
let l:pattern = '\v^.*\=(\d+).*\=(\d+).*\=(ALE[a-zA-Z]+Sign)' let l:pattern = '\v^.*\=(\d+).*\=(\d+).*\=(ALE[a-zA-Z]+Sign)'
let l:result = [] let l:result = []
let l:is_dummy_sign_set = 0
for l:line in a:line_list for l:line in a:line_list
let l:match = matchlist(l:line, l:pattern) let l:match = matchlist(l:line, l:pattern)
if len(l:match) > 0 if len(l:match) > 0
if l:match[3] is# 'ALEDummySign'
let l:is_dummy_sign_set = 1
else
call add(l:result, [ call add(l:result, [
\ str2nr(l:match[1]), \ str2nr(l:match[1]),
\ str2nr(l:match[2]), \ str2nr(l:match[2]),
\ l:match[3], \ l:match[3],
\]) \])
endif endif
endif
endfor endfor
return l:result return [l:is_dummy_sign_set, l:result]
endfunction endfunction
function! ale#sign#FindCurrentSigns(buffer) abort function! ale#sign#FindCurrentSigns(buffer) abort
@ -122,78 +181,7 @@ function! s:GroupLoclistItems(buffer, loclist) abort
let l:last_lnum = l:obj.lnum let l:last_lnum = l:obj.lnum
endfor endfor
" Now we've gathered the items in groups, filter the groups down to return l:grouped_items
" the groups containing at least one new item.
let l:new_grouped_items = []
for l:group in l:grouped_items
for l:obj in l:group
if !has_key(l:obj, 'sign_id')
call add(l:new_grouped_items, l:group)
break
endif
endfor
endfor
return l:new_grouped_items
endfunction
function! s:IsDummySignSet(current_id_list) abort
for [l:line, l:id, l:name] in a:current_id_list
if l:id == g:ale_sign_offset
return 1
endif
if l:line > 1
return 0
endif
endfor
return 0
endfunction
function! s:SetDummySignIfNeeded(buffer, current_sign_list, new_signs) abort
let l:is_dummy_sign_set = s:IsDummySignSet(a:current_sign_list)
" If we haven't already set a dummy sign, and we have some previous signs
" or always want a dummy sign, then set one, to keep the sign column open.
if !l:is_dummy_sign_set && (a:new_signs || g:ale_sign_column_always)
silent! execute 'sign place ' . g:ale_sign_offset
\ . ' line=1 name=ALEDummySign buffer='
\ . a:buffer
let l:is_dummy_sign_set = 1
endif
return l:is_dummy_sign_set
endfunction
function! ale#sign#GetSignType(sublist) abort
let l:highest_level = 100
for l:item in a:sublist
let l:level = (l:item.type is# 'I' ? 2 : l:item.type is# 'W')
if get(l:item, 'sub_type', '') is# 'style'
let l:level += 10
endif
if l:level < l:highest_level
let l:highest_level = l:level
endif
endfor
if l:highest_level == 10
return 'ALEStyleErrorSign'
elseif l:highest_level == 11
return 'ALEStyleWarningSign'
elseif l:highest_level == 2
return 'ALEInfoSign'
elseif l:highest_level == 1
return 'ALEWarningSign'
endif
return 'ALEErrorSign'
endfunction endfunction
function! ale#sign#SetSignColumnHighlight(has_problems) abort function! ale#sign#SetSignColumnHighlight(has_problems) abort
@ -206,64 +194,130 @@ function! ale#sign#SetSignColumnHighlight(has_problems) abort
endif endif
endfunction endfunction
function! s:PlaceNewSigns(buffer, grouped_items, current_sign_offset) abort function! s:UpdateLineNumbers(buffer, current_sign_list, loclist) abort
if g:ale_change_sign_column_color let l:line_map = {}
call ale#sign#SetSignColumnHighlight(!empty(a:grouped_items)) let l:line_numbers_changed = 0
endif
let l:offset = a:current_sign_offset > 0
\ ? a:current_sign_offset
\ : g:ale_sign_offset
" Add the new signs,
for l:index in range(0, len(a:grouped_items) - 1)
let l:sign_id = l:offset + l:index + 1
let l:sublist = a:grouped_items[l:index]
let l:type = ale#sign#GetSignType(a:grouped_items[l:index])
" Save the sign IDs we are setting back on our loclist objects.
" These IDs will be used to preserve items which are set many times.
for l:obj in l:sublist
let l:obj.sign_id = l:sign_id
endfor
silent! execute 'sign place ' . l:sign_id
\ . ' line=' . l:sublist[0].lnum
\ . ' name=' . l:type
\ . ' buffer=' . a:buffer
endfor
endfunction
" Get items grouped by any current sign IDs they might have.
function! s:GetItemsWithSignIDs(buffer, loclist) abort
let l:items_by_sign_id = {}
for l:item in a:loclist
if l:item.bufnr == a:buffer && has_key(l:item, 'sign_id')
if !has_key(l:items_by_sign_id, l:item.sign_id)
let l:items_by_sign_id[l:item.sign_id] = []
endif
call add(l:items_by_sign_id[l:item.sign_id], l:item)
endif
endfor
return l:items_by_sign_id
endfunction
" Given some current signs and a loclist, look for items with sign IDs,
" and change the line numbers for loclist items to match the signs.
function! s:UpdateLineNumbers(current_sign_list, items_by_sign_id) abort
" Do nothing if there's nothing to work with.
if empty(a:items_by_sign_id)
return
endif
for [l:line, l:sign_id, l:name] in a:current_sign_list for [l:line, l:sign_id, l:name] in a:current_sign_list
for l:obj in get(a:items_by_sign_id, l:sign_id, []) let l:line_map[l:sign_id] = l:line
let l:obj.lnum = l:line
endfor endfor
for l:item in a:loclist
if l:item.bufnr == a:buffer
let l:lnum = get(l:line_map, get(l:item, 'sign_id', 0), 0)
if l:lnum && l:item.lnum != l:lnum
let l:item.lnum = l:lnum
let l:line_numbers_changed = 1
endif
endif
endfor endfor
" When the line numbers change, sort the list again
if l:line_numbers_changed
call sort(a:loclist, 'ale#util#LocItemCompare')
endif
endfunction
function! s:BuildSignMap(current_sign_list, grouped_items) abort
let l:sign_map = {}
let l:sign_offset = g:ale_sign_offset
for [l:line, l:sign_id, l:name] in a:current_sign_list
let l:sign_map[l:line] = {
\ 'current_id': l:sign_id,
\ 'current_name': l:name,
\ 'new_id': 0,
\ 'new_name': '',
\ 'items': [],
\}
if l:sign_id > l:sign_offset
let l:sign_offset = l:sign_id
endif
endfor
for l:group in a:grouped_items
let l:line = l:group[0].lnum
let l:sign_info = get(l:sign_map, l:line, {
\ 'current_id': 0,
\ 'current_name': '',
\ 'new_id': 0,
\ 'new_name': '',
\ 'items': [],
\})
let l:sign_info.new_name = ale#sign#GetSignName(l:group)
let l:sign_info.items = l:group
if l:sign_info.current_name isnot# l:sign_info.new_name
let l:sign_info.new_id = l:sign_offset + 1
let l:sign_offset += 1
else
let l:sign_info.new_id = l:sign_info.current_id
endif
let l:sign_map[l:line] = l:sign_info
endfor
return l:sign_map
endfunction
function! ale#sign#GetSignCommands(buffer, was_sign_set, sign_map) abort
let l:command_list = []
let l:is_dummy_sign_set = a:was_sign_set
" Set the dummy sign if we need to.
" The dummy sign is needed to keep the sign column open while we add
" and remove signs.
if !l:is_dummy_sign_set && (!empty(a:sign_map) || g:ale_sign_column_always)
call add(l:command_list, 'sign place '
\ . g:ale_sign_offset
\ . ' line=1 name=ALEDummySign buffer='
\ . a:buffer
\)
let l:is_dummy_sign_set = 1
endif
" Place new items first.
for [l:line_str, l:info] in items(a:sign_map)
if l:info.new_id
" Save the sign IDs we are setting back on our loclist objects.
" These IDs will be used to preserve items which are set many times.
for l:item in l:info.items
let l:item.sign_id = l:info.new_id
endfor
if l:info.new_id isnot l:info.current_id
call add(l:command_list, 'sign place '
\ . (l:info.new_id)
\ . ' line=' . l:line_str
\ . ' name=' . (l:info.new_name)
\ . ' buffer=' . a:buffer
\)
endif
endif
endfor
" Remove signs without new IDs.
for l:info in values(a:sign_map)
if l:info.current_id && l:info.current_id isnot l:info.new_id
call add(l:command_list, 'sign unplace '
\ . (l:info.current_id)
\ . ' buffer=' . a:buffer
\)
endif
endfor
" Remove the dummy sign to close the sign column if we need to.
if l:is_dummy_sign_set && !g:ale_sign_column_always
call add(l:command_list, 'sign unplace '
\ . g:ale_sign_offset
\ . ' buffer=' . a:buffer
\)
endif
return l:command_list
endfunction endfunction
" This function will set the signs which show up on the left. " This function will set the signs which show up on the left.
@ -275,42 +329,25 @@ function! ale#sign#SetSigns(buffer, loclist) abort
endif endif
" Find the current markers " Find the current markers
let l:current_sign_list = ale#sign#FindCurrentSigns(a:buffer) let [l:is_dummy_sign_set, l:current_sign_list] =
" Get a mapping from sign IDs to current loclist items which have them. \ ale#sign#FindCurrentSigns(a:buffer)
let l:items_by_sign_id = s:GetItemsWithSignIDs(a:buffer, a:loclist)
" Use sign information to update the line numbers for the loclist items. " Update the line numbers for items from before which may have moved.
call s:UpdateLineNumbers(l:current_sign_list, l:items_by_sign_id) call s:UpdateLineNumbers(a:buffer, l:current_sign_list, a:loclist)
" Sort items again, as the line numbers could have changed.
call sort(a:loclist, 'ale#util#LocItemCompare')
" Group items after updating the line numbers.
let l:grouped_items = s:GroupLoclistItems(a:buffer, a:loclist) let l:grouped_items = s:GroupLoclistItems(a:buffer, a:loclist)
" Set the dummy sign if we need to. " Build a map of current and new signs, with the lines as the keys.
" This keeps the sign gutter open while we remove things, etc. let l:sign_map = s:BuildSignMap(l:current_sign_list, l:grouped_items)
let l:is_dummy_sign_set = s:SetDummySignIfNeeded(
let l:command_list = ale#sign#GetSignCommands(
\ a:buffer, \ a:buffer,
\ l:current_sign_list, \ l:is_dummy_sign_set,
\ !empty(l:grouped_items), \ l:sign_map,
\) \)
" Now remove the previous signs. The dummy will hold the column open for l:command in l:command_list
" while we add the new signs, if we had signs before. silent! execute l:command
for [l:line, l:sign_id, l:name] in l:current_sign_list
if l:sign_id != g:ale_sign_offset
\&& !has_key(l:items_by_sign_id, l:sign_id)
execute 'sign unplace ' . l:sign_id . ' buffer=' . a:buffer
endif
endfor endfor
" Compute a sign ID offset so we don't hit the same sign IDs again.
let l:current_sign_offset = max(map(keys(l:items_by_sign_id), 'str2nr(v:val)'))
call s:PlaceNewSigns(a:buffer, l:grouped_items, l:current_sign_offset)
endfunction
function! ale#sign#RemoveDummySignIfNeeded(buffer) abort
if !g:ale_sign_column_always
execute 'sign unplace ' . g:ale_sign_offset . ' buffer=' . a:buffer
endif
endfunction endfunction

View File

@ -1,6 +1,6 @@
Execute (Parsing English signs should work): Execute (Parsing English signs should work):
AssertEqual AssertEqual
\ [[9, 1000001, 'ALEWarningSign']], \ [0, [[9, 1000001, 'ALEWarningSign']]],
\ ale#sign#ParseSigns([ \ ale#sign#ParseSigns([
\ 'Signs for app.js:', \ 'Signs for app.js:',
\ ' line=9 id=1000001 name=ALEWarningSign', \ ' line=9 id=1000001 name=ALEWarningSign',
@ -8,20 +8,28 @@ Execute (Parsing English signs should work):
Execute (Parsing Russian signs should work): Execute (Parsing Russian signs should work):
AssertEqual AssertEqual
\ [[1, 1000001, 'ALEErrorSign']], \ [0, [[1, 1000001, 'ALEErrorSign']]],
\ ale#sign#ParseSigns([' строка=1 id=1000001 имя=ALEErrorSign']) \ ale#sign#ParseSigns([' строка=1 id=1000001 имя=ALEErrorSign'])
Execute (Parsing Japanese signs should work): Execute (Parsing Japanese signs should work):
AssertEqual AssertEqual
\ [[1, 1000001, 'ALEWarningSign']], \ [0, [[1, 1000001, 'ALEWarningSign']]],
\ ale#sign#ParseSigns([' 行=1 識別子=1000001 名前=ALEWarningSign']) \ ale#sign#ParseSigns([' 行=1 識別子=1000001 名前=ALEWarningSign'])
Execute (Parsing Spanish signs should work): Execute (Parsing Spanish signs should work):
AssertEqual AssertEqual
\ [[12, 1000001, 'ALEWarningSign']], \ [0, [[12, 1000001, 'ALEWarningSign']]],
\ ale#sign#ParseSigns([' línea=12 id=1000001 nombre=ALEWarningSign']) \ ale#sign#ParseSigns([' línea=12 id=1000001 nombre=ALEWarningSign'])
Execute (Parsing Italian signs should work): Execute (Parsing Italian signs should work):
AssertEqual AssertEqual
\ [[1, 1000001, 'ALEWarningSign']], \ [0, [[1, 1000001, 'ALEWarningSign']]],
\ ale#sign#ParseSigns([' riga=1 id=1000001, nome=ALEWarningSign']) \ ale#sign#ParseSigns([' riga=1 id=1000001, nome=ALEWarningSign'])
\
Execute (The sign parser should indicate if the dummy sign is set):
AssertEqual
\ [1, [[1, 1000001, 'ALEErrorSign']]],
\ ale#sign#ParseSigns([
\ ' строка=1 id=1000001 имя=ALEErrorSign',
\ ' line=1 id=1000000 name=ALEDummySign',
\ ])

View File

@ -1,4 +1,8 @@
Before: Before:
Save g:ale_set_signs
let g:ale_set_signs = 1
function! GenerateResults(buffer, output) function! GenerateResults(buffer, output)
return [ return [
\ { \ {
@ -65,41 +69,43 @@ Before:
\}) \})
After: After:
Restore
unlet! g:loclist unlet! g:loclist
delfunction GenerateResults delfunction GenerateResults
delfunction ParseSigns delfunction ParseSigns
call ale#linter#Reset() call ale#linter#Reset()
sign unplace * sign unplace *
Execute(ale#sign#GetSignType should return the right sign types): Execute(ale#sign#GetSignName should return the right sign names):
AssertEqual 'ALEErrorSign', ale#sign#GetSignType([{'type': 'E'}]) AssertEqual 'ALEErrorSign', ale#sign#GetSignName([{'type': 'E'}])
AssertEqual 'ALEStyleErrorSign', ale#sign#GetSignType([{'type': 'E', 'sub_type': 'style'}]) AssertEqual 'ALEStyleErrorSign', ale#sign#GetSignName([{'type': 'E', 'sub_type': 'style'}])
AssertEqual 'ALEWarningSign', ale#sign#GetSignType([{'type': 'W'}]) AssertEqual 'ALEWarningSign', ale#sign#GetSignName([{'type': 'W'}])
AssertEqual 'ALEStyleWarningSign', ale#sign#GetSignType([{'type': 'W', 'sub_type': 'style'}]) AssertEqual 'ALEStyleWarningSign', ale#sign#GetSignName([{'type': 'W', 'sub_type': 'style'}])
AssertEqual 'ALEInfoSign', ale#sign#GetSignType([{'type': 'I'}]) AssertEqual 'ALEInfoSign', ale#sign#GetSignName([{'type': 'I'}])
AssertEqual 'ALEErrorSign', ale#sign#GetSignType([ AssertEqual 'ALEErrorSign', ale#sign#GetSignName([
\ {'type': 'E'}, \ {'type': 'E'},
\ {'type': 'W'}, \ {'type': 'W'},
\ {'type': 'I'}, \ {'type': 'I'},
\ {'type': 'E', 'sub_type': 'style'}, \ {'type': 'E', 'sub_type': 'style'},
\ {'type': 'W', 'sub_type': 'style'}, \ {'type': 'W', 'sub_type': 'style'},
\]) \])
AssertEqual 'ALEWarningSign', ale#sign#GetSignType([ AssertEqual 'ALEWarningSign', ale#sign#GetSignName([
\ {'type': 'W'}, \ {'type': 'W'},
\ {'type': 'I'}, \ {'type': 'I'},
\ {'type': 'E', 'sub_type': 'style'}, \ {'type': 'E', 'sub_type': 'style'},
\ {'type': 'W', 'sub_type': 'style'}, \ {'type': 'W', 'sub_type': 'style'},
\]) \])
AssertEqual 'ALEInfoSign', ale#sign#GetSignType([ AssertEqual 'ALEInfoSign', ale#sign#GetSignName([
\ {'type': 'I'}, \ {'type': 'I'},
\ {'type': 'E', 'sub_type': 'style'}, \ {'type': 'E', 'sub_type': 'style'},
\ {'type': 'W', 'sub_type': 'style'}, \ {'type': 'W', 'sub_type': 'style'},
\]) \])
AssertEqual 'ALEStyleErrorSign', ale#sign#GetSignType([ AssertEqual 'ALEStyleErrorSign', ale#sign#GetSignName([
\ {'type': 'E', 'sub_type': 'style'}, \ {'type': 'E', 'sub_type': 'style'},
\ {'type': 'W', 'sub_type': 'style'}, \ {'type': 'W', 'sub_type': 'style'},
\]) \])
AssertEqual 'ALEStyleWarningSign', ale#sign#GetSignType([ AssertEqual 'ALEStyleWarningSign', ale#sign#GetSignName([
\ {'type': 'W', 'sub_type': 'style'}, \ {'type': 'W', 'sub_type': 'style'},
\]) \])
@ -125,9 +131,9 @@ Execute(The current signs should be set for running a job):
\ ParseSigns() \ ParseSigns()
Execute(Loclist items with sign_id values should be kept): Execute(Loclist items with sign_id values should be kept):
exec 'sign place 1000347 line=3 name=ALEErrorSign buffer=' . bufnr('%') exec 'sign place 1000347 line=3 name=ALEErrorSign buffer=' . bufnr('')
exec 'sign place 1000348 line=15 name=ALEErrorSign buffer=' . bufnr('%') exec 'sign place 1000348 line=15 name=ALEErrorSign buffer=' . bufnr('')
exec 'sign place 1000349 line=16 name=ALEWarningSign buffer=' . bufnr('%') exec 'sign place 1000349 line=16 name=ALEWarningSign buffer=' . bufnr('')
let g:loclist = [ let g:loclist = [
\ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'E', 'text': 'a', 'sign_id': 1000348}, \ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'E', 'text': 'a', 'sign_id': 1000348},
@ -138,8 +144,7 @@ Execute(Loclist items with sign_id values should be kept):
\ {'bufnr': bufnr(''), 'lnum': 16, 'col': 2, 'type': 'E', 'text': 'f'}, \ {'bufnr': bufnr(''), 'lnum': 16, 'col': 2, 'type': 'E', 'text': 'f'},
\] \]
call ale#sign#SetSigns(bufnr('%'), g:loclist) call ale#sign#SetSigns(bufnr(''), g:loclist)
call ale#sign#RemoveDummySignIfNeeded(bufnr('%'))
" Sign IDs from before should be kept, and new signs should use " Sign IDs from before should be kept, and new signs should use
" IDs that haven't been used yet. " IDs that haven't been used yet.
@ -147,10 +152,10 @@ Execute(Loclist items with sign_id values should be kept):
\ [ \ [
\ {'bufnr': bufnr(''), 'lnum': 3, 'col': 1, 'type': 'E', 'text': 'c', 'sign_id': 1000347}, \ {'bufnr': bufnr(''), 'lnum': 3, 'col': 1, 'type': 'E', 'text': 'c', 'sign_id': 1000347},
\ {'bufnr': bufnr(''), 'lnum': 4, 'col': 1, 'type': 'W', 'text': 'd', 'sign_id': 1000350}, \ {'bufnr': bufnr(''), 'lnum': 4, 'col': 1, 'type': 'W', 'text': 'd', 'sign_id': 1000350},
\ {'bufnr': bufnr(''), 'lnum': 15, 'col': 1, 'type': 'E', 'text': 'a', 'sign_id': 1000351}, \ {'bufnr': bufnr(''), 'lnum': 15, 'col': 1, 'type': 'E', 'text': 'a', 'sign_id': 1000348},
\ {'bufnr': bufnr(''), 'lnum': 15, 'col': 2, 'type': 'W', 'text': 'e', 'sign_id': 1000351}, \ {'bufnr': bufnr(''), 'lnum': 15, 'col': 2, 'type': 'W', 'text': 'e', 'sign_id': 1000348},
\ {'bufnr': bufnr(''), 'lnum': 16, 'col': 1, 'type': 'W', 'text': 'b', 'sign_id': 1000352}, \ {'bufnr': bufnr(''), 'lnum': 16, 'col': 1, 'type': 'W', 'text': 'b', 'sign_id': 1000351},
\ {'bufnr': bufnr(''), 'lnum': 16, 'col': 2, 'type': 'E', 'text': 'f', 'sign_id': 1000352}, \ {'bufnr': bufnr(''), 'lnum': 16, 'col': 2, 'type': 'E', 'text': 'f', 'sign_id': 1000351},
\ ], \ ],
\ g:loclist \ g:loclist
@ -160,9 +165,7 @@ Execute(Loclist items with sign_id values should be kept):
AssertEqual AssertEqual
\ [ \ [
\ ['15', '1000348', 'ALEErrorSign'], \ ['15', '1000348', 'ALEErrorSign'],
\ ['15', '1000351', 'ALEErrorSign'], \ ['16', '1000351', 'ALEErrorSign'],
\ ['16', '1000349', 'ALEWarningSign'],
\ ['16', '1000352', 'ALEErrorSign'],
\ ['3', '1000347', 'ALEErrorSign'], \ ['3', '1000347', 'ALEErrorSign'],
\ ['4', '1000350', 'ALEWarningSign'], \ ['4', '1000350', 'ALEWarningSign'],
\ ], \ ],
@ -182,7 +185,6 @@ Execute(Items for other buffers should be ignored):
\] \]
call ale#sign#SetSigns(bufnr(''), g:loclist) call ale#sign#SetSigns(bufnr(''), g:loclist)
call ale#sign#RemoveDummySignIfNeeded(bufnr(''))
AssertEqual AssertEqual
\ [ \ [
@ -195,5 +197,72 @@ Execute(Items for other buffers should be ignored):
\ ], \ ],
\ sort(ParseSigns()) \ sort(ParseSigns())
Execute(No excpetions should be thrown when setting signs for invalid buffers): Execute(Signs should be downgraded correctly):
call ale#sign#SetSigns(bufnr(''), [
\ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'E', 'text': 'x'},
\ {'bufnr': bufnr(''), 'lnum': 2, 'col': 1, 'type': 'W', 'text': 'x'},
\])
AssertEqual
\ [
\ ['1', '1000001', 'ALEErrorSign'],
\ ['2', '1000002', 'ALEWarningSign'],
\ ],
\ sort(ParseSigns())
call ale#sign#SetSigns(bufnr(''), [
\ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'W', 'text': 'x'},
\ {'bufnr': bufnr(''), 'lnum': 2, 'col': 1, 'type': 'I', 'text': 'x'},
\])
AssertEqual
\ [
\ ['1', '1000003', 'ALEWarningSign'],
\ ['2', '1000004', 'ALEInfoSign'],
\ ],
\ sort(ParseSigns())
Execute(Signs should be upgraded correctly):
call ale#sign#SetSigns(bufnr(''), [
\ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'W', 'text': 'x'},
\ {'bufnr': bufnr(''), 'lnum': 2, 'col': 1, 'type': 'I', 'text': 'x'},
\])
AssertEqual
\ [
\ ['1', '1000001', 'ALEWarningSign'],
\ ['2', '1000002', 'ALEInfoSign'],
\ ],
\ sort(ParseSigns())
call ale#sign#SetSigns(bufnr(''), [
\ {'bufnr': bufnr(''), 'lnum': 1, 'col': 1, 'type': 'E', 'text': 'x'},
\ {'bufnr': bufnr(''), 'lnum': 2, 'col': 1, 'type': 'W', 'text': 'x'},
\])
AssertEqual
\ [
\ ['1', '1000003', 'ALEErrorSign'],
\ ['2', '1000004', 'ALEWarningSign'],
\ ],
\ sort(ParseSigns())
Execute(It should be possible to clear signs with empty lists):
let g:loclist = [
\ {'bufnr': bufnr(''), 'lnum': 16, 'col': 2, 'type': 'E', 'text': 'f'},
\]
call ale#sign#SetSigns(bufnr(''), g:loclist)
AssertEqual
\ [
\ ['16', '1000001', 'ALEErrorSign'],
\ ],
\ sort(ParseSigns())
call ale#sign#SetSigns(bufnr(''), [])
AssertEqual [], ParseSigns()
Execute(No exceptions should be thrown when setting signs for invalid buffers):
call ale#sign#SetSigns(123456789, [{'lnum': 15, 'col': 2, 'type': 'W', 'text': 'e'}]) call ale#sign#SetSigns(123456789, [{'lnum': 15, 'col': 2, 'type': 'W', 'text': 'e'}])

View File

@ -1,5 +1,10 @@
Before: Before:
Save g:ale_buffer_info Save g:ale_buffer_info
Save g:ale_set_signs
Save g:ale_set_lists_synchronously
let g:ale_set_signs = 1
let g:ale_set_lists_synchronously = 1
let g:ale_buffer_info = {} let g:ale_buffer_info = {}
let g:expected_loclist = [{ let g:expected_loclist = [{
@ -67,6 +72,8 @@ Before:
\ 'read_buffer': 0, \ 'read_buffer': 0,
\}) \})
sign unplace *
After: After:
Restore Restore
@ -96,7 +103,7 @@ Execute(ALEToggle should reset everything and then run again):
" First check that everything is there... " First check that everything is there...
AssertEqual g:expected_loclist, getloclist(0) AssertEqual g:expected_loclist, getloclist(0)
AssertEqual [[2, 1000001, 'ALEErrorSign']], ale#sign#FindCurrentSigns(bufnr('%')) AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%'))
AssertEqual AssertEqual
\ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}],
\ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}')
@ -109,7 +116,7 @@ Execute(ALEToggle should reset everything and then run again):
" Everything should be cleared. " Everything should be cleared.
Assert !has_key(g:ale_buffer_info, bufnr('')), 'The g:ale_buffer_info Dictionary was not removed' Assert !has_key(g:ale_buffer_info, bufnr('')), 'The g:ale_buffer_info Dictionary was not removed'
AssertEqual [], getloclist(0), 'The loclist was not cleared' AssertEqual [], getloclist(0), 'The loclist was not cleared'
AssertEqual [], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared' AssertEqual [0, []], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared'
AssertEqual [], getmatches(), 'The highlights were not cleared' AssertEqual [], getmatches(), 'The highlights were not cleared'
AssertEqual ['ALECleanupGroup', 'ALEHighlightBufferGroup'], ParseAuGroups() AssertEqual ['ALECleanupGroup', 'ALEHighlightBufferGroup'], ParseAuGroups()
@ -118,7 +125,7 @@ Execute(ALEToggle should reset everything and then run again):
call ale#engine#WaitForJobs(2000) call ale#engine#WaitForJobs(2000)
AssertEqual g:expected_loclist, getloclist(0) AssertEqual g:expected_loclist, getloclist(0)
AssertEqual [[2, 1000001, 'ALEErrorSign']], ale#sign#FindCurrentSigns(bufnr('%')) AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%'))
AssertEqual AssertEqual
\ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}],
\ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}')

View File

@ -1,4 +1,7 @@
Before: Before:
Save g:ale_set_signs
let g:ale_set_signs = 1
let g:expected_data = [ let g:expected_data = [
\ { \ {
\ 'lnum': 1, \ 'lnum': 1,
@ -49,7 +52,11 @@ Before:
\ 'read_buffer': 0, \ 'read_buffer': 0,
\}) \})
sign unplace *
After: After:
Restore
delfunction TestCallback delfunction TestCallback
unlet! g:expected_data unlet! g:expected_data