Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add settings for the Alex linter #2268

Merged
merged 1 commit into from
Feb 10, 2019
Merged

Add settings for the Alex linter #2268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions ale_linters/asciidoc/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for asciidoc files

call ale#linter#Define('help', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('asciidoc', '--text')
9 changes: 1 addition & 8 deletions ale_linters/help/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for help files

call ale#linter#Define('help', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('help', '--text')
9 changes: 1 addition & 8 deletions ale_linters/html/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for HTML files

call ale#linter#Define('html', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('html', '--html')
11 changes: 2 additions & 9 deletions ale_linters/mail/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for HTML files
" Description: alex for mail files

call ale#linter#Define('mail', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('mail', '--text')
9 changes: 1 addition & 8 deletions ale_linters/markdown/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for markdown files

call ale#linter#Define('markdown', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('markdown', '')
9 changes: 1 addition & 8 deletions ale_linters/nroff/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for nroff files

call ale#linter#Define('nroff', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('nroff', '--text')
9 changes: 1 addition & 8 deletions ale_linters/po/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Cian Butler https://github.com/butlerx
" Description: alex for PO files

call ale#linter#Define('po', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('po', '--text')
9 changes: 1 addition & 8 deletions ale_linters/pod/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for pod files

call ale#linter#Define('pod', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('pod', '--text')
9 changes: 1 addition & 8 deletions ale_linters/rst/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for rst files

call ale#linter#Define('rst', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('rst', '--text')
9 changes: 1 addition & 8 deletions ale_linters/tex/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for TeX files

call ale#linter#Define('tex', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('tex', '--text')
9 changes: 1 addition & 8 deletions ale_linters/texinfo/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for texinfo files

call ale#linter#Define('texinfo', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('texinfo', '--text')
9 changes: 1 addition & 8 deletions ale_linters/text/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for text files

call ale#linter#Define('text', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('text', '--text')
9 changes: 1 addition & 8 deletions ale_linters/xhtml/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
" Author: Johannes Wienke <[email protected]>
" Description: alex for XHTML files

call ale#linter#Define('xhtml', {
\ 'name': 'alex',
\ 'executable': 'alex',
\ 'command': 'alex %s -t',
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
call ale#handlers#alex#DefineLinter('xhtml', '--text')
33 changes: 32 additions & 1 deletion autoload/ale/handlers/alex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
" Author: Johannes Wienke <[email protected]>
" Description: Error handling for errors in alex output format

function! ale#handlers#alex#GetExecutable(buffer) abort
return ale#node#FindExecutable(a:buffer, 'alex', [
\ 'node_modules/.bin/alex',
\ 'node_modules/alex/cli.js',
\])
endfunction

function! ale#handlers#alex#CreateCommandCallback(flags) abort
return {b -> ale#node#Executable(b, ale#handlers#alex#GetExecutable(b))
\ . ' %s '
\ . a:flags}
endfunction

function! ale#handlers#alex#Handle(buffer, lines) abort
" Example output:
" 6:256-6:262 warning Be careful with “killed”, it’s profane in some cases killed retext-profanities
let l:pattern = '^ *\(\d\+\):\(\d\+\)-\(\d\+\):\(\d\+\) \+warning \+\(.\{-\}\) \+\(.\{-\}\) \+\(.\{-\}\)$'
let l:pattern = '\v^ *(\d+):(\d+)-(\d+):(\d+) +warning +(.{-}) +(.{-}) +(.{-})$'
let l:output = []

for l:match in ale#util#GetMatches(a:lines, l:pattern)
Expand All @@ -20,3 +33,21 @@ function! ale#handlers#alex#Handle(buffer, lines) abort

return l:output
endfunction

" Define a linter for a specific filetype. Accept flags to adapt to the filetype.
" no flags treat input as markdown
" --html treat input as HTML
" --text treat input as plaintext
function! ale#handlers#alex#DefineLinter(filetype, flags) abort
call ale#Set('alex_executable', 'alex')
call ale#Set('alex_use_global', get(g:, 'ale_use_global_executables', 0))

call ale#linter#Define(a:filetype, {
\ 'name': 'alex',
\ 'executable_callback': 'ale#handlers#alex#GetExecutable',
\ 'command_callback': ale#handlers#alex#CreateCommandCallback(a:flags),
\ 'output_stream': 'stderr',
\ 'callback': 'ale#handlers#alex#Handle',
\ 'lint_file': 1,
\})
endfunction
27 changes: 25 additions & 2 deletions doc/ale.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ CONTENTS *ale-contents*
5.6 Symbol Search.....................|ale-symbol-search|
6. Global Options.......................|ale-options|
6.1 Highlights........................|ale-highlights|
6.2 Options for write-good Linter.....|ale-write-good-options|
6.2 Options for alex Linter...........|ale-alex-options|
6.3 Options for write-good Linter.....|ale-write-good-options|
7. Integration Documentation............|ale-integrations|
ada...................................|ale-ada-options|
gcc.................................|ale-ada-gcc|
Expand Down Expand Up @@ -2219,7 +2220,29 @@ ALEWarningSign *ALEWarningSign*


-------------------------------------------------------------------------------
6.2. Options for write-good *ale-write-good-options*
6.2. Options for alex *ale-alex-options*

The options for the alex linter are global because it does not make sense to
have them specified on a per-language basis.

g:ale_alex_executable *g:ale_alex_executable*
*b:ale_alex_executable*
Type: |String|
Default: `'alex'`

See |ale-integrations-local-executables|


g:ale_alex_use_global *g:ale_alex_use_global*
*b:ale_alex_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`

See |ale-integrations-local-executables|


-------------------------------------------------------------------------------
6.3. Options for write-good *ale-write-good-options*

The options for the write-good linter are global because it does not make
sense to have them specified on a per-language basis.
Expand Down
Empty file added test/command_callback/alex-node-modules-2/node_modules/alex/cli.js
View file
Open in desktop
Empty file.
Empty file added test/command_callback/alex-node-modules/node_modules/.bin/alex
View file
Open in desktop
Empty file.
34 changes: 34 additions & 0 deletions test/command_callback/test_alex_command_callback.vader
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Before:
call ale#assert#SetUpLinterTest('tex', 'alex')
call ale#test#SetFilename('test_file.tex')

After:
call ale#assert#TearDownLinterTest()

Execute(The global executable should be used when the local one cannot be found):
AssertLinter 'alex',
\ ale#Escape('alex') . ' %s --text',

Execute(Should use the node_modules/.bin executable, if available):
call ale#test#SetFilename('alex-node-modules/test_file.tex')

AssertLinter ale#path#Simplify(g:dir . '/alex-node-modules/node_modules/.bin/alex'),
\ ale#Escape(ale#path#Simplify(g:dir . '/alex-node-modules/node_modules/.bin/alex'))
\ . ' %s --text',

Execute(Should use the node_modules/alex executable, if available):
call ale#test#SetFilename('alex-node-modules-2/test_file.tex')

AssertLinter ale#path#Simplify(g:dir . '/alex-node-modules-2/node_modules/alex/cli.js'),
\ (has('win32') ? 'node.exe ' : '')
\ . ale#Escape(ale#path#Simplify(g:dir . '/alex-node-modules-2/node_modules/alex/cli.js'))
\ . ' %s --text',

Execute(Should let users configure a global executable and override local paths):
call ale#test#SetFilename('write-good-node-modules-2/test_file.tex')

let g:ale_alex_executable = '/path/to/custom/alex'
let g:ale_alex_use_global = 1

AssertLinter '/path/to/custom/alex',
\ ale#Escape('/path/to/custom/alex') . ' %s --text'