mirror of
https://github.com/VectorKappa/dotfiles.git
synced 2025-12-19 16:26:10 +01:00
Change pathogen to vim-plug
This commit is contained in:
@@ -1,347 +0,0 @@
|
|||||||
" pathogen.vim - path option manipulation
|
|
||||||
" Maintainer: Tim Pope <http://tpo.pe/>
|
|
||||||
" Version: 2.3
|
|
||||||
|
|
||||||
" Install in ~/.vim/autoload (or ~\vimfiles\autoload).
|
|
||||||
"
|
|
||||||
" For management of individually installed plugins in ~/.vim/bundle (or
|
|
||||||
" ~\vimfiles\bundle), adding `execute pathogen#infect()` to the top of your
|
|
||||||
" .vimrc is the only other setup necessary.
|
|
||||||
"
|
|
||||||
" The API is documented inline below.
|
|
||||||
|
|
||||||
if exists("g:loaded_pathogen") || &cp
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
let g:loaded_pathogen = 1
|
|
||||||
|
|
||||||
" Point of entry for basic default usage. Give a relative path to invoke
|
|
||||||
" pathogen#interpose() (defaults to "bundle/{}"), or an absolute path to invoke
|
|
||||||
" pathogen#surround(). Curly braces are expanded with pathogen#expand():
|
|
||||||
" "bundle/{}" finds all subdirectories inside "bundle" inside all directories
|
|
||||||
" in the runtime path.
|
|
||||||
function! pathogen#infect(...) abort
|
|
||||||
for path in a:0 ? filter(reverse(copy(a:000)), 'type(v:val) == type("")') : ['bundle/{}']
|
|
||||||
if path =~# '^\%({\=[$~\\/]\|{\=\w:[\\/]\).*[{}*]'
|
|
||||||
call pathogen#surround(path)
|
|
||||||
elseif path =~# '^\%([$~\\/]\|\w:[\\/]\)'
|
|
||||||
call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
|
|
||||||
call pathogen#surround(path . '/{}')
|
|
||||||
elseif path =~# '[{}*]'
|
|
||||||
call pathogen#interpose(path)
|
|
||||||
else
|
|
||||||
call s:warn('Change pathogen#infect('.string(path).') to pathogen#infect('.string(path.'/{}').')')
|
|
||||||
call pathogen#interpose(path . '/{}')
|
|
||||||
endif
|
|
||||||
endfor
|
|
||||||
call pathogen#cycle_filetype()
|
|
||||||
if pathogen#is_disabled($MYVIMRC)
|
|
||||||
return 'finish'
|
|
||||||
endif
|
|
||||||
return ''
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Split a path into a list.
|
|
||||||
function! pathogen#split(path) abort
|
|
||||||
if type(a:path) == type([]) | return a:path | endif
|
|
||||||
if empty(a:path) | return [] | endif
|
|
||||||
let split = split(a:path,'\\\@<!\%(\\\\\)*\zs,')
|
|
||||||
return map(split,'substitute(v:val,''\\\([\\,]\)'',''\1'',"g")')
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Convert a list to a path.
|
|
||||||
function! pathogen#join(...) abort
|
|
||||||
if type(a:1) == type(1) && a:1
|
|
||||||
let i = 1
|
|
||||||
let space = ' '
|
|
||||||
else
|
|
||||||
let i = 0
|
|
||||||
let space = ''
|
|
||||||
endif
|
|
||||||
let path = ""
|
|
||||||
while i < a:0
|
|
||||||
if type(a:000[i]) == type([])
|
|
||||||
let list = a:000[i]
|
|
||||||
let j = 0
|
|
||||||
while j < len(list)
|
|
||||||
let escaped = substitute(list[j],'[,'.space.']\|\\[\,'.space.']\@=','\\&','g')
|
|
||||||
let path .= ',' . escaped
|
|
||||||
let j += 1
|
|
||||||
endwhile
|
|
||||||
else
|
|
||||||
let path .= "," . a:000[i]
|
|
||||||
endif
|
|
||||||
let i += 1
|
|
||||||
endwhile
|
|
||||||
return substitute(path,'^,','','')
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Convert a list to a path with escaped spaces for 'path', 'tag', etc.
|
|
||||||
function! pathogen#legacyjoin(...) abort
|
|
||||||
return call('pathogen#join',[1] + a:000)
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Turn filetype detection off and back on again if it was already enabled.
|
|
||||||
function! pathogen#cycle_filetype() abort
|
|
||||||
if exists('g:did_load_filetypes')
|
|
||||||
filetype off
|
|
||||||
filetype on
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Check if a bundle is disabled. A bundle is considered disabled if its
|
|
||||||
" basename or full name is included in the list g:pathogen_disabled.
|
|
||||||
function! pathogen#is_disabled(path) abort
|
|
||||||
if a:path =~# '\~$'
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
let sep = pathogen#slash()
|
|
||||||
let blacklist = map(
|
|
||||||
\ get(g:, 'pathogen_blacklist', get(g:, 'pathogen_disabled', [])) +
|
|
||||||
\ pathogen#split($VIMBLACKLIST),
|
|
||||||
\ 'substitute(v:val, "[\\/]$", "", "")')
|
|
||||||
return index(blacklist, fnamemodify(a:path, ':t')) != -1 || index(blacklist, a:path) != -1
|
|
||||||
endfunction "}}}1
|
|
||||||
|
|
||||||
" Prepend the given directory to the runtime path and append its corresponding
|
|
||||||
" after directory. Curly braces are expanded with pathogen#expand().
|
|
||||||
function! pathogen#surround(path) abort
|
|
||||||
let sep = pathogen#slash()
|
|
||||||
let rtp = pathogen#split(&rtp)
|
|
||||||
let path = fnamemodify(a:path, ':p:?[\\/]\=$??')
|
|
||||||
let before = filter(pathogen#expand(path), '!pathogen#is_disabled(v:val)')
|
|
||||||
let after = filter(reverse(pathogen#expand(path.sep.'after')), '!pathogen#is_disabled(v:val[0:-7])')
|
|
||||||
call filter(rtp, 'index(before + after, v:val) == -1')
|
|
||||||
let &rtp = pathogen#join(before, rtp, after)
|
|
||||||
return &rtp
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" For each directory in the runtime path, add a second entry with the given
|
|
||||||
" argument appended. Curly braces are expanded with pathogen#expand().
|
|
||||||
function! pathogen#interpose(name) abort
|
|
||||||
let sep = pathogen#slash()
|
|
||||||
let name = a:name
|
|
||||||
if has_key(s:done_bundles, name)
|
|
||||||
return ""
|
|
||||||
endif
|
|
||||||
let s:done_bundles[name] = 1
|
|
||||||
let list = []
|
|
||||||
for dir in pathogen#split(&rtp)
|
|
||||||
if dir =~# '\<after$'
|
|
||||||
let list += reverse(filter(pathogen#expand(dir[0:-6].name.sep.'after'), '!pathogen#is_disabled(v:val[0:-7])')) + [dir]
|
|
||||||
else
|
|
||||||
let list += [dir] + filter(pathogen#expand(dir.sep.name), '!pathogen#is_disabled(v:val)')
|
|
||||||
endif
|
|
||||||
endfor
|
|
||||||
let &rtp = pathogen#join(pathogen#uniq(list))
|
|
||||||
return 1
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
let s:done_bundles = {}
|
|
||||||
|
|
||||||
" Invoke :helptags on all non-$VIM doc directories in runtimepath.
|
|
||||||
function! pathogen#helptags() abort
|
|
||||||
let sep = pathogen#slash()
|
|
||||||
for glob in pathogen#split(&rtp)
|
|
||||||
for dir in map(split(glob(glob), "\n"), 'v:val.sep."/doc/".sep')
|
|
||||||
if (dir)[0 : strlen($VIMRUNTIME)] !=# $VIMRUNTIME.sep && filewritable(dir) == 2 && !empty(split(glob(dir.'*.txt'))) && (!filereadable(dir.'tags') || filewritable(dir.'tags'))
|
|
||||||
silent! execute 'helptags' pathogen#fnameescape(dir)
|
|
||||||
endif
|
|
||||||
endfor
|
|
||||||
endfor
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
command! -bar Helptags :call pathogen#helptags()
|
|
||||||
|
|
||||||
" Execute the given command. This is basically a backdoor for --remote-expr.
|
|
||||||
function! pathogen#execute(...) abort
|
|
||||||
for command in a:000
|
|
||||||
execute command
|
|
||||||
endfor
|
|
||||||
return ''
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Section: Unofficial
|
|
||||||
|
|
||||||
function! pathogen#is_absolute(path) abort
|
|
||||||
return a:path =~# (has('win32') ? '^\%([\\/]\|\w:\)[\\/]\|^[~$]' : '^[/~$]')
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Given a string, returns all possible permutations of comma delimited braced
|
|
||||||
" alternatives of that string. pathogen#expand('/{a,b}/{c,d}') yields
|
|
||||||
" ['/a/c', '/a/d', '/b/c', '/b/d']. Empty braces are treated as a wildcard
|
|
||||||
" and globbed. Actual globs are preserved.
|
|
||||||
function! pathogen#expand(pattern) abort
|
|
||||||
if a:pattern =~# '{[^{}]\+}'
|
|
||||||
let [pre, pat, post] = split(substitute(a:pattern, '\(.\{-\}\){\([^{}]\+\)}\(.*\)', "\\1\001\\2\001\\3", ''), "\001", 1)
|
|
||||||
let found = map(split(pat, ',', 1), 'pre.v:val.post')
|
|
||||||
let results = []
|
|
||||||
for pattern in found
|
|
||||||
call extend(results, pathogen#expand(pattern))
|
|
||||||
endfor
|
|
||||||
return results
|
|
||||||
elseif a:pattern =~# '{}'
|
|
||||||
let pat = matchstr(a:pattern, '^.*{}[^*]*\%($\|[\\/]\)')
|
|
||||||
let post = a:pattern[strlen(pat) : -1]
|
|
||||||
return map(split(glob(substitute(pat, '{}', '*', 'g')), "\n"), 'v:val.post')
|
|
||||||
else
|
|
||||||
return [a:pattern]
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" \ on Windows unless shellslash is set, / everywhere else.
|
|
||||||
function! pathogen#slash() abort
|
|
||||||
return !exists("+shellslash") || &shellslash ? '/' : '\'
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! pathogen#separator() abort
|
|
||||||
return pathogen#slash()
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Convenience wrapper around glob() which returns a list.
|
|
||||||
function! pathogen#glob(pattern) abort
|
|
||||||
let files = split(glob(a:pattern),"\n")
|
|
||||||
return map(files,'substitute(v:val,"[".pathogen#slash()."/]$","","")')
|
|
||||||
endfunction "}}}1
|
|
||||||
|
|
||||||
" Like pathogen#glob(), only limit the results to directories.
|
|
||||||
function! pathogen#glob_directories(pattern) abort
|
|
||||||
return filter(pathogen#glob(a:pattern),'isdirectory(v:val)')
|
|
||||||
endfunction "}}}1
|
|
||||||
|
|
||||||
" Remove duplicates from a list.
|
|
||||||
function! pathogen#uniq(list) abort
|
|
||||||
let i = 0
|
|
||||||
let seen = {}
|
|
||||||
while i < len(a:list)
|
|
||||||
if (a:list[i] ==# '' && exists('empty')) || has_key(seen,a:list[i])
|
|
||||||
call remove(a:list,i)
|
|
||||||
elseif a:list[i] ==# ''
|
|
||||||
let i += 1
|
|
||||||
let empty = 1
|
|
||||||
else
|
|
||||||
let seen[a:list[i]] = 1
|
|
||||||
let i += 1
|
|
||||||
endif
|
|
||||||
endwhile
|
|
||||||
return a:list
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Backport of fnameescape().
|
|
||||||
function! pathogen#fnameescape(string) abort
|
|
||||||
if exists('*fnameescape')
|
|
||||||
return fnameescape(a:string)
|
|
||||||
elseif a:string ==# '-'
|
|
||||||
return '\-'
|
|
||||||
else
|
|
||||||
return substitute(escape(a:string," \t\n*?[{`$\\%#'\"|!<"),'^[+>]','\\&','')
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Like findfile(), but hardcoded to use the runtimepath.
|
|
||||||
function! pathogen#runtime_findfile(file,count) abort "{{{1
|
|
||||||
let rtp = pathogen#join(1,pathogen#split(&rtp))
|
|
||||||
let file = findfile(a:file,rtp,a:count)
|
|
||||||
if file ==# ''
|
|
||||||
return ''
|
|
||||||
else
|
|
||||||
return fnamemodify(file,':p')
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Section: Deprecated
|
|
||||||
|
|
||||||
function! s:warn(msg) abort
|
|
||||||
echohl WarningMsg
|
|
||||||
echomsg a:msg
|
|
||||||
echohl NONE
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Prepend all subdirectories of path to the rtp, and append all 'after'
|
|
||||||
" directories in those subdirectories. Deprecated.
|
|
||||||
function! pathogen#runtime_prepend_subdirectories(path) abort
|
|
||||||
call s:warn('Change pathogen#runtime_prepend_subdirectories('.string(a:path).') to pathogen#infect('.string(a:path.'/{}').')')
|
|
||||||
return pathogen#surround(a:path . pathogen#slash() . '{}')
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! pathogen#incubate(...) abort
|
|
||||||
let name = a:0 ? a:1 : 'bundle/{}'
|
|
||||||
call s:warn('Change pathogen#incubate('.(a:0 ? string(a:1) : '').') to pathogen#infect('.string(name).')')
|
|
||||||
return pathogen#interpose(name)
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Deprecated alias for pathogen#interpose().
|
|
||||||
function! pathogen#runtime_append_all_bundles(...) abort
|
|
||||||
if a:0
|
|
||||||
call s:warn('Change pathogen#runtime_append_all_bundles('.string(a:1).') to pathogen#infect('.string(a:1.'/{}').')')
|
|
||||||
else
|
|
||||||
call s:warn('Change pathogen#runtime_append_all_bundles() to pathogen#infect()')
|
|
||||||
endif
|
|
||||||
return pathogen#interpose(a:0 ? a:1 . '/{}' : 'bundle/{}')
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
if exists(':Vedit')
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
|
|
||||||
let s:vopen_warning = 0
|
|
||||||
|
|
||||||
function! s:find(count,cmd,file,lcd)
|
|
||||||
let rtp = pathogen#join(1,pathogen#split(&runtimepath))
|
|
||||||
let file = pathogen#runtime_findfile(a:file,a:count)
|
|
||||||
if file ==# ''
|
|
||||||
return "echoerr 'E345: Can''t find file \"".a:file."\" in runtimepath'"
|
|
||||||
endif
|
|
||||||
if !s:vopen_warning
|
|
||||||
let s:vopen_warning = 1
|
|
||||||
let warning = '|echohl WarningMsg|echo "Install scriptease.vim to continue using :V'.a:cmd.'"|echohl NONE'
|
|
||||||
else
|
|
||||||
let warning = ''
|
|
||||||
endif
|
|
||||||
if a:lcd
|
|
||||||
let path = file[0:-strlen(a:file)-2]
|
|
||||||
execute 'lcd `=path`'
|
|
||||||
return a:cmd.' '.pathogen#fnameescape(a:file) . warning
|
|
||||||
else
|
|
||||||
return a:cmd.' '.pathogen#fnameescape(file) . warning
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! s:Findcomplete(A,L,P)
|
|
||||||
let sep = pathogen#slash()
|
|
||||||
let cheats = {
|
|
||||||
\'a': 'autoload',
|
|
||||||
\'d': 'doc',
|
|
||||||
\'f': 'ftplugin',
|
|
||||||
\'i': 'indent',
|
|
||||||
\'p': 'plugin',
|
|
||||||
\'s': 'syntax'}
|
|
||||||
if a:A =~# '^\w[\\/]' && has_key(cheats,a:A[0])
|
|
||||||
let request = cheats[a:A[0]].a:A[1:-1]
|
|
||||||
else
|
|
||||||
let request = a:A
|
|
||||||
endif
|
|
||||||
let pattern = substitute(request,'/\|\'.sep,'*'.sep,'g').'*'
|
|
||||||
let found = {}
|
|
||||||
for path in pathogen#split(&runtimepath)
|
|
||||||
let path = expand(path, ':p')
|
|
||||||
let matches = split(glob(path.sep.pattern),"\n")
|
|
||||||
call map(matches,'isdirectory(v:val) ? v:val.sep : v:val')
|
|
||||||
call map(matches,'expand(v:val, ":p")[strlen(path)+1:-1]')
|
|
||||||
for match in matches
|
|
||||||
let found[match] = 1
|
|
||||||
endfor
|
|
||||||
endfor
|
|
||||||
return sort(keys(found))
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Ve :execute s:find(<count>,'edit<bang>',<q-args>,0)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vedit :execute s:find(<count>,'edit<bang>',<q-args>,0)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vopen :execute s:find(<count>,'edit<bang>',<q-args>,1)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vsplit :execute s:find(<count>,'split',<q-args>,<bang>1)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vvsplit :execute s:find(<count>,'vsplit',<q-args>,<bang>1)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vtabedit :execute s:find(<count>,'tabedit',<q-args>,<bang>1)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vpedit :execute s:find(<count>,'pedit',<q-args>,<bang>1)
|
|
||||||
command! -bar -bang -range=1 -nargs=1 -complete=customlist,s:Findcomplete Vread :execute s:find(<count>,'read',<q-args>,<bang>1)
|
|
||||||
|
|
||||||
" vim:set et sw=2 foldmethod=expr foldexpr=getline(v\:lnum)=~'^\"\ Section\:'?'>1'\:getline(v\:lnum)=~#'^fu'?'a1'\:getline(v\:lnum)=~#'^endf'?'s1'\:'=':
|
|
||||||
@@ -1,606 +0,0 @@
|
|||||||
" Vim color file --- psc (peak sea color) "Lite version"
|
|
||||||
" Maintainer: Pan, Shi Zhu <Go to the following URL for my email>
|
|
||||||
" URL: http://vim.sourceforge.net/scripts/script.php?script_id=760
|
|
||||||
" Last Change: 5 Feb 2010
|
|
||||||
" Version: 3.4
|
|
||||||
"
|
|
||||||
" Comments and e-mails are welcomed, thanks.
|
|
||||||
"
|
|
||||||
" The peaksea color is simply a colorscheme with the default settings of
|
|
||||||
" the original ps_color. Lite version means there's no custom settings
|
|
||||||
" and fancy features such as integration with reloaded.vim
|
|
||||||
"
|
|
||||||
" The full version of ps_color.vim will be maintained until Vim 8.
|
|
||||||
" By then there will be only the lite version: peaksea.vim
|
|
||||||
"
|
|
||||||
" Note: Please set the background option in your .vimrc and/or .gvimrc
|
|
||||||
"
|
|
||||||
" It is much better *not* to set 'background' option inside
|
|
||||||
" a colorscheme file. because ":set background" improperly
|
|
||||||
" may cause colorscheme be sourced twice
|
|
||||||
"
|
|
||||||
" Color Scheme Overview:
|
|
||||||
" :ru syntax/hitest.vim
|
|
||||||
"
|
|
||||||
" Relevant Help:
|
|
||||||
" :h highlight-groups
|
|
||||||
" :h psc-cterm-color-table
|
|
||||||
"
|
|
||||||
" Colors Order:
|
|
||||||
" #rrggbb
|
|
||||||
"
|
|
||||||
|
|
||||||
hi clear
|
|
||||||
|
|
||||||
if exists("syntax_on")
|
|
||||||
syntax reset
|
|
||||||
endif
|
|
||||||
|
|
||||||
let g:colors_name = "peaksea"
|
|
||||||
|
|
||||||
" I don't want to abuse folding, but here folding is used to avoid confusion.
|
|
||||||
if &background=='light'
|
|
||||||
" for background=light {{{2
|
|
||||||
" LIGHT COLOR DEFINE START
|
|
||||||
|
|
||||||
hi Normal guifg=#000000 guibg=#e0e0e0 gui=NONE
|
|
||||||
hi Search guifg=White guibg=DarkRed gui=NONE
|
|
||||||
hi Visual guifg=NONE guibg=#a6caf0 gui=NONE
|
|
||||||
hi Cursor guifg=#f0f0f0 guibg=#008000 gui=NONE
|
|
||||||
" The idea of CursorIM is pretty good, however, the feature is still buggy
|
|
||||||
" in the current version (Vim 7.0).
|
|
||||||
" The following line will be kept commented until the bug fixed.
|
|
||||||
"
|
|
||||||
" hi CursorIM guifg=#f0f0f0 guibg=#800080
|
|
||||||
hi Special guifg=#907000 guibg=NONE gui=NONE
|
|
||||||
hi Comment guifg=#606000 guibg=NONE gui=NONE
|
|
||||||
hi Number guifg=#907000 guibg=NONE gui=NONE
|
|
||||||
hi Constant guifg=#007068 guibg=NONE gui=NONE
|
|
||||||
hi StatusLine guifg=fg guibg=#a6caf0 gui=NONE
|
|
||||||
hi LineNr guifg=#686868 guibg=NONE gui=NONE
|
|
||||||
hi Question guifg=fg guibg=#d0d090 gui=NONE
|
|
||||||
hi PreProc guifg=#009030 guibg=NONE gui=NONE
|
|
||||||
hi Statement guifg=#2060a8 guibg=NONE gui=NONE
|
|
||||||
hi Type guifg=#0850a0 guibg=NONE gui=NONE
|
|
||||||
hi Todo guifg=#800000 guibg=#e0e090 gui=NONE
|
|
||||||
" NOTE THIS IS IN THE WARM SECTION
|
|
||||||
hi Error guifg=#c03000 guibg=NONE gui=NONE
|
|
||||||
hi Identifier guifg=#a030a0 guibg=NONE gui=NONE
|
|
||||||
hi ModeMsg guifg=fg guibg=#b0b0e0 gui=NONE
|
|
||||||
hi VisualNOS guifg=fg guibg=#b0b0e0 gui=NONE
|
|
||||||
hi SpecialKey guifg=#1050a0 guibg=NONE gui=NONE
|
|
||||||
hi NonText guifg=#002090 guibg=#d0d0d0 gui=NONE
|
|
||||||
hi Directory guifg=#a030a0 guibg=NONE gui=NONE
|
|
||||||
hi ErrorMsg guifg=fg guibg=#f0b090 gui=NONE
|
|
||||||
hi MoreMsg guifg=#489000 guibg=NONE gui=NONE
|
|
||||||
hi Title guifg=#a030a0 guibg=NONE gui=NONE
|
|
||||||
hi WarningMsg guifg=#b02000 guibg=NONE gui=NONE
|
|
||||||
hi WildMenu guifg=fg guibg=#d0d090 gui=NONE
|
|
||||||
hi Folded guifg=NONE guibg=#b0e0b0 gui=NONE
|
|
||||||
hi FoldColumn guifg=fg guibg=NONE gui=NONE
|
|
||||||
hi DiffAdd guifg=NONE guibg=#b0b0e0 gui=NONE
|
|
||||||
hi DiffChange guifg=NONE guibg=#e0b0e0 gui=NONE
|
|
||||||
hi DiffDelete guifg=#002090 guibg=#d0d0d0 gui=NONE
|
|
||||||
hi DiffText guifg=NONE guibg=#c0e080 gui=NONE
|
|
||||||
hi SignColumn guifg=fg guibg=#90e090 gui=NONE
|
|
||||||
|
|
||||||
hi IncSearch guifg=White guibg=DarkRed gui=NONE
|
|
||||||
hi StatusLineNC guifg=fg guibg=#c0c0c0 gui=NONE
|
|
||||||
hi VertSplit guifg=fg guibg=#c0c0c0 gui=NONE
|
|
||||||
hi Underlined guifg=#6a5acd guibg=NONE gui=underline
|
|
||||||
hi Ignore guifg=bg guibg=NONE
|
|
||||||
" NOTE THIS IS IN THE WARM SECTION
|
|
||||||
if v:version >= 700
|
|
||||||
if has('spell')
|
|
||||||
hi SpellBad guifg=NONE guibg=NONE guisp=#c03000
|
|
||||||
hi SpellCap guifg=NONE guibg=NONE guisp=#2060a8
|
|
||||||
hi SpellRare guifg=NONE guibg=NONE guisp=#a030a0
|
|
||||||
hi SpellLocal guifg=NONE guibg=NONE guisp=#007068
|
|
||||||
endif
|
|
||||||
hi Pmenu guifg=fg guibg=#e0b0e0
|
|
||||||
hi PmenuSel guifg=#f0f0f0 guibg=#806060 gui=NONE
|
|
||||||
hi PmenuSbar guifg=fg guibg=#c0c0c0 gui=NONE
|
|
||||||
hi PmenuThumb guifg=fg guibg=#c0e080 gui=NONE
|
|
||||||
hi TabLine guifg=fg guibg=#c0c0c0 gui=NONE
|
|
||||||
hi TabLineFill guifg=fg guibg=#c0c0c0 gui=NONE
|
|
||||||
hi TabLineSel guifg=fg guibg=NONE gui=NONE
|
|
||||||
hi CursorColumn guifg=NONE guibg=#f0b090
|
|
||||||
hi CursorLine guifg=NONE guibg=NONE gui=underline
|
|
||||||
hi MatchParen guifg=NONE guibg=#c0e080
|
|
||||||
endif
|
|
||||||
|
|
||||||
" LIGHT COLOR DEFINE END
|
|
||||||
|
|
||||||
" Vim 7 added stuffs
|
|
||||||
if v:version >= 700
|
|
||||||
hi Ignore gui=NONE
|
|
||||||
|
|
||||||
" the gui=undercurl guisp could only support in Vim 7
|
|
||||||
if has('spell')
|
|
||||||
hi SpellBad gui=undercurl
|
|
||||||
hi SpellCap gui=undercurl
|
|
||||||
hi SpellRare gui=undercurl
|
|
||||||
hi SpellLocal gui=undercurl
|
|
||||||
endif
|
|
||||||
hi TabLine gui=underline
|
|
||||||
hi TabLineFill gui=underline
|
|
||||||
hi CursorLine gui=underline
|
|
||||||
endif
|
|
||||||
|
|
||||||
" For reversed stuffs, clear the reversed prop and set the bold prop again
|
|
||||||
hi IncSearch gui=bold
|
|
||||||
hi StatusLine gui=bold
|
|
||||||
hi StatusLineNC gui=bold
|
|
||||||
hi VertSplit gui=bold
|
|
||||||
hi Visual gui=bold
|
|
||||||
|
|
||||||
" Enable the bold property
|
|
||||||
hi Question gui=bold
|
|
||||||
hi DiffText gui=bold
|
|
||||||
hi Statement gui=bold
|
|
||||||
hi Type gui=bold
|
|
||||||
hi MoreMsg gui=bold
|
|
||||||
hi ModeMsg gui=bold
|
|
||||||
hi NonText gui=bold
|
|
||||||
hi Title gui=bold
|
|
||||||
hi DiffDelete gui=bold
|
|
||||||
hi TabLineSel gui=bold
|
|
||||||
|
|
||||||
" gui define for background=light end here
|
|
||||||
|
|
||||||
" generally, a dumb terminal is dark, we assume the light terminal has 256
|
|
||||||
" color support.
|
|
||||||
if &t_Co==8 || &t_Co==16
|
|
||||||
set t_Co=256
|
|
||||||
endif
|
|
||||||
if &t_Co==256
|
|
||||||
" 256color light terminal support here
|
|
||||||
|
|
||||||
hi Normal ctermfg=16 ctermbg=254 cterm=NONE
|
|
||||||
" Comment/Uncomment the following line to disable/enable transparency
|
|
||||||
"hi Normal ctermfg=16 ctermbg=NONE cterm=NONE
|
|
||||||
hi Search ctermfg=White ctermbg=DarkRed cterm=NONE
|
|
||||||
hi Visual ctermfg=NONE ctermbg=153 cterm=NONE
|
|
||||||
hi Cursor ctermfg=255 ctermbg=28 cterm=NONE
|
|
||||||
" hi CursorIM ctermfg=255 ctermbg=90
|
|
||||||
hi Special ctermfg=94 ctermbg=NONE cterm=NONE
|
|
||||||
hi Comment ctermfg=58 ctermbg=NONE cterm=NONE
|
|
||||||
hi Number ctermfg=94 ctermbg=NONE cterm=NONE
|
|
||||||
hi Constant ctermfg=23 ctermbg=NONE cterm=NONE
|
|
||||||
hi StatusLine ctermfg=fg ctermbg=153 cterm=NONE
|
|
||||||
hi LineNr ctermfg=242 ctermbg=NONE cterm=NONE
|
|
||||||
hi Question ctermfg=fg ctermbg=186 cterm=NONE
|
|
||||||
hi PreProc ctermfg=29 ctermbg=NONE cterm=NONE
|
|
||||||
hi Statement ctermfg=25 ctermbg=NONE cterm=NONE
|
|
||||||
hi Type ctermfg=25 ctermbg=NONE cterm=NONE
|
|
||||||
hi Todo ctermfg=88 ctermbg=186 cterm=NONE
|
|
||||||
" NOTE THIS IS IN THE WARM SECTION
|
|
||||||
hi Error ctermfg=130 ctermbg=NONE cterm=NONE
|
|
||||||
hi Identifier ctermfg=133 ctermbg=NONE cterm=NONE
|
|
||||||
hi ModeMsg ctermfg=fg ctermbg=146 cterm=NONE
|
|
||||||
hi VisualNOS ctermfg=fg ctermbg=146 cterm=NONE
|
|
||||||
hi SpecialKey ctermfg=25 ctermbg=NONE cterm=NONE
|
|
||||||
hi NonText ctermfg=18 ctermbg=252 cterm=NONE
|
|
||||||
" Comment/Uncomment the following line to disable/enable transparency
|
|
||||||
"hi NonText ctermfg=18 ctermbg=NONE cterm=NONE
|
|
||||||
hi Directory ctermfg=133 ctermbg=NONE cterm=NONE
|
|
||||||
hi ErrorMsg ctermfg=fg ctermbg=216 cterm=NONE
|
|
||||||
hi MoreMsg ctermfg=64 ctermbg=NONE cterm=NONE
|
|
||||||
hi Title ctermfg=133 ctermbg=NONE cterm=NONE
|
|
||||||
hi WarningMsg ctermfg=124 ctermbg=NONE cterm=NONE
|
|
||||||
hi WildMenu ctermfg=fg ctermbg=186 cterm=NONE
|
|
||||||
hi Folded ctermfg=NONE ctermbg=151 cterm=NONE
|
|
||||||
hi FoldColumn ctermfg=fg ctermbg=NONE cterm=NONE
|
|
||||||
hi DiffAdd ctermfg=NONE ctermbg=146 cterm=NONE
|
|
||||||
hi DiffChange ctermfg=NONE ctermbg=182 cterm=NONE
|
|
||||||
hi DiffDelete ctermfg=18 ctermbg=252 cterm=NONE
|
|
||||||
hi DiffText ctermfg=NONE ctermbg=150 cterm=NONE
|
|
||||||
hi SignColumn ctermfg=fg ctermbg=114 cterm=NONE
|
|
||||||
|
|
||||||
hi IncSearch ctermfg=White ctermbg=DarkRed cterm=NONE
|
|
||||||
hi StatusLineNC ctermfg=fg ctermbg=250 cterm=NONE
|
|
||||||
hi VertSplit ctermfg=fg ctermbg=250 cterm=NONE
|
|
||||||
hi Underlined ctermfg=62 ctermbg=NONE cterm=underline
|
|
||||||
hi Ignore ctermfg=bg ctermbg=NONE
|
|
||||||
" NOTE THIS IS IN THE WARM SECTION
|
|
||||||
if v:version >= 700
|
|
||||||
if has('spell')
|
|
||||||
if 0
|
|
||||||
" ctermsp is not supported in Vim7, we ignore it.
|
|
||||||
hi SpellBad cterm=undercurl ctermbg=NONE ctermfg=130
|
|
||||||
hi SpellCap cterm=undercurl ctermbg=NONE ctermfg=25
|
|
||||||
hi SpellRare cterm=undercurl ctermbg=NONE ctermfg=133
|
|
||||||
hi SpellLocal cterm=undercurl ctermbg=NONE ctermfg=23
|
|
||||||
else
|
|
||||||
hi SpellBad cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellCap cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellRare cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellLocal cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
endif
|
|
||||||
endif
|
|
||||||
hi Pmenu ctermfg=fg ctermbg=182
|
|
||||||
hi PmenuSel ctermfg=255 ctermbg=95 cterm=NONE
|
|
||||||
hi PmenuSbar ctermfg=fg ctermbg=250 cterm=NONE
|
|
||||||
hi PmenuThumb ctermfg=fg ctermbg=150 cterm=NONE
|
|
||||||
hi TabLine ctermfg=fg ctermbg=250 cterm=NONE
|
|
||||||
hi TabLineFill ctermfg=fg ctermbg=250 cterm=NONE
|
|
||||||
hi TabLineSel ctermfg=fg ctermbg=NONE cterm=NONE
|
|
||||||
hi CursorColumn ctermfg=NONE ctermbg=216
|
|
||||||
hi CursorLine ctermfg=NONE ctermbg=NONE cterm=underline
|
|
||||||
hi MatchParen ctermfg=NONE ctermbg=150
|
|
||||||
endif
|
|
||||||
|
|
||||||
hi TabLine cterm=underline
|
|
||||||
hi TabLineFill cterm=underline
|
|
||||||
hi CursorLine cterm=underline
|
|
||||||
|
|
||||||
" For reversed stuffs, clear the reversed prop and set the bold prop again
|
|
||||||
hi IncSearch cterm=bold
|
|
||||||
hi StatusLine cterm=bold
|
|
||||||
hi StatusLineNC cterm=bold
|
|
||||||
hi VertSplit cterm=bold
|
|
||||||
hi Visual cterm=bold
|
|
||||||
|
|
||||||
hi NonText cterm=bold
|
|
||||||
hi Question cterm=bold
|
|
||||||
hi Title cterm=bold
|
|
||||||
hi DiffDelete cterm=bold
|
|
||||||
hi DiffText cterm=bold
|
|
||||||
hi Statement cterm=bold
|
|
||||||
hi Type cterm=bold
|
|
||||||
hi MoreMsg cterm=bold
|
|
||||||
hi ModeMsg cterm=bold
|
|
||||||
hi TabLineSel cterm=bold
|
|
||||||
|
|
||||||
"hi lCursor ctermfg=bg ctermbg=fg cterm=NONE
|
|
||||||
endif " t_Co==256
|
|
||||||
" }}}2
|
|
||||||
elseif &background=='dark'
|
|
||||||
" for background=dark {{{2
|
|
||||||
" DARK COLOR DEFINE START
|
|
||||||
|
|
||||||
hi Normal guifg=#d0d0d0 guibg=#202020 gui=NONE
|
|
||||||
hi Comment guifg=#d0d090 guibg=NONE gui=NONE
|
|
||||||
hi Constant guifg=#80c0e0 guibg=NONE gui=NONE
|
|
||||||
hi Number guifg=#e0c060 guibg=NONE gui=NONE
|
|
||||||
hi Identifier guifg=#f0c0f0 guibg=NONE gui=NONE
|
|
||||||
hi Statement guifg=#c0d8f8 guibg=NONE gui=NONE
|
|
||||||
hi PreProc guifg=#60f080 guibg=NONE gui=NONE
|
|
||||||
hi Type guifg=#b0d0f0 guibg=NONE gui=NONE
|
|
||||||
hi Special guifg=#e0c060 guibg=NONE gui=NONE
|
|
||||||
hi Error guifg=#f08060 guibg=NONE gui=NONE
|
|
||||||
hi Todo guifg=#800000 guibg=#d0d090 gui=NONE
|
|
||||||
hi Search guifg=White guibg=DarkRed gui=NONE
|
|
||||||
hi Visual guifg=#000000 guibg=#a6caf0 gui=NONE
|
|
||||||
hi Cursor guifg=#000000 guibg=#00f000 gui=NONE
|
|
||||||
" NOTE THIS IS IN THE COOL SECTION
|
|
||||||
" hi CursorIM guifg=#000000 guibg=#f000f0 gui=NONE
|
|
||||||
hi StatusLine guifg=#000000 guibg=#a6caf0 gui=NONE
|
|
||||||
hi LineNr guifg=#b0b0b0 guibg=NONE gui=NONE
|
|
||||||
hi Question guifg=#000000 guibg=#d0d090 gui=NONE
|
|
||||||
hi ModeMsg guifg=fg guibg=#000080 gui=NONE
|
|
||||||
hi VisualNOS guifg=fg guibg=#000080 gui=NONE
|
|
||||||
hi SpecialKey guifg=#b0d0f0 guibg=NONE gui=NONE
|
|
||||||
hi NonText guifg=#6080f0 guibg=#101010 gui=NONE
|
|
||||||
hi Directory guifg=#80c0e0 guibg=NONE gui=NONE
|
|
||||||
hi ErrorMsg guifg=#d0d090 guibg=#800000 gui=NONE
|
|
||||||
hi MoreMsg guifg=#c0e080 guibg=NONE gui=NONE
|
|
||||||
hi Title guifg=#f0c0f0 guibg=NONE gui=NONE
|
|
||||||
hi WarningMsg guifg=#f08060 guibg=NONE gui=NONE
|
|
||||||
hi WildMenu guifg=#000000 guibg=#d0d090 gui=NONE
|
|
||||||
hi Folded guifg=#aaaaaa guibg=#333333 gui=NONE
|
|
||||||
hi FoldColumn guifg=#202020 guibg=NONE gui=NONE
|
|
||||||
hi DiffAdd guifg=NONE guibg=#000080 gui=NONE
|
|
||||||
hi DiffChange guifg=NONE guibg=#800080 gui=NONE
|
|
||||||
hi DiffDelete guifg=#6080f0 guibg=#202020 gui=NONE
|
|
||||||
hi DiffText guifg=#000000 guibg=#c0e080 gui=NONE
|
|
||||||
hi SignColumn guifg=#e0e0e0 guibg=#202020 gui=NONE
|
|
||||||
hi IncSearch guifg=White guibg=DarkRed gui=NONE
|
|
||||||
hi StatusLineNC guifg=#000000 guibg=#c0c0c0 gui=NONE
|
|
||||||
hi VertSplit guifg=#000000 guibg=#c0c0c0 gui=NONE
|
|
||||||
hi Underlined guifg=#80a0ff guibg=NONE gui=underline
|
|
||||||
hi Ignore guifg=#000000 guibg=NONE
|
|
||||||
" NOTE THIS IS IN THE COOL SECTION
|
|
||||||
if v:version >= 700
|
|
||||||
if has('spell')
|
|
||||||
" the guisp= could only support in Vim 7
|
|
||||||
hi SpellBad guifg=NONE guibg=NONE guisp=#f08060
|
|
||||||
hi SpellCap guifg=NONE guibg=NONE guisp=#6080f0
|
|
||||||
hi SpellRare guifg=NONE guibg=NONE guisp=#f0c0f0
|
|
||||||
hi SpellLocal guifg=NONE guibg=NONE guisp=#c0d8f8
|
|
||||||
endif
|
|
||||||
|
|
||||||
hi Pmenu guifg=#dddddd guibg=#444444 gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi PmenuSel guifg=#000000 guibg=#ffffff gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi TabLine guifg=fg guibg=#008000 gui=NONE
|
|
||||||
hi TabLineFill guifg=fg guibg=#008000 gui=NONE
|
|
||||||
hi TabLineSel guifg=fg guibg=NONE gui=NONE
|
|
||||||
hi CursorColumn guifg=NONE guibg=#800000 gui=NONE
|
|
||||||
hi CursorLine guifg=NONE guibg=NONE gui=underline
|
|
||||||
hi MatchParen guifg=NONE guibg=#800080
|
|
||||||
endif
|
|
||||||
|
|
||||||
" DARK COLOR DEFINE END
|
|
||||||
|
|
||||||
" Vim 7 added stuffs
|
|
||||||
if v:version >= 700
|
|
||||||
hi Ignore gui=NONE
|
|
||||||
|
|
||||||
" the gui=undercurl could only support in Vim 7
|
|
||||||
if has('spell')
|
|
||||||
hi SpellBad gui=undercurl
|
|
||||||
hi SpellCap gui=undercurl
|
|
||||||
hi SpellRare gui=undercurl
|
|
||||||
hi SpellLocal gui=undercurl
|
|
||||||
endif
|
|
||||||
hi TabLine gui=underline
|
|
||||||
hi TabLineFill gui=underline
|
|
||||||
hi Underlined gui=underline
|
|
||||||
hi CursorLine gui=underline
|
|
||||||
endif
|
|
||||||
|
|
||||||
" gui define for background=dark end here
|
|
||||||
|
|
||||||
if &t_Co==8 || &t_Co==16
|
|
||||||
" for 8-color and 16-color term
|
|
||||||
hi Normal ctermfg=LightGrey ctermbg=Black
|
|
||||||
hi Special ctermfg=Yellow ctermbg=bg
|
|
||||||
hi Comment ctermfg=DarkYellow ctermbg=bg
|
|
||||||
hi Constant ctermfg=Blue ctermbg=bg
|
|
||||||
hi Number ctermfg=Yellow ctermbg=bg
|
|
||||||
hi LineNr ctermfg=DarkGrey ctermbg=bg
|
|
||||||
hi PreProc ctermfg=Green ctermbg=bg
|
|
||||||
hi Statement ctermfg=Cyan ctermbg=bg
|
|
||||||
hi Type ctermfg=Cyan ctermbg=bg
|
|
||||||
hi Error ctermfg=Red ctermbg=bg
|
|
||||||
hi Identifier ctermfg=Magenta ctermbg=bg
|
|
||||||
hi SpecialKey ctermfg=Cyan ctermbg=bg
|
|
||||||
hi NonText ctermfg=Blue ctermbg=bg
|
|
||||||
hi Directory ctermfg=Blue ctermbg=bg
|
|
||||||
hi MoreMsg ctermfg=Green ctermbg=bg
|
|
||||||
hi Title ctermfg=Magenta ctermbg=bg
|
|
||||||
hi WarningMsg ctermfg=Red ctermbg=bg
|
|
||||||
hi DiffDelete ctermfg=Blue ctermbg=bg
|
|
||||||
|
|
||||||
hi Search ctermfg=NONE ctermbg=DarkRed
|
|
||||||
hi Visual ctermfg=Black ctermbg=DarkCyan
|
|
||||||
hi Cursor ctermfg=Black ctermbg=Green
|
|
||||||
hi StatusLine ctermfg=Black ctermbg=DarkCyan
|
|
||||||
hi Question ctermfg=Black ctermbg=DarkYellow
|
|
||||||
hi Todo ctermfg=DarkRed ctermbg=DarkYellow
|
|
||||||
hi Folded ctermfg=DarkGrey ctermbg=DarkGrey
|
|
||||||
hi FoldColumn ctermfg=DarkGrey ctermbg=NONE
|
|
||||||
hi ModeMsg ctermfg=Grey ctermbg=DarkBlue
|
|
||||||
hi VisualNOS ctermfg=Grey ctermbg=DarkBlue
|
|
||||||
hi ErrorMsg ctermfg=DarkYellow ctermbg=DarkRed
|
|
||||||
hi WildMenu ctermfg=Black ctermbg=DarkYellow
|
|
||||||
hi SignColumn ctermfg=White ctermbg=DarkGreen
|
|
||||||
hi DiffText ctermfg=Black ctermbg=DarkYellow
|
|
||||||
|
|
||||||
if v:version >= 700
|
|
||||||
if has('spell')
|
|
||||||
hi SpellBad ctermfg=NONE ctermbg=DarkRed
|
|
||||||
hi SpellCap ctermfg=NONE ctermbg=DarkBlue
|
|
||||||
hi SpellRare ctermfg=NONE ctermbg=DarkMagenta
|
|
||||||
hi SpellLocal ctermfg=NONE ctermbg=DarkGreen
|
|
||||||
endif
|
|
||||||
|
|
||||||
hi Pmenu ctermfg=White ctermbg=DarkGrey
|
|
||||||
hi PmenuSel ctermfg=Black ctermbg=White
|
|
||||||
|
|
||||||
hi TabLine ctermfg=fg ctermbg=Black cterm=underline
|
|
||||||
hi TabLineFill ctermfg=fg ctermbg=Black cterm=underline
|
|
||||||
hi CursorColumn ctermfg=NONE ctermbg=DarkRed
|
|
||||||
|
|
||||||
hi TabLineSel ctermfg=fg ctermbg=bg
|
|
||||||
hi CursorLine ctermfg=NONE ctermbg=bg cterm=underline
|
|
||||||
|
|
||||||
hi MatchParen ctermfg=NONE ctermbg=DarkMagenta
|
|
||||||
endif
|
|
||||||
if &t_Co==8
|
|
||||||
" 8 colour terminal support, this assumes 16 colour is available through
|
|
||||||
" setting the 'bold' attribute, will get bright foreground colour.
|
|
||||||
" However, the bright background color is not available for 8-color terms.
|
|
||||||
"
|
|
||||||
" You can manually set t_Co=16 in your .vimrc to see if your terminal
|
|
||||||
" supports 16 colours,
|
|
||||||
hi DiffText cterm=none
|
|
||||||
hi Visual cterm=none
|
|
||||||
hi Cursor cterm=none
|
|
||||||
hi Comment cterm=none
|
|
||||||
hi Todo cterm=none
|
|
||||||
hi StatusLine cterm=none
|
|
||||||
hi Question cterm=none
|
|
||||||
hi DiffChange cterm=none
|
|
||||||
hi ModeMsg cterm=none
|
|
||||||
hi VisualNOS cterm=none
|
|
||||||
hi ErrorMsg cterm=none
|
|
||||||
hi WildMenu cterm=none
|
|
||||||
hi DiffAdd cterm=none
|
|
||||||
hi Folded cterm=none
|
|
||||||
hi DiffDelete cterm=none
|
|
||||||
hi Normal cterm=none
|
|
||||||
hi PmenuThumb cterm=none
|
|
||||||
hi Search cterm=bold
|
|
||||||
hi Special cterm=bold
|
|
||||||
hi Constant cterm=bold
|
|
||||||
hi Number cterm=bold
|
|
||||||
hi LineNr cterm=bold
|
|
||||||
hi PreProc cterm=bold
|
|
||||||
hi Statement cterm=bold
|
|
||||||
hi Type cterm=bold
|
|
||||||
hi Error cterm=bold
|
|
||||||
hi Identifier cterm=bold
|
|
||||||
hi SpecialKey cterm=bold
|
|
||||||
hi NonText cterm=bold
|
|
||||||
hi MoreMsg cterm=bold
|
|
||||||
hi Title cterm=bold
|
|
||||||
hi WarningMsg cterm=bold
|
|
||||||
hi FoldColumn cterm=bold
|
|
||||||
hi SignColumn cterm=bold
|
|
||||||
hi Directory cterm=bold
|
|
||||||
hi DiffDelete cterm=bold
|
|
||||||
else
|
|
||||||
" Background > 7 is only available with 16 or more colors
|
|
||||||
|
|
||||||
hi WarningMsg cterm=none
|
|
||||||
hi Search cterm=none
|
|
||||||
hi Visual cterm=none
|
|
||||||
hi Cursor cterm=none
|
|
||||||
hi Special cterm=none
|
|
||||||
hi Comment cterm=none
|
|
||||||
hi Constant cterm=none
|
|
||||||
hi Number cterm=none
|
|
||||||
hi LineNr cterm=none
|
|
||||||
hi PreProc cterm=none
|
|
||||||
hi Todo cterm=none
|
|
||||||
hi Error cterm=none
|
|
||||||
hi Identifier cterm=none
|
|
||||||
hi Folded cterm=none
|
|
||||||
hi SpecialKey cterm=none
|
|
||||||
hi Directory cterm=none
|
|
||||||
hi ErrorMsg cterm=none
|
|
||||||
hi Normal cterm=none
|
|
||||||
hi PmenuThumb cterm=none
|
|
||||||
hi WildMenu cterm=none
|
|
||||||
hi FoldColumn cterm=none
|
|
||||||
hi SignColumn cterm=none
|
|
||||||
hi DiffAdd cterm=none
|
|
||||||
hi DiffChange cterm=none
|
|
||||||
hi Question cterm=none
|
|
||||||
hi StatusLine cterm=none
|
|
||||||
hi DiffText cterm=none
|
|
||||||
hi IncSearch cterm=reverse
|
|
||||||
hi StatusLineNC cterm=reverse
|
|
||||||
hi VertSplit cterm=reverse
|
|
||||||
|
|
||||||
" Well, well, bold font with color 0-7 is not possible.
|
|
||||||
" So, the Question, StatusLine, DiffText cannot act as expected.
|
|
||||||
|
|
||||||
hi Statement cterm=none
|
|
||||||
hi Type cterm=none
|
|
||||||
hi MoreMsg cterm=none
|
|
||||||
hi ModeMsg cterm=none
|
|
||||||
hi NonText cterm=none
|
|
||||||
hi Title cterm=none
|
|
||||||
hi VisualNOS cterm=none
|
|
||||||
hi DiffDelete cterm=none
|
|
||||||
hi TabLineSel cterm=none
|
|
||||||
|
|
||||||
endif
|
|
||||||
elseif &t_Co==256
|
|
||||||
" 256color dark terminal support here
|
|
||||||
hi Normal ctermfg=252 ctermbg=234 cterm=NONE
|
|
||||||
" Comment/Uncomment the following line to disable/enable transparency
|
|
||||||
"hi Normal ctermfg=252 ctermbg=NONE cterm=NONE
|
|
||||||
hi Comment ctermfg=186 ctermbg=NONE cterm=NONE
|
|
||||||
hi Constant ctermfg=110 ctermbg=NONE cterm=NONE
|
|
||||||
hi Number ctermfg=179 ctermbg=NONE cterm=NONE
|
|
||||||
hi Identifier ctermfg=219 ctermbg=NONE cterm=NONE
|
|
||||||
hi Statement ctermfg=153 ctermbg=NONE cterm=NONE
|
|
||||||
hi PreProc ctermfg=84 ctermbg=NONE cterm=NONE
|
|
||||||
hi Type ctermfg=153 ctermbg=NONE cterm=NONE
|
|
||||||
hi Special ctermfg=179 ctermbg=NONE cterm=NONE
|
|
||||||
hi Error ctermfg=209 ctermbg=NONE cterm=NONE
|
|
||||||
hi Todo ctermfg=88 ctermbg=186 cterm=NONE
|
|
||||||
hi Search ctermfg=White ctermbg=DarkRed cterm=NONE
|
|
||||||
hi Visual ctermfg=16 ctermbg=153 cterm=NONE
|
|
||||||
hi Cursor ctermfg=16 ctermbg=46 cterm=NONE
|
|
||||||
" NOTE THIS IS IN THE COOL SECTION
|
|
||||||
" hi CursorIM ctermfg=16 ctermbg=201 cterm=NONE
|
|
||||||
hi StatusLine ctermfg=16 ctermbg=153 cterm=NONE
|
|
||||||
hi LineNr ctermfg=249 ctermbg=NONE cterm=NONE
|
|
||||||
hi Question ctermfg=16 ctermbg=186 cterm=NONE
|
|
||||||
hi ModeMsg ctermfg=fg ctermbg=18 cterm=NONE
|
|
||||||
hi VisualNOS ctermfg=fg ctermbg=18 cterm=NONE
|
|
||||||
hi SpecialKey ctermfg=153 ctermbg=NONE cterm=NONE
|
|
||||||
hi NonText ctermfg=69 ctermbg=233 cterm=NONE
|
|
||||||
" Comment/Uncomment the following line to disable/enable transparency
|
|
||||||
"hi NonText ctermfg=69 ctermbg=NONE cterm=NONE
|
|
||||||
hi Directory ctermfg=110 ctermbg=NONE cterm=NONE
|
|
||||||
hi ErrorMsg ctermfg=186 ctermbg=88 cterm=NONE
|
|
||||||
hi MoreMsg ctermfg=150 ctermbg=NONE cterm=NONE
|
|
||||||
hi Title ctermfg=219 ctermbg=NONE cterm=NONE
|
|
||||||
hi WarningMsg ctermfg=209 ctermbg=NONE cterm=NONE
|
|
||||||
hi WildMenu ctermfg=16 ctermbg=186 cterm=NONE
|
|
||||||
hi Folded ctermfg=NONE ctermbg=DarkGrey cterm=NONE
|
|
||||||
hi FoldColumn ctermfg=DarkGrey ctermbg=NONE cterm=NONE
|
|
||||||
hi DiffAdd ctermfg=NONE ctermbg=18 cterm=NONE
|
|
||||||
hi DiffChange ctermfg=NONE ctermbg=90 cterm=NONE
|
|
||||||
hi DiffDelete ctermfg=69 ctermbg=234 cterm=NONE
|
|
||||||
hi DiffText ctermfg=16 ctermbg=150 cterm=NONE
|
|
||||||
hi SignColumn ctermfg=254 ctermbg=28 cterm=NONE
|
|
||||||
hi IncSearch ctermfg=White ctermbg=DarkRed cterm=NONE
|
|
||||||
hi StatusLineNC ctermfg=16 ctermbg=250 cterm=NONE
|
|
||||||
hi VertSplit ctermfg=16 ctermbg=250 cterm=NONE
|
|
||||||
hi Underlined ctermfg=111 ctermbg=NONE cterm=underline
|
|
||||||
hi Ignore ctermfg=16 ctermbg=NONE
|
|
||||||
" NOTE THIS IS IN THE COOL SECTION
|
|
||||||
if v:version >= 700
|
|
||||||
if has('spell')
|
|
||||||
" the ctermsp= is not supported in Vim 7 we simply ignored
|
|
||||||
if 0
|
|
||||||
hi SpellBad cterm=undercurl ctermbg=NONE ctermfg=209
|
|
||||||
hi SpellCap cterm=undercurl ctermbg=NONE ctermfg=69
|
|
||||||
hi SpellRare cterm=undercurl ctermbg=NONE ctermfg=219
|
|
||||||
hi SpellLocal cterm=undercurl ctermbg=NONE ctermfg=153
|
|
||||||
else
|
|
||||||
hi SpellBad cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellCap cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellRare cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
hi SpellLocal cterm=undercurl ctermbg=NONE ctermfg=NONE
|
|
||||||
endif
|
|
||||||
endif
|
|
||||||
|
|
||||||
hi Pmenu ctermfg=White ctermbg=DarkGrey
|
|
||||||
hi PmenuSel ctermfg=Black ctermbg=White cterm=NONE
|
|
||||||
|
|
||||||
hi TabLine ctermfg=fg ctermbg=Black cterm=NONE
|
|
||||||
hi TabLineFill ctermfg=fg ctermbg=Black cterm=NONE
|
|
||||||
hi TabLineSel ctermfg=fg ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi CursorColumn ctermfg=NONE ctermbg=88 cterm=NONE
|
|
||||||
hi CursorLine ctermfg=NONE ctermbg=NONE cterm=underline
|
|
||||||
hi MatchParen ctermfg=NONE ctermbg=90
|
|
||||||
hi TabLine cterm=underline
|
|
||||||
hi TabLineFill cterm=underline
|
|
||||||
hi Underlined cterm=underline
|
|
||||||
hi CursorLine cterm=underline
|
|
||||||
endif
|
|
||||||
|
|
||||||
endif " t_Co
|
|
||||||
|
|
||||||
" }}}2
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Links:
|
|
||||||
"
|
|
||||||
" COLOR LINKS DEFINE START
|
|
||||||
|
|
||||||
hi link String Constant
|
|
||||||
" Character must be different from strings because in many languages
|
|
||||||
" (especially C, C++) a 'char' variable is scalar while 'string' is pointer,
|
|
||||||
" mistaken a 'char' for a 'string' will cause disaster!
|
|
||||||
hi link Character Number
|
|
||||||
hi link SpecialChar LineNr
|
|
||||||
hi link Tag Identifier
|
|
||||||
hi link cCppOut LineNr
|
|
||||||
" The following are not standard hi links,
|
|
||||||
" these are used by DrChip
|
|
||||||
hi link Warning MoreMsg
|
|
||||||
hi link Notice Constant
|
|
||||||
" these are used by Calendar
|
|
||||||
hi link CalToday PreProc
|
|
||||||
" these are used by TagList
|
|
||||||
hi link MyTagListTagName IncSearch
|
|
||||||
hi link MyTagListTagScope Constant
|
|
||||||
|
|
||||||
hi TabLineFill guifg=#9098a0 guibg=#111111
|
|
||||||
hi TabLine guifg=black guibg=#888888
|
|
||||||
hi TabLineSel guifg=white guibg=#202020 gui=bold
|
|
||||||
|
|
||||||
" COLOR LINKS DEFINE END
|
|
||||||
|
|
||||||
" vim:et:nosta:sw=2:ts=8:
|
|
||||||
" vim600:fdm=marker:fdl=1:
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
function! CustomizedTabLine()
|
|
||||||
let s = ''
|
|
||||||
let t = tabpagenr()
|
|
||||||
let i = 1
|
|
||||||
while i <= tabpagenr('$')
|
|
||||||
let buflist = tabpagebuflist(i)
|
|
||||||
let winnr = tabpagewinnr(i)
|
|
||||||
let s .= '%' . i . 'T'
|
|
||||||
let s .= (i == t ? '%1*' : '%2*')
|
|
||||||
let s .= ' '
|
|
||||||
let s .= i . ':'
|
|
||||||
let s .= '%*'
|
|
||||||
let s .= (i == t ? '%#TabLineSel#' : '%#TabLine#')
|
|
||||||
let file = bufname(buflist[winnr - 1])
|
|
||||||
let file = fnamemodify(file, ':p:t')
|
|
||||||
if file == ''
|
|
||||||
let file = '[No Name]'
|
|
||||||
endif
|
|
||||||
let s .= file
|
|
||||||
let s .= ' '
|
|
||||||
let i = i + 1
|
|
||||||
endwhile
|
|
||||||
let s .= '%T%#TabLineFill#%='
|
|
||||||
let s .= (tabpagenr('$') > 1 ? '%999XX' : 'X')
|
|
||||||
return s
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Always show the tablilne
|
|
||||||
set stal=2
|
|
||||||
set tabline=%!CustomizedTabLine()
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
This is a version of Infinite Red's vim theme (http://blog.infinitered.com/entries/show/8) packaged to work with Tim Pope's pathogen plugin (http://www.vim.org/scripts/script.php?script_id=2332).
|
|
||||||
|
|
||||||
To use it (assuming you're using pathogen):
|
|
||||||
|
|
||||||
- go to your bundle directory (.vim/bundle or .vimbundles) and clone the repo:
|
|
||||||
|
|
||||||
git clone git@github.com:wgibbs/vim-irblack.git
|
|
||||||
|
|
||||||
- edit your .vimrc and add:
|
|
||||||
|
|
||||||
:colorscheme ir_black
|
|
||||||
@@ -1,220 +0,0 @@
|
|||||||
" ir_black color scheme
|
|
||||||
" More at: http://blog.infinitered.com/entries/show/8
|
|
||||||
|
|
||||||
|
|
||||||
" ********************************************************************************
|
|
||||||
" Standard colors used in all ir_black themes:
|
|
||||||
" Note, x:x:x are RGB values
|
|
||||||
"
|
|
||||||
" normal: #f6f3e8
|
|
||||||
"
|
|
||||||
" string: #A8FF60 168:255:96
|
|
||||||
" string inner (punc, code, etc): #00A0A0 0:160:160
|
|
||||||
" number: #FF73FD 255:115:253
|
|
||||||
" comments: #7C7C7C 124:124:124
|
|
||||||
" keywords: #96CBFE 150:203:254
|
|
||||||
" operators: white
|
|
||||||
" class: #FFFFB6 255:255:182
|
|
||||||
" method declaration name: #FFD2A7 255:210:167
|
|
||||||
" regular expression: #E9C062 233:192:98
|
|
||||||
" regexp alternate: #FF8000 255:128:0
|
|
||||||
" regexp alternate 2: #B18A3D 177:138:61
|
|
||||||
" variable: #C6C5FE 198:197:254
|
|
||||||
"
|
|
||||||
" Misc colors:
|
|
||||||
" red color (used for whatever): #FF6C60 255:108:96
|
|
||||||
" light red: #FFB6B0 255:182:176
|
|
||||||
"
|
|
||||||
" brown: #E18964 good for special
|
|
||||||
"
|
|
||||||
" lightpurpleish: #FFCCFF
|
|
||||||
"
|
|
||||||
" Interface colors:
|
|
||||||
" background color: black
|
|
||||||
" cursor (where underscore is used): #FFA560 255:165:96
|
|
||||||
" cursor (where block is used): white
|
|
||||||
" visual selection: #1D1E2C
|
|
||||||
" current line: #151515 21:21:21
|
|
||||||
" search selection: #07281C 7:40:28
|
|
||||||
" line number: #3D3D3D 61:61:61
|
|
||||||
|
|
||||||
|
|
||||||
" ********************************************************************************
|
|
||||||
" The following are the preferred 16 colors for your terminal
|
|
||||||
" Colors Bright Colors
|
|
||||||
" Black #4E4E4E #7C7C7C
|
|
||||||
" Red #FF6C60 #FFB6B0
|
|
||||||
" Green #A8FF60 #CEFFAB
|
|
||||||
" Yellow #FFFFB6 #FFFFCB
|
|
||||||
" Blue #96CBFE #FFFFCB
|
|
||||||
" Magenta #FF73FD #FF9CFE
|
|
||||||
" Cyan #C6C5FE #DFDFFE
|
|
||||||
" White #EEEEEE #FFFFFF
|
|
||||||
|
|
||||||
|
|
||||||
" ********************************************************************************
|
|
||||||
set background=dark
|
|
||||||
hi clear
|
|
||||||
|
|
||||||
if exists("syntax_on")
|
|
||||||
syntax reset
|
|
||||||
endif
|
|
||||||
|
|
||||||
let colors_name = "ir_black"
|
|
||||||
|
|
||||||
|
|
||||||
"hi Example guifg=NONE guibg=NONE gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
" General colors
|
|
||||||
hi Normal guifg=#f6f3e8 guibg=black gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi NonText guifg=#070707 guibg=black gui=NONE ctermfg=black ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi Cursor guifg=black guibg=white gui=NONE ctermfg=black ctermbg=white cterm=reverse
|
|
||||||
hi LineNr guifg=#3D3D3D guibg=black gui=NONE ctermfg=darkgray ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi VertSplit guifg=#202020 guibg=#202020 gui=NONE ctermfg=darkgray ctermbg=darkgray cterm=NONE
|
|
||||||
hi StatusLine guifg=#CCCCCC guibg=#202020 gui=None ctermfg=white ctermbg=darkgray cterm=NONE
|
|
||||||
hi StatusLineNC guifg=black guibg=#202020 gui=NONE ctermfg=blue ctermbg=darkgray cterm=NONE
|
|
||||||
|
|
||||||
hi Folded guifg=#a0a8b0 guibg=#384048 gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi Title guifg=#f6f3e8 guibg=NONE gui=bold ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi Visual guifg=NONE guibg=DarkBlue gui=NONE ctermfg=NONE ctermbg=darkgray cterm=NONE
|
|
||||||
|
|
||||||
hi SpecialKey guifg=#808080 guibg=#343434 gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi WildMenu guifg=white guibg=DarkRed gui=NONE ctermfg=white ctermbg=DarkRed cterm=NONE
|
|
||||||
hi PmenuSbar guifg=black guibg=white gui=NONE ctermfg=black ctermbg=white cterm=NONE
|
|
||||||
"hi Ignore guifg=gray guibg=black gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi Error guifg=NONE guibg=red gui=undercurl ctermfg=white ctermbg=red cterm=NONE guisp=#FF6C60 " undercurl color
|
|
||||||
hi ErrorMsg guifg=white guibg=#FF6C60 gui=BOLD ctermfg=white ctermbg=red cterm=NONE
|
|
||||||
hi WarningMsg guifg=white guibg=#FF6C60 gui=BOLD ctermfg=white ctermbg=red cterm=NONE
|
|
||||||
|
|
||||||
" Message displayed in lower left, such as --INSERT--
|
|
||||||
hi ModeMsg guifg=black guibg=#C6C5FE gui=BOLD ctermfg=black ctermbg=cyan cterm=BOLD
|
|
||||||
|
|
||||||
if version >= 700 " Vim 7.x specific colors
|
|
||||||
hi CursorLine guifg=NONE guibg=#121212 gui=NONE ctermfg=NONE ctermbg=NONE cterm=BOLD
|
|
||||||
hi CursorColumn guifg=NONE guibg=#121212 gui=NONE ctermfg=NONE ctermbg=NONE cterm=BOLD
|
|
||||||
hi MatchParen guifg=#f6f3e8 guibg=#857b6f gui=BOLD ctermfg=white ctermbg=darkgray cterm=NONE
|
|
||||||
hi Pmenu guifg=#f6f3e8 guibg=#444444 gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi PmenuSel guifg=#000000 guibg=#cae682 gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
hi Search guifg=NONE guibg=NONE gui=NONE ctermfg=NONE ctermbg=NONE cterm=NONE
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Syntax highlighting
|
|
||||||
hi Comment guifg=#7C7C7C guibg=NONE gui=NONE ctermfg=darkgray ctermbg=NONE cterm=NONE
|
|
||||||
hi String guifg=#A8FF60 guibg=NONE gui=NONE ctermfg=green ctermbg=NONE cterm=NONE
|
|
||||||
hi Number guifg=#FF73FD guibg=NONE gui=NONE ctermfg=magenta ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi Keyword guifg=#96CBFE guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE
|
|
||||||
hi PreProc guifg=#96CBFE guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE
|
|
||||||
hi Conditional guifg=#6699CC guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE " if else end
|
|
||||||
|
|
||||||
hi Todo guifg=#8f8f8f guibg=NONE gui=NONE ctermfg=red ctermbg=NONE cterm=NONE
|
|
||||||
hi Constant guifg=#99CC99 guibg=NONE gui=NONE ctermfg=cyan ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi Identifier guifg=#C6C5FE guibg=NONE gui=NONE ctermfg=cyan ctermbg=NONE cterm=NONE
|
|
||||||
hi Function guifg=#FFD2A7 guibg=NONE gui=NONE ctermfg=brown ctermbg=NONE cterm=NONE
|
|
||||||
hi Type guifg=#FFFFB6 guibg=NONE gui=NONE ctermfg=yellow ctermbg=NONE cterm=NONE
|
|
||||||
hi Statement guifg=#6699CC guibg=NONE gui=NONE ctermfg=lightblue ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi Special guifg=#E18964 guibg=NONE gui=NONE ctermfg=white ctermbg=NONE cterm=NONE
|
|
||||||
hi Delimiter guifg=#00A0A0 guibg=NONE gui=NONE ctermfg=cyan ctermbg=NONE cterm=NONE
|
|
||||||
hi Operator guifg=#6699CC guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
hi link Character Constant
|
|
||||||
hi link Boolean Constant
|
|
||||||
hi link Float Number
|
|
||||||
hi link Repeat Statement
|
|
||||||
hi link Label Statement
|
|
||||||
hi link Exception Statement
|
|
||||||
hi link Include PreProc
|
|
||||||
hi link Define PreProc
|
|
||||||
hi link Macro PreProc
|
|
||||||
hi link PreCondit PreProc
|
|
||||||
hi link StorageClass Type
|
|
||||||
hi link Structure Type
|
|
||||||
hi link Typedef Type
|
|
||||||
hi link Tag Special
|
|
||||||
hi link SpecialChar Special
|
|
||||||
hi link SpecialComment Special
|
|
||||||
hi link Debug Special
|
|
||||||
|
|
||||||
|
|
||||||
" Special for Ruby
|
|
||||||
hi rubyRegexp guifg=#B18A3D guibg=NONE gui=NONE ctermfg=brown ctermbg=NONE cterm=NONE
|
|
||||||
hi rubyRegexpDelimiter guifg=#FF8000 guibg=NONE gui=NONE ctermfg=brown ctermbg=NONE cterm=NONE
|
|
||||||
hi rubyEscape guifg=white guibg=NONE gui=NONE ctermfg=cyan ctermbg=NONE cterm=NONE
|
|
||||||
hi rubyInterpolationDelimiter guifg=#00A0A0 guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE
|
|
||||||
hi rubyControl guifg=#6699CC guibg=NONE gui=NONE ctermfg=blue ctermbg=NONE cterm=NONE "and break, etc
|
|
||||||
"hi rubyGlobalVariable guifg=#FFCCFF guibg=NONE gui=NONE ctermfg=lightblue ctermbg=NONE cterm=NONE "yield
|
|
||||||
hi rubyStringDelimiter guifg=#336633 guibg=NONE gui=NONE ctermfg=lightgreen ctermbg=NONE cterm=NONE
|
|
||||||
"rubyInclude
|
|
||||||
"rubySharpBang
|
|
||||||
"rubyAccess
|
|
||||||
"rubyPredefinedVariable
|
|
||||||
"rubyBoolean
|
|
||||||
"rubyClassVariable
|
|
||||||
"rubyBeginEnd
|
|
||||||
"rubyRepeatModifier
|
|
||||||
"hi link rubyArrayDelimiter Special " [ , , ]
|
|
||||||
"rubyCurlyBlock { , , }
|
|
||||||
|
|
||||||
hi link rubyClass Keyword
|
|
||||||
hi link rubyModule Keyword
|
|
||||||
hi link rubyKeyword Keyword
|
|
||||||
hi link rubyOperator Operator
|
|
||||||
hi link rubyIdentifier Identifier
|
|
||||||
hi link rubyInstanceVariable Identifier
|
|
||||||
hi link rubyGlobalVariable Identifier
|
|
||||||
hi link rubyClassVariable Identifier
|
|
||||||
hi link rubyConstant Type
|
|
||||||
|
|
||||||
|
|
||||||
" Special for Java
|
|
||||||
" hi link javaClassDecl Type
|
|
||||||
hi link javaScopeDecl Identifier
|
|
||||||
hi link javaCommentTitle javaDocSeeTag
|
|
||||||
hi link javaDocTags javaDocSeeTag
|
|
||||||
hi link javaDocParam javaDocSeeTag
|
|
||||||
hi link javaDocSeeTagParam javaDocSeeTag
|
|
||||||
|
|
||||||
hi javaDocSeeTag guifg=#CCCCCC guibg=NONE gui=NONE ctermfg=darkgray ctermbg=NONE cterm=NONE
|
|
||||||
hi javaDocSeeTag guifg=#CCCCCC guibg=NONE gui=NONE ctermfg=darkgray ctermbg=NONE cterm=NONE
|
|
||||||
"hi javaClassDecl guifg=#CCFFCC guibg=NONE gui=NONE ctermfg=white ctermbg=NONE cterm=NONE
|
|
||||||
|
|
||||||
|
|
||||||
" Special for XML
|
|
||||||
hi link xmlTag Keyword
|
|
||||||
hi link xmlTagName Conditional
|
|
||||||
hi link xmlEndTag Identifier
|
|
||||||
|
|
||||||
|
|
||||||
" Special for HTML
|
|
||||||
hi link htmlTag Keyword
|
|
||||||
hi link htmlTagName Conditional
|
|
||||||
hi link htmlEndTag Identifier
|
|
||||||
|
|
||||||
|
|
||||||
" Special for Javascript
|
|
||||||
hi link javaScriptNumber Number
|
|
||||||
|
|
||||||
|
|
||||||
" Special for Python
|
|
||||||
"hi link pythonEscape Keyword
|
|
||||||
|
|
||||||
|
|
||||||
" Special for CSharp
|
|
||||||
hi link csXmlTag Keyword
|
|
||||||
|
|
||||||
|
|
||||||
" Amix customizations
|
|
||||||
|
|
||||||
" Tab line
|
|
||||||
hi TabLineFill guifg=#000000 guibg=#000000 gui=NONE
|
|
||||||
hi TabLine guifg=black guibg=#888888 gui=NONE
|
|
||||||
hi TabLineSel guifg=white guibg=#000000 gui=bold
|
|
||||||
|
|
||||||
" Search higlights
|
|
||||||
hi Search guifg=White guibg=DarkRed gui=NONE
|
|
||||||
File diff suppressed because one or more lines are too long
@@ -1,57 +0,0 @@
|
|||||||
" plugin/peepopen.vim
|
|
||||||
" Author: Geoffrey Grosenbach <boss@topfunky.com>
|
|
||||||
" License: MIT License
|
|
||||||
|
|
||||||
" Install this file as plugin/peepopen.vim.
|
|
||||||
|
|
||||||
" If you prefer Command-T, use this snippet in your .gvimrc:
|
|
||||||
|
|
||||||
" if has("gui_macvim")
|
|
||||||
" macmenu &File.New\ Tab key=<nop>
|
|
||||||
" map <D-t> <Plug>PeepOpen
|
|
||||||
" end
|
|
||||||
|
|
||||||
" ============================================================================
|
|
||||||
|
|
||||||
" Exit quickly when:
|
|
||||||
" - this plugin was already loaded (or disabled)
|
|
||||||
" - when 'compatible' is set
|
|
||||||
if &cp || exists("g:peepopen_loaded") && g:peepopen_loaded
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
let g:peepopen_loaded = 1
|
|
||||||
let s:save_cpo = &cpo
|
|
||||||
set cpo&vim
|
|
||||||
|
|
||||||
if !exists('g:peepopen_quit')
|
|
||||||
let g:peepopen_quit = 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
function s:LaunchPeepOpenViaVim()
|
|
||||||
silent exe "!open -a PeepOpen " . shellescape(getcwd())
|
|
||||||
redraw!
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function s:QuitPeepOpenViaVim()
|
|
||||||
silent exe '!ps ax | grep PeepOpen | grep -v grep | awk "{ print $1 }" | xargs kill -QUIT'
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
command! PeepOpen :call <SID>LaunchPeepOpenViaVim()
|
|
||||||
command! PeepQuit :call <SID>QuitPeepOpenViaVim()
|
|
||||||
|
|
||||||
if has('autocmd') && exists('g:peepopen_quit') && g:peepopen_quit
|
|
||||||
au VimLeave * :call <SID>QuitPeepOpenViaVim()
|
|
||||||
endif
|
|
||||||
|
|
||||||
noremap <unique> <script> <Plug>PeepOpen <SID>Launch
|
|
||||||
noremap <SID>Launch :call <SID>LaunchPeepOpenViaVim()<CR>
|
|
||||||
|
|
||||||
if !hasmapto('<Plug>PeepOpen')
|
|
||||||
map! <unique> <silent> <Leader>p <Plug>PeepOpen
|
|
||||||
endif
|
|
||||||
|
|
||||||
let &cpo = s:save_cpo
|
|
||||||
unlet s:save_cpo
|
|
||||||
|
|
||||||
" vim:set sw=2 sts=2:
|
|
||||||
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
tags
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
ack.vim is distributed under the same license terms as Vim itself, which you
|
|
||||||
can find in full with `:help license` within Vim, or copied in full herein.
|
|
||||||
|
|
||||||
Copyright (c) 2007-2015 Antoine Imbert <antoine.imbert+ackvim@gmail.com>
|
|
||||||
and contributors.
|
|
||||||
|
|
||||||
Maintainers may be contacted via GitHub Issues at:
|
|
||||||
|
|
||||||
https://github.com/mileszs/ack.vim/issues
|
|
||||||
|
|
||||||
|
|
||||||
VIM LICENSE
|
|
||||||
|
|
||||||
I) There are no restrictions on distributing unmodified copies of Vim except
|
|
||||||
that they must include this license text. You can also distribute
|
|
||||||
unmodified parts of Vim, likewise unrestricted except that they must
|
|
||||||
include this license text. You are also allowed to include executables
|
|
||||||
that you made from the unmodified Vim sources, plus your own usage
|
|
||||||
examples and Vim scripts.
|
|
||||||
|
|
||||||
II) It is allowed to distribute a modified (or extended) version of Vim,
|
|
||||||
including executables and/or source code, when the following four
|
|
||||||
conditions are met:
|
|
||||||
1) This license text must be included unmodified.
|
|
||||||
2) The modified Vim must be distributed in one of the following five ways:
|
|
||||||
a) If you make changes to Vim yourself, you must clearly describe in
|
|
||||||
the distribution how to contact you. When the maintainer asks you
|
|
||||||
(in any way) for a copy of the modified Vim you distributed, you
|
|
||||||
must make your changes, including source code, available to the
|
|
||||||
maintainer without fee. The maintainer reserves the right to
|
|
||||||
include your changes in the official version of Vim. What the
|
|
||||||
maintainer will do with your changes and under what license they
|
|
||||||
will be distributed is negotiable. If there has been no negotiation
|
|
||||||
then this license, or a later version, also applies to your changes.
|
|
||||||
The current maintainer is Bram Moolenaar <Bram@vim.org>. If this
|
|
||||||
changes it will be announced in appropriate places (most likely
|
|
||||||
vim.sf.net, www.vim.org and/or comp.editors). When it is completely
|
|
||||||
impossible to contact the maintainer, the obligation to send him
|
|
||||||
your changes ceases. Once the maintainer has confirmed that he has
|
|
||||||
received your changes they will not have to be sent again.
|
|
||||||
b) If you have received a modified Vim that was distributed as
|
|
||||||
mentioned under a) you are allowed to further distribute it
|
|
||||||
unmodified, as mentioned at I). If you make additional changes the
|
|
||||||
text under a) applies to those changes.
|
|
||||||
c) Provide all the changes, including source code, with every copy of
|
|
||||||
the modified Vim you distribute. This may be done in the form of a
|
|
||||||
context diff. You can choose what license to use for new code you
|
|
||||||
add. The changes and their license must not restrict others from
|
|
||||||
making their own changes to the official version of Vim.
|
|
||||||
d) When you have a modified Vim which includes changes as mentioned
|
|
||||||
under c), you can distribute it without the source code for the
|
|
||||||
changes if the following three conditions are met:
|
|
||||||
- The license that applies to the changes permits you to distribute
|
|
||||||
the changes to the Vim maintainer without fee or restriction, and
|
|
||||||
permits the Vim maintainer to include the changes in the official
|
|
||||||
version of Vim without fee or restriction.
|
|
||||||
- You keep the changes for at least three years after last
|
|
||||||
distributing the corresponding modified Vim. When the maintainer
|
|
||||||
or someone who you distributed the modified Vim to asks you (in
|
|
||||||
any way) for the changes within this period, you must make them
|
|
||||||
available to him.
|
|
||||||
- You clearly describe in the distribution how to contact you. This
|
|
||||||
contact information must remain valid for at least three years
|
|
||||||
after last distributing the corresponding modified Vim, or as long
|
|
||||||
as possible.
|
|
||||||
e) When the GNU General Public License (GPL) applies to the changes,
|
|
||||||
you can distribute the modified Vim under the GNU GPL version 2 or
|
|
||||||
any later version.
|
|
||||||
3) A message must be added, at least in the output of the ":version"
|
|
||||||
command and in the intro screen, such that the user of the modified Vim
|
|
||||||
is able to see that it was modified. When distributing as mentioned
|
|
||||||
under 2)e) adding the message is only required for as far as this does
|
|
||||||
not conflict with the license used for the changes.
|
|
||||||
4) The contact information as required under 2)a) and 2)d) must not be
|
|
||||||
removed or changed, except that the person himself can make
|
|
||||||
corrections.
|
|
||||||
|
|
||||||
III) If you distribute a modified version of Vim, you are encouraged to use
|
|
||||||
the Vim license for your changes and make them available to the
|
|
||||||
maintainer, including the source code. The preferred way to do this is
|
|
||||||
by e-mail or by uploading the files to a server and e-mailing the URL.
|
|
||||||
If the number of changes is small (e.g., a modified Makefile) e-mailing a
|
|
||||||
context diff will do. The e-mail address to be used is
|
|
||||||
<maintainer@vim.org>
|
|
||||||
|
|
||||||
IV) It is not allowed to remove this license from the distribution of the Vim
|
|
||||||
sources, parts of it or from a modified version. You may use this
|
|
||||||
license for previous Vim releases instead of the license that they came
|
|
||||||
with, at your option.
|
|
||||||
File diff suppressed because one or more lines are too long
@@ -1,246 +0,0 @@
|
|||||||
if exists('g:autoloaded_ack') || &cp
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
|
|
||||||
if exists('g:ack_use_dispatch')
|
|
||||||
if g:ack_use_dispatch && !exists(':Dispatch')
|
|
||||||
call s:Warn('Dispatch not loaded! Falling back to g:ack_use_dispatch = 0.')
|
|
||||||
let g:ack_use_dispatch = 0
|
|
||||||
endif
|
|
||||||
else
|
|
||||||
let g:ack_use_dispatch = 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
"-----------------------------------------------------------------------------
|
|
||||||
" Public API
|
|
||||||
"-----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
function! ack#Ack(cmd, args) "{{{
|
|
||||||
call s:Init(a:cmd)
|
|
||||||
redraw
|
|
||||||
|
|
||||||
" Local values that we'll temporarily set as options when searching
|
|
||||||
let l:grepprg = g:ackprg
|
|
||||||
let l:grepformat = '%f:%l:%c:%m,%f:%l:%m' " Include column number
|
|
||||||
|
|
||||||
" Strip some options that are meaningless for path search and set match
|
|
||||||
" format accordingly.
|
|
||||||
if s:SearchingFilepaths()
|
|
||||||
let l:grepprg = substitute(l:grepprg, '-H\|--column', '', 'g')
|
|
||||||
let l:grepformat = '%f'
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Check user policy for blank searches
|
|
||||||
if empty(a:args)
|
|
||||||
if !g:ack_use_cword_for_empty_search
|
|
||||||
echo "No regular expression found."
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
endif
|
|
||||||
|
|
||||||
" If no pattern is provided, search for the word under the cursor
|
|
||||||
let l:grepargs = empty(a:args) ? expand("<cword>") : a:args . join(a:000, ' ')
|
|
||||||
|
|
||||||
"Bypass search if cursor is on blank string
|
|
||||||
if l:grepargs == ""
|
|
||||||
echo "No regular expression found."
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
|
|
||||||
" NOTE: we escape special chars, but not everything using shellescape to
|
|
||||||
" allow for passing arguments etc
|
|
||||||
let l:escaped_args = escape(l:grepargs, '|#%')
|
|
||||||
|
|
||||||
echo "Searching ..."
|
|
||||||
|
|
||||||
if g:ack_use_dispatch
|
|
||||||
call s:SearchWithDispatch(l:grepprg, l:escaped_args, l:grepformat)
|
|
||||||
else
|
|
||||||
call s:SearchWithGrep(a:cmd, l:grepprg, l:escaped_args, l:grepformat)
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Dispatch has no callback mechanism currently, we just have to display the
|
|
||||||
" list window early and wait for it to populate :-/
|
|
||||||
call ack#ShowResults()
|
|
||||||
call s:Highlight(l:grepargs)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! ack#AckFromSearch(cmd, args) "{{{
|
|
||||||
let search = getreg('/')
|
|
||||||
" translate vim regular expression to perl regular expression.
|
|
||||||
let search = substitute(search, '\(\\<\|\\>\)', '\\b', 'g')
|
|
||||||
call ack#Ack(a:cmd, '"' . search . '" ' . a:args)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! ack#AckHelp(cmd, args) "{{{
|
|
||||||
let args = a:args . ' ' . s:GetDocLocations()
|
|
||||||
call ack#Ack(a:cmd, args)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! ack#AckWindow(cmd, args) "{{{
|
|
||||||
let files = tabpagebuflist()
|
|
||||||
|
|
||||||
" remove duplicated filenames (files appearing in more than one window)
|
|
||||||
let files = filter(copy(sort(files)), 'index(files,v:val,v:key+1)==-1')
|
|
||||||
call map(files, "bufname(v:val)")
|
|
||||||
|
|
||||||
" remove unnamed buffers as quickfix (empty strings before shellescape)
|
|
||||||
call filter(files, 'v:val != ""')
|
|
||||||
|
|
||||||
" expand to full path (avoid problems with cd/lcd in au QuickFixCmdPre)
|
|
||||||
let files = map(files, "shellescape(fnamemodify(v:val, ':p'))")
|
|
||||||
let args = a:args . ' ' . join(files)
|
|
||||||
|
|
||||||
call ack#Ack(a:cmd, args)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! ack#ShowResults() "{{{
|
|
||||||
let l:handler = s:UsingLocList() ? g:ack_lhandler : g:ack_qhandler
|
|
||||||
execute l:handler
|
|
||||||
call s:ApplyMappings()
|
|
||||||
redraw!
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
"-----------------------------------------------------------------------------
|
|
||||||
" Private API
|
|
||||||
"-----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
function! s:ApplyMappings() "{{{
|
|
||||||
if !s:UsingListMappings() || &filetype != 'qf'
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
|
|
||||||
let l:wintype = s:UsingLocList() ? 'l' : 'c'
|
|
||||||
let l:closemap = ':' . l:wintype . 'close<CR>'
|
|
||||||
let g:ack_mappings.q = l:closemap
|
|
||||||
|
|
||||||
nnoremap <buffer> <silent> ? :call <SID>QuickHelp()<CR>
|
|
||||||
|
|
||||||
if g:ack_autoclose
|
|
||||||
" We just map the 'go' and 'gv' mappings to close on autoclose, wtf?
|
|
||||||
for key_map in items(g:ack_mappings)
|
|
||||||
execute printf("nnoremap <buffer> <silent> %s %s", get(key_map, 0), get(key_map, 1) . l:closemap)
|
|
||||||
endfor
|
|
||||||
|
|
||||||
execute "nnoremap <buffer> <silent> <CR> <CR>" . l:closemap
|
|
||||||
else
|
|
||||||
for key_map in items(g:ack_mappings)
|
|
||||||
execute printf("nnoremap <buffer> <silent> %s %s", get(key_map, 0), get(key_map, 1))
|
|
||||||
endfor
|
|
||||||
endif
|
|
||||||
|
|
||||||
if exists("g:ackpreview") " if auto preview in on, remap j and k keys
|
|
||||||
nnoremap <buffer> <silent> j j<CR><C-W><C-P>
|
|
||||||
nnoremap <buffer> <silent> k k<CR><C-W><C-P>
|
|
||||||
nmap <buffer> <silent> <Down> j
|
|
||||||
nmap <buffer> <silent> <Up> k
|
|
||||||
endif
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:GetDocLocations() "{{{
|
|
||||||
let dp = ''
|
|
||||||
for p in split(&rtp, ',')
|
|
||||||
let p = p . '/doc/'
|
|
||||||
if isdirectory(p)
|
|
||||||
let dp = p . '*.txt ' . dp
|
|
||||||
endif
|
|
||||||
endfor
|
|
||||||
|
|
||||||
return dp
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:Highlight(args) "{{{
|
|
||||||
if !g:ackhighlight
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
|
|
||||||
let @/ = matchstr(a:args, "\\v(-)\@<!(\<)\@<=\\w+|['\"]\\zs.{-}\\ze['\"]")
|
|
||||||
call feedkeys(":let &hlsearch=1 \| echo \<CR>", "n")
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
" Initialize state for an :Ack* or :LAck* search
|
|
||||||
function! s:Init(cmd) "{{{
|
|
||||||
let s:searching_filepaths = (a:cmd =~# '-g$') ? 1 : 0
|
|
||||||
let s:using_loclist = (a:cmd =~# '^l') ? 1 : 0
|
|
||||||
|
|
||||||
if g:ack_use_dispatch && s:using_loclist
|
|
||||||
call s:Warn('Dispatch does not support location lists! Proceeding with quickfix...')
|
|
||||||
let s:using_loclist = 0
|
|
||||||
endif
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:QuickHelp() "{{{
|
|
||||||
execute 'edit' globpath(&rtp, 'doc/ack_quick_help.txt')
|
|
||||||
|
|
||||||
silent normal gg
|
|
||||||
setlocal buftype=nofile bufhidden=hide nobuflisted
|
|
||||||
setlocal nomodifiable noswapfile
|
|
||||||
setlocal filetype=help
|
|
||||||
setlocal nonumber norelativenumber nowrap
|
|
||||||
setlocal foldmethod=diff foldlevel=20
|
|
||||||
|
|
||||||
nnoremap <buffer> <silent> ? :q!<CR>:call ack#ShowResults()<CR>
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:SearchWithDispatch(grepprg, grepargs, grepformat) "{{{
|
|
||||||
let l:makeprg_bak = &l:makeprg
|
|
||||||
let l:errorformat_bak = &l:errorformat
|
|
||||||
|
|
||||||
" We don't execute a :grep command for Dispatch, so add -g here instead
|
|
||||||
if s:SearchingFilepaths()
|
|
||||||
let l:grepprg = a:grepprg . ' -g'
|
|
||||||
else
|
|
||||||
let l:grepprg = a:grepprg
|
|
||||||
endif
|
|
||||||
|
|
||||||
try
|
|
||||||
let &l:makeprg = l:grepprg . ' ' . a:grepargs
|
|
||||||
let &l:errorformat = a:grepformat
|
|
||||||
|
|
||||||
Make
|
|
||||||
finally
|
|
||||||
let &l:makeprg = l:makeprg_bak
|
|
||||||
let &l:errorformat = l:errorformat_bak
|
|
||||||
endtry
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:SearchWithGrep(grepcmd, grepprg, grepargs, grepformat) "{{{
|
|
||||||
let l:grepprg_bak = &l:grepprg
|
|
||||||
let l:grepformat_bak = &grepformat
|
|
||||||
|
|
||||||
try
|
|
||||||
let &l:grepprg = a:grepprg
|
|
||||||
let &grepformat = a:grepformat
|
|
||||||
|
|
||||||
silent execute a:grepcmd a:grepargs
|
|
||||||
finally
|
|
||||||
let &l:grepprg = l:grepprg_bak
|
|
||||||
let &grepformat = l:grepformat_bak
|
|
||||||
endtry
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
" Are we finding matching files, not lines? (the -g option -- :AckFile)
|
|
||||||
function! s:SearchingFilepaths() "{{{
|
|
||||||
return get(s:, 'searching_filepaths', 0)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
" Predicate for whether mappings are enabled for list type of current search.
|
|
||||||
function! s:UsingListMappings() "{{{
|
|
||||||
if s:UsingLocList()
|
|
||||||
return g:ack_apply_lmappings
|
|
||||||
else
|
|
||||||
return g:ack_apply_qmappings
|
|
||||||
endif
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
" Were we invoked with a :LAck command?
|
|
||||||
function! s:UsingLocList() "{{{
|
|
||||||
return get(s:, 'using_loclist', 0)
|
|
||||||
endfunction "}}}
|
|
||||||
|
|
||||||
function! s:Warn(msg) "{{{
|
|
||||||
echohl WarningMsg | echomsg 'Ack: ' . a:msg | echohl None
|
|
||||||
endf "}}}
|
|
||||||
|
|
||||||
let g:autoloaded_ack = 1
|
|
||||||
" vim:set et sw=2 ts=2 tw=78 fdm=marker
|
|
||||||
@@ -1,315 +0,0 @@
|
|||||||
*ack.txt* Plugin that integrates ack with Vim
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
Author: Antoine Imbert <antoine.imbert+ackvim@gmail.com> *ack-author*
|
|
||||||
License: Same terms as Vim itself (see |license|)
|
|
||||||
|
|
||||||
This plugin is only available if 'compatible' is not set.
|
|
||||||
|
|
||||||
{Vi does not have any of this}
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
INTRODUCTION *ack*
|
|
||||||
|
|
||||||
This plugin is a front for the Perl module App::Ack. Ack can be used as a
|
|
||||||
replacement for grep. This plugin will allow you to run ack from vim, and
|
|
||||||
shows the results in a split window.
|
|
||||||
|
|
||||||
:Ack[!] [options] {pattern} [{directory}] *:Ack*
|
|
||||||
|
|
||||||
Search recursively in {directory} (which defaults to the current
|
|
||||||
directory) for the {pattern}. Behaves just like the |:grep| command, but
|
|
||||||
will open the |Quickfix| window for you. If [!] is not given the first
|
|
||||||
occurrence is jumped to.
|
|
||||||
|
|
||||||
:AckAdd [options] {pattern} [{directory}] *:AckAdd*
|
|
||||||
|
|
||||||
Just like |:Ack|, but instead of making a new list, the matches are
|
|
||||||
appended to the current |quickfix| list.
|
|
||||||
|
|
||||||
:AckFromSearch [{directory}] *:AckFromSearch*
|
|
||||||
|
|
||||||
Just like |:Ack| but the pattern is from previous search.
|
|
||||||
|
|
||||||
:LAck [options] {pattern} [{directory}] *:LAck*
|
|
||||||
|
|
||||||
Just like |:Ack| but instead of the |quickfix| list, matches are placed in
|
|
||||||
the current |location-list|.
|
|
||||||
|
|
||||||
:LAckAdd [options] {pattern} [{directory}] *:LAckAdd*
|
|
||||||
|
|
||||||
Just like |:AckAdd| but instead of the |quickfix| list, matches are added
|
|
||||||
to the current |location-list|
|
|
||||||
|
|
||||||
:AckFile [options] {pattern} [{directory}] *:AckFile*
|
|
||||||
|
|
||||||
Search recursively in {directory} (which defaults to the current
|
|
||||||
directory) for filenames matching the {pattern}. Behaves just like the
|
|
||||||
|:grep| command, but will open the |Quickfix| window for you.
|
|
||||||
|
|
||||||
:AckHelp[!] [options] {pattern} *:AckHelp*
|
|
||||||
|
|
||||||
Search vim documentation files for the {pattern}. Behaves just like the
|
|
||||||
|:Ack| command, but searches only vim documentation .txt files
|
|
||||||
|
|
||||||
:LAckHelp [options] {pattern} *:LAckHelp*
|
|
||||||
|
|
||||||
Just like |:AckHelp| but instead of the |quickfix| list, matches are placed
|
|
||||||
in the current |location-list|.
|
|
||||||
|
|
||||||
:AckWindow[!] [options] {pattern} *:AckWindow*
|
|
||||||
|
|
||||||
Search all buffers visible in the screen (current tab page only) files for
|
|
||||||
the {pattern}.
|
|
||||||
|
|
||||||
:LAckWindow [options] {pattern} *:LAckWindow*
|
|
||||||
|
|
||||||
Just like |:AckWindow| but instead of the |quickfix| list, matches are
|
|
||||||
placed in the current |location-list|.
|
|
||||||
|
|
||||||
Files containing the search term will be listed in the split window, along
|
|
||||||
with the line number of the occurrence, once for each occurrence. <Enter> on
|
|
||||||
a line in this window will open the file, and place the cursor on the matching
|
|
||||||
line.
|
|
||||||
|
|
||||||
Note that if you are using Dispatch.vim with |g:ack_use_dispatch|, location
|
|
||||||
lists are not supported, because Dispatch does not support them at this time.
|
|
||||||
`:LAck` versions of commands above will give a warning and proceed to use the
|
|
||||||
quickfix list instead.
|
|
||||||
|
|
||||||
See http://beyondgrep.com/ for more information on searching with ack.
|
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
CONFIGURATION *ack-configuration*
|
|
||||||
|
|
||||||
*g:ackprg*
|
|
||||||
g:ackprg
|
|
||||||
Default for ubuntu: "ack-grep"
|
|
||||||
Default for other systems: "ack"
|
|
||||||
|
|
||||||
Use this option to specify the search command and its default arguments.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ackprg = "ag --vimgrep"
|
|
||||||
<
|
|
||||||
*g:ack_default_options*
|
|
||||||
g:ack_default_options
|
|
||||||
Default: " -s -H --nocolor --nogroup --column"
|
|
||||||
|
|
||||||
Use this option to specify the default arguments given to `ack`. This is only
|
|
||||||
used if |g:ackprg| has not been customized from the default--if you are using
|
|
||||||
a custom search program instead of Ack, set your preferred options in
|
|
||||||
|g:ackprg|.
|
|
||||||
|
|
||||||
NOTE: This option may be deprecated in the future. ~
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ack_default_options =
|
|
||||||
\ " -s -H --nocolor --nogroup --column --smart-case --follow"
|
|
||||||
<
|
|
||||||
*g:ack_apply_qmappings*
|
|
||||||
g:ack_apply_qmappings
|
|
||||||
Default: 1
|
|
||||||
|
|
||||||
This option enables mappings on the |quickfix| window.
|
|
||||||
|
|
||||||
*g:ack_apply_lmappings*
|
|
||||||
g:ack_apply_lmappings
|
|
||||||
Default: 1
|
|
||||||
|
|
||||||
This option enables mappings on |location-list| windows.
|
|
||||||
|
|
||||||
*g:ack_mappings*
|
|
||||||
g:ack_mappings
|
|
||||||
Default: {
|
|
||||||
\ "t": "<C-W><CR><C-W>T",
|
|
||||||
\ "T": "<C-W><CR><C-W>TgT<C-W>j",
|
|
||||||
\ "o": "<CR>",
|
|
||||||
\ "O": "<CR><C-W><C-W>:ccl<CR>",
|
|
||||||
\ "go": "<CR><C-W>j",
|
|
||||||
\ "h": "<C-W><CR><C-W>K",
|
|
||||||
\ "H": "<C-W><CR><C-W>K<C-W>b",
|
|
||||||
\ "v": "<C-W><CR><C-W>H<C-W>b<C-W>J<C-W>t",
|
|
||||||
\ "gv": "<C-W><CR><C-W>H<C-W>b<C-W>J" }
|
|
||||||
|
|
||||||
This option list all maps create on quickfix/Location list window.
|
|
||||||
|
|
||||||
Example, if you want to open the result in the middle of the screen:
|
|
||||||
>
|
|
||||||
let g:ack_mappings = { "o": "<CR>zz" }
|
|
||||||
<
|
|
||||||
*g:ack_qhandler*
|
|
||||||
g:ack_qhandler
|
|
||||||
Default: "botright copen"
|
|
||||||
|
|
||||||
Command to open the quickview window.
|
|
||||||
|
|
||||||
If you want to open a quickview window with 30 lines you can do:
|
|
||||||
>
|
|
||||||
let g:ack_qhandler = "botright copen 30"
|
|
||||||
<
|
|
||||||
*g:ack_lhandler*
|
|
||||||
g:ack_lhandler
|
|
||||||
Default: "botright lopen"
|
|
||||||
|
|
||||||
Command to open the Location list window.
|
|
||||||
|
|
||||||
If you want to open a Location list window with 30 lines you can do:
|
|
||||||
>
|
|
||||||
let g:ack_lhandler = "botright lopen 30"
|
|
||||||
<
|
|
||||||
*g:ackhighlight*
|
|
||||||
g:ackhighlight
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Use this option to highlight the searched term.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ackhighlight = 1
|
|
||||||
<
|
|
||||||
*g:ack_autoclose*
|
|
||||||
g:ack_autoclose
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Use this option to specify whether to close the quickfix window after
|
|
||||||
using any of the shortcuts.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ack_autoclose = 1
|
|
||||||
<
|
|
||||||
*g:ack_autofold_results*
|
|
||||||
g:ack_autofold_results
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Use this option to fold the results in quickfix by file name. Only the current
|
|
||||||
fold will be open by default and while you press 'j' and 'k' to move between the
|
|
||||||
results if you hit other fold the last one will be closed and the current will
|
|
||||||
be open.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ack_autofold_results = 1
|
|
||||||
<
|
|
||||||
*g:ackpreview*
|
|
||||||
g:ackpreview
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Use this option to automagically open the file with 'j' or 'k'.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ackpreview = 1
|
|
||||||
<
|
|
||||||
*g:ack_use_dispatch*
|
|
||||||
g:ack_use_dispatch
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Use this option to use vim-dispatch to run searches in the background, with a
|
|
||||||
variety of execution backends for different systems.
|
|
||||||
|
|
||||||
Due to limitations in Dispatch at this time, location lists are unsupported
|
|
||||||
and result windows will appear before results are ready. Still, these may be
|
|
||||||
acceptable tradeoffs for very large projects where searches are slow.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ack_use_dispatch = 1
|
|
||||||
<
|
|
||||||
*g:ack_use_cword_for_empty_search*
|
|
||||||
g:ack_use_cword_for_empty_search
|
|
||||||
Default: 1
|
|
||||||
|
|
||||||
Use this option to enable blank searches to run against the word under the
|
|
||||||
cursor. When this option is not set, blank searches will only output an error
|
|
||||||
message.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
>
|
|
||||||
let g:ack_use_cword_for_empty_search = 0
|
|
||||||
<
|
|
||||||
==============================================================================
|
|
||||||
MAPPINGS *ack-mappings*
|
|
||||||
|
|
||||||
The following keyboard shortcuts are available in the |quickfix| and
|
|
||||||
|location-list| windows:
|
|
||||||
|
|
||||||
? display a quick summary of these mappings.
|
|
||||||
|
|
||||||
o open file (same as Enter).
|
|
||||||
|
|
||||||
O open file and close the quickfix window.
|
|
||||||
|
|
||||||
go preview file (open but maintain focus on ack.vim results).
|
|
||||||
|
|
||||||
t open in a new tab.
|
|
||||||
|
|
||||||
T open in new tab without moving to it.
|
|
||||||
|
|
||||||
h open in horizontal split.
|
|
||||||
|
|
||||||
H open in horizontal split, keeping focus on the results.
|
|
||||||
|
|
||||||
v open in vertical split.
|
|
||||||
|
|
||||||
gv open in vertical split, keeping focus on the results.
|
|
||||||
|
|
||||||
q close the quickfix window.
|
|
||||||
|
|
||||||
To adjust these, see |g:ack_mappings|.
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
Ignoring files *ack-ignore*
|
|
||||||
|
|
||||||
If you're using this plugin with ag, The Silver Searcher, bear in mind that:
|
|
||||||
|
|
||||||
- It ignores file patterns from your .gitignore and .hgignore.
|
|
||||||
|
|
||||||
- If there are other files in your source repository you don't wish to
|
|
||||||
search, you can add their patterns to an .agignore file.
|
|
||||||
|
|
||||||
==============================================================================
|
|
||||||
ISSUES AND FAQ *ack-issues-and-faq*
|
|
||||||
|
|
||||||
I don't want to jump to the first result automatically.~
|
|
||||||
|
|
||||||
Use `:Ack!`, with bang. If you want this behavior most of the time, you
|
|
||||||
might like an abbreviation or mapping in your personal config, something
|
|
||||||
like these:
|
|
||||||
>
|
|
||||||
cnoreabbrev Ack Ack!
|
|
||||||
nnoremap <Leader>a :Ack!<Space>
|
|
||||||
<
|
|
||||||
Most of the `:[L]Ack*` commands support this. Note that this behavior
|
|
||||||
follows the convention of Vim's built-in |:grep| and |:make| commands.
|
|
||||||
|
|
||||||
I use NERDTree and opening ack.vim results in a vertical split displacing it.~
|
|
||||||
|
|
||||||
You are probably using NERDTree with its default alignment at the left
|
|
||||||
side of the window. Set these custom mappings in your vimrc to work around
|
|
||||||
this:
|
|
||||||
>
|
|
||||||
let g:ack_mappings = {
|
|
||||||
\ 'v': '<C-W><CR><C-W>L<C-W>p<C-W>J<C-W>p',
|
|
||||||
\ 'gv': '<C-W><CR><C-W>L<C-W>p<C-W>J' }
|
|
||||||
<
|
|
||||||
This solution will be improved in the future.
|
|
||||||
|
|
||||||
Results show a mix of relative and absolute paths, making them hard to read.~
|
|
||||||
|
|
||||||
This is a quirk of Vim that can happen with plain |:vimgrep| too. You can
|
|
||||||
try this in your vimrc to work around it:
|
|
||||||
>
|
|
||||||
autocmd BufAdd * exe "cd" fnameescape(getcwd())
|
|
||||||
<
|
|
||||||
but for some users this may be disruptive to their Vim workflow. For more
|
|
||||||
details, see:
|
|
||||||
|
|
||||||
http://vi.stackexchange.com/a/4816/7174
|
|
||||||
https://github.com/mileszs/ack.vim/issues/143
|
|
||||||
|
|
||||||
vim:set et sw=4 ts=4 tw=78:
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
==== ack.vim quick help ===============
|
|
||||||
|
|
||||||
*?:* a quick summary of these keys, repeat to close
|
|
||||||
*o:* to open (same as Enter)
|
|
||||||
*O:* to open and close the quickfix window
|
|
||||||
*go:* to preview file, open but maintain focus on ack.vim results
|
|
||||||
*t:* to open in new tab
|
|
||||||
*T:* to open in new tab without moving to it
|
|
||||||
*h:* to open in horizontal split
|
|
||||||
*H:* to open in horizontal split, keeping focus on the results
|
|
||||||
*v:* to open in vertical split
|
|
||||||
*gv:* to open in vertical split, keeping focus on the results
|
|
||||||
*q:* to close the quickfix window
|
|
||||||
|
|
||||||
========================================
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
if exists("g:ack_autofold_results") && g:ack_autofold_results
|
|
||||||
setlocal foldlevel=0
|
|
||||||
setlocal foldmethod=expr
|
|
||||||
setlocal foldexpr=matchstr(getline(v:lnum),'^[^\|]\\+')==#matchstr(getline(v:lnum+1),'^[^\|]\\+')?1:'<1'
|
|
||||||
setlocal foldenable
|
|
||||||
setlocal foldclose=all
|
|
||||||
setlocal foldopen=all
|
|
||||||
nnoremap <buffer> j jzz
|
|
||||||
endif
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
if exists('g:loaded_ack') || &cp
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_default_options")
|
|
||||||
let g:ack_default_options = " -s -H --nopager --nocolor --nogroup --column"
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Location of the ack utility
|
|
||||||
if !exists("g:ackprg")
|
|
||||||
if executable('ack-grep')
|
|
||||||
let g:ackprg = "ack-grep"
|
|
||||||
elseif executable('ack')
|
|
||||||
let g:ackprg = "ack"
|
|
||||||
else
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
let g:ackprg .= g:ack_default_options
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_apply_qmappings")
|
|
||||||
let g:ack_apply_qmappings = !exists("g:ack_qhandler")
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_apply_lmappings")
|
|
||||||
let g:ack_apply_lmappings = !exists("g:ack_lhandler")
|
|
||||||
endif
|
|
||||||
|
|
||||||
let s:ack_mappings = {
|
|
||||||
\ "t": "<C-W><CR><C-W>T",
|
|
||||||
\ "T": "<C-W><CR><C-W>TgT<C-W>j",
|
|
||||||
\ "o": "<CR>",
|
|
||||||
\ "O": "<CR><C-W>p<C-W>c",
|
|
||||||
\ "go": "<CR><C-W>p",
|
|
||||||
\ "h": "<C-W><CR><C-W>K",
|
|
||||||
\ "H": "<C-W><CR><C-W>K<C-W>b",
|
|
||||||
\ "v": "<C-W><CR><C-W>H<C-W>b<C-W>J<C-W>t",
|
|
||||||
\ "gv": "<C-W><CR><C-W>H<C-W>b<C-W>J" }
|
|
||||||
|
|
||||||
if exists("g:ack_mappings")
|
|
||||||
let g:ack_mappings = extend(s:ack_mappings, g:ack_mappings)
|
|
||||||
else
|
|
||||||
let g:ack_mappings = s:ack_mappings
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_qhandler")
|
|
||||||
let g:ack_qhandler = "botright copen"
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_lhandler")
|
|
||||||
let g:ack_lhandler = "botright lopen"
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ackhighlight")
|
|
||||||
let g:ackhighlight = 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_autoclose")
|
|
||||||
let g:ack_autoclose = 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_autofold_results")
|
|
||||||
let g:ack_autofold_results = 0
|
|
||||||
endif
|
|
||||||
|
|
||||||
if !exists("g:ack_use_cword_for_empty_search")
|
|
||||||
let g:ack_use_cword_for_empty_search = 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
command! -bang -nargs=* -complete=file Ack call ack#Ack('grep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=file AckAdd call ack#Ack('grepadd<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=file AckFromSearch call ack#AckFromSearch('grep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=file LAck call ack#Ack('lgrep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=file LAckAdd call ack#Ack('lgrepadd<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=file AckFile call ack#Ack('grep<bang> -g', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=help AckHelp call ack#AckHelp('grep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* -complete=help LAckHelp call ack#AckHelp('lgrep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* AckWindow call ack#AckWindow('grep<bang>', <q-args>)
|
|
||||||
command! -bang -nargs=* LAckWindow call ack#AckWindow('lgrep<bang>', <q-args>)
|
|
||||||
|
|
||||||
let g:loaded_ack = 1
|
|
||||||
|
|
||||||
" vim:set et sw=2 ts=2 tw=78 fdm=marker
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
Copyright (c) 2016-2019, w0rp <devw0rp@gmail.com>
|
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this
|
|
||||||
list of conditions and the following disclaimer.
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
||||||
this list of conditions and the following disclaimer in the documentation
|
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
||||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
||||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
|
||||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
||||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
||||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
@@ -1,268 +0,0 @@
|
|||||||
" Author: w0rp <devw0rp@gmail.com>, David Alexander <opensource@thelonelyghost.com>
|
|
||||||
" Description: Primary code path for the plugin
|
|
||||||
" Manages execution of linters when requested by autocommands
|
|
||||||
|
|
||||||
" Strings used for severity in the echoed message
|
|
||||||
let g:ale_echo_msg_error_str = get(g:, 'ale_echo_msg_error_str', 'Error')
|
|
||||||
let g:ale_echo_msg_info_str = get(g:, 'ale_echo_msg_info_str', 'Info')
|
|
||||||
let g:ale_echo_msg_log_str = get(g:, 'ale_echo_msg_log_str', 'Log')
|
|
||||||
let g:ale_echo_msg_warning_str = get(g:, 'ale_echo_msg_warning_str', 'Warning')
|
|
||||||
" Ignoring linters, for disabling some, or ignoring LSP diagnostics.
|
|
||||||
let g:ale_linters_ignore = get(g:, 'ale_linters_ignore', {})
|
|
||||||
let g:ale_disable_lsp = get(g:, 'ale_disable_lsp', 0)
|
|
||||||
|
|
||||||
" LSP window/showMessage format
|
|
||||||
let g:ale_lsp_show_message_format = get(g:, 'ale_lsp_show_message_format', '%severity%:%linter%: %s')
|
|
||||||
" Valid values mimic LSP definitions (error, warning and information; log is
|
|
||||||
" never shown)
|
|
||||||
let g:ale_lsp_show_message_severity = get(g:, 'ale_lsp_show_message_severity', 'error')
|
|
||||||
|
|
||||||
let s:lint_timer = -1
|
|
||||||
let s:getcmdwintype_exists = exists('*getcmdwintype')
|
|
||||||
|
|
||||||
" Return 1 if a file is too large for ALE to handle.
|
|
||||||
function! ale#FileTooLarge(buffer) abort
|
|
||||||
let l:max = getbufvar(a:buffer, 'ale_maximum_file_size', get(g:, 'ale_maximum_file_size', 0))
|
|
||||||
|
|
||||||
return l:max > 0 ? (line2byte(line('$') + 1) > l:max) : 0
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" A function for checking various conditions whereby ALE just shouldn't
|
|
||||||
" attempt to do anything, say if particular buffer types are open in Vim.
|
|
||||||
function! ale#ShouldDoNothing(buffer) abort
|
|
||||||
" The checks are split into separate if statements to make it possible to
|
|
||||||
" profile each check individually with Vim's profiling tools.
|
|
||||||
"
|
|
||||||
" Do nothing if ALE is disabled.
|
|
||||||
if !getbufvar(a:buffer, 'ale_enabled', get(g:, 'ale_enabled', 0))
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Don't perform any checks when newer NeoVim versions are exiting.
|
|
||||||
if get(v:, 'exiting', v:null) isnot v:null
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
let l:filetype = getbufvar(a:buffer, '&filetype')
|
|
||||||
|
|
||||||
" Do nothing when there's no filetype.
|
|
||||||
if l:filetype is# ''
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing for diff buffers.
|
|
||||||
if getbufvar(a:buffer, '&diff')
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing for blacklisted files.
|
|
||||||
if index(get(g:, 'ale_filetype_blacklist', []), l:filetype) >= 0
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing if running from command mode.
|
|
||||||
if s:getcmdwintype_exists && !empty(getcmdwintype())
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
let l:filename = fnamemodify(bufname(a:buffer), ':t')
|
|
||||||
|
|
||||||
" Do nothing for directories.
|
|
||||||
if l:filename is# '.'
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Don't start linting and so on when an operator is pending.
|
|
||||||
if ale#util#Mode(1) is# 'no'
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing if running in the sandbox.
|
|
||||||
if ale#util#InSandbox()
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing if the file is too large.
|
|
||||||
if ale#FileTooLarge(a:buffer)
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Do nothing from CtrlP buffers with CtrlP-funky.
|
|
||||||
if exists(':CtrlPFunky') is 2
|
|
||||||
\&& getbufvar(a:buffer, '&l:statusline') =~# 'CtrlPMode.*funky'
|
|
||||||
return 1
|
|
||||||
endif
|
|
||||||
|
|
||||||
return 0
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
function! s:Lint(buffer, should_lint_file, timer_id) abort
|
|
||||||
" Use the filetype from the buffer
|
|
||||||
let l:filetype = getbufvar(a:buffer, '&filetype')
|
|
||||||
let l:linters = ale#linter#Get(l:filetype)
|
|
||||||
|
|
||||||
" Apply ignore lists for linters only if needed.
|
|
||||||
let l:ignore_config = ale#Var(a:buffer, 'linters_ignore')
|
|
||||||
let l:disable_lsp = ale#Var(a:buffer, 'disable_lsp')
|
|
||||||
let l:linters = !empty(l:ignore_config) || l:disable_lsp
|
|
||||||
\ ? ale#engine#ignore#Exclude(l:filetype, l:linters, l:ignore_config, l:disable_lsp)
|
|
||||||
\ : l:linters
|
|
||||||
|
|
||||||
" Tell other sources that they can start checking the buffer now.
|
|
||||||
let g:ale_want_results_buffer = a:buffer
|
|
||||||
silent doautocmd <nomodeline> User ALEWantResults
|
|
||||||
unlet! g:ale_want_results_buffer
|
|
||||||
|
|
||||||
" Don't set up buffer data and so on if there are no linters to run.
|
|
||||||
if !has_key(g:ale_buffer_info, a:buffer) && empty(l:linters)
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Clear lint_file linters, or only run them if the file exists.
|
|
||||||
let l:lint_file = empty(l:linters)
|
|
||||||
\ || (a:should_lint_file && filereadable(expand('#' . a:buffer . ':p')))
|
|
||||||
|
|
||||||
call ale#engine#RunLinters(a:buffer, l:linters, l:lint_file)
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" (delay, [linting_flag, buffer_number])
|
|
||||||
function! ale#Queue(delay, ...) abort
|
|
||||||
if a:0 > 2
|
|
||||||
throw 'too many arguments!'
|
|
||||||
endif
|
|
||||||
|
|
||||||
let l:buffer = get(a:000, 1, v:null)
|
|
||||||
|
|
||||||
if l:buffer is v:null
|
|
||||||
let l:buffer = bufnr('')
|
|
||||||
endif
|
|
||||||
|
|
||||||
if type(l:buffer) isnot v:t_number
|
|
||||||
throw 'buffer_number must be a Number'
|
|
||||||
endif
|
|
||||||
|
|
||||||
if ale#ShouldDoNothing(l:buffer)
|
|
||||||
return
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Default linting_flag to ''
|
|
||||||
let l:should_lint_file = get(a:000, 0) is# 'lint_file'
|
|
||||||
|
|
||||||
if s:lint_timer != -1
|
|
||||||
call timer_stop(s:lint_timer)
|
|
||||||
let s:lint_timer = -1
|
|
||||||
endif
|
|
||||||
|
|
||||||
if a:delay > 0
|
|
||||||
let s:lint_timer = timer_start(
|
|
||||||
\ a:delay,
|
|
||||||
\ function('s:Lint', [l:buffer, l:should_lint_file])
|
|
||||||
\)
|
|
||||||
else
|
|
||||||
call s:Lint(l:buffer, l:should_lint_file, 0)
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
let s:current_ale_version = [2, 7, 0]
|
|
||||||
|
|
||||||
" A function used to check for ALE features in files outside of the project.
|
|
||||||
function! ale#Has(feature) abort
|
|
||||||
let l:match = matchlist(a:feature, '\c\v^ale-(\d+)\.(\d+)(\.(\d+))?$')
|
|
||||||
|
|
||||||
if !empty(l:match)
|
|
||||||
let l:version = [l:match[1] + 0, l:match[2] + 0, l:match[4] + 0]
|
|
||||||
|
|
||||||
return ale#semver#GTE(s:current_ale_version, l:version)
|
|
||||||
endif
|
|
||||||
|
|
||||||
return 0
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Given a buffer number and a variable name, look for that variable in the
|
|
||||||
" buffer scope, then in global scope. If the name does not exist in the global
|
|
||||||
" scope, an exception will be thrown.
|
|
||||||
"
|
|
||||||
" Every variable name will be prefixed with 'ale_'.
|
|
||||||
function! ale#Var(buffer, variable_name) abort
|
|
||||||
let l:full_name = 'ale_' . a:variable_name
|
|
||||||
let l:vars = getbufvar(str2nr(a:buffer), '', {})
|
|
||||||
|
|
||||||
return get(l:vars, l:full_name, g:[l:full_name])
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Initialize a variable with a default value, if it isn't already set.
|
|
||||||
"
|
|
||||||
" Every variable name will be prefixed with 'ale_'.
|
|
||||||
function! ale#Set(variable_name, default) abort
|
|
||||||
let l:full_name = 'ale_' . a:variable_name
|
|
||||||
|
|
||||||
if !has_key(g:, l:full_name)
|
|
||||||
let g:[l:full_name] = a:default
|
|
||||||
endif
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Given a string for adding to a command, return the string padded with a
|
|
||||||
" space on the left if it is not empty. Otherwise return an empty string.
|
|
||||||
"
|
|
||||||
" This can be used for making command strings cleaner and easier to test.
|
|
||||||
function! ale#Pad(string) abort
|
|
||||||
return !empty(a:string) ? ' ' . a:string : ''
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Given a environment variable name and a value, produce part of a command for
|
|
||||||
" setting an environment variable before running a command. The syntax will be
|
|
||||||
" valid for cmd on Windows, or most shells on Unix.
|
|
||||||
function! ale#Env(variable_name, value) abort
|
|
||||||
if has('win32')
|
|
||||||
return 'set ' . a:variable_name . '=' . ale#Escape(a:value) . ' && '
|
|
||||||
endif
|
|
||||||
|
|
||||||
return a:variable_name . '=' . ale#Escape(a:value) . ' '
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Escape a string suitably for each platform.
|
|
||||||
" shellescape does not work on Windows.
|
|
||||||
function! ale#Escape(str) abort
|
|
||||||
if fnamemodify(&shell, ':t') is? 'cmd.exe'
|
|
||||||
" If the string contains spaces, it will be surrounded by quotes.
|
|
||||||
" Otherwise, special characters will be escaped with carets (^).
|
|
||||||
return substitute(
|
|
||||||
\ a:str =~# ' '
|
|
||||||
\ ? '"' . substitute(a:str, '"', '""', 'g') . '"'
|
|
||||||
\ : substitute(a:str, '\v([&|<>^])', '^\1', 'g'),
|
|
||||||
\ '%',
|
|
||||||
\ '%%',
|
|
||||||
\ 'g',
|
|
||||||
\)
|
|
||||||
endif
|
|
||||||
|
|
||||||
return shellescape (a:str)
|
|
||||||
endfunction
|
|
||||||
|
|
||||||
" Get the loclist item message according to a given format string.
|
|
||||||
"
|
|
||||||
" See `:help g:ale_loclist_msg_format` and `:help g:ale_echo_msg_format`
|
|
||||||
function! ale#GetLocItemMessage(item, format_string) abort
|
|
||||||
let l:msg = a:format_string
|
|
||||||
let l:severity = g:ale_echo_msg_warning_str
|
|
||||||
let l:code = get(a:item, 'code', '')
|
|
||||||
let l:type = get(a:item, 'type', 'E')
|
|
||||||
let l:linter_name = get(a:item, 'linter_name', '')
|
|
||||||
let l:code_repl = !empty(l:code) ? '\=submatch(1) . l:code . submatch(2)' : ''
|
|
||||||
|
|
||||||
if l:type is# 'E'
|
|
||||||
let l:severity = g:ale_echo_msg_error_str
|
|
||||||
elseif l:type is# 'I'
|
|
||||||
let l:severity = g:ale_echo_msg_info_str
|
|
||||||
endif
|
|
||||||
|
|
||||||
" Replace special markers with certain information.
|
|
||||||
" \=l:variable is used to avoid escaping issues.
|
|
||||||
let l:msg = substitute(l:msg, '\v\%([^\%]*)code([^\%]*)\%', l:code_repl, 'g')
|
|
||||||
let l:msg = substitute(l:msg, '\V%severity%', '\=l:severity', 'g')
|
|
||||||
let l:msg = substitute(l:msg, '\V%linter%', '\=l:linter_name', 'g')
|
|
||||||
" Replace %s with the text.
|
|
||||||
let l:msg = substitute(l:msg, '\V%s', '\=a:item.text', 'g')
|
|
||||||
|
|
||||||
return l:msg
|
|
||||||
endfunction
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Ada Integration *ale-ada-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gcc *ale-ada-gcc*
|
|
||||||
|
|
||||||
g:ale_ada_gcc_executable *g:ale_ada_gcc_executable*
|
|
||||||
*b:ale_ada_gcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gcc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for gcc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ada_gcc_options *g:ale_ada_gcc_options*
|
|
||||||
*b:ale_ada_gcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-gnatwa -gnatq'`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to gcc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gnatpp *ale-ada-gnatpp*
|
|
||||||
|
|
||||||
g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options*
|
|
||||||
*b:ale_ada_gnatpp_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass extra options to the gnatpp fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Ansible Integration *ale-ansible-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ansible-lint *ale-ansible-ansible-lint*
|
|
||||||
|
|
||||||
g:ale_ansible_ansible_lint_executable *g:ale_ansible_ansible_lint_executable*
|
|
||||||
*b:ale_ansible_ansible_lint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ansible-lint'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for ansible-lint.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE AsciiDoc Integration *ale-asciidoc-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-asciidoc-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
textlint *ale-asciidoc-textlint*
|
|
||||||
|
|
||||||
See |ale-text-textlint|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE ASM Integration *ale-asm-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gcc *ale-asm-gcc*
|
|
||||||
|
|
||||||
g:ale_asm_gcc_executable *g:ale_asm_gcc_executable*
|
|
||||||
*b:ale_asm_gcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gcc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for gcc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_asm_gcc_options *g:ale_asm_gcc_options*
|
|
||||||
*b:ale_asm_gcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-Wall'`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to gcc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Awk Integration *ale-awk-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gawk *ale-awk-gawk*
|
|
||||||
|
|
||||||
g:ale_awk_gawk_executable *g:ale_awk_gawk_executable*
|
|
||||||
*b:ale_awk_gawk_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gawk'`
|
|
||||||
|
|
||||||
This variable sets executable used for gawk.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_awk_gawk_options *g:ale_awk_gawk_options*
|
|
||||||
*b:ale_awk_gawk_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
With this variable we are able to pass extra arguments for gawk
|
|
||||||
for invocation.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Bats Integration *ale-bats-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
shellcheck *ale-bats-shellcheck*
|
|
||||||
|
|
||||||
The `shellcheck` linter for Bats uses the sh options for `shellcheck`; see:
|
|
||||||
|ale-sh-shellcheck|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE BibTeX Integration *ale-bib-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
bibclean *ale-bib-bibclean*
|
|
||||||
|
|
||||||
g:ale_bib_bibclean_executable *g:ale_bib_bibclean_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'bibclean'`
|
|
||||||
|
|
||||||
g:ale_bib_bibclean_options *g:ale_bib_bibclean_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-align-equals'`
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,333 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE C Integration *ale-c-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Global Options
|
|
||||||
|
|
||||||
g:ale_c_build_dir_names *g:ale_c_build_dir_names*
|
|
||||||
*b:ale_c_build_dir_names*
|
|
||||||
|
|
||||||
Type: |List|
|
|
||||||
Default: `['build', 'bin']`
|
|
||||||
|
|
||||||
A list of directory names to be used when searching upwards from cpp
|
|
||||||
files to discover compilation databases with. For directory named `'foo'`,
|
|
||||||
ALE will search for `'foo/compile_commands.json'` in all directories on and above
|
|
||||||
the directory containing the cpp file to find path to compilation database.
|
|
||||||
This feature is useful for the clang tools wrapped around LibTooling (namely
|
|
||||||
here, clang-tidy)
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_build_dir *g:ale_c_build_dir*
|
|
||||||
*b:ale_c_build_dir*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
For programs that can read `compile_commands.json` files, this option can be
|
|
||||||
set to the directory containing the file for the project. ALE will try to
|
|
||||||
determine the location of `compile_commands.json` automatically, but if your
|
|
||||||
file exists in some other directory, you can set this option so ALE will
|
|
||||||
know where it is.
|
|
||||||
|
|
||||||
This directory will be searched instead of |g:ale_c_build_dir_names|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
|
|
||||||
*b:ale_c_parse_compile_commands*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
If set to `1`, ALE will parse `compile_commands.json` files to automatically
|
|
||||||
determine flags for C or C++ compilers. ALE will first search for the
|
|
||||||
nearest `compile_commands.json` file, and then look for
|
|
||||||
`compile_commands.json` files in the directories for
|
|
||||||
|g:ale_c_build_dir_names|.
|
|
||||||
|
|
||||||
If |g:ale_c_parse_makefile| or |b:ale_c_parse_makefile| is set to `1`, the
|
|
||||||
output of `make -n` will be preferred over `compile_commands.json` files.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_parse_makefile *g:ale_c_parse_makefile*
|
|
||||||
*b:ale_c_parse_makefile*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
If set to `1`, ALE will run `make -n` to automatically determine flags to
|
|
||||||
set for C or C++ compilers. This can make it easier to determine the correct
|
|
||||||
build flags to use for different files.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang *ale-c-clang*
|
|
||||||
|
|
||||||
g:ale_c_clang_executable *g:ale_c_clang_executable*
|
|
||||||
*b:ale_c_clang_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clang.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clang_options *g:ale_c_clang_options*
|
|
||||||
*b:ale_c_clang_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c11 -Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangd *ale-c-clangd*
|
|
||||||
|
|
||||||
g:ale_c_clangd_executable *g:ale_c_clangd_executable*
|
|
||||||
*b:ale_c_clangd_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clangd'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangd.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangd_options *g:ale_c_clangd_options*
|
|
||||||
*b:ale_c_clangd_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clangd.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang-format *ale-c-clangformat*
|
|
||||||
|
|
||||||
g:ale_c_clangformat_executable *g:ale_c_clangformat_executable*
|
|
||||||
*b:ale_c_clangformat_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang-format'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clang-format.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangformat_options *g:ale_c_clangformat_options*
|
|
||||||
*b:ale_c_clangformat_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be change to modify flags given to clang-format.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangtidy *ale-c-clangtidy*
|
|
||||||
|
|
||||||
`clang-tidy` will be run only when files are saved to disk, so that
|
|
||||||
`compile_commands.json` files can be used. It is recommended to use this
|
|
||||||
linter in combination with `compile_commands.json` files.
|
|
||||||
Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
|
|
||||||
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
|
|
||||||
overrides |g:ale_c_build_dir_names|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangtidy_checks *g:ale_c_clangtidy_checks*
|
|
||||||
*b:ale_c_clangtidy_checks*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
The checks to enable for clang-tidy with the `-checks` argument.
|
|
||||||
|
|
||||||
All options will be joined with commas, and escaped appropriately for
|
|
||||||
the shell. The `-checks` flag can be removed entirely by setting this
|
|
||||||
option to an empty List.
|
|
||||||
|
|
||||||
Not all of clangtidy checks are applicable for C. You should consult the
|
|
||||||
clang documentation for an up-to-date list of compatible checks:
|
|
||||||
http://clang.llvm.org/extra/clang-tidy/checks/list.html
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangtidy_executable *g:ale_c_clangtidy_executable*
|
|
||||||
*b:ale_c_clangtidy_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang-tidy'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangtidy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangtidy_options *g:ale_c_clangtidy_options*
|
|
||||||
*b:ale_c_clangtidy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify compiler flags given to clang-tidy.
|
|
||||||
|
|
||||||
- Setting this variable to a non-empty string,
|
|
||||||
- and working in a buffer where no compilation database is found using
|
|
||||||
|g:ale_c_build_dir_names| or |g:ale_c_build_dir|,
|
|
||||||
will cause the `--` argument to be passed to `clang-tidy`, which will mean
|
|
||||||
that detection of `compile_commands.json` files for compile command
|
|
||||||
databases will be disabled.
|
|
||||||
Only set this option if you want to control compiler flags
|
|
||||||
entirely manually, and no `compile_commands.json` file is in one
|
|
||||||
of the |g:ale_c_build_dir_names| directories of the project tree.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangtidy_extra_options *g:ale_c_clangtidy_extra_options*
|
|
||||||
*b:ale_c_clangtidy_extra_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang-tidy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors*
|
|
||||||
*b:ale_c_clangtidy_fix_errors*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
This variable can be changed to disable the `-fix-errors` option for the
|
|
||||||
|clangtidy| fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cppcheck *ale-c-cppcheck*
|
|
||||||
|
|
||||||
g:ale_c_cppcheck_executable *g:ale_c_cppcheck_executable*
|
|
||||||
*b:ale_c_cppcheck_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cppcheck'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cppcheck.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
|
|
||||||
*b:ale_c_cppcheck_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--enable=style'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to cppcheck.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cquery *ale-c-cquery*
|
|
||||||
|
|
||||||
g:ale_c_cquery_executable *g:ale_c_cquery_executable*
|
|
||||||
*b:ale_c_cquery_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cquery'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cquery.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_cquery_cache_directory *g:ale_c_cquery_cache_directory*
|
|
||||||
*b:ale_c_cquery_cache_directory*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'~/.cache/cquery'`
|
|
||||||
|
|
||||||
This variable can be changed to decide which directory cquery uses for its
|
|
||||||
cache.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
flawfinder *ale-c-flawfinder*
|
|
||||||
|
|
||||||
g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable*
|
|
||||||
*b:ale_c_flawfinder_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'flawfinder'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for flawfinder.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel*
|
|
||||||
*b:ale_c_flawfinder_minlevel*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
This variable can be changed to ignore risks under the given risk threshold.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_flawfinder_options *g:ale-c-flawfinder*
|
|
||||||
*b:ale-c-flawfinder*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be used to pass extra options into the flawfinder command.
|
|
||||||
|
|
||||||
g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity*
|
|
||||||
*b:ale_c_flawfinder_error_severity*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `6`
|
|
||||||
|
|
||||||
This variable can be changed to set the minimum severity to be treated as an
|
|
||||||
error. This setting also applies to flawfinder for c++.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gcc *ale-c-gcc*
|
|
||||||
|
|
||||||
g:ale_c_gcc_executable *g:ale_c_gcc_executable*
|
|
||||||
*b:ale_c_gcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gcc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for gcc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_gcc_options *g:ale_c_gcc_options*
|
|
||||||
*b:ale_c_gcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c11 -Wall'`
|
|
||||||
|
|
||||||
This variable can be change to modify flags given to gcc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-c-uncrustify*
|
|
||||||
|
|
||||||
g:ale_c_uncrustify_executable *g:ale_c_uncrustify_executable*
|
|
||||||
*b:ale_c_uncrustify_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'uncrustify'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for uncrustify.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_uncrustify_options *g:ale_c_uncrustify_options*
|
|
||||||
*b:ale_c_uncrustify_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be change to modify flags given to uncrustify.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ccls *ale-c-ccls*
|
|
||||||
|
|
||||||
g:ale_c_ccls_executable *g:ale_c_ccls_executable*
|
|
||||||
*b:ale_c_ccls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ccls'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ccls.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_c_ccls_init_options *g:ale_c_ccls_init_options*
|
|
||||||
*b:ale_c_ccls_init_options*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
This variable can be changed to customize ccls initialization options.
|
|
||||||
Example: >
|
|
||||||
{
|
|
||||||
\ 'cacheDirectory': '/tmp/ccls',
|
|
||||||
\ 'cacheFormat': 'binary',
|
|
||||||
\ 'diagnostics': {
|
|
||||||
\ 'onOpen': 0,
|
|
||||||
\ 'opChange': 1000,
|
|
||||||
\ },
|
|
||||||
\ }
|
|
||||||
<
|
|
||||||
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
|
|
||||||
available options and explanations.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Chef Integration *ale-chef-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cookstyle *ale-chef-cookstyle*
|
|
||||||
|
|
||||||
g:ale_chef_cookstyle_options *g:ale_chef_cookstyle_options*
|
|
||||||
*b:ale_chef_cookstyle_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to cookstyle.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
|
|
||||||
*b:ale_chef_cookstyle_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cookstyle'`
|
|
||||||
|
|
||||||
This variable can be changed to point to the cookstyle binary in case it's
|
|
||||||
not on the $PATH or a specific version/path must be used.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
foodcritic *ale-chef-foodcritic*
|
|
||||||
|
|
||||||
g:ale_chef_foodcritic_options *g:ale_chef_foodcritic_options*
|
|
||||||
*b:ale_chef_foodcritic_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to foodcritic.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_chef_foodcritic_executable *g:ale_chef_foodcritic_executable*
|
|
||||||
*b:ale_chef_foodcritic_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'foodcritic'`
|
|
||||||
|
|
||||||
This variable can be changed to point to the foodcritic binary in case it's
|
|
||||||
not on the $PATH or a specific version/path must be used.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Clojure Integration *ale-clojure-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clj-kondo *ale-clojure-clj-kondo*
|
|
||||||
|
|
||||||
A minimal and opinionated linter for code that sparks joy.
|
|
||||||
|
|
||||||
https://github.com/borkdude/clj-kondo
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
joker *ale-clojure-joker*
|
|
||||||
|
|
||||||
Joker is a small Clojure interpreter and linter written in Go.
|
|
||||||
|
|
||||||
https://github.com/candid82/joker
|
|
||||||
|
|
||||||
Linting options are not configurable by ale, but instead are controlled by a
|
|
||||||
`.joker` file in same directory as the file (or current working directory if
|
|
||||||
linting stdin), a parent directory relative to the file, or the users home
|
|
||||||
directory.
|
|
||||||
|
|
||||||
see https://github.com/candid82/joker#linter-mode for more information.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE CloudFormation Integration *ale-cloudformation-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cfn-python-lint *ale-cloudformation-cfn-python-lint*
|
|
||||||
|
|
||||||
cfn-python-lint is a linter for AWS CloudFormation template file.
|
|
||||||
|
|
||||||
Website: https://github.com/awslabs/cfn-python-lint
|
|
||||||
|
|
||||||
Installation
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
Install cfn-python-lint using either pip or brew: >
|
|
||||||
|
|
||||||
`pip install cfn-lint`. If pip is not available, run
|
|
||||||
`python setup.py clean --all` then `python setup.py install`.
|
|
||||||
|
|
||||||
Homebrew (macOS):
|
|
||||||
|
|
||||||
`brew install cfn-lint`
|
|
||||||
|
|
||||||
<
|
|
||||||
Configuration
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
To get cloudformation linter to work on only CloudFormation files we must set
|
|
||||||
the buffer |filetype| to yaml.cloudformation.
|
|
||||||
This causes ALE to lint the file with linters configured for cloudformation and
|
|
||||||
yaml files.
|
|
||||||
|
|
||||||
Just put:
|
|
||||||
|
|
||||||
>
|
|
||||||
|
|
||||||
au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
|
|
||||||
|
|
||||||
<
|
|
||||||
|
|
||||||
on `ftdetect/cloudformation.vim`
|
|
||||||
|
|
||||||
This will get both cloudformation and yaml linters to work on any file with `.template.yaml` ext.
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE CMake Integration *ale-cmake-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cmakelint *ale-cmake-cmakelint*
|
|
||||||
|
|
||||||
g:ale_cmake_cmakelint_executable *g:ale_cmake_cmakelint_executable*
|
|
||||||
*b:ale_cmake_cmakelint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cmakelint'`
|
|
||||||
|
|
||||||
This variable can be set to change the path the cmakelint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options*
|
|
||||||
*b:ale_cmake_cmakelint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to cmakelint.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cmake-format *ale-cmake-cmakeformat*
|
|
||||||
|
|
||||||
g:ale_cmake_cmakeformat_executable *g:ale_cmake_cmakeformat_executable*
|
|
||||||
*b:ale_cmake_cmakeformat_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cmakeformat'`
|
|
||||||
|
|
||||||
This variable can be set to change the path the cmake-format.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cmake_cmakeformat_options *g:ale_cmake_cmakeformat_options*
|
|
||||||
*b:ale_cmake_cmakeformat_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to cmake-format.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,331 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE C++ Integration *ale-cpp-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Global Options
|
|
||||||
|
|
||||||
The following C options also apply to some C++ linters too.
|
|
||||||
|
|
||||||
* |g:ale_c_build_dir_names|
|
|
||||||
* |g:ale_c_build_dir|
|
|
||||||
* |g:ale_c_parse_makefile|
|
|
||||||
* |g:ale_c_parse_compile_commands|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang *ale-cpp-clang*
|
|
||||||
|
|
||||||
g:ale_cpp_clang_executable *g:ale_cpp_clang_executable*
|
|
||||||
*b:ale_cpp_clang_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang++'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clang.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clang_options *g:ale_cpp_clang_options*
|
|
||||||
*b:ale_cpp_clang_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c++14 -Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangd *ale-cpp-clangd*
|
|
||||||
|
|
||||||
g:ale_cpp_clangd_executable *g:ale_cpp_clangd_executable*
|
|
||||||
*b:ale_cpp_clangd_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clangd'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangd.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangd_options *g:ale_cpp_clangd_options*
|
|
||||||
*b:ale_cpp_clangd_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clangd.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangcheck *ale-cpp-clangcheck*
|
|
||||||
|
|
||||||
`clang-check` will be run only when files are saved to disk, so that
|
|
||||||
`compile_commands.json` files can be used. It is recommended to use this
|
|
||||||
linter in combination with `compile_commands.json` files.
|
|
||||||
Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
|
|
||||||
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
|
|
||||||
overrides |g:ale_c_build_dir_names|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangcheck_executable *g:ale_cpp_clangcheck_executable*
|
|
||||||
*b:ale_cpp_clangcheck_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang-check'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangcheck.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
|
|
||||||
*b:ale_cpp_clangcheck_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang-check.
|
|
||||||
|
|
||||||
This variable should not be set to point to build subdirectory with
|
|
||||||
`-p path/to/build` option, as it is handled by the |g:ale_c_build_dir|
|
|
||||||
option.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang-format *ale-cpp-clangformat*
|
|
||||||
|
|
||||||
See |ale-c-clangformat| for information about the available options.
|
|
||||||
Note that the C options are also used for C++.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangtidy *ale-cpp-clangtidy*
|
|
||||||
|
|
||||||
`clang-tidy` will be run only when files are saved to disk, so that
|
|
||||||
`compile_commands.json` files can be used. It is recommended to use this
|
|
||||||
linter in combination with `compile_commands.json` files.
|
|
||||||
Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
|
|
||||||
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
|
|
||||||
overrides |g:ale_c_build_dir_names|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks*
|
|
||||||
*b:ale_cpp_clangtidy_checks*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
The checks to enable for clang-tidy with the `-checks` argument.
|
|
||||||
|
|
||||||
All options will be joined with commas, and escaped appropriately for
|
|
||||||
the shell. The `-checks` flag can be removed entirely by setting this
|
|
||||||
option to an empty List.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangtidy_executable *g:ale_cpp_clangtidy_executable*
|
|
||||||
*b:ale_cpp_clangtidy_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clang-tidy'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangtidy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
|
|
||||||
*b:ale_cpp_clangtidy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify compiler flags given to clang-tidy.
|
|
||||||
|
|
||||||
- Setting this variable to a non-empty string,
|
|
||||||
- and working in a buffer where no compilation database is found using
|
|
||||||
|g:ale_c_build_dir_names| or |g:ale_c_build_dir|,
|
|
||||||
will cause the `--` argument to be passed to `clang-tidy`, which will mean
|
|
||||||
that detection of `compile_commands.json` files for compile command
|
|
||||||
databases will be disabled.
|
|
||||||
Only set this option if you want to control compiler flags
|
|
||||||
entirely manually, and no `compile_commands.json` file is in one
|
|
||||||
of the |g:ale_c_build_dir_names| directories of the project tree.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangtidy_extra_options *g:ale_cpp_clangtidy_extra_options*
|
|
||||||
*b:ale_cpp_clangtidy_extra_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang-tidy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors*
|
|
||||||
*b:ale_cpp_clangtidy_fix_errors*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
This variable can be changed to disable the `-fix-errors` option for the
|
|
||||||
|clangtidy| fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clazy *ale-cpp-clazy*
|
|
||||||
|
|
||||||
g:ale_cpp_clazy_executable *g:ale_cpp_clazy_executable*
|
|
||||||
*b:ale_cpp_clazy_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clazy-standalone'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clazy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks*
|
|
||||||
*b:ale_cpp_clazy_checks*
|
|
||||||
Type: |List|
|
|
||||||
Default: `['level1']`
|
|
||||||
|
|
||||||
The checks to enable for clazy with the `-checks` argument.
|
|
||||||
|
|
||||||
All options will be joined with commas, and escaped appropriately for
|
|
||||||
the shell. The `-checks` flag can be removed entirely by setting this
|
|
||||||
option to an empty List.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
|
|
||||||
*b:ale_cpp_clazy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clazy.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cppcheck *ale-cpp-cppcheck*
|
|
||||||
|
|
||||||
g:ale_cpp_cppcheck_executable *g:ale_cpp_cppcheck_executable*
|
|
||||||
*b:ale_cpp_cppcheck_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cppcheck'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cppcheck.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
|
|
||||||
*b:ale_cpp_cppcheck_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--enable=style'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to cppcheck.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cpplint *ale-cpp-cpplint*
|
|
||||||
|
|
||||||
g:ale_cpp_cpplint_executable *g:ale_cpp_cpplint_executable*
|
|
||||||
*b:ale_cpp_cpplint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cpplint'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cpplint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options*
|
|
||||||
*b:ale_cpp_cpplint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to cpplint.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cquery *ale-cpp-cquery*
|
|
||||||
|
|
||||||
g:ale_cpp_cquery_executable *g:ale_cpp_cquery_executable*
|
|
||||||
*b:ale_cpp_cquery_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cquery'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cquery.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory*
|
|
||||||
*b:ale_cpp_cquery_cache_directory*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'~/.cache/cquery'`
|
|
||||||
|
|
||||||
This variable can be changed to decide which directory cquery uses for its
|
|
||||||
cache.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
flawfinder *ale-cpp-flawfinder*
|
|
||||||
|
|
||||||
g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable*
|
|
||||||
*b:ale_cpp_flawfinder_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'flawfinder'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for flawfinder.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_flawfinder_minlevel *g:ale_cpp_flawfinder_minlevel*
|
|
||||||
*b:ale_cpp_flawfinder_minlevel*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
This variable can be changed to ignore risks under the given risk threshold.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder*
|
|
||||||
*b:ale-cpp-flawfinder*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be used to pass extra options into the flawfinder command.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gcc *ale-cpp-gcc*
|
|
||||||
|
|
||||||
g:ale_cpp_gcc_executable *g:ale_cpp_gcc_executable*
|
|
||||||
*b:ale_cpp_gcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gcc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for gcc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
|
|
||||||
*b:ale_cpp_gcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c++14 -Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to gcc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-cpp-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ccls *ale-cpp-ccls*
|
|
||||||
|
|
||||||
g:ale_cpp_ccls_executable *g:ale_cpp_ccls_executable*
|
|
||||||
*b:ale_cpp_ccls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ccls'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ccls.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cpp_ccls_init_options *g:ale_cpp_ccls_init_options*
|
|
||||||
*b:ale_cpp_ccls_init_options*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
This variable can be changed to customize ccls initialization options.
|
|
||||||
Example: >
|
|
||||||
{
|
|
||||||
\ 'cacheDirectory': '/tmp/ccls',
|
|
||||||
\ 'cacheFormat': 'binary',
|
|
||||||
\ 'diagnostics': {
|
|
||||||
\ 'onOpen': 0,
|
|
||||||
\ 'opChange': 1000,
|
|
||||||
\ },
|
|
||||||
\ }
|
|
||||||
<
|
|
||||||
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
|
|
||||||
available options and explanations.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,197 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE C# Integration *ale-cs-options*
|
|
||||||
|
|
||||||
|
|
||||||
In addition to the linters that are provided with ALE, C# code can be checked
|
|
||||||
with the OmniSharp plugin. See here: https://github.com/OmniSharp/omnisharp-vim
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
csc *ale-cs-csc*
|
|
||||||
|
|
||||||
The |ale-cs-csc| linter checks for semantic errors when files are opened or
|
|
||||||
saved.
|
|
||||||
|
|
||||||
See |ale-lint-file-linters| for more information on linters which do not
|
|
||||||
check for problems while you type.
|
|
||||||
|
|
||||||
The csc linter uses the mono csc compiler, providing full C# 7 and newer
|
|
||||||
support, to generate a temporary module target file (/t:module). The module
|
|
||||||
includes all '*.cs' files contained in the directory tree rooted at the path
|
|
||||||
defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source| variable and
|
|
||||||
all sub directories.
|
|
||||||
|
|
||||||
It will in future replace the |ale-cs-mcs| and |ale-cs-mcsc| linters as both
|
|
||||||
utilize the mcsc compiler which, according to the mono project, is no longer
|
|
||||||
actively developed, and only receives maintenance updates. However, because
|
|
||||||
the csc compiler does not support the -syntax option, this linter does not
|
|
||||||
offer any as-you-type syntax checking, similar to the |ale-cs-mcsc| linter.
|
|
||||||
|
|
||||||
The paths to search for additional assembly files can be specified using the
|
|
||||||
|g:ale_cs_csc_assembly_path| or |b:ale_cs_csc_assembly_path| variables.
|
|
||||||
|
|
||||||
NOTE: ALE will not find any errors in files apart from syntax errors if any
|
|
||||||
one of the source files contains a syntax error. Syntax errors must be fixed
|
|
||||||
first before other errors will be shown.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_csc_options *g:ale_cs_csc_options*
|
|
||||||
*b:ale_cs_csc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This option can be set to pass additional arguments to the `csc` compiler.
|
|
||||||
|
|
||||||
For example, to add the dotnet package which is not added per default: >
|
|
||||||
|
|
||||||
let g:ale_cs_mcs_options = ' /warn:4 /langversion:7.2'
|
|
||||||
<
|
|
||||||
NOTE: the `/unsafe` option is always passed to `csc`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_csc_source *g:ale_cs_csc_source*
|
|
||||||
*b:ale_cs_csc_source*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable defines the root path of the directory tree searched for the
|
|
||||||
'*.cs' files to be linted. If this option is empty, the source file's
|
|
||||||
directory will be used.
|
|
||||||
|
|
||||||
NOTE: Currently it is not possible to specify sub directories and
|
|
||||||
directory sub trees which shall not be searched for *.cs files.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_csc_assembly_path *g:ale_cs_csc_assembly_path*
|
|
||||||
*b:ale_cs_csc_assembly_path*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
This variable defines a list of path strings to be searched for external
|
|
||||||
assembly files. The list is passed to the csc compiler using the `/lib:`
|
|
||||||
flag.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies*
|
|
||||||
*b:ale_cs_csc_assemblies*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
This variable defines a list of external assembly (*.dll) files required
|
|
||||||
by the mono mcs compiler to generate a valid module target. The list is
|
|
||||||
passed the csc compiler using the `/r:` flag.
|
|
||||||
|
|
||||||
For example: >
|
|
||||||
|
|
||||||
" Compile C# programs with the Unity engine DLL file on Mac.
|
|
||||||
let g:ale_cs_mcsc_assemblies = [
|
|
||||||
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
|
|
||||||
\ 'path-to-unityproject/obj/Debug',
|
|
||||||
\]
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mcs *ale-cs-mcs*
|
|
||||||
|
|
||||||
The `mcs` linter looks only for syntax errors while you type. See
|
|
||||||
|ale-cs-mcsc| for the separately configured linter for checking for semantic
|
|
||||||
errors.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_mcs_options *g:ale_cs_mcs_options*
|
|
||||||
*b:ale_cs_mcs_options*
|
|
||||||
|
|
||||||
Type: String
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to pass additional flags given to mcs.
|
|
||||||
|
|
||||||
NOTE: The -unsafe flag is selected implicitly and thus does not need to be
|
|
||||||
explicitly included in the |g:ale_cs_mcs_options| or |b:ale_cs_mcs_options|
|
|
||||||
parameter.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mcsc *ale-cs-mcsc*
|
|
||||||
|
|
||||||
The mcsc linter checks for semantic errors when files are opened or saved
|
|
||||||
See |ale-lint-file-linters| for more information on linters which do not
|
|
||||||
check for problems while you type.
|
|
||||||
|
|
||||||
The mcsc linter uses the mono mcs compiler to generate a temporary module
|
|
||||||
target file (-t:module). The module includes including all '*.cs' files
|
|
||||||
contained in the directory tree rooted at the path defined by the
|
|
||||||
|g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable.
|
|
||||||
variable and all sub directories.
|
|
||||||
|
|
||||||
The paths to search for additional assembly files can be specified using the
|
|
||||||
|g:ale_cs_mcsc_assembly_path| or |b:ale_cs_mcsc_assembly_path| variables.
|
|
||||||
|
|
||||||
NOTE: ALE will not find any errors in files apart from syntax errors if any
|
|
||||||
one of the source files contains a syntax error. Syntax errors must be fixed
|
|
||||||
first before other errors will be shown.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_mcsc_options *g:ale_cs_mcsc_options*
|
|
||||||
*b:ale_cs_mcsc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This option can be set to pass additional arguments to the `mcs` compiler.
|
|
||||||
|
|
||||||
For example, to add the dotnet package which is not added per default: >
|
|
||||||
|
|
||||||
let g:ale_cs_mcs_options = '-pkg:dotnet'
|
|
||||||
<
|
|
||||||
NOTE: the `-unsafe` option is always passed to `mcs`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_mcsc_source *g:ale_cs_mcsc_source*
|
|
||||||
*b:ale_cs_mcsc_source*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable defines the root path of the directory tree searched for the
|
|
||||||
'*.cs' files to be linted. If this option is empty, the source file's
|
|
||||||
directory will be used.
|
|
||||||
|
|
||||||
NOTE: Currently it is not possible to specify sub directories and
|
|
||||||
directory sub trees which shall not be searched for *.cs files.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path*
|
|
||||||
*b:ale_cs_mcsc_assembly_path*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
This variable defines a list of path strings to be searched for external
|
|
||||||
assembly files. The list is passed to the mcs compiler using the `-lib:`
|
|
||||||
flag.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
|
|
||||||
*b:ale_cs_mcsc_assemblies*
|
|
||||||
Type: |List|
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
This variable defines a list of external assembly (*.dll) files required
|
|
||||||
by the mono mcs compiler to generate a valid module target. The list is
|
|
||||||
passed the mcs compiler using the `-r:` flag.
|
|
||||||
|
|
||||||
For example: >
|
|
||||||
|
|
||||||
" Compile C# programs with the Unity engine DLL file on Mac.
|
|
||||||
let g:ale_cs_mcsc_assemblies = [
|
|
||||||
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
|
|
||||||
\ 'path-to-unityproject/obj/Debug',
|
|
||||||
\]
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-cs-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE CSS Integration *ale-css-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
fecs *ale-css-fecs*
|
|
||||||
|
|
||||||
`fecs` options for CSS is the same as the options for JavaScript, and both of
|
|
||||||
them reads `./.fecsrc` as the default configuration file. See:
|
|
||||||
|ale-javascript-fecs|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-css-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stylelint *ale-css-stylelint*
|
|
||||||
|
|
||||||
g:ale_css_stylelint_executable *g:ale_css_stylelint_executable*
|
|
||||||
*b:ale_css_stylelint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'stylelint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_css_stylelint_options *g:ale_css_stylelint_options*
|
|
||||||
*b:ale_css_stylelint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to stylelint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
|
|
||||||
*b:ale_css_stylelint_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE CUDA Integration *ale-cuda-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nvcc *ale-cuda-nvcc*
|
|
||||||
|
|
||||||
g:ale_cuda_nvcc_executable *g:ale_cuda_nvcc_executable*
|
|
||||||
*b:ale_cuda_nvcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'nvcc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for nvcc.
|
|
||||||
Currently only nvcc 8.0 is supported.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options*
|
|
||||||
*b:ale_cuda_nvcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c++11'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to nvcc.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang-format *ale-cuda-clangformat*
|
|
||||||
|
|
||||||
See |ale-c-clangformat| for information about the available options.
|
|
||||||
Note that the C options are also used for cuda.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE D Integration *ale-d-options*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dfmt *ale-d-dfmt*
|
|
||||||
|
|
||||||
g:ale_d_dfmt_options *g:ale_d_dfmt_options*
|
|
||||||
*b:ale_d_dfmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the dfmt fixer.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dls *ale-d-dls*
|
|
||||||
|
|
||||||
g:ale_d_dls_executable *g:ale_d_dls_executable*
|
|
||||||
*b:ale_d_dls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `dls`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-d-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Dart Integration *ale-dart-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dartanalyzer *ale-dart-dartanalyzer*
|
|
||||||
|
|
||||||
Installation
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
Install Dart via whatever means. `dartanalyzer` will be included in the SDK.
|
|
||||||
|
|
||||||
You can add the SDK to `$PATH`, as described here:
|
|
||||||
https://www.dartlang.org/tools/sdk
|
|
||||||
|
|
||||||
If you have installed Dart on Linux, you can also try the following: >
|
|
||||||
" Set the executable path for dartanalyzer to the absolute path to it.
|
|
||||||
let g:ale_dart_dartanalyzer_executable = '/usr/lib/dart/bin/dartanalyzer'
|
|
||||||
<
|
|
||||||
... or similarly for wherever your Dart SDK lives. This should work without
|
|
||||||
having to modify `$PATH`.
|
|
||||||
|
|
||||||
ALE can only check for problems with `dartanalyzer` with the file on disk.
|
|
||||||
See |ale-lint-file-linters|
|
|
||||||
|
|
||||||
Options
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
g:ale_dart_dartanalyzer_executable *g:ale_dart_dartanalyzer_executable*
|
|
||||||
*b:ale_dart_dartanalyzer_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'dartanalyzer'`
|
|
||||||
|
|
||||||
This variable can be set to change the path to dartanalyzer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dartfmt *ale-dart-dartfmt*
|
|
||||||
|
|
||||||
Installation
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
Installing Dart should probably ensure that `dartfmt` is in your `$PATH`.
|
|
||||||
|
|
||||||
In case it is not, try to set the executable option to its absolute path. : >
|
|
||||||
" Set the executable path for dartfmt to the absolute path to it.
|
|
||||||
let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt'
|
|
||||||
>
|
|
||||||
|
|
||||||
Options
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
g:ale_dart_dartfmt_executable *g:ale_dart_dartfmt_executable*
|
|
||||||
*b:ale_dart_dartfmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to specify an absolute path to the
|
|
||||||
dartfmt executable (or to specify an alternate executable).
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_dart_dartfmt_options *g:ale_dart_dartfmt_options*
|
|
||||||
*b:ale_dart_dartfmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the dartfmt fixer.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,357 +0,0 @@
|
|||||||
*ale-development.txt* For Vim version 8.0.
|
|
||||||
*ale-dev*
|
|
||||||
*ale-development*
|
|
||||||
|
|
||||||
ALE Development Documentation
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
CONTENTS *ale-development-contents*
|
|
||||||
|
|
||||||
1. Introduction.........................|ale-development-introduction|
|
|
||||||
2. Design Goals.........................|ale-design-goals|
|
|
||||||
3. Coding Standards.....................|ale-coding-standards|
|
|
||||||
4. Testing ALE..........................|ale-development-tests|
|
|
||||||
4.1. Writing Linter Tests.............|ale-development-linter-tests|
|
|
||||||
4.2. Writing Fixer Tests..............|ale-development-fixer-tests|
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
1. Introduction *ale-development-introduction*
|
|
||||||
|
|
||||||
This document contains helpful information for ALE developers, including
|
|
||||||
design goals, information on how to run the tests, coding standards, and so
|
|
||||||
on. You should read this document if you want to get involved with ALE
|
|
||||||
development.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
2. Design Goals *ale-design-goals*
|
|
||||||
|
|
||||||
This section lists design goals for ALE, in no particular order. They are as
|
|
||||||
follows.
|
|
||||||
|
|
||||||
ALE code should be almost 100% VimL. This makes the plugin as portable as
|
|
||||||
possible.
|
|
||||||
|
|
||||||
ALE should run without needing any other plugins to be installed, to make
|
|
||||||
installation simple. ALE can integrate with other plugins for more advanced
|
|
||||||
functionality, non-essential functionality, or improving on basic first party
|
|
||||||
functionality.
|
|
||||||
|
|
||||||
ALE should check files with as many tools as possible by default, except where
|
|
||||||
they cause security issues or make excessive use of resources on modern
|
|
||||||
machines.
|
|
||||||
|
|
||||||
ALE should be free of breaking changes to the public API, which is comprised of
|
|
||||||
documented functions and options, until a major version is planned. Breaking
|
|
||||||
changes should be preceded by a deprecation phase complete with warnings.
|
|
||||||
Changes required for security may be an exception.
|
|
||||||
|
|
||||||
ALE supports Vim 8 and above, and NeoVim 0.2.0 or newer. These are the
|
|
||||||
earliest versions of Vim and NeoVim which support |job|, |timer|, |closure|,
|
|
||||||
and |lambda| features. All ALE code should be written so it is compatible with
|
|
||||||
these versions of Vim, or with version checks so particular features can
|
|
||||||
degrade or fail gracefully.
|
|
||||||
|
|
||||||
Just about everything should be documented and covered with tests.
|
|
||||||
|
|
||||||
By and large, people shouldn't pay for the functionality they don't use. Care
|
|
||||||
should be taken when adding new features, so supporting new features doesn't
|
|
||||||
degrade the general performance of anything ALE does.
|
|
||||||
|
|
||||||
LSP support will become more important as time goes on. ALE should provide
|
|
||||||
better support for LSP features as time goes on.
|
|
||||||
|
|
||||||
When merging pull requests, you should respond with `Cheers! :beers:`, purely
|
|
||||||
for comedy value.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
3. Coding Standards *ale-coding-standards*
|
|
||||||
|
|
||||||
The following general coding standards should be adhered to for Vim code.
|
|
||||||
|
|
||||||
* Check your Vim code with `Vint` and do everything it says. ALE will check
|
|
||||||
your Vim code with Vint automatically. See: https://github.com/Kuniwak/vint
|
|
||||||
Read ALE's `Dockerfile` to see which version of `Vint` it uses.
|
|
||||||
* Try to write descriptive and concise names for variables and functions.
|
|
||||||
Names shouldn't be too short or too long. Think about others reading your
|
|
||||||
code later on.
|
|
||||||
* Use `snake_case` names for variables and arguments, and `PascalCase` names
|
|
||||||
for functions. Prefix every variable name with its scope. (`l:`, `g:`, etc.)
|
|
||||||
* Try to keep lines no longer than 80 characters, but this isn't an absolute
|
|
||||||
requirement.
|
|
||||||
* Use 4 spaces for every level of indentation in Vim code.
|
|
||||||
* Add a blank line before every `function`, `if`, `for`, `while`, or `return`,
|
|
||||||
which doesn't start a new level of indentation. This makes the logic in
|
|
||||||
your code easier to follow.
|
|
||||||
* End every file with a trailing newline character, but not with extra blank
|
|
||||||
lines. Remove trailing whitespace from the ends of lines.
|
|
||||||
* Write the full names of commands instead of abbreviations. For example, write
|
|
||||||
`function` instead of `func`, and `endif` instead of `end`.
|
|
||||||
* Write functions with `!`, so files can be reloaded. Use the |abort| keyword
|
|
||||||
for all functions, so functions exit on the first error.
|
|
||||||
* Make sure to credit yourself in files you have authored with `Author:`
|
|
||||||
and `Description:` comments.
|
|
||||||
|
|
||||||
In addition to the above general guidelines for the style of your code, you
|
|
||||||
should also follow some additional rules designed to prevent mistakes. Some of
|
|
||||||
these are reported with ALE's `custom-linting-rules` script. See
|
|
||||||
|ale-development-tests|.
|
|
||||||
|
|
||||||
* Don't leave stray `:echo` lines in code. Use `execute 'echo' ...` if you must
|
|
||||||
echo something.
|
|
||||||
* For strings use |is#| instead of |==#|, `is?` instead of `==?`, `isnot#`
|
|
||||||
instead of `!=#`, and `isnot?` instead of `!=?`. This is because `'x' ==# 0`
|
|
||||||
returns 1, while `'x' is# 0` returns 0, so you will experience fewer issues
|
|
||||||
when numbers are compared with strings. `is` and `isnot` also do not throw
|
|
||||||
errors when other objects like List or Dictionaries are compared with
|
|
||||||
strings.
|
|
||||||
* Don't use the `getcwd()` function in the ALE codebase. Most of ALE's code
|
|
||||||
runs from asynchronous callback functions, and these functions can execute
|
|
||||||
from essentially random buffers. Therefore, the `getcwd()` output is
|
|
||||||
useless. Use `expand('#' . a:buffer . ':p:h')` instead. Don't use
|
|
||||||
`expand('%...')` for the same reason.
|
|
||||||
* Don't use the `simplify()` function. It doesn't simplify paths enough. Use
|
|
||||||
`ale#path#Simplify()` instead.
|
|
||||||
* Don't use the `shellescape()` function. It doesn't escape arguments properly
|
|
||||||
on Windows. Use `ale#Escape()` instead, which will avoid escaping where it
|
|
||||||
isn't needed, and generally escape arguments better on Windows.
|
|
||||||
* Don't use the `tempname()` function. It doesn't work when `$TMPDIR` isn't
|
|
||||||
set. Use `ale#util#Tempname()` instead, which temporarily sets `$TMPDIR`
|
|
||||||
appropriately where needed.
|
|
||||||
* Use `snake_case` names for linter names, so they can be used as part of
|
|
||||||
variable names. You can define `aliases` for linters, for other names people
|
|
||||||
might try to configure linters with.
|
|
||||||
* Use |v:t_TYPE| variables instead of `type()`, which are more readable.
|
|
||||||
|
|
||||||
Apply the following guidelines when writing Vader test files.
|
|
||||||
|
|
||||||
* Use 2 spaces for Vader test files, instead of the 4 spaces for Vim files.
|
|
||||||
* If you write `Before` and `After` blocks, you should typically write them at
|
|
||||||
the top of the file, so they run for all tests. There may be some tests
|
|
||||||
where it make sense to modify the `Before` and `After` code part of the way
|
|
||||||
through the file.
|
|
||||||
* If you modify any settings or global variables, reset them in `After`
|
|
||||||
blocks. The Vader `Save` and `Restore` commands can be useful for this
|
|
||||||
purpose.
|
|
||||||
* If you load or define linters in tests, write `call ale#linter#Reset()` in
|
|
||||||
an `After` block.
|
|
||||||
* Just write `Execute` blocks for Vader tests, and don't bother writing `Then`
|
|
||||||
blocks. `Then` blocks execute after `After` blocks in older versions, and
|
|
||||||
that can be confusing.
|
|
||||||
|
|
||||||
Apply the following rules when writing Bash scripts.
|
|
||||||
|
|
||||||
* Run `shellcheck`, and do everything it says.
|
|
||||||
See: https://github.com/koalaman/shellcheck
|
|
||||||
* Try to write scripts so they will run on Linux, BSD, or Mac OSX.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests*
|
|
||||||
|
|
||||||
ALE is tested with a suite of tests executed in Travis CI and AppVeyor. ALE
|
|
||||||
runs tests with the following versions of Vim in the following environments.
|
|
||||||
|
|
||||||
1. Vim 8.0.0027 on Linux via Travis CI.
|
|
||||||
2. Vim 8.1.0519 on Linux via Travis CI.
|
|
||||||
3. NeoVim 0.2.0 on Linux via Travis CI.
|
|
||||||
4. NeoVim 0.3.5 on Linux via Travis CI.
|
|
||||||
5. Vim 8 (stable builds) on Windows via AppVeyor.
|
|
||||||
|
|
||||||
If you are developing ALE code on Linux, Mac OSX, or BSD, you can run ALEs
|
|
||||||
tests by installing Docker and running the `run-tests` script. Follow the
|
|
||||||
instructions on the Docker site for installing Docker.
|
|
||||||
See: https://docs.docker.com/install/
|
|
||||||
|
|
||||||
NOTE: Don't forget to add your user to the `docker` group on Linux, or Docker
|
|
||||||
just won't work. See: https://docs.docker.com/install/linux/linux-postinstall/
|
|
||||||
|
|
||||||
If you run simply `./run-tests` from the ALE repository root directory, the
|
|
||||||
latest Docker image for tests will be downloaded if needed, and the script
|
|
||||||
will run all of the tests in Vader, Vint checks, and several Bash scripts for
|
|
||||||
finding extra issues. Run `./run-tests --help` to see all of the options the
|
|
||||||
script supports. Note that the script supports selecting particular test files.
|
|
||||||
|
|
||||||
Generally write tests for any changes you make. The following types of tests
|
|
||||||
are recommended for the following types of code.
|
|
||||||
|
|
||||||
* New/edited error handler callbacks -> Write tests in `test/handler`
|
|
||||||
* New/edited command callbacks -> Write tests in `test/command_callback`
|
|
||||||
* New/edited fixer functions -> Write tests in `test/fixers`
|
|
||||||
|
|
||||||
Look at existing tests in the codebase for examples of how to write tests.
|
|
||||||
Refer to the Vader documentation for general information on how to write Vader
|
|
||||||
tests: https://github.com/junegunn/vader.vim
|
|
||||||
|
|
||||||
See |ale-development-linter-tests| for more information on how to write linter
|
|
||||||
tests.
|
|
||||||
|
|
||||||
When you add new linters or fixers, make sure to add them into the tables in
|
|
||||||
supported-tools.md and |ale-supported-languages-and-tools.txt|. If you forget to
|
|
||||||
keep them both in sync, you should see an error like the following in Travis CI.
|
|
||||||
>
|
|
||||||
========================================
|
|
||||||
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
|
|
||||||
========================================
|
|
||||||
Differences follow:
|
|
||||||
|
|
||||||
--- /tmp/readme.qLjNhJdB 2018-07-01 16:29:55.590331972 +0100
|
|
||||||
+++ /tmp/doc.dAi8zfVE 2018-07-01 16:29:55.582331877 +0100
|
|
||||||
@@ -1 +1 @@
|
|
||||||
- ASM: gcc, foobar
|
|
||||||
+ ASM: gcc
|
|
||||||
<
|
|
||||||
Make sure to list documentation entries for linters and fixers in individual
|
|
||||||
help files in the table of contents, and to align help tags to the right
|
|
||||||
margin. For example, if you add a heading for an `aardvark` tool to
|
|
||||||
`ale-python.txt` with a badly aligned doc tag, you will see errors like so. >
|
|
||||||
|
|
||||||
========================================
|
|
||||||
Look for badly aligned doc tags
|
|
||||||
========================================
|
|
||||||
Badly aligned tags follow:
|
|
||||||
|
|
||||||
doc/ale-python.txt:aardvark ...
|
|
||||||
========================================
|
|
||||||
Look for table of contents issues
|
|
||||||
========================================
|
|
||||||
|
|
||||||
Check for bad ToC sorting:
|
|
||||||
|
|
||||||
Check for mismatched ToC and headings:
|
|
||||||
|
|
||||||
--- /tmp/table-of-contents.mwCFOgSI 2018-07-01 16:33:25.068811878 +0100
|
|
||||||
+++ /tmp/headings.L4WU0hsO 2018-07-01 16:33:25.076811973 +0100
|
|
||||||
@@ -168,6 +168,7 @@
|
|
||||||
pyrex (cython), ale-pyrex-options
|
|
||||||
cython, ale-pyrex-cython
|
|
||||||
python, ale-python-options
|
|
||||||
+ aardvark, ale-python-aardvark
|
|
||||||
autopep8, ale-python-autopep8
|
|
||||||
black, ale-python-black
|
|
||||||
flake8, ale-python-flake8
|
|
||||||
<
|
|
||||||
Make sure to make the table of contents match the headings, and to keep the
|
|
||||||
doc tags on the right margin.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
4.1 Writing Linter Tests *ale-development-linter-tests*
|
|
||||||
|
|
||||||
Tests for ALE linters take two forms.
|
|
||||||
|
|
||||||
1. Tests for handling the output of commands.
|
|
||||||
2. Tests for checking which commands are run, or connections are made.
|
|
||||||
|
|
||||||
Tests of the first form should go in the `test/handler` directory, and should
|
|
||||||
be written like so. >
|
|
||||||
|
|
||||||
Before:
|
|
||||||
" Load the file which defines the linter.
|
|
||||||
runtime ale_linters/filetype/linter_name_here.vim
|
|
||||||
|
|
||||||
After:
|
|
||||||
" Unload all linters again.
|
|
||||||
call ale#linter#Reset()
|
|
||||||
|
|
||||||
Execute(The output should be correct):
|
|
||||||
|
|
||||||
" Test that the right loclist items are parsed from the handler.
|
|
||||||
AssertEqual
|
|
||||||
\ [
|
|
||||||
\ {
|
|
||||||
\ 'lnum': 1,
|
|
||||||
\ 'type': 'E',
|
|
||||||
\ 'text': 'Something went wrong',
|
|
||||||
\ },
|
|
||||||
\ ],
|
|
||||||
\ ale_linters#filetype#linter_name#Handle(bufnr(''), [
|
|
||||||
\ '1:Something went wrong',
|
|
||||||
\ ]
|
|
||||||
<
|
|
||||||
Tests for what ALE runs should go in the `test/command_callback` directory,
|
|
||||||
and should be written like so. >
|
|
||||||
|
|
||||||
Before:
|
|
||||||
" Load the linter and set up a series of commands, reset linter variables,
|
|
||||||
" clear caches, etc.
|
|
||||||
"
|
|
||||||
" Vader's 'Save' command will be called here for linter variables.
|
|
||||||
call ale#assert#SetUpLinterTest('filetype', 'linter_name')
|
|
||||||
|
|
||||||
After:
|
|
||||||
" Reset linters, variables, etc.
|
|
||||||
"
|
|
||||||
" Vader's 'Restore' command will be called here.
|
|
||||||
call ale#assert#TearDownLinterTest()
|
|
||||||
|
|
||||||
Execute(The default command should be correct):
|
|
||||||
" AssertLinter checks the executable and command.
|
|
||||||
" Pass expected_executable, expected_command
|
|
||||||
AssertLinter 'some-command', ale#Escape('some-command') . ' --foo'
|
|
||||||
|
|
||||||
Execute(Check chained commands):
|
|
||||||
" GivenCommandOutput can be called with 1 or more list for passing output
|
|
||||||
" to chained commands. The output for each callback defaults to an empty
|
|
||||||
" list.
|
|
||||||
GivenCommandOutput ['v2.1.2']
|
|
||||||
" Given a List of commands, check all of them.
|
|
||||||
" Given a String, only the last command in the chain will be checked.
|
|
||||||
AssertLinter 'some-command', [
|
|
||||||
\ ale#Escape('some-command') . ' --version',
|
|
||||||
\ ale#Escape('some-command') . ' --foo',
|
|
||||||
\]
|
|
||||||
<
|
|
||||||
The full list of commands that will be temporarily defined for linter tests
|
|
||||||
given the above setup are as follows.
|
|
||||||
|
|
||||||
`GivenCommandOutput [...]` - Define output for ale#command#Run.
|
|
||||||
`AssertLinter executable, command` - Check the executable and command.
|
|
||||||
`AssertLinterNotExecuted` - Check that linters will not be executed.
|
|
||||||
`AssertLSPLanguage language` - Check the language given to an LSP server.
|
|
||||||
`AssertLSPOptions options_dict` - Check the options given to an LSP server.
|
|
||||||
`AssertLSPConfig config_dict` - Check the config given to an LSP server.
|
|
||||||
`AssertLSPProject project_root` - Check the root given to an LSP server.
|
|
||||||
`AssertLSPAddress address` - Check the address to an LSP server.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
4.2 Writing Fixer Tests *ale-development-fixer-tests*
|
|
||||||
|
|
||||||
Tests for ALE fixers should go in the `test/fixers` directory, and should
|
|
||||||
be written like so. >
|
|
||||||
|
|
||||||
Before:
|
|
||||||
" Load the fixer and set up a series of commands, reset fixer variables,
|
|
||||||
" clear caches, etc.
|
|
||||||
"
|
|
||||||
" Vader's 'Save' command will be called here for fixer variables.
|
|
||||||
call ale#assert#SetUpFixerTest('filetype', 'fixer_name')
|
|
||||||
|
|
||||||
After:
|
|
||||||
" Reset fixers, variables, etc.
|
|
||||||
"
|
|
||||||
" Vader's 'Restore' command will be called here.
|
|
||||||
call ale#assert#TearDownFixerTest()
|
|
||||||
|
|
||||||
Execute(The default command should be correct):
|
|
||||||
" AssertFixer checks the result of the loaded fixer function.
|
|
||||||
AssertFixer {'command': ale#Escape('some-command') . ' --foo'}
|
|
||||||
|
|
||||||
Execute(Check chained commands):
|
|
||||||
" Same as above for linter tests.
|
|
||||||
GivenCommandOutput ['v2.1.2']
|
|
||||||
" Given a List of commands, check all of them.
|
|
||||||
" Given anything else, only the last result will be checked.
|
|
||||||
AssertFixer [
|
|
||||||
\ ale#Escape('some-command') . ' --version',
|
|
||||||
\ {'command': ale#Escape('some-command') . ' --foo'}
|
|
||||||
\]
|
|
||||||
<
|
|
||||||
The full list of commands that will be temporarily defined for fixer tests
|
|
||||||
given the above setup are as follows.
|
|
||||||
|
|
||||||
`GivenCommandOutput [...]` - Define output for ale#command#Run.
|
|
||||||
`AssertFixer results` - Check the fixer results
|
|
||||||
`AssertFixerNotExecuted` - Check that fixers will not be executed.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Dockerfile Integration *ale-dockerfile-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dockerfile_lint *ale-dockerfile-dockerfile_lint*
|
|
||||||
|
|
||||||
g:ale_dockerfile_dockerfile_lint_executable
|
|
||||||
*g:ale_dockerfile_dockerfile_lint_executable*
|
|
||||||
*b:ale_dockerfile_dockerfile_lint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'dockerfile_lint'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the executable used to run
|
|
||||||
dockerfile_lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_dockerfile_dockerfile_lint_options
|
|
||||||
*g:ale_dockerfile_dockerfile_lint_options*
|
|
||||||
*b:ale_dockerfile_dockerfile_lint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add additional command-line arguments to
|
|
||||||
the dockerfile lint invocation - like custom rule file definitions.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hadolint *ale-dockerfile-hadolint*
|
|
||||||
|
|
||||||
hadolint can be found at: https://github.com/hadolint/hadolint
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
|
|
||||||
*b:ale_dockerfile_hadolint_use_docker*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'never'`
|
|
||||||
|
|
||||||
This variable controls if docker and the hadolint image are used to run this
|
|
||||||
linter: if 'never', docker will never be used; 'always' means docker will
|
|
||||||
always be used; 'yes' and docker will be used if the hadolint executable
|
|
||||||
cannot be found.
|
|
||||||
|
|
||||||
For now, the default is 'never'. This may change as ale's support for using
|
|
||||||
docker to lint evolves.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image*
|
|
||||||
*b:ale_dockerfile_hadolint_image*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hadolint/hadolint'`
|
|
||||||
|
|
||||||
This variable controls the docker image used to run hadolint. The default
|
|
||||||
is hadolint's author's build, and can be found at:
|
|
||||||
|
|
||||||
https://hub.docker.com/r/hadolint/hadolint/
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Elixir Integration *ale-elixir-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mix *ale-elixir-mix*
|
|
||||||
|
|
||||||
|
|
||||||
The `mix` linter is disabled by default, as it can bee too expensive to run.
|
|
||||||
See `:help g:ale_linters`
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
|
|
||||||
*b:ale_elixir_mix_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'mix'`
|
|
||||||
|
|
||||||
|
|
||||||
This variable can be changed to specify the mix executable.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mix_format *ale-elixir-mix-format*
|
|
||||||
|
|
||||||
g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
|
|
||||||
*b:ale_elixir_mix_format_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
|
|
||||||
This variable can be changed to specify the mix options passed to the
|
|
||||||
mix_format fixer
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dialyxir *ale-elixir-dialyxir*
|
|
||||||
|
|
||||||
Dialyzer, a DIscrepancy AnaLYZer for ERlang programs.
|
|
||||||
http://erlang.org/doc/man/dialyzer.html
|
|
||||||
|
|
||||||
It can be used with elixir through dialyxir
|
|
||||||
https://github.com/jeremyjh/dialyxir
|
|
||||||
|
|
||||||
Options for dialyzer are not configurable by ale, but they are instead
|
|
||||||
configured on your project's `mix.exs`.
|
|
||||||
|
|
||||||
See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more
|
|
||||||
information.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
elixir-ls *ale-elixir-elixir-ls*
|
|
||||||
|
|
||||||
Elixir Language Server (https://github.com/JakeBecker/elixir-ls)
|
|
||||||
|
|
||||||
g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
|
|
||||||
*b:ale_elixir_elixir_ls_release*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'elixir-ls'`
|
|
||||||
|
|
||||||
Location of the elixir-ls release directory. This directory must contain
|
|
||||||
the language server scripts (language_server.sh and language_server.bat).
|
|
||||||
|
|
||||||
g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
|
|
||||||
*b:ale_elixir_elixir_ls_config*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary containing configuration settings that will be passed to the
|
|
||||||
language server. For example, to disable Dialyzer: >
|
|
||||||
{
|
|
||||||
\ 'elixirLS': {
|
|
||||||
\ 'dialyzerEnabled': v:false,
|
|
||||||
\ },
|
|
||||||
\ }
|
|
||||||
<
|
|
||||||
Consult the ElixirLS documentation for more information about settings.
|
|
||||||
===============================================================================
|
|
||||||
credo *ale-elixir-credo*
|
|
||||||
|
|
||||||
Credo (https://github.com/rrrene/credo)
|
|
||||||
|
|
||||||
g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*
|
|
||||||
|
|
||||||
Type: Integer
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
|
|
||||||
enable --strict mode.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Elm Integration *ale-elm-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
elm-format *ale-elm-elm-format*
|
|
||||||
|
|
||||||
g:ale_elm_format_executable *g:ale_elm_format_executable*
|
|
||||||
*b:ale_elm_format_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'elm-format'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_format_use_global *g:ale_elm_format_use_global*
|
|
||||||
*b:ale_elm_format_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_format_options *g:ale_elm_format_options*
|
|
||||||
*b:ale_elm_format_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--yes'`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to elm-format.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
elm-ls *ale-elm-elm-ls*
|
|
||||||
|
|
||||||
g:ale_elm_ls_executable *g:ale_elm_ls_executable*
|
|
||||||
*b:ale_elm_ls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'elm-language-server'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_ls_use_global *g:ale_elm_ls_use_global*
|
|
||||||
*b:ale_elm_ls_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 1)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
|
|
||||||
*b:ale_elm_ls_elm_path*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
|
|
||||||
*b:ale_elm_ls_elm_format_path*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path*
|
|
||||||
*b:ale_elm_ls_elm_test_path*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger*
|
|
||||||
*b:ale_elm_ls_elm_analyse_trigger*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'change'`
|
|
||||||
|
|
||||||
One of 'change', 'save' or 'never'
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
elm-make *ale-elm-elm-make*
|
|
||||||
|
|
||||||
g:ale_elm_make_executable *g:ale_elm_make_executable*
|
|
||||||
*b:ale_elm_make_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'elm'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_elm_make_use_global *g:ale_elm_make_use_global*
|
|
||||||
*b:ale_elm_make_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Erlang Integration *ale-erlang-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
dialyzer *ale-erlang-dialyzer*
|
|
||||||
|
|
||||||
g:ale_erlang_dialyzer_executable *g:ale_erlang_dialyzer_executable*
|
|
||||||
*b:ale_erlang_dialyzer_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'dialyzer'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the dialyzer executable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_erlang_dialyzer_plt_file *g:ale_erlang_dialyzer_plt_file*
|
|
||||||
*b:ale_erlang_dialyzer_plt_file*
|
|
||||||
Type: |String|
|
|
||||||
|
|
||||||
This variable can be changed to specify the path to the PLT file. By
|
|
||||||
default, it will search for the PLT file inside the `_build` directory. If
|
|
||||||
there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`.
|
|
||||||
Otherwise, it will default to `$HOME/.dialyzer_plt`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile*
|
|
||||||
*b:ale_erlang_dialyzer_rebar3_profile*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'default'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the profile that is used to
|
|
||||||
run dialyzer with rebar3.
|
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
erlc *ale-erlang-erlc*
|
|
||||||
|
|
||||||
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
|
|
||||||
*b:ale_erlang_erlc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable controls additional parameters passed to `erlc`, such as `-I`
|
|
||||||
or `-pa`.
|
|
||||||
|
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
syntaxerl *ale-erlang-syntaxerl*
|
|
||||||
|
|
||||||
g:ale_erlang_syntaxerl_executable *g:ale_erlang_syntaxerl_executable*
|
|
||||||
*b:ale_erlang_syntaxerl_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'syntaxerl'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the syntaxerl executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Eruby Integration *ale-eruby-options*
|
|
||||||
|
|
||||||
There are four linters for `eruby` files:
|
|
||||||
|
|
||||||
- `erb`
|
|
||||||
- `erubis`
|
|
||||||
- `erubi`
|
|
||||||
- `ruumba`
|
|
||||||
|
|
||||||
`erb` is in the Ruby standard library and is mostly universal. `erubis` is the
|
|
||||||
default parser in Rails between 3.0 and 5.1. `erubi` is the default in Rails
|
|
||||||
5.1 and later. `ruumba` can extract Ruby from eruby files and run rubocop on
|
|
||||||
the result. To selectively enable a subset, see |g:ale_linters|.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ruumba *ale-eruby-ruumba*
|
|
||||||
|
|
||||||
g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable*
|
|
||||||
*b:ale_eruby_ruumba_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'ruumba`
|
|
||||||
|
|
||||||
Override the invoked ruumba binary. This is useful for running ruumba
|
|
||||||
from binstubs or a bundle.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options*
|
|
||||||
*b:ale_ruby_ruumba_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be change to modify flags given to ruumba.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Fish Integration *ale-fish-options*
|
|
||||||
|
|
||||||
Lints fish files using `fish -n`.
|
|
||||||
|
|
||||||
Note that `fish -n` is not foolproof: it sometimes gives false positives or
|
|
||||||
errors that are difficult to parse without more context. This integration skips
|
|
||||||
displaying errors if an error message is not found.
|
|
||||||
|
|
||||||
If ALE is not showing any errors but your file does not run as expected, run
|
|
||||||
`fish -n <file.fish>` from the command line.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Fortran Integration *ale-fortran-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gcc *ale-fortran-gcc*
|
|
||||||
|
|
||||||
g:ale_fortran_gcc_executable *g:ale_fortran_gcc_executable*
|
|
||||||
*b:ale_fortran_gcc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gcc'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for checking
|
|
||||||
Fortran code with GCC.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
|
|
||||||
*b:ale_fortran_gcc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to gcc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_fortran_gcc_use_free_form *g:ale_fortran_gcc_use_free_form*
|
|
||||||
*b:ale_fortran_gcc_use_free_form*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
When set to `1`, the `-ffree-form` flag will be used for GCC, to check files
|
|
||||||
with the free form layout. When set to `0`, `-ffixed-form` will be used
|
|
||||||
instead, for checking files with fixed form layouts.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
language_server *ale-fortran-language-server*
|
|
||||||
|
|
||||||
g:ale_fortran_language_server_executable *g:ale_fortran_language_server_executable*
|
|
||||||
*b:ale_fortran_language_server_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'fortls'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for the Fortran
|
|
||||||
Language Server.
|
|
||||||
|
|
||||||
g:ale_fortran_language_server_use_global *g:ale_fortran_language_server_use_global*
|
|
||||||
*b:ale_fortran_language_server_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Fountain Integration *ale-fountain-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE FusionScript Integration *ale-fuse-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
fusion-lint *ale-fuse-fusionlint*
|
|
||||||
|
|
||||||
g:ale_fusion_fusionlint_executable *g:ale_fuse_fusionlint_executable*
|
|
||||||
*b:ale_fuse_fusionlint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'fusion-lint'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to fusion-lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_fuse_fusionlint_options *g:ale_fuse_fusionlint_options*
|
|
||||||
*b:ale_fuse_fusionlint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to fusion-lint.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Git Commit Integration *ale-gitcommit-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gitlint *ale-gitcommit-gitlint*
|
|
||||||
|
|
||||||
g:ale_gitcommit_gitlint_executable *g:ale_gitcommit_gitlint_executable*
|
|
||||||
*b:ale_gitcommit_gitlint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gitlint'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for gitlint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
|
|
||||||
*b:ale_gitcommit_gitlint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the gitlint
|
|
||||||
invocation. For example, you can specify the path to a configuration file. >
|
|
||||||
|
|
||||||
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
|
|
||||||
<
|
|
||||||
You can also disable particular error codes using this option. For example,
|
|
||||||
you can ignore errors for git commits with a missing body. >
|
|
||||||
|
|
||||||
let g:ale_gitcommit_gitlint_options = '--ignore B6'
|
|
||||||
<
|
|
||||||
|
|
||||||
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
|
|
||||||
*b:ale_gitcommit_gitlint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable controls whether or not ALE will search for gitlint in a
|
|
||||||
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
||||||
always use |g:ale_gitcommit_gitlint_executable| for the executable path.
|
|
||||||
|
|
||||||
Both variables can be set with `b:` buffer variables instead.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE GLSL Integration *ale-glsl-options*
|
|
||||||
*ale-integration-glsl*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Integration Information
|
|
||||||
|
|
||||||
Since Vim does not detect the glsl file types out-of-the-box, you need the
|
|
||||||
runtime files for glsl from here: https://github.com/tikhomirov/vim-glsl
|
|
||||||
|
|
||||||
Note that the current glslang-based linter expects glslangValidator in
|
|
||||||
standard paths. If it's not installed system-wide you can set
|
|
||||||
|g:ale_glsl_glslang_executable| to a specific path.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
glslang *ale-glsl-glslang*
|
|
||||||
|
|
||||||
g:ale_glsl_glslang_executable *g:ale_glsl_glslang_executable*
|
|
||||||
*b:ale_glsl_glslang_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'glslangValidator'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to glslangValidator.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
|
|
||||||
*b:ale_glsl_glslang_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to glslangValidator.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
glslls *ale-glsl-glslls*
|
|
||||||
|
|
||||||
g:ale_glsl_glslls_executable *g:ale_glsl_glslls_executable*
|
|
||||||
*b:ale_glsl_glslls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'glslls'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to glslls.
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
g:ale_glsl_glslls_logfile *g:ale_glsl_glslls_logfile*
|
|
||||||
*b:ale_glsl_glslls_logfile*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Setting this variable to a writeable file path will enable logging to that
|
|
||||||
file.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,263 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Go Integration *ale-go-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Integration Information
|
|
||||||
|
|
||||||
The `gometalinter` linter is disabled by default. ALE enables `gofmt`,
|
|
||||||
`golint` and `go vet` by default. It also supports `staticcheck`, `go
|
|
||||||
build`, `gosimple`, `golangserver`.
|
|
||||||
|
|
||||||
To enable `gometalinter`, update |g:ale_linters| as appropriate:
|
|
||||||
>
|
|
||||||
" Enable all of the linters you want for Go.
|
|
||||||
let g:ale_linters = {'go': ['gometalinter', 'gofmt']}
|
|
||||||
<
|
|
||||||
A possible configuration is to enable `gometalinter` and `gofmt` but paired
|
|
||||||
with the `--fast` option, set by |g:ale_go_gometalinter_options|. This gets you
|
|
||||||
the benefit of running a number of linters, more than ALE would by default,
|
|
||||||
while ensuring it doesn't run any linters known to be slow or resource
|
|
||||||
intensive.
|
|
||||||
|
|
||||||
g:ale_go_go_executable *g:ale_go_go_options*
|
|
||||||
*b:ale_go_go_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'go'`
|
|
||||||
|
|
||||||
The executable that will be run for the `gobuild` and `govet` linters, and
|
|
||||||
the `gomod` fixer.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_go111module *g:ale_go_go111module*
|
|
||||||
*b:ale_go_go111module*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Override the value of the `$GO111MODULE` environment variable for
|
|
||||||
golang tools.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
bingo *ale-go-bingo*
|
|
||||||
|
|
||||||
g:ale_go_bingo_executable *g:ale_go_bingo_executable*
|
|
||||||
*b:ale_go_bingo_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'bingo'`
|
|
||||||
|
|
||||||
Location of the bingo binary file.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_bingo_options *g:ale_go_bingo_options*
|
|
||||||
*b:ale_go_bingo_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gobuild *ale-go-gobuild*
|
|
||||||
|
|
||||||
g:ale_go_gobuild_options *g:ale_go_gobuild_options*
|
|
||||||
*b:ale_go_gobuild_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the gobuild linter.
|
|
||||||
They are injected directly after "go test".
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gofmt *ale-go-gofmt*
|
|
||||||
|
|
||||||
g:ale_go_gofmt_options *g:ale_go_gofmt_options*
|
|
||||||
*b:ale_go_gofmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the gofmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
golangci-lint *ale-go-golangci-lint*
|
|
||||||
|
|
||||||
`golangci-lint` is a `lint_file` linter, which only lints files that are
|
|
||||||
written to disk. This differs from the default behavior of linting the buffer.
|
|
||||||
See: |ale-lint-file|
|
|
||||||
|
|
||||||
g:ale_go_golangci_lint_executable *g:ale_go_golangci_lint_executable*
|
|
||||||
*b:ale_go_golangci_lint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'golangci-lint'`
|
|
||||||
|
|
||||||
The executable that will be run for golangci-lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_golangci_lint_options *g:ale_go_golangci_lint_options*
|
|
||||||
*b:ale_go_golangci_lint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--enable-all'`
|
|
||||||
|
|
||||||
This variable can be changed to alter the command-line arguments to the
|
|
||||||
golangci-lint invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package*
|
|
||||||
*b:ale_go_golangci_lint_package*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, the whole Go package will be checked instead of only the
|
|
||||||
current file.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
golangserver *ale-go-golangserver*
|
|
||||||
|
|
||||||
g:ale_go_langserver_executable *g:ale_go_langserver_executable*
|
|
||||||
*b:ale_go_langserver_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'go-langserver'`
|
|
||||||
|
|
||||||
Location of the go-langserver binary file.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_langserver_options *g:ale_go_langserver_options*
|
|
||||||
*b:ale_go_langserver_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Additional options passed to the go-langserver command. Note that the
|
|
||||||
`-gocodecompletion` option is ignored because it is handled automatically
|
|
||||||
by the |g:ale_completion_enabled| variable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
golint *ale-go-golint*
|
|
||||||
|
|
||||||
g:ale_go_golint_executable *g:ale_go_golint_executable*
|
|
||||||
*b:ale_go_golint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'golint'`
|
|
||||||
|
|
||||||
This variable can be set to change the golint executable path.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_golint_options *g:ale_go_golint_options*
|
|
||||||
*b:ale_go_golint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the golint linter.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gometalinter *ale-go-gometalinter*
|
|
||||||
|
|
||||||
`gometalinter` is a `lint_file` linter, which only lints files that are
|
|
||||||
written to disk. This differs from the default behavior of linting the buffer.
|
|
||||||
See: |ale-lint-file|
|
|
||||||
|
|
||||||
g:ale_go_gometalinter_executable *g:ale_go_gometalinter_executable*
|
|
||||||
*b:ale_go_gometalinter_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gometalinter'`
|
|
||||||
|
|
||||||
The executable that will be run for gometalinter.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_gometalinter_options *g:ale_go_gometalinter_options*
|
|
||||||
*b:ale_go_gometalinter_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to alter the command-line arguments to the
|
|
||||||
gometalinter invocation.
|
|
||||||
|
|
||||||
Since `gometalinter` runs a number of linters that can consume a lot of
|
|
||||||
resources it's recommended to set this option to a value of `--fast` if you
|
|
||||||
use `gometalinter` as one of the linters in |g:ale_linters|. This disables a
|
|
||||||
number of linters known to be slow or consume a lot of resources.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_gometalinter_lint_package *g:ale_go_gometalinter_lint_package*
|
|
||||||
*b:ale_go_gometalinter_lint_package*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, the whole Go package will be checked instead of only the
|
|
||||||
current file.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gopls *ale-go-gopls*
|
|
||||||
|
|
||||||
g:ale_go_gopls_executable *g:ale_go_gopls_executable*
|
|
||||||
*b:ale_go_gopls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'gopls'`
|
|
||||||
|
|
||||||
Location of the gopls binary file.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_gopls_options *g:ale_go_gopls_options*
|
|
||||||
*b:ale_go_gopls_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
govet *ale-go-govet*
|
|
||||||
|
|
||||||
g:ale_go_govet_options *g:ale_go_govet_options*
|
|
||||||
*b:ale_go_govet_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the go vet linter.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
revive *ale-go-revive*
|
|
||||||
|
|
||||||
g:ale_go_revive_executable *g:ale_go_revive_executable*
|
|
||||||
*b:ale_go_revive_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'revive'`
|
|
||||||
|
|
||||||
This variable can be set to change the revive executable path.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_revive_options *g:ale_go_revive_options*
|
|
||||||
*b:ale_go_revive_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the revive
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
staticcheck *ale-go-staticcheck*
|
|
||||||
|
|
||||||
g:ale_go_staticcheck_options *g:ale_go_staticcheck_options*
|
|
||||||
*b:ale_go_staticcheck_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the staticcheck
|
|
||||||
linter.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package*
|
|
||||||
*b:ale_go_staticcheck_lint_package*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, the whole Go package will be checked instead of only the
|
|
||||||
current file.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE GraphQL Integration *ale-graphql-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
eslint *ale-graphql-eslint*
|
|
||||||
|
|
||||||
The `eslint` linter for GraphQL uses the JavaScript options for `eslint`; see:
|
|
||||||
|ale-javascript-eslint|.
|
|
||||||
|
|
||||||
You will need the GraphQL ESLint plugin installed for this to work.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
gqlint *ale-graphql-gqlint*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-graphql-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Hack Integration *ale-hack-options*
|
|
||||||
*ale-integration-hack*
|
|
||||||
|
|
||||||
HHAST is disabled by default, as it executes code in the project root.
|
|
||||||
|
|
||||||
Currently linters must be enabled globally. HHAST can be enabled with:
|
|
||||||
|
|
||||||
>
|
|
||||||
let g:ale_linters = {'hack': ['hack', 'hhast']}
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hack *ale-hack-hack*
|
|
||||||
|
|
||||||
g:ale_hack_hack_executable *g:ale_hack_hack_executable*
|
|
||||||
*b:ale_hack_hack_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hh_client'`
|
|
||||||
|
|
||||||
This variable can be set to use a specific executable to interact with the
|
|
||||||
Hack typechecker.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hackfmt *ale-hack-hackfmt*
|
|
||||||
|
|
||||||
g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options*
|
|
||||||
*b:ale_hack_hackfmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the hackfmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hhast *ale-hack-hhast*
|
|
||||||
|
|
||||||
g:ale_hack_hhast_executable *g:ale_hack_hhast_executable*
|
|
||||||
*b:ale_hack_hhast_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'vendor/bin/hhast-lint'`
|
|
||||||
|
|
||||||
This variable can be set to use a specific executable to interact with the
|
|
||||||
Hack typechecker.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Handlebars Integration *ale-handlebars-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-handlebars-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
Uses glimmer parser by default.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ember-template-lint *ale-handlebars-embertemplatelint*
|
|
||||||
|
|
||||||
g:ale_handlebars_embertemplatelint_executable
|
|
||||||
*g:ale_handlebars_embertemplatelint_executable*
|
|
||||||
Type: |String| *b:ale_handlebars_embertemplatelint_executable*
|
|
||||||
Default: `'ember-template-lint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_handlebars_embertemplatelint_use_global
|
|
||||||
*g:ale_handlebars_embertemplatelint_use_global*
|
|
||||||
Type: |Number| *b:ale_handlebars_embertemplatelint_use_global*
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,176 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Haskell Integration *ale-haskell-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
brittany *ale-haskell-brittany*
|
|
||||||
|
|
||||||
g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable*
|
|
||||||
*b:ale_haskell_brittany_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'brittany'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for brittany.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
floskell *ale-haskell-floskell*
|
|
||||||
|
|
||||||
g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
|
|
||||||
*b:ale_haskell_floskell_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'floskell'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for floskell.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ghc *ale-haskell-ghc*
|
|
||||||
|
|
||||||
g:ale_haskell_ghc_options *g:ale_haskell_ghc_options*
|
|
||||||
*b:ale_haskell_ghc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-fno-code -v0'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to ghc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ghc-mod *ale-haskell-ghc-mod*
|
|
||||||
|
|
||||||
g:ale_haskell_ghc_mod_executable *g:ale_haskell_ghc_mod_executable*
|
|
||||||
*b:ale_haskell_ghc_mod_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ghc-mod'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ghc-mod.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cabal-ghc *ale-haskell-cabal-ghc*
|
|
||||||
|
|
||||||
g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
|
|
||||||
*b:ale_haskell_cabal_ghc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-fno-code -v0'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to ghc through cabal
|
|
||||||
exec.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hdevtools *ale-haskell-hdevtools*
|
|
||||||
|
|
||||||
g:ale_haskell_hdevtools_executable *g:ale_haskell_hdevtools_executable*
|
|
||||||
*b:ale_haskell_hdevtools_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hdevtools'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for hdevtools.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
|
|
||||||
*b:ale_haskell_hdevtools_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'hdevtools_options', '-g -Wall')`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to hdevtools.
|
|
||||||
|
|
||||||
The hdevtools documentation recommends setting GHC options for `hdevtools`
|
|
||||||
with `g:hdevtools_options`. ALE will use the value of `g:hdevtools_options`
|
|
||||||
for the value of `g:ale_haskell_hdevtools_options` by default, so this
|
|
||||||
option can be respected and overridden specifically for ALE.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hfmt *ale-haskell-hfmt*
|
|
||||||
|
|
||||||
g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
|
|
||||||
*b:ale_haskell_hfmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hfmt'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for hfmt.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hindent *ale-haskell-hindent*
|
|
||||||
|
|
||||||
g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable*
|
|
||||||
*b:ale_haskell_hindent_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hindent'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for hindent.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hlint *ale-haskell-hlint*
|
|
||||||
|
|
||||||
g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable*
|
|
||||||
*b:ale_haskell_hlint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hlint'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for hlint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_haskell_hlint_options g:ale_haskell_hlint_options
|
|
||||||
b:ale_haskell_hlint_options
|
|
||||||
Type: String
|
|
||||||
Default: ''
|
|
||||||
|
|
||||||
This variable can be used to pass extra options to the underlying hlint
|
|
||||||
executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stack-build *ale-haskell-stack-build*
|
|
||||||
|
|
||||||
g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
|
|
||||||
*b:ale_haskell_stack_build_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--fast'`
|
|
||||||
|
|
||||||
We default to using `'--fast'`. Since Stack generates binaries, your
|
|
||||||
programs will be slower unless you separately rebuild them outside of ALE.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stack-ghc *ale-haskell-stack-ghc*
|
|
||||||
|
|
||||||
g:ale_haskell_stack_ghc_options *g:ale_haskell_stack_ghc_options*
|
|
||||||
*b:ale_haskell_stack_ghc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-fno-code -v0'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to ghc through `stack
|
|
||||||
ghc`
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stylish-haskell *ale-haskell-stylish-haskell*
|
|
||||||
|
|
||||||
g:ale_haskell_stylish_haskell_executable
|
|
||||||
*g:ale_haskell_stylish_haskell_executable*
|
|
||||||
*b:ale_haskell_stylish_haskell_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'stylish-haskell'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for stylish-haskell.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
hie *ale-haskell-hie*
|
|
||||||
|
|
||||||
g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
|
|
||||||
*b:ale_haskell_hie_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'hie'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for the haskell
|
|
||||||
ide engine. i.e. `'hie-wrapper'`
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE HCL Integration *ale-hcl-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
terraform-fmt *ale-hcl-terraform-fmt*
|
|
||||||
|
|
||||||
See |ale-terraform-fmt-fixer| for information about the available options.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,140 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE HTML Integration *ale-html-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
fecs *ale-html-fecs*
|
|
||||||
|
|
||||||
`fecs` options for HTMl is the same as the options for JavaScript,
|
|
||||||
and both of them reads `./.fecsrc` as the default configuration file.
|
|
||||||
See: |ale-javascript-fecs|.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
html-beautify *ale-html-beautify*
|
|
||||||
|
|
||||||
g:ale_html_beautify_options *g:ale_html_beautify_options*
|
|
||||||
*b:ale_html_beautify_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to html-beautify.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
htmlhint *ale-html-htmlhint*
|
|
||||||
|
|
||||||
g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable*
|
|
||||||
*b:ale_html_htmlhint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'htmlhint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
|
|
||||||
*b:ale_html_htmlhint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to HTMLHint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
|
|
||||||
*b:ale_html_htmlhint_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
tidy *ale-html-tidy*
|
|
||||||
|
|
||||||
`tidy` is a console application which corrects and cleans up HTML and XML
|
|
||||||
documents by fixing markup errors and upgrading legacy code to modern
|
|
||||||
standards.
|
|
||||||
|
|
||||||
Note:
|
|
||||||
`/usr/bin/tidy` on macOS (installed by default) is too old. It was released
|
|
||||||
on 31 Oct 2006. It does not consider modern HTML specs (HTML5) and shows
|
|
||||||
outdated warnings. So |ale| ignores `/usr/bin/tidy` on macOS.
|
|
||||||
|
|
||||||
To use `tidy` on macOS, please install the latest version with Homebrew:
|
|
||||||
>
|
|
||||||
$ brew install tidy-html5
|
|
||||||
<
|
|
||||||
`/usr/local/bin/tidy` is installed.
|
|
||||||
|
|
||||||
g:ale_html_tidy_executable *g:ale_html_tidy_executable*
|
|
||||||
*b:ale_html_tidy_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'tidy'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to tidy.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_tidy_options *g:ale_html_tidy_options*
|
|
||||||
*b:ale_html_tidy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-q -e -language en'`
|
|
||||||
|
|
||||||
This variable can be changed to change the arguments provided to the
|
|
||||||
executable.
|
|
||||||
|
|
||||||
ALE will attempt to automatically detect the appropriate file encoding to
|
|
||||||
provide to html-tidy, and fall back to UTF-8 when encoding detection fails.
|
|
||||||
|
|
||||||
The recognized file encodings are as follows: ascii, big5, cp1252 (win1252),
|
|
||||||
cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
|
|
||||||
(mac), sjis (shiftjis), utf-16le, utf-16, utf-8
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_tidy_use_global *g:html_tidy_use_global*
|
|
||||||
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-html-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stylelint *ale-html-stylelint*
|
|
||||||
|
|
||||||
g:ale_html_stylelint_executable *g:ale_html_stylelint_executable*
|
|
||||||
*b:ale_html_stylelint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'stylelint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_stylelint_options *g:ale_html_stylelint_options*
|
|
||||||
*b:ale_html_stylelint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to stylelint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global*
|
|
||||||
*b:ale_html_stylelint_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-html-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Idris Integration *ale-idris-options*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
idris *ale-idris-idris*
|
|
||||||
|
|
||||||
g:ale_idris_idris_executable *g:ale_idris_idris_executable*
|
|
||||||
*b:ale_idris_idris_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'idris'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to idris.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_idris_idris_options *g:ale_idris_idris_options*
|
|
||||||
*b:ale_idris_idris_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--total --warnpartial --warnreach --warnipkg'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to idris.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Ink Integration *ale-ink-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ink-language-server *ale-ink-language-server*
|
|
||||||
|
|
||||||
Ink Language Server
|
|
||||||
(https://github.com/ephraim/ink-language-server)
|
|
||||||
|
|
||||||
g:ale_ink_ls_executable g:ale_ink_ls_executable
|
|
||||||
b:ale_ink_ls_executable
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ink-language-server'`
|
|
||||||
|
|
||||||
Ink language server executable.
|
|
||||||
|
|
||||||
g:ale_ink_ls_initialization_options
|
|
||||||
g:ale_ink_ls_initialization_options
|
|
||||||
b:ale_ink_ls_initialization_options
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary containing configuration settings that will be passed to the
|
|
||||||
language server at startup. For certain platforms and certain story
|
|
||||||
structures, the defaults will suffice. However, many projects will need to
|
|
||||||
change these settings - see the ink-language-server website for more
|
|
||||||
information.
|
|
||||||
|
|
||||||
An example of setting non-default options:
|
|
||||||
{
|
|
||||||
\ 'ink': {
|
|
||||||
\ 'mainStoryPath': 'init.ink',
|
|
||||||
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
|
|
||||||
\ 'runThroughMono': v:false
|
|
||||||
\ }
|
|
||||||
\}
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE ISPC Integration *ale-ispc-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ispc *ale-ispc-ispc*
|
|
||||||
|
|
||||||
g:ale_ispc_ispc_executable *g:ale_ispc_ispc_executable*
|
|
||||||
*b:ale_ispc_ispc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ispc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ispc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ispc_ispc_options *g:ale_ispc_ispc_options*
|
|
||||||
*b:ale_ispc_ispc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to ispc.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,268 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Java Integration *ale-java-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
checkstyle *ale-java-checkstyle*
|
|
||||||
|
|
||||||
g:ale_java_checkstyle_config *g:ale_java_checkstyle_config*
|
|
||||||
*b:ale_java_checkstyle_config*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'/google_checks.xml'`
|
|
||||||
|
|
||||||
A path to a checkstyle configuration file.
|
|
||||||
|
|
||||||
If a configuration file is specified with |g:ale_java_checkstyle_options|,
|
|
||||||
it will be preferred over this setting.
|
|
||||||
|
|
||||||
The path to the configuration file can be an absolute path or a relative
|
|
||||||
path. ALE will search for the relative path in parent directories.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable*
|
|
||||||
*b:ale_java_checkstyle_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: 'checkstyle'
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for checkstyle.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_checkstyle_options *g:ale_java_checkstyle_options*
|
|
||||||
*b:ale_java_checkstyle_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to checkstyle.
|
|
||||||
|
|
||||||
If a configuration file is specified with `-c`, it will be used instead of
|
|
||||||
configuration files set with |g:ale_java_checkstyle_config|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
javac *ale-java-javac*
|
|
||||||
|
|
||||||
g:ale_java_javac_classpath *g:ale_java_javac_classpath*
|
|
||||||
*b:ale_java_javac_classpath*
|
|
||||||
Type: |String| or |List|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to change the global classpath for Java.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_javac_executable *g:ale_java_javac_executable*
|
|
||||||
*b:ale_java_javac_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'javac'`
|
|
||||||
|
|
||||||
This variable can be set to change the executable path used for javac.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_javac_options *g:ale_java_javac_options*
|
|
||||||
*b:ale_java_javac_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to javac.
|
|
||||||
|
|
||||||
g:ale_java_javac_sourcepath *g:ale_java_javac_sourcepath*
|
|
||||||
*b:ale_java_javac_sourcepath*
|
|
||||||
Type: |String| or |List|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can set multiple source code paths, the source code path is a
|
|
||||||
relative path (relative to the project root directory).
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
String type:
|
|
||||||
Note that the unix system separator is a colon(`:`) window system
|
|
||||||
is a semicolon(`;`).
|
|
||||||
>
|
|
||||||
let g:ale_java_javac_sourcepath = 'build/gen/source/xx/main:build/gen/source'
|
|
||||||
<
|
|
||||||
List type:
|
|
||||||
>
|
|
||||||
let g:ale_java_javac_sourcepath = [
|
|
||||||
\ 'build/generated/source/querydsl/main',
|
|
||||||
\ 'target/generated-sources/source/querydsl/main'
|
|
||||||
\ ]
|
|
||||||
<
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
google-java-format *ale-java-google-java-format*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_google_java_format_executable
|
|
||||||
*g:ale_java_google_java_format_executable*
|
|
||||||
*b:ale_java_google_java_format_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'google-java-format'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
|
|
||||||
*b:ale_java_google_java_format_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pmd *ale-java-pmd*
|
|
||||||
|
|
||||||
g:ale_java_pmd_options *g:ale_java_pmd_options*
|
|
||||||
*b:ale_java_pmd_options*
|
|
||||||
|
|
||||||
Type: String
|
|
||||||
Default: '-R category/java/bestpractices'
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to PMD. Do not specify -f
|
|
||||||
and -d. They are added automatically.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
javalsp *ale-java-javalsp*
|
|
||||||
|
|
||||||
To enable Java LSP linter you need to download and build the vscode-javac
|
|
||||||
language server from https://github.com/georgewfraser/java-language-server.
|
|
||||||
Simply download the source code and then build a distribution:
|
|
||||||
|
|
||||||
scripts/link_mac.sh
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
scripts/link_windows.sh
|
|
||||||
|
|
||||||
This generates a dist/mac or dist/windows directory that contains the
|
|
||||||
language server. To let ALE use this language server you need to set the
|
|
||||||
g:ale_java_javalsp_executable variable to the absolute path of the launcher
|
|
||||||
executable in this directory.
|
|
||||||
|
|
||||||
g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
|
|
||||||
*b:ale_java_javalsp_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable must be set to the absolute path of the language server launcher
|
|
||||||
executable. For example:
|
|
||||||
>
|
|
||||||
let g:ale_java_javalsp_executable=/java-language-server/dist/mac/bin/launcher
|
|
||||||
<
|
|
||||||
|
|
||||||
g:ale_java_javalsp_config *g:ale_java_javalsp_config*
|
|
||||||
*b:ale_java_javalsp_config*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
The javalsp linter automatically detects external depenencies for Maven and
|
|
||||||
Gradle projects. In case the javalsp fails to detect some of them, you can
|
|
||||||
specify them setting a dictionary to |g:ale_java_javalsp_config| variable.
|
|
||||||
>
|
|
||||||
let g:ale_java_javalsp_executable =
|
|
||||||
\ {
|
|
||||||
\ 'java': {
|
|
||||||
\ 'externalDependencies': [
|
|
||||||
\ 'junit:junit:jar:4.12:test', " Maven format
|
|
||||||
\ 'junit:junit:4.1' " Gradle format
|
|
||||||
\ ],
|
|
||||||
\ 'classPath': [
|
|
||||||
\ 'lib/some-dependency.jar',
|
|
||||||
\ '/android-sdk/platforms/android-28.jar'
|
|
||||||
\ ]
|
|
||||||
\ }
|
|
||||||
\ }
|
|
||||||
|
|
||||||
The Java language server will look for the dependencies you specify in
|
|
||||||
`externalDependencies` array in your Maven and Gradle caches ~/.m2 and
|
|
||||||
~/.gradle.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
eclipselsp *ale-java-eclipselsp*
|
|
||||||
|
|
||||||
To enable Eclipse LSP linter you need to clone and build the eclipse.jdt.ls
|
|
||||||
language server from https://github.com/eclipse/eclipse.jdt.ls. Simply
|
|
||||||
clone the source code repo and then build the plugin:
|
|
||||||
|
|
||||||
./mvnw clean verify
|
|
||||||
|
|
||||||
Note: currently, the build can only run when launched with JDK 8. JDK 9 or more
|
|
||||||
recent versions can be used to run the server though.
|
|
||||||
|
|
||||||
After build completes the files required to run the language server will be
|
|
||||||
located inside the repository folder `eclipse.jdt.ls`. Please ensure to set
|
|
||||||
|g:ale_java_eclipselsp_path| to the absolute path of that folder.
|
|
||||||
|
|
||||||
You could customize compiler options and code assists of the server.
|
|
||||||
Under your project folder, modify the file `.settings/org.eclipse.jdt.core.prefs`
|
|
||||||
with options presented at
|
|
||||||
https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/JavaCore.html.
|
|
||||||
|
|
||||||
g:ale_java_eclipselsp_path *g:ale_java_eclipselsp_path*
|
|
||||||
*b:ale_java_eclipselsp_path*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'$HOME/eclipse.jdt.ls'`
|
|
||||||
|
|
||||||
Absolute path to the location of the eclipse.jdt.ls repository folder. Or if
|
|
||||||
you have VSCode extension installed the absolute path to the VSCode extensions
|
|
||||||
folder (e.g. $HOME/.vscode/extensions/redhat.java-0.4x.0 in Linux).
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_eclipselsp_executable *g:ale_java_eclipse_executable*
|
|
||||||
*b:ale_java_eclipse_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'java'`
|
|
||||||
|
|
||||||
This variable can be set to change the executable path used for java.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_eclipselsp_config_path *g:ale_java_eclipse_config_path*
|
|
||||||
*b:ale_java_eclipse_config_path*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Set this variable to change the configuration directory path used by
|
|
||||||
eclipselsp (e.g. `$HOME/.jdtls` in Linux).
|
|
||||||
By default ALE will attempt to use the configuration within the installation
|
|
||||||
directory.
|
|
||||||
This setting is particularly useful when eclipselsp is installed in a
|
|
||||||
non-writable directory like `/usr/share/java/jdtls`, as is the case when
|
|
||||||
installed via system package.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path*
|
|
||||||
*b:ale_java_eclipselsp_workspace_path*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
If you have Eclipse installed is good idea to set this variable to the
|
|
||||||
absolute path of the Eclipse workspace. If not set this value will be set to
|
|
||||||
the parent folder of the project root.
|
|
||||||
|
|
||||||
g:ale_java_eclipselsp_javaagent *g:ale_java_eclipselsp_javaagent*
|
|
||||||
*b:ale_java_eclipselsp_javaagent*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A variable to add java agent for annotation processing such as Lombok.
|
|
||||||
If you have multiple java agent files, use space to separate them. For example:
|
|
||||||
>
|
|
||||||
let g:ale_java_eclipselsp_javaagent='/eclipse/lombok.jar /eclipse/jacoco.jar'
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-java-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,336 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE JavaScript Integration *ale-javascript-options*
|
|
||||||
|
|
||||||
*ale-eslint-nested-configuration-files*
|
|
||||||
|
|
||||||
For fixing files with ESLint, nested configuration files with `root: false`
|
|
||||||
are not supported. This is because ALE fixes files by writing the contents of
|
|
||||||
buffers to temporary files, and then explicitly sets the configuration file.
|
|
||||||
Configuration files which are set explicitly must be root configuration files.
|
|
||||||
If you are using nested configuration files, you should restructure your
|
|
||||||
project so your configuration files use `extends` instead.
|
|
||||||
|
|
||||||
See the ESLint documentation here:
|
|
||||||
http://eslint.org/docs/user-guide/configuring#extending-configuration-files
|
|
||||||
|
|
||||||
You should change the structure of your project from this: >
|
|
||||||
/path/foo/.eslintrc.js # root: true
|
|
||||||
/path/foo/bar/.eslintrc.js # root: false
|
|
||||||
<
|
|
||||||
To this: >
|
|
||||||
/path/foo/.base-eslintrc.js # Base configuration here
|
|
||||||
/path/foo/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
|
|
||||||
/path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
eslint *ale-javascript-eslint*
|
|
||||||
|
|
||||||
g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable*
|
|
||||||
*b:ale_javascript_eslint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'eslint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_eslint_options *g:ale_javascript_eslint_options*
|
|
||||||
*b:ale_javascript_eslint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to eslint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
|
|
||||||
*b:ale_javascript_eslint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_eslint_suppress_eslintignore
|
|
||||||
*g:ale_javascript_eslint_suppress_eslintignore*
|
|
||||||
*b:ale_javascript_eslint_suppress_eslintignore*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
This variable can be set to `1` to disable warnings for files being ignored
|
|
||||||
by eslint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_eslint_suppress_missing_config
|
|
||||||
*g:ale_javascript_eslint_suppress_missing_config*
|
|
||||||
*b:ale_javascript_eslint_suppress_missing_config*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
This variable can be set to `1` to disable errors for missing eslint
|
|
||||||
configuration files.
|
|
||||||
|
|
||||||
When turning this option on, eslint will not report any problems when no
|
|
||||||
configuration files are found.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
fecs *ale-javascript-fecs*
|
|
||||||
|
|
||||||
`fecs` is a lint tool for HTML/CSS/JavaScript, can be installed via:
|
|
||||||
|
|
||||||
`$ npm install --save-dev fecs`
|
|
||||||
|
|
||||||
And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com
|
|
||||||
for more options.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_fecs_executable *g:ale_javascript_fecs_executable*
|
|
||||||
*b:ale_javascript_fecs_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'fecs'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_fecs_use_global *g:ale_javascript_fecs_use_global*
|
|
||||||
*b:ale_javascript_fecs_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
flow *ale-javascript-flow*
|
|
||||||
|
|
||||||
g:ale_javascript_flow_executable *g:ale_javascript_flow_executable*
|
|
||||||
*b:ale_javascript_flow_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'flow'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
|
|
||||||
*b:ale_javascript_flow_use_home_config*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, ALE will allow Flow to be executed with configuration files
|
|
||||||
from your home directory. ALE will not run Flow with home directory
|
|
||||||
configuration files by default, as doing so can lead to Vim consuming all of
|
|
||||||
your RAM and CPU power.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global*
|
|
||||||
*b:ale_javascript_flow_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_flow_use_respect_pragma
|
|
||||||
*g:ale_javascript_flow_use_respect_pragma*
|
|
||||||
*b:ale_javascript_flow_use_respect_pragma*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
By default, ALE will use the `--respect-pragma` option for `flow`, so only
|
|
||||||
files with the `@flow` pragma are checked by ALE. This option can be set to
|
|
||||||
`0` to disable that behaviour, so all files can be checked by `flow`.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
importjs *ale-javascript-importjs*
|
|
||||||
|
|
||||||
g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable*
|
|
||||||
*b:ale_javascript_importjs_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'importjs'`
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
jscs *ale-javascript-jscs*
|
|
||||||
|
|
||||||
g:ale_javascript_jscs_executable *g:ale_javascript_jscs_executable*
|
|
||||||
*b:ale_javascript_jscs_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'jscs'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
|
|
||||||
*b:ale_javascript_jscs_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
jshint *ale-javascript-jshint*
|
|
||||||
|
|
||||||
g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable*
|
|
||||||
*b:ale_javascript_jshint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'jshint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
|
|
||||||
*b:ale_javascript_jshint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-javascript-prettier*
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_executable *g:ale_javascript_prettier_executable*
|
|
||||||
*b:ale_javascript_prettier_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'prettier'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
|
|
||||||
*b:ale_javascript_prettier_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to prettier.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
|
|
||||||
*b:ale_javascript_prettier_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier-eslint *ale-javascript-prettier-eslint*
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_eslint_executable
|
|
||||||
*g:ale_javascript_prettier_eslint_executable*
|
|
||||||
*b:ale_javascript_prettier_eslint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'prettier-eslint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_eslint_options
|
|
||||||
*g:ale_javascript_prettier_eslint_options*
|
|
||||||
*b:ale_javascript_prettier_eslint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to prettier-eslint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_eslint_use_global
|
|
||||||
*g:ale_javascript_prettier_eslint_use_global*
|
|
||||||
*b:ale_javascript_prettier_eslint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier-standard *ale-javascript-prettier-standard*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_standard_executable
|
|
||||||
*g:ale_javascript_prettier_standard_executable*
|
|
||||||
*b:ale_javascript_prettier_standard_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'prettier-standard'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_standard_options
|
|
||||||
*g:ale_javascript_prettier_standard_options*
|
|
||||||
*b:ale_javascript_prettier_standard_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to prettier-standard.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_prettier_standard_use_global
|
|
||||||
*g:ale_javascript_prettier_standard_use_global*
|
|
||||||
*b:ale_javascript_prettier_standard_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
standard *ale-javascript-standard*
|
|
||||||
|
|
||||||
g:ale_javascript_standard_executable *g:ale_javascript_standard_executable*
|
|
||||||
*b:ale_javascript_standard_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'standard'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_standard_options *g:ale_javascript_standard_options*
|
|
||||||
*b:ale_javascript_standard_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to standard.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
|
|
||||||
*b:ale_javascript_standard_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
xo *ale-javascript-xo*
|
|
||||||
|
|
||||||
g:ale_javascript_xo_executable *g:ale_javascript_xo_executable*
|
|
||||||
*b:ale_javascript_xo_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'xo'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_xo_options *g:ale_javascript_xo_options*
|
|
||||||
*b:ale_javascript_xo_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to xo.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
|
|
||||||
*b:ale_javascript_xo_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE JSON Integration *ale-json-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
fixjson *ale-json-fixjson*
|
|
||||||
|
|
||||||
fixjson is a JSON file fixer/formatter for humans using (relaxed) JSON5.
|
|
||||||
It provides:
|
|
||||||
|
|
||||||
- Pretty-prints JSON input
|
|
||||||
- Fixes various failures while humans writing JSON
|
|
||||||
- Fixes trailing commas objects or arrays
|
|
||||||
- Fixes missing commas for elements of objects or arrays
|
|
||||||
- Adds quotes to keys in objects
|
|
||||||
- Newlines in strings
|
|
||||||
- Hex numbers
|
|
||||||
- Fixes single quotes to double quotes
|
|
||||||
|
|
||||||
You can install it using npm:
|
|
||||||
>
|
|
||||||
$ npm install -g fixjson
|
|
||||||
<
|
|
||||||
ALE provides fixjson integration as a fixer. See |ale-fix|.
|
|
||||||
|
|
||||||
g:ale_json_fixjson_executable *g:ale_json_fixjson_executable*
|
|
||||||
*b:ale_json_fixjson_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'fixjson'`
|
|
||||||
|
|
||||||
The executable that will be run for fixjson.
|
|
||||||
|
|
||||||
g:ale_json_fixjson_options *g:ale_json_fixjson_options*
|
|
||||||
*b:ale_json_fixjson_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can add extra options to the command executed for running
|
|
||||||
fixjson.
|
|
||||||
|
|
||||||
g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global*
|
|
||||||
*b:ale_json_fixjson_use_global*
|
|
||||||
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
jsonlint *ale-json-jsonlint*
|
|
||||||
|
|
||||||
g:ale_json_jsonlint_executable *g:ale_json_jsonlint_executable*
|
|
||||||
*b:ale_json_jsonlint_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `'jsonlint'`
|
|
||||||
|
|
||||||
The executable that will be run for jsonlint.
|
|
||||||
|
|
||||||
g:ale_json_jsonlint_use_global *g:ale_json_jsonlint_use_global*
|
|
||||||
*b:ale_json_jsonlint_use_global*
|
|
||||||
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
jq *ale-json-jq*
|
|
||||||
|
|
||||||
g:ale_json_jq_executable *g:ale_json_jq_executable*
|
|
||||||
*b:ale_json_jq_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'jq'`
|
|
||||||
|
|
||||||
This option can be changed to change the path for `jq`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_json_jq_options *g:ale_json_jq_options*
|
|
||||||
*b:ale_json_jq_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This option can be changed to pass extra options to `jq`.
|
|
||||||
|
|
||||||
g:ale_json_jq_filters *g:ale_json_jq_filters*
|
|
||||||
*b:ale_json_jq_filters*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'.'`
|
|
||||||
|
|
||||||
This option can be changed to pass custom filters to `jq`.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-json-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Julia Integration *ale-julia-options*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
languageserver *ale-julia-languageserver*
|
|
||||||
|
|
||||||
To enable Julia LSP linter you need to install the LanguageServer.jl package
|
|
||||||
within julia.
|
|
||||||
|
|
||||||
g:ale_julia_executable *g:ale_julia_executable*
|
|
||||||
*b:ale_julia_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: 'julia'
|
|
||||||
|
|
||||||
Path to the julia exetuable.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Kotlin Integration *ale-kotlin-options*
|
|
||||||
*ale-integration-kotlin*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Integration Information
|
|
||||||
|
|
||||||
Make sure your setup has support for the kotlin file type. A filetype plugin
|
|
||||||
can be found here: https://github.com/udalov/kotlin-vim
|
|
||||||
|
|
||||||
|
|
||||||
Note: Make sure you have a working kotlin compiler
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
kotlinc *ale-kotlin-kotlinc*
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_options *g:ale_kotlin_kotlinc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Additional options to pass to the kotlin compiler
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_enable_config *g:ale_kotlin_kotlinc_enable_config*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Setting this variable to `1` tells the linter to load a configuration file.
|
|
||||||
This should be set in your vimrc
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_config_file *g:ale_kotlin_kotlinc_config_file*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'.ale_kotlin_kotlinc_config'`
|
|
||||||
|
|
||||||
Filename of the configuration file. This should be set in your vimrc
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_classpath *g:ale_kotlin_kotlinc_classpath*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A string containing the paths (separated by the appropriate path separator)
|
|
||||||
of the source directories.
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_sourcepath *g:ale_kotlin_kotlinc_sourcepath*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A string containing the paths (separated by space) of the source
|
|
||||||
directories.
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_use_module_file *g:ale_kotlin_kotlinc_use_module_file*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
This option indicates whether the linter should use a module file. It is off
|
|
||||||
by default.
|
|
||||||
|
|
||||||
g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'module.xml'`
|
|
||||||
|
|
||||||
The filename of the module file that the linter should pass to the kotlin
|
|
||||||
compiler.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ktlint *ale-kotlin-ktlint*
|
|
||||||
|
|
||||||
g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
The Ktlint executable.
|
|
||||||
|
|
||||||
Posix-compliant shell scripts are the only executables that can be found on
|
|
||||||
Ktlint's github release page. If you are not on such a system, your best
|
|
||||||
bet will be to download the ktlint jar and set this option to something
|
|
||||||
similar to `'java -jar /path/to/ktlint.jar'`
|
|
||||||
|
|
||||||
g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets*
|
|
||||||
Type: |List| of |String|s
|
|
||||||
Default: []
|
|
||||||
|
|
||||||
This list should contain paths to ruleset jars and/or strings of maven
|
|
||||||
artifact triples. Example:
|
|
||||||
>
|
|
||||||
let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar',
|
|
||||||
'com.ktlint.rulesets:mycustomrule:1.0.0']
|
|
||||||
|
|
||||||
g:ale_kotlin_ktlint_options *g:ale_kotlin_ktlint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Additional options to pass to ktlint for both linting and fixing. Example:
|
|
||||||
>
|
|
||||||
let g:ale_kotlin_ktlint_options = '--android'
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
languageserver *ale-kotlin-languageserver*
|
|
||||||
|
|
||||||
g:ale_kotlin_languageserver_executable *g:ale_kotlin_languageserver_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
The kotlin-language-server executable.
|
|
||||||
|
|
||||||
Executables are located inside the bin/ folder of the language server
|
|
||||||
release.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE LaTeX Integration *ale-latex-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-latex-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
textlint *ale-latex-textlint*
|
|
||||||
|
|
||||||
See |ale-text-textlint|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Less Integration *ale-less-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
lessc *ale-less-lessc*
|
|
||||||
|
|
||||||
g:ale_less_lessc_executable *g:ale_less_lessc_executable*
|
|
||||||
*b:ale_less_lessc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'lessc'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_less_lessc_options *g:ale_less_lessc_options*
|
|
||||||
*b:ale_less_lessc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to lessc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global*
|
|
||||||
*b:ale_less_lessc_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-less-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stylelint *ale-less-stylelint*
|
|
||||||
|
|
||||||
g:ale_less_stylelint_executable *g:ale_less_stylelint_executable*
|
|
||||||
*b:ale_less_stylelint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'stylelint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_less_stylelint_options *g:ale_less_stylelint_options*
|
|
||||||
*b:ale_less_stylelint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to stylelint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global*
|
|
||||||
*b:ale_less_stylelint_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE LLVM Integration *ale-llvm-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
llc *ale-llvm-llc*
|
|
||||||
|
|
||||||
g:ale_llvm_llc_executable *g:ale_llvm_llc_executable*
|
|
||||||
*b:ale_llvm_llc_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: "llc"
|
|
||||||
|
|
||||||
The command to use for checking. This variable is useful when llc command
|
|
||||||
has suffix like "llc-5.0".
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Lua Integration *ale-lua-options*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
luac *ale-lua-luac*
|
|
||||||
|
|
||||||
g:ale_lua_luac_executable *g:ale_lua_luac_executable*
|
|
||||||
*b:ale_lua_luac_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'luac'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to luac.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
luacheck *ale-lua-luacheck*
|
|
||||||
|
|
||||||
g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable*
|
|
||||||
*b:ale_lua_luacheck_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'luacheck'`
|
|
||||||
|
|
||||||
This variable can be changed to change the path to luacheck.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
|
|
||||||
*b:ale_lua_luacheck_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to luacheck.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Markdown Integration *ale-markdown-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mdl *ale-markdown-mdl*
|
|
||||||
|
|
||||||
g:ale_markdown_mdl_executable *g:ale_markdown_mdl_executable*
|
|
||||||
*b:ale_markdown_mdl_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'mdl'`
|
|
||||||
|
|
||||||
Override the invoked mdl binary. This is useful for running mdl from
|
|
||||||
binstubs or a bundle.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_markdown_mdl_options *g:ale_markdown_mdl_options*
|
|
||||||
*b:ale_markdown_mdl_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to mdl.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prettier *ale-markdown-prettier*
|
|
||||||
|
|
||||||
See |ale-javascript-prettier| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
remark-lint *ale-markdown-remark-lint*
|
|
||||||
|
|
||||||
g:ale_markdown_remark_lint_executable *g:ale_markdown_remark_lint_executable*
|
|
||||||
*b:ale_markdown_remark_lint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'remark'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_markdown_remark_lint_options *g:ale_markdown_remark_lint_options*
|
|
||||||
*b:ale_markdown_remark_lint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to remark-lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_markdown_remark_lint_use_global *g:ale_markdown_remark_lint_use_global*
|
|
||||||
*b:ale_markdown_remark_lint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
textlint *ale-markdown-textlint*
|
|
||||||
|
|
||||||
See |ale-text-textlint|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-markdown-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Mercury Integration *ale-mercury-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mmc *ale-mercury-mmc*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_mercury_mmc_executable *g:ale_mercury_mmc_executable*
|
|
||||||
*b:ale_mercury_mmc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'mmc'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for mmc.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_mercury_mmc_options *g:ale_mercury_mmc_options*
|
|
||||||
*b:ale_mercury_mmc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--make --output-compile-error-lines 100'`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to mmc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE NASM Integration *ale-nasm-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nasm *ale-nasm-nasm*
|
|
||||||
|
|
||||||
g:ale_nasm_nasm_executable *g:ale_nasm_nasm_executable*
|
|
||||||
*b:ale_nasm_nasm_executable*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default `'nasm'`
|
|
||||||
|
|
||||||
This variable can be changed to use different executable for NASM.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_nasm_nasm_options *g:ale_nasm_nasm_options*
|
|
||||||
*b:ale_nasm_nasm_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to NASM.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Nim Integration *ale-nim-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nimcheck *ale-nim-nimcheck*
|
|
||||||
|
|
||||||
ALE does not provide additional configuration options for `nimcheck` at this
|
|
||||||
point.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nimlsp *ale-nim-nimlsp*
|
|
||||||
|
|
||||||
g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Sets the path to Nim source repository as the first argument to `nimlsp`
|
|
||||||
command.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nimpretty *ale-nim-nimpretty*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_nim_nimpretty_executable *g:ale_nim_nimpretty_executable*
|
|
||||||
*b:ale_nim_nimpretty_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'nimpretty'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for nimpretty.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_nim_nimpretty_options *g:ale_nim_nimpretty_options*
|
|
||||||
*b:ale_nim_nimpretty_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--maxLineLen:80'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to nimpretty.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Nix Integration *ale-nix-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
nixpkgs-fmt *ale-nix-nixpkgs-fmt*
|
|
||||||
|
|
||||||
g:ale_nix_nixpkgsfmt_executable *g:ale_nix_nixpkgsfmt_executable*
|
|
||||||
*b:ale_nix_nixpkgsfmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'nixpkgs-fmt'`
|
|
||||||
|
|
||||||
This variable sets executable used for nixpkgs-fmt.
|
|
||||||
|
|
||||||
g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options*
|
|
||||||
*b:ale_nix_nixpkgsfmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the nixpkgs-fmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE nroff Integration *ale-nroff-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-nroff-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Objective-C Integration *ale-objc-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang *ale-objc-clang*
|
|
||||||
|
|
||||||
g:ale_objc_clang_options *g:ale_objc_clang_options*
|
|
||||||
*b:ale_objc_clang_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c11 -Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangd *ale-objc-clangd*
|
|
||||||
|
|
||||||
g:ale_objc_clangd_executable *g:ale_objc_clangd_executable*
|
|
||||||
*b:ale_objc_clangd_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clangd'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangd.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_objc_clangd_options *g:ale_objc_clangd_options*
|
|
||||||
*b:ale_objc_clangd_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clangd.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-objc-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ccls *ale-objc-ccls*
|
|
||||||
|
|
||||||
g:ale_objc_ccls_executable *g:ale_objc_ccls_executable*
|
|
||||||
*b:ale_objc_ccls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ccls'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ccls.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_objc_ccls_init_options *g:ale_objc_ccls_init_options*
|
|
||||||
*b:ale_objc_ccls_init_options*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
This variable can be changed to customize ccls initialization options.
|
|
||||||
Example: >
|
|
||||||
{
|
|
||||||
\ 'cacheDirectory': '/tmp/ccls',
|
|
||||||
\ 'cacheFormat': 'binary',
|
|
||||||
\ 'diagnostics': {
|
|
||||||
\ 'onOpen': 0,
|
|
||||||
\ 'opChange': 1000,
|
|
||||||
\ },
|
|
||||||
\ }
|
|
||||||
<
|
|
||||||
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
|
|
||||||
available options and explanations.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Objective-C++ Integration *ale-objcpp-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clang *ale-objcpp-clang*
|
|
||||||
|
|
||||||
g:ale_objcpp_clang_options *g:ale_objcpp_clang_options*
|
|
||||||
*b:ale_objcpp_clang_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-std=c++14 -Wall'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clang.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
clangd *ale-objcpp-clangd*
|
|
||||||
|
|
||||||
g:ale_objcpp_clangd_executable *g:ale_objcpp_clangd_executable*
|
|
||||||
*b:ale_objcpp_clangd_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'clangd'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for clangd.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_objcpp_clangd_options *g:ale_objcpp_clangd_options*
|
|
||||||
*b:ale_objcpp_clangd_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to clangd.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-objcpp-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE OCaml Integration *ale-ocaml-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
merlin *ale-ocaml-merlin*
|
|
||||||
|
|
||||||
To use merlin linter for OCaml source code you need to make sure Merlin for
|
|
||||||
Vim is correctly configured. See the corresponding Merlin wiki page for
|
|
||||||
detailed instructions
|
|
||||||
(https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ols *ale-ocaml-ols*
|
|
||||||
|
|
||||||
The `ocaml-language-server` is the engine that powers OCaml and ReasonML
|
|
||||||
editor support using the Language Server Protocol. See the installation
|
|
||||||
instructions:
|
|
||||||
https://github.com/freebroccolo/ocaml-language-server#installation
|
|
||||||
|
|
||||||
g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable*
|
|
||||||
*b:ale_ocaml_ols_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ocaml-language-server'`
|
|
||||||
|
|
||||||
This variable can be set to change the executable path for `ols`.
|
|
||||||
|
|
||||||
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global*
|
|
||||||
*b:ale_ocaml_ols_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable can be set to `1` to always use the globally installed
|
|
||||||
executable. See also |ale-integrations-local-executables|.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ocamlformat *ale-ocaml-ocamlformat*
|
|
||||||
|
|
||||||
g:ale_ocaml_ocamlformat_executable *g:ale_ocaml_ocamlformat_executable*
|
|
||||||
*b:ale_ocaml_ocamlformat_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ocamlformat'`
|
|
||||||
|
|
||||||
This variable can be set to pass the path of the ocamlformat fixer.
|
|
||||||
|
|
||||||
g:ale_ocaml_ocamlformat_options *g:ale_ocaml_ocamlformat_options*
|
|
||||||
*b:ale_ocaml_ocamlformat_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the ocamlformat fixer.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ocp-indent *ale-ocaml-ocp-indent*
|
|
||||||
|
|
||||||
g:ale_ocaml_ocp_indent_executable *g:ale_ocaml_ocp_indent_executable*
|
|
||||||
*b:ale_ocaml_ocp_indent_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `ocp-indent`
|
|
||||||
|
|
||||||
This variable can be set to pass the path of the ocp-indent.
|
|
||||||
|
|
||||||
g:ale_ocaml_ocp_indent_options *g:ale_ocaml_ocp_indent_options*
|
|
||||||
*b:ale_ocaml_ocp_indent_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the ocp-indent.
|
|
||||||
|
|
||||||
g:ale_ocaml_ocp_indent_config *g:ale_ocaml_ocp_indent_config*
|
|
||||||
*b:ale_ocaml_ocp_indent_config*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional config to the ocp-indent.
|
|
||||||
Expand after "--config=".
|
|
||||||
|
|
||||||
"ocp-indent" can also be enabled from ocamlformat config.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Pawn Integration *ale-pawn-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
uncrustify *ale-pawn-uncrustify*
|
|
||||||
|
|
||||||
See |ale-c-uncrustify| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Perl Integration *ale-perl-options*
|
|
||||||
|
|
||||||
ALE offers a few ways to check Perl code. Checking code with `perl` is
|
|
||||||
disabled by default, as `perl` code cannot be checked without executing it.
|
|
||||||
Specifically, we use the `-c` flag to see if `perl` code compiles. This does
|
|
||||||
not execute all of the code in a file, but it does run `BEGIN` and `CHECK`
|
|
||||||
blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224
|
|
||||||
|
|
||||||
See |g:ale_linters|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
perl *ale-perl-perl*
|
|
||||||
|
|
||||||
g:ale_perl_perl_executable *g:ale_perl_perl_executable*
|
|
||||||
*b:ale_perl_perl_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'perl'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for linting perl.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_perl_perl_options *g:ale_perl_perl_options*
|
|
||||||
*b:ale_perl_perl_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-c -Mwarnings -Ilib'`
|
|
||||||
|
|
||||||
This variable can be changed to alter the command-line arguments to the perl
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
perlcritic *ale-perl-perlcritic*
|
|
||||||
|
|
||||||
g:ale_perl_perlcritic_executable *g:ale_perl_perlcritic_executable*
|
|
||||||
*b:ale_perl_perlcritic_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'perlcritic'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the perlcritic executable used for
|
|
||||||
linting perl.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_perl_perlcritic_profile *g:ale_perl_perlcritic_profile*
|
|
||||||
*b:ale_perl_perlcritic_profile*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'.perlcriticrc'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the perlcritic profile used for
|
|
||||||
linting perl. The current directory is checked for the file, then the
|
|
||||||
parent directory, etc, until it finds one. If no matching file is found, no
|
|
||||||
profile is passed to perlcritic.
|
|
||||||
|
|
||||||
Set to an empty string to disable passing a specific profile to perlcritic
|
|
||||||
with the `'--profile'` option.
|
|
||||||
|
|
||||||
To prevent perlcritic from using any profile, set this variable to an empty
|
|
||||||
string and pass `'--no-profile'`to perlcritic via the
|
|
||||||
|g:ale_perl_perlcritic_options| variable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_perl_perlcritic_options *g:ale_perl_perlcritic_options*
|
|
||||||
*b:ale_perl_perlcritic_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to supply additional command-line arguments to
|
|
||||||
the perlcritic invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules*
|
|
||||||
|
|
||||||
Type: |Number|
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Controls whether perlcritic rule names are shown after the error message.
|
|
||||||
Defaults to off to reduce length of message.
|
|
||||||
===============================================================================
|
|
||||||
perltidy *ale-perl-perltidy*
|
|
||||||
|
|
||||||
g:ale_perl_perltidy_options *g:ale_perl_perltidy_options*
|
|
||||||
*b:ale_perl_perltidy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to alter the command-line arguments to
|
|
||||||
the perltidy invocation.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Perl6 Integration *ale-perl6-options*
|
|
||||||
|
|
||||||
Checking code with `perl6` is disabled by default, as `perl6` code cannot be
|
|
||||||
checked without executing it. Specifically, we use the `-c` flag to see if
|
|
||||||
`perl6` code compiles. This does not execute all of the code in a file, but it
|
|
||||||
does run `BEGIN` and `CHECK` blocks. See `perl6 --help`
|
|
||||||
|
|
||||||
Full support requires a perl6 implementation that supports the
|
|
||||||
PERL6_EXCEPTIONS_HANDLER environment variable and JSON error output,
|
|
||||||
which was specified in 6.d. Rakudo version 2018.08 is the first rakudo release
|
|
||||||
that supports this. See `perl6 --version` and
|
|
||||||
https://docs.perl6.org/programs/03-environment-variables.
|
|
||||||
|
|
||||||
Without this variable, errors and warnings will appear at line 1, and can be
|
|
||||||
viewed with ALEDetail. This also serves as a fallback for errors and warnings
|
|
||||||
that do not trigger JSON output.
|
|
||||||
|
|
||||||
See |g:ale_linters|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
perl6 *ale-perl6-perl6*
|
|
||||||
|
|
||||||
g:ale_perl6_perl6_executable *g:ale_perl6_perl6_executable*
|
|
||||||
*b:ale_perl6_perl6_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'perl6'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for linting
|
|
||||||
perl6.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_perl6_perl6_options *g:ale_perl6_perl6_options*
|
|
||||||
*b:ale_perl6_perl6_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-c -Ilib'`
|
|
||||||
|
|
||||||
This variable can be changed to alter the command-line arguments to the
|
|
||||||
perl6 invocation.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,234 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE PHP Integration *ale-php-options*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
langserver *ale-php-langserver*
|
|
||||||
|
|
||||||
g:ale_php_langserver_executable *g:ale_php_langserver_executable*
|
|
||||||
*b:ale_php_langserver_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'php-language-server.php'`
|
|
||||||
|
|
||||||
The variable can be set to configure the executable that will be used for
|
|
||||||
running the PHP language server. `vendor` directory executables will be
|
|
||||||
preferred instead of this setting if |g:ale_php_langserver_use_global| is `0`.
|
|
||||||
|
|
||||||
See: |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
|
|
||||||
*b:ale_php_langserver_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable can be set to `1` to force the language server to be run with
|
|
||||||
the executable set for |g:ale_php_langserver_executable|.
|
|
||||||
|
|
||||||
See: |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
phan *ale-php-phan*
|
|
||||||
|
|
||||||
WARNING: please use the phan_client linter if you have an configuration file
|
|
||||||
for your project because the phan will look into your entirely project and
|
|
||||||
ale will display in the current buffer warnings that may belong to other file.
|
|
||||||
|
|
||||||
g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity*
|
|
||||||
*b:ale_php_phan_minimum_severity*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
This variable defines the minimum severity level.
|
|
||||||
|
|
||||||
g:ale_php_phan_executable *g:ale_php_phan_executable*
|
|
||||||
*b:ale_php_phan_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'phan'`
|
|
||||||
|
|
||||||
This variable sets executable used for phan or phan_client.
|
|
||||||
|
|
||||||
g:ale_php_phan_use_client *g:ale_php_phan_use_client*
|
|
||||||
*b:ale_php_phan_use_client*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_php_phan_use_client', 0)`
|
|
||||||
|
|
||||||
This variable can be set to 1 to use the phan_client with phan daemon mode
|
|
||||||
instead of the phan standalone.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
phpcbf *ale-php-phpcbf*
|
|
||||||
|
|
||||||
g:ale_php_phpcbf_executable *g:ale_php_phpcbf_executable*
|
|
||||||
*b:ale_php_phpcbf_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'phpcbf'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
|
|
||||||
*b:ale_php_phpcbf_standard*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to specify the coding standard used by phpcbf. If no
|
|
||||||
coding standard is specified, phpcbf will default to fixing against the
|
|
||||||
PEAR coding standard, or the standard you have set as the default.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
|
|
||||||
*b:ale_php_phpcbf_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
phpcs *ale-php-phpcs*
|
|
||||||
|
|
||||||
g:ale_php_phpcs_executable *g:ale_php_phpcs_executable*
|
|
||||||
*b:ale_php_phpcs_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'phpcs'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
|
|
||||||
*b:ale_php_phpcs_standard*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to specify the coding standard used by phpcs. If no
|
|
||||||
coding standard is specified, phpcs will default to checking against the
|
|
||||||
PEAR coding standard, or the standard you have set as the default.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global*
|
|
||||||
*b:ale_php_phpcs_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpcs_options *g:ale_php_phpcs_options*
|
|
||||||
*b:ale_php_phpcs_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to php-cs
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
phpmd *ale-php-phpmd*
|
|
||||||
|
|
||||||
g:ale_php_phpmd_executable *g:ale_php_phpmd_executable*
|
|
||||||
*b:ale_php_phpmd_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'phpmd'`
|
|
||||||
|
|
||||||
This variable sets executable used for phpmd.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
|
|
||||||
*b:ale_php_phpmd_ruleset*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cleancode,codesize,controversial,design,naming,unusedcode'`
|
|
||||||
|
|
||||||
This variable controls the ruleset used by phpmd. Default is to use all of
|
|
||||||
the available phpmd rulesets
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
phpstan *ale-php-phpstan*
|
|
||||||
|
|
||||||
g:ale_php_phpstan_executable *g:ale_php_phpstan_executable*
|
|
||||||
*b:ale_php_phpstan_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'phpstan'`
|
|
||||||
|
|
||||||
This variable sets executable used for phpstan.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpstan_level *g:ale_php_phpstan_level*
|
|
||||||
*b:ale_php_phpstan_level*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable controls the rule levels. 0 is the loosest and 7 is the
|
|
||||||
strictest. If this option isn't set, the rule level will be controlled by
|
|
||||||
the configuration file. If no configuration file can be detected, `'7'` will
|
|
||||||
be used instead.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpstan_configuration *g:ale_php_phpstan_configuration*
|
|
||||||
*b:ale_php_phpstan_configuration*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable sets path to phpstan configuration file.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_php_phpstan_autoload *g:ale_php_phpstan_autoload*
|
|
||||||
*b:ale_php_phpstan_autoload*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable sets path to phpstan autoload file.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
psalm *ale-php-psalm*
|
|
||||||
|
|
||||||
g:ale_php_psalm_executable *g:ale_php_psalm_executable*
|
|
||||||
*b:ale_php_psalm_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'psalm'`
|
|
||||||
|
|
||||||
This variable sets the executable used for psalm.
|
|
||||||
|
|
||||||
g:ale_psalm_langserver_options *g:ale_psalm_langserver_options*
|
|
||||||
*b:ale_psalm_langserver_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to psalm.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
php-cs-fixer *ale-php-php-cs-fixer*
|
|
||||||
|
|
||||||
g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable*
|
|
||||||
*b:ale_php_cs_fixer_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'php-cs-fixer'`
|
|
||||||
|
|
||||||
This variable sets executable used for php-cs-fixer.
|
|
||||||
|
|
||||||
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
|
|
||||||
*b:ale_php_cs_fixer_use_global*
|
|
||||||
Type: |Boolean|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable force globally installed fixer.
|
|
||||||
|
|
||||||
g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options*
|
|
||||||
*b:ale_php_cs_fixer_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to php-cs-fixer.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
php *ale-php-php*
|
|
||||||
|
|
||||||
g:ale_php_php_executable *g:ale_php_php_executable*
|
|
||||||
*b:ale_php_php_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'php'`
|
|
||||||
|
|
||||||
This variable sets the executable used for php.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE PO Integration *ale-po-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-po-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Pod Integration *ale-pod-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-pod-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Pony Integration *ale-pony-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ponyc *ale-pony-ponyc*
|
|
||||||
|
|
||||||
g:ale_pony_ponyc_executable *g:ale_pony_ponyc_executable*
|
|
||||||
*b:ale_pony_ponyc_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ponyc'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_pony_ponyc_options *g:ale_pony_ponyc_options*
|
|
||||||
*b:ale_pony_ponyc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--pass paint'`
|
|
||||||
|
|
||||||
This variable can be set to pass options to ponyc.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE PowerShell Integration *ale-powershell-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
powershell *ale-powershell-powershell*
|
|
||||||
|
|
||||||
g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable*
|
|
||||||
*b:ale_powershell_powershell_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'pwsh'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for powershell.
|
|
||||||
|
|
||||||
>
|
|
||||||
" Use powershell.exe rather than the default pwsh
|
|
||||||
let g:ale_powershell_powershell_executable = 'powershell.exe'
|
|
||||||
>
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
psscriptanalyzer *ale-powershell-psscriptanalyzer*
|
|
||||||
|
|
||||||
Installation
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
Install PSScriptAnalyzer by any means, so long as it can be automatically
|
|
||||||
imported in PowerShell.
|
|
||||||
Some PowerShell plugins set the filetype of files to `ps1`. To continue using
|
|
||||||
these plugins, use the ale_linter_aliases global to alias `ps1` to `powershell`
|
|
||||||
|
|
||||||
>
|
|
||||||
" Allow ps1 filetype to work with powershell linters
|
|
||||||
let g:ale_linter_aliases = {'ps1': 'powershell'}
|
|
||||||
<
|
|
||||||
|
|
||||||
g:ale_powershell_psscriptanalyzer_executable
|
|
||||||
*g:ale_powershell_psscriptanalyzer_executable*
|
|
||||||
*b:ale_powershell_psscriptanalyzer_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pwsh'`
|
|
||||||
|
|
||||||
This variable sets executable used for powershell.
|
|
||||||
|
|
||||||
For example, on Windows you could set powershell to be Windows Powershell:
|
|
||||||
>
|
|
||||||
let g:ale_powershell_psscriptanalyzer_executable = 'powershell.exe'
|
|
||||||
<
|
|
||||||
|
|
||||||
g:ale_powershell_psscriptanalyzer_module
|
|
||||||
*g:ale_powershell_psscriptanalyzer_module*
|
|
||||||
*b:ale_powershell_psscriptanalyzer_module*
|
|
||||||
Type: |String
|
|
||||||
Default: `'psscriptanalyzer'`
|
|
||||||
|
|
||||||
This variable sets the name of the psscriptanalyzer module.
|
|
||||||
for psscriptanalyzer invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_powershell_psscriptanalyzer_exclusions
|
|
||||||
*g:ale_powershell_psscriptanalyzer_exclusions*
|
|
||||||
*b:ale_powershell_psscriptanalyzer_exclusions*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
Set this variable to exclude test(s) for psscriptanalyzer
|
|
||||||
(-ExcludeRule option). To exclude more than one option, separate them with
|
|
||||||
commas.
|
|
||||||
|
|
||||||
>
|
|
||||||
" Suppress Write-Host and Global vars warnings
|
|
||||||
let g:ale_powershell_psscriptanalyzer_exclusions =
|
|
||||||
\ 'PSAvoidUsingWriteHost,PSAvoidGlobalVars'
|
|
||||||
<
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Prolog Integration *ale-prolog-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
swipl *ale-prolog-swipl*
|
|
||||||
|
|
||||||
g:ale_prolog_swipl_executable *g:ale_prolog_swipl_executable*
|
|
||||||
*b:ale_prolog_swipl_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'swipl'`
|
|
||||||
|
|
||||||
The executable that will be run for the `swipl` linter.
|
|
||||||
|
|
||||||
g:ale_prolog_swipl_load *g:ale_prolog_swipl_load*
|
|
||||||
*b:ale_prolog_swipl_load*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'`
|
|
||||||
|
|
||||||
The prolog goals that will be passed to |g:ale_prolog_swipl_executable| with `-g` option.
|
|
||||||
|
|
||||||
It does:
|
|
||||||
1. Takes the first command argument (current file path)
|
|
||||||
2. Checks (syntactic / semantic) problems and output to stderr
|
|
||||||
|
|
||||||
NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'.
|
|
||||||
|
|
||||||
g:ale_prolog_swipl_timeout *g:ale_prolog_swipl_timeout*
|
|
||||||
*b:ale_prolog_swipl_timeout*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `3`
|
|
||||||
|
|
||||||
Timeout seconds to detect long-running linter.
|
|
||||||
It is done by setting SIGALRM.
|
|
||||||
See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|.
|
|
||||||
|
|
||||||
g:ale_prolog_swipl_alarm *g:ale_prolog_swipl_alarm*
|
|
||||||
*b:ale_prolog_swipl_alarm*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'alarm(%t, (%h), _, [])'`
|
|
||||||
|
|
||||||
The prolog goals to be expected to set SIGALRM.
|
|
||||||
`%t` is replaced by |g:ale_prolog_swipl_timeout|.
|
|
||||||
`%h` is replaced by |g:ale_prolog_swipl_alarm_handler|.
|
|
||||||
|
|
||||||
g:ale_prolog_swipl_alarm_handler *g:ale_prolog_swipl_alarm_handler*
|
|
||||||
*b:ale_prolog_swipl_alarm_handler*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'`
|
|
||||||
|
|
||||||
The prolog goals to be expected that will be run on SIGALRM.
|
|
||||||
`%t` is replaced by |g:ale_prolog_swipl_timeout|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Proto Integration *ale-proto-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Integration Information
|
|
||||||
|
|
||||||
Linting of `.proto` files requires that the `protoc` binary is installed in the
|
|
||||||
system path and that the `protoc-gen-lint` plugin for the `protoc` binary is also
|
|
||||||
installed.
|
|
||||||
|
|
||||||
To enable `.proto` file linting, update |g:ale_linters| as appropriate:
|
|
||||||
>
|
|
||||||
" Enable linter for .proto files
|
|
||||||
let g:ale_linters = {'proto': ['protoc-gen-lint']}
|
|
||||||
<
|
|
||||||
===============================================================================
|
|
||||||
protoc-gen-lint *ale-proto-protoc-gen-lint*
|
|
||||||
|
|
||||||
The linter is a plugin for the `protoc` binary. As long as the binary resides
|
|
||||||
in the system path, `protoc` will find it.
|
|
||||||
|
|
||||||
g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to protoc. Note that the
|
|
||||||
directory of the linted file is always passed as an include path with '-I'
|
|
||||||
before any user-supplied options.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Pug Integration *ale-pug-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
puglint *ale-pug-puglint*
|
|
||||||
|
|
||||||
The puglint linter will detect configuration files based on the path to the
|
|
||||||
filename automatically. Configuration files will be loaded in this order:
|
|
||||||
|
|
||||||
1. `.pug-lintrc`
|
|
||||||
2. `.pug-lintrc.js`
|
|
||||||
3. `.pug-lintrc.json`
|
|
||||||
4. `package.json`
|
|
||||||
|
|
||||||
You might need to create a configuration file for your project to get
|
|
||||||
meaningful results.
|
|
||||||
|
|
||||||
g:ale_pug_puglint_executable *g:ale_pug_puglint_executable*
|
|
||||||
*b:ale_pug_puglint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pug-lint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_pug_puglint_options *g:ale_pug_puglint_options*
|
|
||||||
*b:ale_pug_puglint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to pug-lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_pug_puglint_use_global *g:ale_pug_puglint_use_global*
|
|
||||||
*b:ale_pug_puglint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Puppet Integration *ale-puppet-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
puppet *ale-puppet-puppet*
|
|
||||||
|
|
||||||
g:ale_puppet_puppet_executable *g:ale_puppet_puppet_executable*
|
|
||||||
*b:ale_puppet_puppet_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'puppet'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the executable used for puppet.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_puppet_puppet_options *g:ale_puppet_puppet_options*
|
|
||||||
*b:ale_puppet_puppet_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the
|
|
||||||
puppet parser validate invocation.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
puppetlint *ale-puppet-puppetlint*
|
|
||||||
|
|
||||||
g:ale_puppet_puppetlint_executable *g:ale_puppet_puppetlint_executable*
|
|
||||||
*b:ale_puppet_puppetlint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'puppet-lint'`
|
|
||||||
|
|
||||||
This variable can be changed to specify the executable used for puppet-lint.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_puppet_puppetlint_options *g:ale_puppet_puppetlint_options*
|
|
||||||
*b:ale_puppet_puppetlint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--no-autoloader_layout-check'`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the
|
|
||||||
puppet-lint invocation.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
puppet-languageserver *ale-puppet-languageserver*
|
|
||||||
|
|
||||||
g:ale_puppet_languageserver_executable *g:ale_puppet_languageserver_executable*
|
|
||||||
*b:ale_puppet_languageserver_executable*
|
|
||||||
type: |String|
|
|
||||||
Default: `'puppet-languageserver'`
|
|
||||||
|
|
||||||
This variable can be used to specify the executable used for
|
|
||||||
puppet-languageserver.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE PureScript Integration *ale-purescript-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
purescript-language-server *ale-purescript-language-server*
|
|
||||||
|
|
||||||
PureScript Language Server
|
|
||||||
(https://github.com/nwolverson/purescript-language-server)
|
|
||||||
|
|
||||||
g:ale_purescript_ls_executable g:ale_purescript_ls_executable
|
|
||||||
b:ale_purescript_ls_executable
|
|
||||||
Type: |String|
|
|
||||||
Default: `'purescript-language-server'`
|
|
||||||
|
|
||||||
PureScript language server executable.
|
|
||||||
|
|
||||||
g:ale_purescript_ls_config g:ale_purescript_ls_config
|
|
||||||
b:ale_purescript_ls_config
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary containing configuration settings that will be passed to the
|
|
||||||
language server. For example, with a spago project:
|
|
||||||
{
|
|
||||||
\ 'purescript': {
|
|
||||||
\ 'addSpagoSources': v:true,
|
|
||||||
\ 'addNpmPath': v:true,
|
|
||||||
\ 'buildCommand': 'spago build -- --json-errors'
|
|
||||||
\ }
|
|
||||||
\}
|
|
||||||
===============================================================================
|
|
||||||
purty *ale-purescript-purty*
|
|
||||||
|
|
||||||
g:ale_purescript_purty_executable *g:ale_purescript_purty_executable*
|
|
||||||
*b:ale_purescript_purty_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'purty'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for purty.
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Pyrex (Cython) Integration *ale-pyrex-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cython *ale-pyrex-cython*
|
|
||||||
|
|
||||||
g:ale_pyrex_cython_executable *g:ale_pyrex_cython_executable*
|
|
||||||
*b:ale_pyrex_cython_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'cython'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for cython.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_pyrex_cython_options *g:ale_pyrex_cython_options*
|
|
||||||
*b:ale_pyrex_cython_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'--warning-extra --warning-errors'`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to cython.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,774 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Python Integration *ale-python-options*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_auto_pipenv *g:ale_python_auto_pipenv*
|
|
||||||
*b:ale_python_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ALE Python Project Root Behavior *ale-python-root*
|
|
||||||
|
|
||||||
For some linters, ALE will search for a Python project root by looking at the
|
|
||||||
files in directories on or above where a file being checked is. ALE applies
|
|
||||||
the following methods, in order:
|
|
||||||
|
|
||||||
1. Find the first directory containing a common Python configuration file.
|
|
||||||
2. If no configuration file can be found, use the first directory which does
|
|
||||||
not contain a readable file named `__init__.py`.
|
|
||||||
|
|
||||||
ALE will look for configuration files with the following filenames. >
|
|
||||||
|
|
||||||
MANIFEST.in
|
|
||||||
setup.cfg
|
|
||||||
pytest.ini
|
|
||||||
tox.ini
|
|
||||||
mypy.ini
|
|
||||||
pycodestyle.cfg
|
|
||||||
.flake8
|
|
||||||
.flake8rc
|
|
||||||
pylama.ini
|
|
||||||
pylintrc
|
|
||||||
.pylintrc
|
|
||||||
Pipfile
|
|
||||||
Pipfile.lock
|
|
||||||
<
|
|
||||||
|
|
||||||
The first directory containing any of the files named above will be used.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
autopep8 *ale-python-autopep8*
|
|
||||||
|
|
||||||
g:ale_python_autopep8_executable *g:ale_python_autopep8_executable*
|
|
||||||
*b:ale_python_autopep8_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'autopep8'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_autopep8_options *g:ale_python_autopep8_options*
|
|
||||||
*b:ale_python_autopep8_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass extra options to autopep8.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
|
|
||||||
*b:ale_python_autopep8_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
bandit *ale-python-bandit*
|
|
||||||
|
|
||||||
g:ale_python_bandit_executable *g:ale_python_bandit_executable*
|
|
||||||
*b:ale_python_bandit_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'bandit'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `bandit'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_bandit_options *g:ale_python_bandit_options*
|
|
||||||
*b:ale_python_bandit_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the
|
|
||||||
bandit invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_bandit_use_config *g:ale_python_bandit_use_config*
|
|
||||||
*b:ale_python_bandit_use_config*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If this variable is true and a `.bandit` file exists in the directory of the
|
|
||||||
file being checked or a parent directory, an `--ini` option is added to the
|
|
||||||
`bandit` command for the nearest `.bandit` file. Set this variable false to
|
|
||||||
disable adding the `--ini` option automatically.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_bandit_use_global *g:ale_python_bandit_use_global*
|
|
||||||
*b:ale_python_bandit_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_bandit_auto_pipenv *g:ale_python_bandit_auto_pipenv*
|
|
||||||
*b:ale_python_bandit_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
black *ale-python-black*
|
|
||||||
|
|
||||||
g:ale_python_black_executable *g:ale_python_black_executable*
|
|
||||||
*b:ale_python_black_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'black'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_black_options *g:ale_python_black_options*
|
|
||||||
*b:ale_python_black_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass extra options to black.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_black_use_global *g:ale_python_black_use_global*
|
|
||||||
*b:ale_python_black_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_black_auto_pipenv *g:ale_python_black_auto_pipenv*
|
|
||||||
*b:ale_python_black_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
g:ale_python_black_change_directory *g:ale_python_black_change_directory*
|
|
||||||
*b:ale_python_black_change_directory*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If set to `1`, ALE will switch to the directory the Python file being
|
|
||||||
checked with `black` is in before checking it. This helps `black` find
|
|
||||||
configuration files more easily. This option can be turned off if you want
|
|
||||||
to control the directory Python is executed from yourself.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
flake8 *ale-python-flake8*
|
|
||||||
|
|
||||||
g:ale_python_flake8_change_directory *g:ale_python_flake8_change_directory*
|
|
||||||
*b:ale_python_flake8_change_directory*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If set to `1`, ALE will switch to the directory the Python file being
|
|
||||||
checked with `flake8` is in before checking it. This helps `flake8` find
|
|
||||||
configuration files more easily. This option can be turned off if you want
|
|
||||||
to control the directory Python is executed from yourself.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_flake8_executable *g:ale_python_flake8_executable*
|
|
||||||
*b:ale_python_flake8_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'flake8'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for flake8. Set
|
|
||||||
this to `'pipenv'` to invoke `'pipenv` `run` `flake8'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_flake8_options *g:ale_python_flake8_options*
|
|
||||||
*b:ale_python_flake8_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the flake8
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
For example, to dynamically switch between programs targeting Python 2 and
|
|
||||||
Python 3, you may want to set >
|
|
||||||
|
|
||||||
let g:ale_python_flake8_executable = 'python3' " or 'python' for Python 2
|
|
||||||
let g:ale_python_flake8_options = '-m flake8'
|
|
||||||
<
|
|
||||||
after making sure it's installed for the appropriate Python versions (e.g.
|
|
||||||
`python3 -m pip install --user flake8`).
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
|
|
||||||
*b:ale_python_flake8_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable controls whether or not ALE will search for flake8 in a
|
|
||||||
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
||||||
always use |g:ale_python_flake8_executable| for the executable path.
|
|
||||||
|
|
||||||
Both variables can be set with `b:` buffer variables instead.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_flake8_auto_pipenv *g:ale_python_flake8_auto_pipenv*
|
|
||||||
*b:ale_python_flake8_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
isort *ale-python-isort*
|
|
||||||
|
|
||||||
g:ale_python_isort_executable *g:ale_python_isort_executable*
|
|
||||||
*b:ale_python_isort_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'isort'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_isort_options *g:ale_python_isort_options*
|
|
||||||
*b:ale_python_isort_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass extra options to isort.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_isort_use_global *g:ale_python_isort_use_global*
|
|
||||||
*b:ale_python_isort_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
mypy *ale-python-mypy*
|
|
||||||
|
|
||||||
The minimum supported version of mypy that ALE supports is v0.4.4. This is
|
|
||||||
the first version containing the `--shadow-file` option ALE needs to be able
|
|
||||||
to check for errors while you type.
|
|
||||||
|
|
||||||
`mypy` will be run from a detected project root, per |ale-python-root|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_auto_pipenv *g:ale_python_mypy_auto_pipenv*
|
|
||||||
*b:ale_python_mypy_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_executable *g:ale_python_mypy_executable*
|
|
||||||
*b:ale_python_mypy_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'mypy'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `mypy'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_ignore_invalid_syntax
|
|
||||||
*g:ale_python_mypy_ignore_invalid_syntax*
|
|
||||||
*b:ale_python_mypy_ignore_invalid_syntax*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, syntax error messages for mypy will be ignored. This option
|
|
||||||
can be used when running other Python linters which check for syntax errors,
|
|
||||||
as mypy can take a while to finish executing.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_options *g:ale_python_mypy_options*
|
|
||||||
*b:ale_python_mypy_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the mypy
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_show_notes *g:ale_python_mypy_show_notes*
|
|
||||||
*b:ale_python_mypy_show_notes*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If enabled, notes on lines will be displayed as 'I' (info) messages.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
|
|
||||||
*b:ale_python_mypy_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
prospector *ale-python-prospector*
|
|
||||||
|
|
||||||
g:ale_python_prospector_executable *g:ale_python_prospector_executable*
|
|
||||||
*b:ale_python_prospector_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'prospector'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `prospector'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_prospector_options *g:ale_python_prospector_options*
|
|
||||||
*b:ale_python_prospector_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the prospector
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
For example, to dynamically switch between programs targeting Python 2 and
|
|
||||||
Python 3, you may want to set >
|
|
||||||
|
|
||||||
let g:ale_python_prospector_executable = 'python3'
|
|
||||||
" or 'python' for Python 2
|
|
||||||
let g:ale_python_prospector_options = '--rcfile /path/to/.prospector.yaml'
|
|
||||||
" The virtualenv detection needs to be disabled.
|
|
||||||
let g:ale_python_prospector_use_global = 0
|
|
||||||
|
|
||||||
after making sure it's installed for the appropriate Python versions (e.g.
|
|
||||||
`python3 -m pip install --user prospector`).
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_prospector_use_global *g:ale_python_prospector_use_global*
|
|
||||||
*b:ale_python_prospector_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_prospector_auto_pipenv *g:ale_python_prospector_auto_pipenv*
|
|
||||||
*b:ale_python_prospector_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pycodestyle *ale-python-pycodestyle*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pycodestyle_executable *g:ale_python_pycodestyle_executable*
|
|
||||||
*b:ale_python_pycodestyle_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pycodestyle'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pycodestyle'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pycodestyle_options *g:ale_python_pycodestyle_options*
|
|
||||||
*b:ale_python_pycodestyle_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the
|
|
||||||
pycodestyle invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pycodestyle_use_global *g:ale_python_pycodestyle_use_global*
|
|
||||||
*b:ale_python_pycodestyle_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pycodestyle_auto_pipenv *g:ale_python_pycodestyle_auto_pipenv*
|
|
||||||
*b:ale_python_pycodestyle_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pydocstyle *ale-python-pydocstyle*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pydocstyle_executable *g:ale_python_pydocstyle_executable*
|
|
||||||
*b:ale_python_pydocstyle_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pydocstyle'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pydocstyle'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pydocstyle_options *g:ale_python_pydocstyle_options*
|
|
||||||
*b:ale_python_pydocstyle_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the
|
|
||||||
pydocstyle invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pydocstyle_use_global *g:ale_python_pydocstyle_use_global*
|
|
||||||
*b:ale_python_pydocstyle_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pydocstyle_auto_pipenv *g:ale_python_pydocstyle_auto_pipenv*
|
|
||||||
*b:ale_python_pydocstyle_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pyflakes *ale-python-pyflakes*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyflakes_executable *g:ale_python_pyflakes_executable*
|
|
||||||
*b:ale_python_pyflakes_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pyflakes'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyflakes'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyflakes_auto_pipenv *g:ale_python_pyflakes_auto_pipenv*
|
|
||||||
*b:ale_python_pyflakes_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pylama *ale-python-pylama*
|
|
||||||
|
|
||||||
g:ale_python_pylama_change_directory *g:ale_python_pylama_change_directory*
|
|
||||||
*b:ale_python_pylama_change_directory*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If set to `1`, `pylama` will be run from a detected project root, per
|
|
||||||
|ale-python-root|. This is useful because `pylama` only searches for
|
|
||||||
configuration files in its current directory and applies file masks using
|
|
||||||
paths relative to its current directory. This option can be turned off if
|
|
||||||
you want to control the directory in which `pylama` is executed.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylama_executable *g:ale_python_pylama_executable*
|
|
||||||
*b:ale_python_pylama_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pylama'`
|
|
||||||
|
|
||||||
This variable can be changed to modify the executable used for pylama. Set
|
|
||||||
this to `'pipenv'` to invoke `'pipenv` `run` `pylama'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylama_options *g:ale_python_pylama_options*
|
|
||||||
*b:ale_python_pylama_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the pylama
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylama_use_global *g:ale_python_pylama_use_global*
|
|
||||||
*b:ale_python_pylama_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable controls whether or not ALE will search for pylama in a
|
|
||||||
virtualenv directory first. If this variable is set to `1`, then ALE will
|
|
||||||
always use |g:ale_python_pylama_executable| for the executable path.
|
|
||||||
|
|
||||||
Both variables can be set with `b:` buffer variables instead.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylama_auto_pipenv *g:ale_python_pylama_auto_pipenv*
|
|
||||||
*b:ale_python_pylama_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pylint *ale-python-pylint*
|
|
||||||
|
|
||||||
g:ale_python_pylint_change_directory *g:ale_python_pylint_change_directory*
|
|
||||||
*b:ale_python_pylint_change_directory*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If set to `1`, `pylint` will be run from a detected project root, per
|
|
||||||
|ale-python-root|. Since `pylint` only checks for `pylintrc` in the packages
|
|
||||||
above its current directory before falling back to user and global `pylintrc`
|
|
||||||
files, this is necessary for `pylint` to use a project `pylintrc` file, if
|
|
||||||
present. This option can be turned off if you want to control the directory
|
|
||||||
Python is executed from yourself.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylint_executable *g:ale_python_pylint_executable*
|
|
||||||
*b:ale_python_pylint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pylint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pylint'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylint_options *g:ale_python_pylint_options*
|
|
||||||
*b:ale_python_pylint_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the pylint
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
For example, to dynamically switch between programs targeting Python 2 and
|
|
||||||
Python 3, you may want to set >
|
|
||||||
|
|
||||||
let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2
|
|
||||||
let g:ale_python_pylint_options = '--rcfile /path/to/pylint.rc'
|
|
||||||
" The virtualenv detection needs to be disabled.
|
|
||||||
let g:ale_python_pylint_use_global = 0
|
|
||||||
|
|
||||||
after making sure it's installed for the appropriate Python versions (e.g.
|
|
||||||
`python3 -m pip install --user pylint`).
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
|
|
||||||
*b:ale_python_pylint_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylint_auto_pipenv *g:ale_python_pylint_auto_pipenv*
|
|
||||||
*b:ale_python_pylint_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pylint_use_msg_id *g:ale_python_pylint_use_msg_id*
|
|
||||||
*b:ale_python_pylint_use_msg_id*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Use message for output (e.g. I0011) instead of symbolic name of the message
|
|
||||||
(e.g. locally-disabled).
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pyls *ale-python-pyls*
|
|
||||||
|
|
||||||
`pyls` will be run from a detected project root, per |ale-python-root|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyls_executable *g:ale_python_pyls_executable*
|
|
||||||
*b:ale_python_pyls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pyls'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyls'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
|
|
||||||
*b:ale_python_pyls_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyls_auto_pipenv *g:ale_python_pyls_auto_pipenv*
|
|
||||||
*b:ale_python_pyls_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyls_config *g:ale_python_pyls_config*
|
|
||||||
*b:ale_python_pyls_config*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary with configuration settings for pyls. For example, to disable
|
|
||||||
the pycodestyle linter: >
|
|
||||||
{
|
|
||||||
\ 'pyls': {
|
|
||||||
\ 'plugins': {
|
|
||||||
\ 'pycodestyle': {
|
|
||||||
\ 'enabled': v:false
|
|
||||||
\ }
|
|
||||||
\ }
|
|
||||||
\ },
|
|
||||||
\ }
|
|
||||||
<
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
pyre *ale-python-pyre*
|
|
||||||
|
|
||||||
`pyre` will be run from a detected project root, per |ale-python-root|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyre_executable *g:ale_python_pyre_executable*
|
|
||||||
*b:ale_python_pyre_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'pyre'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyre'`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyre_use_global *g:ale_python_pyre_use_global*
|
|
||||||
*b:ale_python_pyre_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_pyre_auto_pipenv *g:ale_python_pyre_auto_pipenv*
|
|
||||||
*b:ale_python_pyre_auto_pipenv*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
|
|
||||||
if true. This is overridden by a manually-set executable.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
reorder-python-imports *ale-python-reorder_python_imports*
|
|
||||||
|
|
||||||
g:ale_python_reorder_python_imports_executable
|
|
||||||
*g:ale_python_reorder_python_imports_executable*
|
|
||||||
*b:ale_python_reorder_python_imports_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'reorder-python-imports'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_reorder_python_imports_options
|
|
||||||
*g:ale_python_reorder_python_imports_options*
|
|
||||||
*b:ale_python_reorder_python_imports_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass extra options to reorder-python-imports.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_reorder_python_imports_use_global
|
|
||||||
*g:ale_python_reorder_python_imports_use_global*
|
|
||||||
*b:ale_python_reorder_python_imports_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vulture *ale-python-vulture*
|
|
||||||
|
|
||||||
g:ale_python_vulture_change_directory *g:ale_python_vulture_change_directory*
|
|
||||||
*b:ale_python_vulture_change_directory*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
If set to `1`, ALE will switch to the directory the Python file being
|
|
||||||
checked with `vulture` is in before checking it and check the whole project
|
|
||||||
directory instead of checking only the file opened in the current buffer.
|
|
||||||
This helps `vulture` to know the context and avoid false-negative results.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_vulture_executable *g:ale_python_vulture_executable*
|
|
||||||
*b:ale_python_vulture_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'vulture'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_vulture_options *g:ale_python_vulture_options*
|
|
||||||
*b:ale_python_vulture_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to add command-line arguments to the vulture
|
|
||||||
invocation.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_vulture_use_global *g:ale_python_vulture_use_global*
|
|
||||||
*b:ale_python_vulture_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
yapf *ale-python-yapf*
|
|
||||||
|
|
||||||
g:ale_python_yapf_executable *g:ale_python_yapf_executable*
|
|
||||||
*b:ale_python_yapf_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'yapf'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_python_yapf_use_global *g:ale_python_yapf_use_global*
|
|
||||||
*b:ale_python_yapf_use_global*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE QML Integration *ale-qml-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
qmlfmt *ale-qml-qmlfmt*
|
|
||||||
|
|
||||||
g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable*
|
|
||||||
*b:ale_qml_qmlfmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'qmlfmt'`
|
|
||||||
|
|
||||||
This variable can be set to change the path to qmlfmt.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE R Integration *ale-r-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
lintr *ale-r-lintr*
|
|
||||||
|
|
||||||
g:ale_r_lintr_options *g:ale_r_lintr_options*
|
|
||||||
*b:ale_r_lintr_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'lintr::with_defaults()'`
|
|
||||||
|
|
||||||
This option can be configured to change the options for lintr.
|
|
||||||
|
|
||||||
The value of this option will be run with `eval` for the `lintr::lint`
|
|
||||||
options. Consult the lintr documentation for more information.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package*
|
|
||||||
*b:ale_r_lintr_lint_package*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, the file will be checked with `lintr::lint_package` instead
|
|
||||||
of `lintr::lint`. This prevents erroneous namespace warnings when linting
|
|
||||||
package files.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
styler *ale-r-styler*
|
|
||||||
|
|
||||||
g:ale_r_styler_options *g:ale_r_styler_options*
|
|
||||||
*b:ale_r_styler_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'styler::tidyverse_style'`
|
|
||||||
|
|
||||||
This option can be configured to change the options for styler.
|
|
||||||
|
|
||||||
The value of this option will be used as the `style` argument for the
|
|
||||||
`styler::style_file` options. Consult the styler documentation
|
|
||||||
for more information.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE ReasonML Integration *ale-reasonml-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
merlin *ale-reasonml-merlin*
|
|
||||||
|
|
||||||
To use merlin linter for ReasonML source code you need to make sure Merlin for
|
|
||||||
Vim is correctly configured. See the corresponding Merlin wiki page for
|
|
||||||
detailed instructions:
|
|
||||||
https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ols *ale-reasonml-ols*
|
|
||||||
|
|
||||||
The `ocaml-language-server` is the engine that powers OCaml and ReasonML
|
|
||||||
editor support using the Language Server Protocol. See the installation
|
|
||||||
instructions:
|
|
||||||
https://github.com/freebroccolo/ocaml-language-server#installation
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_reason_ols_executable *g:ale_reason_ols_executable*
|
|
||||||
*b:ale_reason_ols_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'ocaml-language-server'`
|
|
||||||
|
|
||||||
This variable can be set to change the executable path for `ols`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_reason_ols_use_global *g:ale_reason_ols_use_global*
|
|
||||||
*b:ale_reason_ols_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
This variable can be set to `1` to always use the globally installed
|
|
||||||
executable. See also |ale-integrations-local-executables|.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
reason-language-server *ale-reasonml-language-server*
|
|
||||||
|
|
||||||
Note: You must set an executable - there is no 'default' install location.
|
|
||||||
Go to https://github.com/jaredly/reason-language-server and download the
|
|
||||||
latest release. You can place it anywhere, but ensure you set the executable
|
|
||||||
path.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_reason_ls_executable *g:ale_reason_ls_executable*
|
|
||||||
*b:ale_reason_ls_executable*
|
|
||||||
Type: |String|
|
|
||||||
|
|
||||||
This variable defines the standard location of the language server
|
|
||||||
executable. This must be set.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
refmt *ale-reasonml-refmt*
|
|
||||||
|
|
||||||
g:ale_reasonml_refmt_executable *g:ale_reasonml_refmt_executable*
|
|
||||||
*b:ale_reasonml_refmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'refmt'`
|
|
||||||
|
|
||||||
This variable can be set to pass the path of the refmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_reasonml_refmt_options *g:ale_reasonml_refmt_options*
|
|
||||||
*b:ale_reasonml_refmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the refmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE reStructuredText Integration *ale-restructuredtext-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
textlint *ale-restructuredtext-textlint*
|
|
||||||
|
|
||||||
To use textlint at reStructuredText, please install `textlint-plugin-rst`.
|
|
||||||
https://github.com/jimo1001/textlint-plugin-rst
|
|
||||||
>
|
|
||||||
$ npm install textlint-plugin-rst
|
|
||||||
|
|
||||||
To install `textlint-plugin-rst`, `docutils-ast-writer` python package
|
|
||||||
must be installed.
|
|
||||||
See: https://github.com/jimo1001/docutils-ast-writer
|
|
||||||
|
|
||||||
See |ale-text-textlint|
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
write-good *ale-restructuredtext-write-good*
|
|
||||||
|
|
||||||
See |ale-write-good-options|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,195 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Ruby Integration *ale-ruby-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
brakeman *ale-ruby-brakeman*
|
|
||||||
|
|
||||||
g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable*
|
|
||||||
*b:ale_ruby_brakeman_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'brakeman'`
|
|
||||||
|
|
||||||
Override the invoked brakeman binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` brakeman'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_brakeman_options *g:ale_ruby_brakeman_options*
|
|
||||||
*b:ale_ruby_brakeman_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
The contents of this variable will be passed through to brakeman.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
debride *ale-ruby-debride*
|
|
||||||
|
|
||||||
g:ale_ruby_debride_executable *g:ale_ruby_debride_executable*
|
|
||||||
*b:ale_ruby_debride_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'debride'`
|
|
||||||
|
|
||||||
Override the invoked debride binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` debride'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_debride_options *g:ale_ruby_debride_options*
|
|
||||||
*b:ale_ruby_debride_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to debride.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rails_best_practices *ale-ruby-rails_best_practices*
|
|
||||||
|
|
||||||
g:ale_ruby_rails_best_practices_executable
|
|
||||||
*g:ale_ruby_rails_best_practices_executable*
|
|
||||||
*b:ale_ruby_rails_best_practices_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'rails_best_practices'`
|
|
||||||
|
|
||||||
Override the invoked rails_best_practices binary. Set this to `'bundle'` to
|
|
||||||
invoke `'bundle` `exec` rails_best_practices'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_rails_best_practices_options
|
|
||||||
*g:ale_ruby_rails_best_practices_options*
|
|
||||||
*b:ale_ruby_rails_best_practices_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
The contents of this variable will be passed through to rails_best_practices.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
reek *ale-ruby-reek*
|
|
||||||
|
|
||||||
g:ale_ruby_reek_executable *g:ale_ruby_reek_executable*
|
|
||||||
*b:ale_ruby_reek_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'reek'`
|
|
||||||
|
|
||||||
Override the invoked reek binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` reek'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context*
|
|
||||||
*b:ale_ruby_reek_show_context*
|
|
||||||
Type: |Number|
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Controls whether context is included in the linter message. Defaults to off
|
|
||||||
because context is usually obvious while viewing a file.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link*
|
|
||||||
*b:ale_ruby_reek_show_wiki_link*
|
|
||||||
Type: |Number|
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
Controls whether linter messages contain a link to an explanatory wiki page
|
|
||||||
for the type of code smell. Defaults to off to improve readability.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rubocop *ale-ruby-rubocop*
|
|
||||||
|
|
||||||
g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable*
|
|
||||||
*b:ale_ruby_rubocop_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'rubocop'`
|
|
||||||
|
|
||||||
Override the invoked rubocop binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` rubocop'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
|
|
||||||
*b:ale_ruby_rubocop_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to rubocop.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
ruby *ale-ruby-ruby*
|
|
||||||
|
|
||||||
g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable*
|
|
||||||
*b:ale_ruby_ruby_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'ruby'`
|
|
||||||
|
|
||||||
This variable can be changed to use a different executable for ruby.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rufo *ale-ruby-rufo*
|
|
||||||
|
|
||||||
g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable*
|
|
||||||
*b:ale_ruby_rufo_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'rufo'`
|
|
||||||
|
|
||||||
Override the invoked rufo binary. This is useful for running rufo from
|
|
||||||
binstubs or a bundle.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
solargraph *ale-ruby-solargraph*
|
|
||||||
|
|
||||||
g:ale_ruby_solargraph_executable *g:ale_ruby_solargraph_executable*
|
|
||||||
*b:ale_ruby_solargraph_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'solargraph'`
|
|
||||||
|
|
||||||
Override the invoked solargraph binary. This is useful for running solargraph
|
|
||||||
from binstubs or a bundle.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
sorbet *ale-ruby-sorbet*
|
|
||||||
|
|
||||||
g:ale_ruby_sorbet_executable *g:ale_ruby_sorbet_executable*
|
|
||||||
*b:ale_ruby_sorbet_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'srb'`
|
|
||||||
|
|
||||||
Override the invoked sorbet binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` srb'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
|
|
||||||
*b:ale_ruby_sorbet_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to sorbet.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
standardrb *ale-ruby-standardrb*
|
|
||||||
|
|
||||||
g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
|
|
||||||
*b:ale_ruby_standardrb_executable*
|
|
||||||
Type: String
|
|
||||||
Default: `'standardrb'`
|
|
||||||
|
|
||||||
Override the invoked standardrb binary. Set this to `'bundle'` to invoke
|
|
||||||
`'bundle` `exec` standardrb'.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_ruby_standardrb_options *g:ale_ruby_standardrb_options*
|
|
||||||
*b:ale_ruby_standardrb_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be changed to modify flags given to standardrb.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,272 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Rust Integration *ale-rust-options*
|
|
||||||
*ale-integration-rust*
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
Integration Information
|
|
||||||
|
|
||||||
If Vim does not detect the Rust file type out-of-the-box, you need the runtime
|
|
||||||
files for Rust distributed in Vim >=8.0.0501 or upstream:
|
|
||||||
https://github.com/rust-lang/rust.vim
|
|
||||||
|
|
||||||
Note that there are several possible linters and fixers for Rust files:
|
|
||||||
|
|
||||||
1. rustc -- The Rust compiler is used to check the currently edited file.
|
|
||||||
So, if your project consists of multiple files, you will get some errors
|
|
||||||
when you use e.g. a struct which is defined in another file. You can use
|
|
||||||
|g:ale_rust_ignore_error_codes| to ignore some of these errors.
|
|
||||||
2. cargo -- If your project is managed by Cargo, the whole project is
|
|
||||||
checked. That means that all errors are properly shown, but cargo can
|
|
||||||
only operate on the files written on disk, so errors will not be reported
|
|
||||||
while you type.
|
|
||||||
3. rls -- If you have `rls` installed, you might prefer using this linter
|
|
||||||
over cargo. rls implements the Language Server Protocol for incremental
|
|
||||||
compilation of Rust code, and can check Rust files while you type. `rls`
|
|
||||||
requires Rust files to contained in Cargo projects.
|
|
||||||
4. analyzer -- If you have rust-analyzer installed, you might prefer using
|
|
||||||
this linter over cargo and rls. rust-analyzer also implements the
|
|
||||||
Language Server Protocol for incremental compilation of Rust code, and is
|
|
||||||
the next iteration of rls. rust-analyzer, like rls, requires Rust files
|
|
||||||
to contained in Cargo projects.
|
|
||||||
5. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
|
|
||||||
consistently reformat your Rust code.
|
|
||||||
|
|
||||||
Only cargo is enabled by default. To switch to using rustc instead of cargo,
|
|
||||||
configure |g:ale_linters| appropriately: >
|
|
||||||
|
|
||||||
" See the help text for the option for more information.
|
|
||||||
let g:ale_linters = {'rust': ['rustc']}
|
|
||||||
<
|
|
||||||
|
|
||||||
Also note that rustc 1.12. or later is needed.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
analyzer *ale-rust-analyzer*
|
|
||||||
|
|
||||||
g:ale_rust_analyzer_executable *g:ale_rust_analyzer_executable*
|
|
||||||
*b:ale_rust_analyzer_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'rust-analyzer'`
|
|
||||||
|
|
||||||
This variable can be modified to change the executable path for
|
|
||||||
`rust-analyzer`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_analyzer_config *g:ale_rust_analyzer_config*
|
|
||||||
*b:ale_rust_analyzer_config*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary with configuration settings for rust-analyzer.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
cargo *ale-rust-cargo*
|
|
||||||
|
|
||||||
g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check*
|
|
||||||
*b:ale_rust_cargo_use_check*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
When set to `1`, this option will cause ALE to use `cargo check` instead of
|
|
||||||
`cargo build` . `cargo check` is supported since version 1.16.0 of Rust.
|
|
||||||
|
|
||||||
ALE will never use `cargo check` when the version of `cargo` is less than
|
|
||||||
0.17.0.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets*
|
|
||||||
*b:ale_rust_cargo_check_all_targets*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, ALE will set the `--all-targets` option when `cargo check`
|
|
||||||
is used. See |g:ale_rust_cargo_use_check|,
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_check_tests *g:ale_rust_cargo_check_tests*
|
|
||||||
*b:ale_rust_cargo_check_tests*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, ALE will set the `--tests` option when `cargo check`
|
|
||||||
is used. This allows for linting of tests which are normally excluded.
|
|
||||||
See |g:ale_rust_cargo_use_check|,
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_check_examples *g:ale_rust_cargo_check_examples*
|
|
||||||
*b:ale_rust_cargo_check_examples*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to `1`, ALE will set the `--examples` option when `cargo check`
|
|
||||||
is used. This allows for linting of examples which are normally excluded.
|
|
||||||
See |g:ale_rust_cargo_use_check|,
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_default_feature_behavior
|
|
||||||
*g:ale_rust_cargo_default_feature_behavior*
|
|
||||||
*b:ale_rust_cargo_default_feature_behavior*
|
|
||||||
Type: |String|
|
|
||||||
Default: `default`
|
|
||||||
|
|
||||||
When set to `none`, ALE will set the `--no-default-features` option when
|
|
||||||
invoking `cargo`. Only the features specified in
|
|
||||||
|g:ale_rust_cargo_include_features| will be included when performing the
|
|
||||||
lint check.
|
|
||||||
|
|
||||||
When set to `default`, ALE will instruct `cargo` to build all default
|
|
||||||
features specified in the project's `Cargo.toml` file, in addition to
|
|
||||||
including any additional features defined in
|
|
||||||
|g:ale_rust_cargo_include_features|.
|
|
||||||
|
|
||||||
When set to `all`, ALE will set the `--all-features` option when
|
|
||||||
invoking `cargo`, which will include all features defined in the project's
|
|
||||||
`Cargo.toml` file when performing the lint check.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features*
|
|
||||||
*b:ale_rust_cargo_include_features*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
When defined, ALE will set the `--features` option when invoking `cargo` to
|
|
||||||
perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
|
|
||||||
*b:ale_rust_cargo_avoid_whole_workspace*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `1`
|
|
||||||
|
|
||||||
When set to 1, and ALE is used to edit a crate that is part of a Cargo
|
|
||||||
workspace, avoid building the entire workspace by invoking `cargo` directly
|
|
||||||
in the crate's directory. Otherwise, behave as usual.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_cargo_use_clippy
|
|
||||||
*g:ale_rust_cargo_use_clippy*
|
|
||||||
*b:ale_rust_cargo_use_clippy*
|
|
||||||
Type: |Number|
|
|
||||||
Default: `0`
|
|
||||||
|
|
||||||
When set to 1, `cargo clippy` will be used instead of `cargo check` or
|
|
||||||
`cargo build` as linter.
|
|
||||||
For details of `cargo clippy`, please visit the following link:
|
|
||||||
|
|
||||||
https://github.com/rust-lang-nursery/rust-clippy
|
|
||||||
|
|
||||||
Since `cargo clippy` is optional toolchain, it's safer to check whether
|
|
||||||
`cargo-clippy` is executable as follows:
|
|
||||||
>
|
|
||||||
let g:ale_rust_cargo_use_clippy = executable('cargo-clippy')
|
|
||||||
<
|
|
||||||
|
|
||||||
g:ale_rust_cargo_clippy_options
|
|
||||||
*g:ale_rust_cargo_clippy_options*
|
|
||||||
*b:ale_rust_cargo_clippy_options*
|
|
||||||
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
When `cargo clippy` is used, this value will be added to a command line to run
|
|
||||||
it. This variable is useful when you want to add some extra options which
|
|
||||||
only `cargo clippy` supports (e.g. `--deny`).
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rls *ale-rust-rls*
|
|
||||||
|
|
||||||
g:ale_rust_rls_executable *g:ale_rust_rls_executable*
|
|
||||||
*b:ale_rust_rls_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'rls'`
|
|
||||||
|
|
||||||
This variable can be modified to change the executable path for `rls`.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain*
|
|
||||||
*b:ale_rust_rls_toolchain*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This option can be set to change the toolchain used for `rls`. Possible
|
|
||||||
values include `'nightly'`, `'beta'`, `'stable'`, and `''`. When using
|
|
||||||
option `''`, rls will automatically find the default toolchain set by
|
|
||||||
rustup. If you want to use `rls` from a specific toolchain version, you may
|
|
||||||
also use values like `'channel-yyyy-mm-dd-arch-target'` as long as
|
|
||||||
`'rls +{toolchain_name} -V'` runs correctly in your command line.
|
|
||||||
|
|
||||||
The `rls` server will only be started once per executable.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_rls_config *g:ale_rust_rls_config*
|
|
||||||
*b:ale_rust_rls_config*
|
|
||||||
Type: |Dictionary|
|
|
||||||
Default: `{}`
|
|
||||||
|
|
||||||
Dictionary with configuration settings for rls. For example, to force
|
|
||||||
using clippy as linter: >
|
|
||||||
{
|
|
||||||
\ 'rust': {
|
|
||||||
\ 'clippy_preference': 'on'
|
|
||||||
\ }
|
|
||||||
\ }
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rustc *ale-rust-rustc*
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_rustc_options *g:ale_rust_rustc_options*
|
|
||||||
*b:ale_rust_rustc_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'-Z no-codegen'`
|
|
||||||
|
|
||||||
The variable can be used to change the options passed to `rustc`.
|
|
||||||
|
|
||||||
`-Z no-codegen` should only work with nightly builds of Rust. Be careful when
|
|
||||||
setting the options, as running `rustc` could execute code or generate
|
|
||||||
binary files.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
|
|
||||||
*b:ale_rust_ignore_error_codes*
|
|
||||||
Type: |List| of |String|s
|
|
||||||
Default: `[]`
|
|
||||||
|
|
||||||
This variable can contain error codes which will be ignored. For example, to
|
|
||||||
ignore most errors regarding failed imports, put this in your .vimrc
|
|
||||||
>
|
|
||||||
let g:ale_rust_ignore_error_codes = ['E0432', 'E0433']
|
|
||||||
|
|
||||||
g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans*
|
|
||||||
*b:ale_rust_ignore_secondary_spans*
|
|
||||||
Type: Number
|
|
||||||
Default: 0
|
|
||||||
|
|
||||||
When set to 1, instructs the Rust error repporting to ignore secondary
|
|
||||||
spans. The problem with secondary spans is that they sometimes appear in
|
|
||||||
error messages before the main cause of the error, for example: >
|
|
||||||
|
|
||||||
1 src/main.rs|98 col 5 error| this function takes 4 parameters but 5
|
|
||||||
parameters were supplied: defined here
|
|
||||||
2 src/main.rs|430 col 32 error| this function takes 4 parameters but 5
|
|
||||||
parameters were supplied: expected 4 parameters
|
|
||||||
<
|
|
||||||
This is due to the sorting by line numbers. With this option set to 1,
|
|
||||||
the 'defined here' span will not be presented.
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
rustfmt *ale-rust-rustfmt*
|
|
||||||
|
|
||||||
g:ale_rust_rustfmt_options *g:ale_rust_rustfmt_options*
|
|
||||||
*b:ale_rust_rustfmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
This variable can be set to pass additional options to the rustfmt fixer.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Sass Integration *ale-sass-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
sasslint *ale-sass-sasslint*
|
|
||||||
|
|
||||||
See |ale-scss-sasslint| for information about the available options.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
stylelint *ale-sass-stylelint*
|
|
||||||
|
|
||||||
g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable*
|
|
||||||
*b:ale_sass_stylelint_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'stylelint'`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global*
|
|
||||||
*b:ale_sass_stylelint_use_global*
|
|
||||||
Type: |String|
|
|
||||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
||||||
|
|
||||||
See |ale-integrations-local-executables|
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
@@ -1,124 +0,0 @@
|
|||||||
===============================================================================
|
|
||||||
ALE Scala Integration *ale-scala-options*
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
metals *ale-scala-metals*
|
|
||||||
|
|
||||||
`metals` requires either an SBT project, a Mill project, or a running Bloop
|
|
||||||
server.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_metals_executable *g:ale_scala_metals_executable*
|
|
||||||
*b:ale_scala_metals_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'metals-vim'`
|
|
||||||
|
|
||||||
Override the invoked `metals` binary.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_metals_project_root *g:ale_scala_metals_project_root*
|
|
||||||
*b:ale_scala_metals_project_root*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
By default the project root is found by searching upwards for `build.sbt`,
|
|
||||||
`build.sc`, `.bloop` or `.metals`.
|
|
||||||
If the project root is elsewhere, you can override the project root
|
|
||||||
directory.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
sbtserver *ale-scala-sbtserver*
|
|
||||||
|
|
||||||
`sbtserver` requires a running ^1.1.x sbt shell to connect to. It will attempt
|
|
||||||
to connect via TCP to the address defined in `g:ale_scala_sbtserver_address`.
|
|
||||||
As `sbt` defaults to listening via unix sockets, place these settings into
|
|
||||||
your `~/.sbt/1.0/global.sbt` to ensure that ale will always attempt to connect
|
|
||||||
to the right socket:
|
|
||||||
|
|
||||||
`serverConnectionType := ConnectionType.Tcp` and `serverPort := 4273`
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_sbtserver_address *g:ale_scala_sbtserver_address*
|
|
||||||
*b:ale_scala_sbtserver_address*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'127.0.0.1:4273'`
|
|
||||||
|
|
||||||
By default the address is found by parsing `active.json`, however, reading a
|
|
||||||
file is a blocking operation which should be avoided in ale. The easy way
|
|
||||||
around this is to configure sbt to always connect to the same port, which
|
|
||||||
the instructions above describe.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_sbtserver_project_root *g:ale_scala_sbtserver_project_root*
|
|
||||||
*b:ale_scala_sbtserver_project_root*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
By default the project root is found by searching upwards for `build.sbt`.
|
|
||||||
If the project root is elsewhere, you can override the project root
|
|
||||||
directory.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
scalafmt *ale-scala-scalafmt*
|
|
||||||
|
|
||||||
If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: >
|
|
||||||
let g:ale_scala_scalafmt_executable = 'ng'
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_scalafmt_executable *g:ale_scala_scalafmt_executable*
|
|
||||||
*b:ale_scala_scalafmt_executable*
|
|
||||||
Type: |String|
|
|
||||||
Default: `'scalafmt'`
|
|
||||||
|
|
||||||
Override the invoked `scalafmt` binary. This is useful for running `scalafmt`
|
|
||||||
with Nailgun.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_scalafmt_options *g:ale_scala_scalafmt_options*
|
|
||||||
*b:ale_scala_scalafmt_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A string containing additional options to pass to `'scalafmt'`, or
|
|
||||||
`'ng scalafmt'` if Nailgun is used.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
scalastyle *ale-scala-scalastyle*
|
|
||||||
|
|
||||||
`scalastyle` requires a configuration file for a project to run. When no
|
|
||||||
configuration file can be found, ALE will report a problem saying that a
|
|
||||||
configuration file is required at line 1.
|
|
||||||
|
|
||||||
To disable `scalastyle` globally, use |g:ale_linters| like so: >
|
|
||||||
let g:ale_linters = {'scala': ['scalac']} " Enable only scalac instead
|
|
||||||
<
|
|
||||||
|
|
||||||
See |g:ale_linters| for more information on disabling linters.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_scalastyle_config *g:ale_scala_scalastyle_config*
|
|
||||||
*b:ale_scala_scalastyle_config*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A string containing the location of a global fallback configuration file.
|
|
||||||
|
|
||||||
By default, ALE will look for a configuration file named
|
|
||||||
`scalastyle_config.xml` or `scalastyle-config.xml` in the current file's
|
|
||||||
directory or parent directories.
|
|
||||||
|
|
||||||
|
|
||||||
g:ale_scala_scalastyle_options *g:ale_scala_scalastyle_options*
|
|
||||||
*b:ale_scala_scalastyle_options*
|
|
||||||
Type: |String|
|
|
||||||
Default: `''`
|
|
||||||
|
|
||||||
A string containing additional options to pass to scalastyle.
|
|
||||||
|
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user