hasufell/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1574 from hecrj/elm-0.19

Browse Source 
Support Elm 0.19
This commit is contained in:
w0rp 2018-05-26 09:19:30 +01:00 committed by GitHub
commit b67c9a83b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 374 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

170
ale_linters/elm/make.vim
View File

@ -1,45 +1,26 @@
" Author: buffalocoder - https://github.com/buffalocoder, soywod - https://github.com/soywod
" Author: buffalocoder - https://github.com/buffalocoder, soywod - https://github.com/soywod, hecrj - https://github.com/hecrj
" Description: Elm linting in Ale. Closely follows the Syntastic checker in https://github.com/ElmCast/elm-vim.
call ale#Set('elm_make_executable', 'elm-make')
call ale#Set('elm_make_executable', 'elm')
call ale#Set('elm_make_use_global', get(g:, 'ale_use_global_executables', 0))
function! ale_linters#elm#make#GetExecutable(buffer) abort
return ale#node#FindExecutable(a:buffer, 'elm_make', [
\ 'node_modules/.bin/elm-make',
\ 'node_modules/.bin/elm',
\])
endfunction
function! ale_linters#elm#make#Handle(buffer, lines) abort
let l:output = []
let l:is_windows = has('win32')
let l:temp_dir = l:is_windows ? $TMP : $TMPDIR
let l:unparsed_lines = []
for l:line in a:lines
if l:line[0] is# '['
let l:errors = json_decode(l:line)
for l:error in l:errors
" Check if file is from the temp directory.
" Filters out any errors not related to the buffer.
if l:is_windows
let l:file_is_buffer = l:error.file[0:len(l:temp_dir) - 1] is? l:temp_dir
else
let l:file_is_buffer = l:error.file[0:len(l:temp_dir) - 1] is# l:temp_dir
endif
if l:file_is_buffer
call add(l:output, {
\ 'lnum': l:error.region.start.line,
\ 'col': l:error.region.start.column,
\ 'end_lnum': l:error.region.end.line,
\ 'end_col': l:error.region.end.column,
\ 'type': (l:error.type is? 'error') ? 'E' : 'W',
\ 'text': l:error.overview,
\ 'detail': l:error.overview . "\n\n" . l:error.details
\})
endif
endfor
if l:line[0] is# '{'
" Elm 0.19
call ale_linters#elm#make#HandleElm019Line(l:line, l:output)
elseif l:line[0] is# '['
" Elm 0.18
call ale_linters#elm#make#HandleElm018Line(l:line, l:output)
elseif l:line isnot# 'Successfully generated /dev/null'
call add(l:unparsed_lines, l:line)
endif
@ -57,23 +38,142 @@ function! ale_linters#elm#make#Handle(buffer, lines) abort
return l:output
endfunction
function! ale_linters#elm#make#HandleElm019Line(line, output) abort
let l:report = json_decode(a:line)
if l:report.type is? 'error'
" General problem
let l:details = ale_linters#elm#make#ParseMessage(l:report.message)
if empty(l:report.path)
let l:report.path = 'Elm'
endif
if ale_linters#elm#make#FileIsBuffer(l:report.path)
call add(a:output, {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': l:details,
\})
else
call add(a:output, {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': l:report.path .' - '. l:details,
\ 'detail': l:report.path ." ----------\n\n". l:details,
\})
endif
else
" Compilation errors
for l:error in l:report.errors
let l:file_is_buffer = ale_linters#elm#make#FileIsBuffer(l:error.path)
for l:problem in l:error.problems
let l:details = ale_linters#elm#make#ParseMessage(l:problem.message)
if l:file_is_buffer
" Buffer module has problems
call add(a:output, {
\ 'lnum': l:problem.region.start.line,
\ 'col': l:problem.region.start.column,
\ 'end_lnum': l:problem.region.end.line,
\ 'end_col': l:problem.region.end.column,
\ 'type': 'E',
\ 'text': l:details,
\})
else
" Imported module has problems
let l:location = l:error.path .':'. l:problem.region.start.line
call add(a:output, {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': l:location .' - '. l:details,
\ 'detail': l:location ." ----------\n\n". l:details,
\})
endif
endfor
endfor
endif
endfunction
function! ale_linters#elm#make#HandleElm018Line(line, output) abort
let l:errors = json_decode(a:line)
for l:error in l:errors
let l:file_is_buffer = ale_linters#elm#make#FileIsBuffer(l:error.file)
if l:file_is_buffer
" Current buffer has problems
call add(a:output, {
\ 'lnum': l:error.region.start.line,
\ 'col': l:error.region.start.column,
\ 'end_lnum': l:error.region.end.line,
\ 'end_col': l:error.region.end.column,
\ 'type': (l:error.type is? 'error') ? 'E' : 'W',
\ 'text': l:error.overview,
\ 'detail': l:error.overview . "\n\n" . l:error.details
\})
elseif l:error.type is? 'error'
" Imported module has errors
let l:location = l:error.file .':'. l:error.region.start.line
call add(a:output, {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': l:location .' - '. l:error.overview,
\ 'detail': l:location ." ----------\n\n". l:error.overview . "\n\n" . l:error.details
\})
endif
endfor
endfunction
function! ale_linters#elm#make#FileIsBuffer(path) abort
let l:is_windows = has('win32')
let l:temp_dir = l:is_windows ? $TMP : $TMPDIR
if has('win32')
return a:path[0:len(l:temp_dir) - 1] is? l:temp_dir
else
return a:path[0:len(l:temp_dir) - 1] is# l:temp_dir
endif
endfunction
function! ale_linters#elm#make#ParseMessage(message) abort
return join(map(copy(a:message), 'ale_linters#elm#make#ParseMessageItem(v:val)'), '')
endfunction
function! ale_linters#elm#make#ParseMessageItem(item) abort
if type(a:item) == type('')
return a:item
else
return a:item.string
endif
endfunction
" Return the command to execute the linter in the projects directory.
" If it doesn't, then this will fail when imports are needed.
function! ale_linters#elm#make#GetCommand(buffer) abort
let l:elm_package = ale#path#FindNearestFile(a:buffer, 'elm-package.json')
let l:elm_json = ale#path#FindNearestFile(a:buffer, 'elm.json')
let l:elm_exe = ale_linters#elm#make#GetExecutable(a:buffer)
if empty(l:elm_package)
if empty(l:elm_json)
" Fallback to Elm 0.18
let l:elm_json = ale#path#FindNearestFile(a:buffer, 'elm-package.json')
endif
if empty(l:elm_json)
let l:dir_set_cmd = ''
else
let l:root_dir = fnamemodify(l:elm_package, ':p:h')
let l:root_dir = fnamemodify(l:elm_json, ':p:h')
let l:dir_set_cmd = 'cd ' . ale#Escape(l:root_dir) . ' && '
endif
" The elm-make compiler, at the time of this writing, uses '/dev/null' as
" The elm compiler, at the time of this writing, uses '/dev/null' as
" a sort of flag to tell the compiler not to generate an output file,
" which is why this is hard coded here. It does not use NUL on Windows.
" Source: https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs
" which is why this is hard coded here.
" Source: https://github.com/elm-lang/elm-compiler/blob/19d5a769b30ec0b2fc4475985abb4cd94cd1d6c3/builder/src/Generate/Output.hs#L253
let l:elm_cmd = ale#Escape(l:elm_exe)
\ . ' make'
\ . ' --report=json'
\ . ' --output=/dev/null'

2
doc/ale-elm.txt
View File

@ -34,7 +34,7 @@ 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-make'`
Default: `'elm'`
See |ale-integrations-local-executables|

0
test/elm-test-files/app/node_modules/.bin/elm-make → test/elm-test-files/app/node_modules/.bin/elm generated vendored
View File

246
test/handler/test_elmmake_handler.vader
View File

@ -9,7 +9,139 @@ After:
call ale#linter#Reset()
Execute(The elm-make handler should parse lines correctly):
" Elm 0.19
Execute(The elm-make handler should parse Elm 0.19 general problems correctly):
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': "error details\n\nstyled details"
\ }
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '{
\ "type": "error",
\ "path": "' . b:tmp . '/Module.elm",
\ "title": "UNKNOWN IMPORT",
\ "message": ["error details\n\n", { "string": "styled details" }]
\ }'
\ ])
Execute(The elm-make handler should parse Elm 0.19 compilation errors correctly):
AssertEqual
\ [
\ {
\ 'lnum': 404,
\ 'col': 1,
\ 'end_lnum': 408,
\ 'end_col': 18,
\ 'type': 'E',
\ 'text': "error details 1\n\nstyled details"
\ },
\ {
\ 'lnum': 406,
\ 'col': 5,
\ 'end_lnum': 407,
\ 'end_col': 17,
\ 'type': 'E',
\ 'text': "error details 2",
\ },
\ {
\ 'lnum': 406,
\ 'col': 5,
\ 'end_lnum': 406,
\ 'end_col': 93,
\ 'type': 'E',
\ 'text': "error details 3",
\ },
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '{
\ "type": "compile-errors",
\ "errors": [
\ {
\ "path": "' . b:tmp . '/Module.elm",
\ "problems": [
\ {
\ "title": "TYPE MISMATCH",
\ "message": ["error details 1\n\n", { "string": "styled details" }],
\ "region": { "start": { "line": 404, "column": 1 }, "end": { "line": 408, "column": 18 } }
\ },
\ {
\ "title": "TYPE MISMATCH",
\ "message": ["error details 2"],
\ "region": { "start": {"line": 406, "column": 5}, "end": {"line": 407, "column": 17 } }
\ },
\ {
\ "title": "TYPE MISMATCH",
\ "message": ["error details 3"],
\ "region": { "start": { "line": 406, "column": 5}, "end": {"line": 406, "column": 93 } }
\ }
\ ]
\ }
\ ]
\ }'
\ ])
Execute(The elm-make handler should handle errors in Elm 0.19 imported modules):
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': "src/Module.elm - error details\n\nstyled details",
\ 'detail': "src/Module.elm ----------\n\nerror details\n\nstyled details"
\ },
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': "Elm - error details\n\nstyled details",
\ 'detail': "Elm ----------\n\nerror details\n\nstyled details"
\ },
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': "src/Module.elm:404 - error details\n\nstyled details",
\ 'detail': "src/Module.elm:404 ----------\n\nerror details\n\nstyled details"
\ },
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '{
\ "type": "error",
\ "path": "src/Module.elm",
\ "title": "UNKNOWN IMPORT",
\ "message": ["error details\n\n", { "string": "styled details" }]
\ }',
\ '{
\ "type": "error",
\ "path": null,
\ "title": "UNKNOWN IMPORT",
\ "message": ["error details\n\n", { "string": "styled details" }]
\ }',
\ '{
\ "type": "compile-errors",
\ "errors": [
\ {
\ "path": "src/Module.elm",
\ "problems": [
\ {
\ "title": "TYPE MISMATCH",
\ "message": ["error details\n\n", { "string": "styled details" }],
\ "region": { "start": { "line": 404, "column": 1 }, "end": { "line": 408, "column": 18 } }
\ }
\ ]
\ }
\ ]
\ }'
\ ])
" Elm 0.18
Execute(The elm-make handler should parse Elm 0.18 compilation errors correctly):
AssertEqual
\ [
\ {
@ -50,21 +182,90 @@ Execute(The elm-make handler should parse lines correctly):
\ },
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '[{"tag":"unused import","overview":"warning overview","details":"warning details","region":{"start":{"line":33,"column":1},"end":{"line":33,"column":19}},"type":"warning","file":"' . b:tmp . 'Module.elm"}]',
\ '[{"tag":"TYPE MISMATCH","overview":"error overview 1","subregion":{"start":{"line":406,"column":5},"end":{"line":408,"column":18}},"details":"error details 1","region":{"start":{"line":404,"column":1},"end":{"line":408,"column":18}},"type":"error","file":"' . b:tmp . 'Module.elm"},{"tag":"TYPE MISMATCH","overview":"error overview 2","subregion":{"start":{"line":407,"column":12},"end":{"line":407,"column":17}},"details":"error details 2","region":{"start":{"line":406,"column":5},"end":{"line":407,"column":17}},"type":"error","file":"' . b:tmp . 'Module.elm"},{"tag":"TYPE MISMATCH","overview":"error overview 3","subregion":{"start":{"line":406,"column":88},"end":{"line":406,"column":93}},"details":"error details 3","region":{"start":{"line":406,"column":5},"end":{"line":406,"column":93}},"type":"error","file":"' . b:tmp . 'Module.elm"}]'
\ '[
\ {
\ "tag": "unused import",
\ "overview": "warning overview",
\ "details": "warning details",
\ "region": {"start": { "line": 33, "column": 1 }, "end": { "line": 33, "column": 19 } },
\ "type": "warning",
\ "file": "' . b:tmp . '/Module.elm"
\ }
\ ]',
\ '[
\ {
\ "tag": "TYPE MISMATCH",
\ "overview": "error overview 1",
\ "subregion": { "start": { "line": 406, "column": 5 }, "end": { "line": 408, "column": 18 } },
\ "details": "error details 1",
\ "region": { "start": { "line": 404, "column": 1 }, "end": { "line": 408, "column": 18 } },
\ "type": "error",
\ "file":"' . b:tmp . '/Module.elm"
\ },
\ {
\ "tag": "TYPE MISMATCH",
\ "overview": "error overview 2",
\ "subregion": { "start": { "line": 407, "column": 12 }, "end": { "line": 407, "column": 17 } },
\ "details": "error details 2",
\ "region": { "start": { "line": 406, "column": 5}, "end": { "line": 407, "column": 17 } },
\ "type":"error",
\ "file":"' . b:tmp . '/Module.elm"
\ },
\ {
\ "tag": "TYPE MISMATCH",
\ "overview": "error overview 3",
\ "subregion": { "start": { "line": 406, "column": 88 }, "end": { "line": 406, "column": 93 } },
\ "details": "error details 3",
\ "region": { "start": { "line": 406, "column": 5 }, "end": { "line": 406, "column": 93 } },
\ "type":"error",
\ "file":"' . b:tmp . '/Module.elm"
\ }
\ ]'
\ ])
Execute(The elm-make handler should handle errors in Elm 0.18 imported modules):
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': "src/Module.elm:33 - error overview",
\ 'detail': "src/Module.elm:33 ----------\n\nerror overview\n\nerror details"
\ }
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '[
\ {
\ "tag": "unused import",
\ "overview": "warning overview",
\ "details": "warning details",
\ "region": {"start": { "line": 33, "column": 1 }, "end": { "line": 33, "column": 19 } },
\ "type": "warning",
\ "file": "src/Module.elm"
\ },
\ {
\ "tag": "type error",
\ "overview": "error overview",
\ "details": "error details",
\ "region": {"start": { "line": 33, "column": 1 }, "end": { "line": 33, "column": 19 } },
\ "type": "error",
\ "file": "src/Module.elm"
\ }
\ ]',
\ ])
" Generic
Execute(The elm-make handler should put an error on the first line if a line cannot be parsed):
AssertEqual
\ [
\ {
\ 'lnum': 33,
\ 'lnum': 404,
\ 'col': 1,
\ 'end_lnum': 33,
\ 'end_col': 19,
\ 'type': 'W',
\ 'text': 'warning overview',
\ 'detail': "warning overview\n\nwarning details",
\ 'end_lnum': 408,
\ 'end_col': 18,
\ 'type': 'E',
\ 'text': "error details 1\n\nstyled details"
\ },
\ {
\ 'lnum': 1,
@ -74,7 +275,28 @@ Execute(The elm-make handler should put an error on the first line if a line can
\ },
\ ],
\ ale_linters#elm#make#Handle(347, [
\ '[{"tag":"unused import","overview":"warning overview","details":"warning details","region":{"start":{"line":33,"column":1},"end":{"line":33,"column":19}},"type":"warning","file":"' . b:tmp . 'Module.elm"}]',
\ "Not JSON",
\ "Also not JSON",
\ '{
\ "type": "compile-errors",
\ "errors": [
\ {
\ "path": "' . b:tmp . '/Module.elm",
\ "problems": [
\ {
\ "title": "TYPE MISMATCH",
\ "message": ["error details 1\n\n", { "string": "styled details" }],
\ "region": { "start": { "line": 404, "column": 1 }, "end": { "line": 408, "column": 18 } }
\ }
\ ]
\ }
\ ]
\ }',
\ 'Not JSON',
\ 'Also not JSON',
\ ])
Execute(The elm-make handler should ignore success lines):
AssertEqual
\ [],
\ ale_linters#elm#make#Handle(347, [
\ 'Successfully generated /dev/null',
\ ])

8
test/test_elm_executable_detection.vader
View File

@ -12,7 +12,7 @@ Execute(should get valid executable with default params):
call ale#test#SetFilename('elm-test-files/app/testfile.elm')
AssertEqual
\ ale#path#Simplify(g:dir . '/elm-test-files/app/node_modules/.bin/elm-make'),
\ ale#path#Simplify(g:dir . '/elm-test-files/app/node_modules/.bin/elm'),
\ ale_linters#elm#make#GetExecutable(bufnr(''))
Execute(should get valid executable with 'use_global' params):
@ -21,16 +21,16 @@ Execute(should get valid executable with 'use_global' params):
call ale#test#SetFilename('elm-test-files/app/testfile.elm')
AssertEqual
\ 'elm-make',
\ 'elm',
\ ale_linters#elm#make#GetExecutable(bufnr(''))
Execute(should get valid executable with 'use_global' and 'executable' params):
let g:ale_elm_make_executable = 'other-elm-make'
let g:ale_elm_make_executable = 'other-elm'
let g:ale_elm_make_use_global = 1
call ale#test#SetFilename('elm-test-files/app/testfile.elm')
AssertEqual
\ 'other-elm-make',
\ 'other-elm',
\ ale_linters#elm#make#GetExecutable(bufnr(''))