#1095 Apply all patterns for g:ale_pattern_options, instead of just the first match

This commit is contained in:
w0rp 2017-11-11 13:44:05 +00:00
parent 6c60ca24c1
commit 8cd1ccff84
5 changed files with 111 additions and 43 deletions

View File

@ -1,22 +1,34 @@
" Author: w0rp <devw0rp@gmail.com> " Author: w0rp <devw0rp@gmail.com>
" Description: Set options in files based on regex patterns. " Description: Set options in files based on regex patterns.
function! ale#pattern_options#SetOptions() abort function! s:CmpPatterns(left_item, right_item) abort
let l:filename = expand('%:p') " no-custom-checks if a:left_item[0] < a:right_item[0]
let l:options = {} return -1
endif
for l:pattern in keys(g:ale_pattern_options) if a:left_item[0] > a:right_item[0]
return 1
endif
return 0
endfunction
function! ale#pattern_options#SetOptions(buffer) abort
if !g:ale_pattern_options_enabled || empty(g:ale_pattern_options)
return
endif
let l:filename = expand('#' . a:buffer . ':p')
" The patterns are sorted, so they are applied consistently.
for [l:pattern, l:options] in sort(
\ items(g:ale_pattern_options),
\ function('s:CmpPatterns')
\)
if match(l:filename, l:pattern) >= 0 if match(l:filename, l:pattern) >= 0
let l:options = g:ale_pattern_options[l:pattern] for [l:key, l:value] in items(l:options)
break call setbufvar(a:buffer, l:key, l:value)
endif endfor
endfor
for l:key in keys(l:options)
if l:key[:0] is# '&'
call setbufvar(bufnr(''), l:key, l:options[l:key])
else
let b:[l:key] = l:options[l:key]
endif endif
endfor endfor
endfunction endfunction

View File

@ -4,9 +4,7 @@ function! ale#toggle#InitAuGroups() abort
augroup ALEPatternOptionsGroup augroup ALEPatternOptionsGroup
autocmd! autocmd!
if g:ale_enabled && g:ale_pattern_options_enabled autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions(str2nr(expand('<abuf>')))
autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions()
endif
augroup END augroup END
augroup ALERunOnTextChangedGroup augroup ALERunOnTextChangedGroup
@ -71,7 +69,6 @@ function! ale#toggle#InitAuGroups() abort
augroup END augroup END
if !g:ale_enabled if !g:ale_enabled
augroup! ALEPatternOptionsGroup
augroup! ALERunOnTextChangedGroup augroup! ALERunOnTextChangedGroup
augroup! ALERunOnEnterGroup augroup! ALERunOnEnterGroup
augroup! ALERunOnInsertLeave augroup! ALERunOnInsertLeave

View File

@ -1009,11 +1009,14 @@ g:ale_pattern_options *g:ale_pattern_options*
only `eslint` for checking those files by setting `b:ale_linters`. only `eslint` for checking those files by setting `b:ale_linters`.
Filenames are matched with |match()|, and patterns depend on the |magic| Filenames are matched with |match()|, and patterns depend on the |magic|
setting, unless prefixed with the special escape sequences like `'\v'`, etc. setting, unless prefixed with the special escape sequences like `'\v'`,
etc.The patterns can match any part of a filename. The absolute path of the
The patterns can match any part of a filename. The absolute path of the
filename will be used for matching, taken from `expand('%:p')`. filename will be used for matching, taken from `expand('%:p')`.
The options for every match for the filename will be applied, with the
pattern keys sorted in alphabetical order. Options for `'zebra'` will
override the options for `'alpha'` for a filename `alpha-zebra`.
g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
@ -1021,8 +1024,9 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
Default: `!empty(g:ale_pattern_options)` Default: `!empty(g:ale_pattern_options)`
This option can be used for turning the behaviour of setting This option can be used for turning the behaviour of setting
|g:ale_pattern_options| on or off. By default, setting a single key |g:ale_pattern_options| on or off. By default, setting a single key for
for |g:ale_pattern_options| will turn this option on. |g:ale_pattern_options| will turn this option on, as long as the setting is
configured before ALE is loaded.
g:ale_set_balloons *g:ale_set_balloons* g:ale_set_balloons *g:ale_set_balloons*

View File

@ -108,17 +108,28 @@ Execute (g:ale_lint_on_insert_leave = 0 should bind no events):
AssertEqual [], CheckAutocmd('ALERunOnInsertLeave') AssertEqual [], CheckAutocmd('ALERunOnInsertLeave')
Execute (g:ale_pattern_options_enabled = 0 should bind no events):
let g:ale_pattern_options_enabled = 0
AssertEqual [], CheckAutocmd('ALEPatternOptionsGroup')
Execute (g:ale_pattern_options_enabled = 1 should bind BufReadPost and BufEnter): Execute (g:ale_pattern_options_enabled = 1 should bind BufReadPost and BufEnter):
let g:ale_pattern_options_enabled = 1 let g:ale_pattern_options_enabled = 1
AssertEqual [ AssertEqual [
\ 'BufEnter * call ale#pattern_options#SetOptions()', \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\ 'BufReadPost * call ale#pattern_options#SetOptions()', \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\], CheckAutocmd('ALEPatternOptionsGroup')
Execute (g:ale_pattern_options_enabled = 0 should still bind events):
let g:ale_pattern_options_enabled = 0
AssertEqual [
\ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\], CheckAutocmd('ALEPatternOptionsGroup')
Execute (g:ale_enabled = 0 should still bind pattern events):
let g:ale_enabled = 0
AssertEqual [
\ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand(''<abuf>'')))',
\], CheckAutocmd('ALEPatternOptionsGroup') \], CheckAutocmd('ALEPatternOptionsGroup')
Execute (g:ale_lint_on_enter = 0 should bind only the BufEnter event): Execute (g:ale_lint_on_enter = 0 should bind only the BufEnter event):

View File

@ -3,30 +3,74 @@ Before:
Save g:ale_pattern_options_enabled Save g:ale_pattern_options_enabled
Save &filetype Save &filetype
let g:ale_pattern_options_enabled = 1
let g:ale_pattern_options = {}
let b:ale_enabled = 0
let b:some_option = 0
call ale#test#SetDirectory('/testplugin/test')
After: After:
Restore Restore
unlet! b:ale_enabled unlet! b:ale_enabled
unlet! b:some_option unlet! b:some_option
call ale#test#RestoreDirectory()
Execute(The pattern options function should work when there are no patterns):
call ale#test#SetFilename('foobar.js')
call ale#pattern_options#SetOptions(bufnr(''))
Execute(Buffer variables should be set when filename patterns match): Execute(Buffer variables should be set when filename patterns match):
let g:ale_pattern_options = {'baz.*\.js': { let g:ale_pattern_options = {
\ 'ale_enabled': 1, \ 'baz.*\.js': {
\ 'some_option': 347, \ 'ale_enabled': 1,
\ '&filetype': 'pattern_option_set_filetype', \ 'some_option': 347,
\}} \ '&filetype': 'pattern_option_set_filetype',
\ },
\}
silent! file foobar.js call ale#test#SetFilename('foobar.js')
call ale#pattern_options#SetOptions(bufnr(''))
call ale#pattern_options#SetOptions() AssertEqual 0, b:ale_enabled
AssertEqual 0, b:some_option
Assert !exists('b:ale_enabled') call ale#test#SetFilename('bazboz.js')
Assert !exists('b:some_option') call ale#pattern_options#SetOptions(bufnr(''))
silent! file bazboz.js
call ale#pattern_options#SetOptions()
AssertEqual 1, b:ale_enabled AssertEqual 1, b:ale_enabled
AssertEqual 347, b:some_option AssertEqual 347, b:some_option
AssertEqual 'pattern_option_set_filetype', &filetype AssertEqual 'pattern_option_set_filetype', &filetype
Execute(Multiple pattern matches should be applied):
let g:ale_pattern_options = {
\ 'foo': {
\ 'some_option': 666,
\ },
\ 'bar': {
\ 'ale_enabled': 1,
\ 'some_option': 123,
\ },
\ 'notmatched': {
\ 'some_option': 489,
\ 'ale_enabled': 0,
\ },
\}
call ale#test#SetFilename('foobar.js')
call ale#pattern_options#SetOptions(bufnr(''))
AssertEqual 1, b:ale_enabled
AssertEqual 666, b:some_option
Execute(Patterns should not be applied when the setting is disabled):
let g:ale_pattern_options_enabled = 0
let g:ale_pattern_options = {'foo': {'some_option': 666}}
call ale#test#SetFilename('foobar.js')
call ale#pattern_options#SetOptions(bufnr(''))
AssertEqual 0, b:some_option