vim/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cddb26558f
ale/ale_linters/elm/make.vim

78 lines
2.9 KiB
VimL
Raw Normal View History

Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
" Author: buffalocoder - https://github.com/buffalocoder
" Description: Elm linting in Ale. Closely follows the Syntastic checker in https://github.com/ElmCast/elm-vim.
Add a script for custom checks to enforce using the abort flag for functions and trailing whitespace, and fix existing issues.
2017-01-22 09:54:57 -05:00
function! ale_linters#elm#make#Handle(buffer, lines) abort
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
let l:output = []
Elm file filter & Windows bug fixes (#223) * Filters out unrelated errors in Elm linter The function now filters out errors that are unrelated to the file, those that were found in imported modules. It does this by comparing the temp directory environment variable to the file name in the elm output. If the file begins with the temp directory, then it sould be included (it's from the buffer). * Changing output to '/dev/null' Turns out the compiler only accepts /dev/null as an ignorable name. It's hard-coded here https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs Changing this allows Windows linting to work. Otherwise the compiler errors when using "nul" * Fixes for Windows Should now be able to successfully handle Windows. Windows seemed to not handle the ";" properly, so I switched it to "&&", which probably should've been done anyway to prevent false positives. Oddly, matchend(l:error.file, l:temp_dir), and various other regex solutions, couldn't properly match the two. Subsetting did though, hence the new solution. * Applying corrections Made the file check case-insensitive for Windows, case-sensitive for Unix/non-windows. Added comment explaining hard coding of 'dev/null' * Spelling correction * Minor corrections Actually uses the is_file_buffer variable now, added space between the if statements, and added space between '-'
2016-12-16 05:41:21 -05:00
let l:is_windows = has('win32')
let l:temp_dir = l:is_windows ? $TMP : $TMPDIR
Improve elm linter (#637) * Improve elm linter Some types of errors do not return nice JSON. Show them on the first line instead of showing nothing. * Remove unnecessary properties from elm linter * Add a vader test for elm-make linter * Test non-JSON elm-make errors are shown
2017-06-25 12:12:40 -04:00
let l:unparsed_lines = []
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
for l:line in a:lines
if l:line[0] ==# '['
let l:errors = json_decode(l:line)
for l:error in l:errors
Elm file filter & Windows bug fixes (#223) * Filters out unrelated errors in Elm linter The function now filters out errors that are unrelated to the file, those that were found in imported modules. It does this by comparing the temp directory environment variable to the file name in the elm output. If the file begins with the temp directory, then it sould be included (it's from the buffer). * Changing output to '/dev/null' Turns out the compiler only accepts /dev/null as an ignorable name. It's hard-coded here https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs Changing this allows Windows linting to work. Otherwise the compiler errors when using "nul" * Fixes for Windows Should now be able to successfully handle Windows. Windows seemed to not handle the ";" properly, so I switched it to "&&", which probably should've been done anyway to prevent false positives. Oddly, matchend(l:error.file, l:temp_dir), and various other regex solutions, couldn't properly match the two. Subsetting did though, hence the new solution. * Applying corrections Made the file check case-insensitive for Windows, case-sensitive for Unix/non-windows. Added comment explaining hard coding of 'dev/null' * Spelling correction * Minor corrections Actually uses the is_file_buffer variable now, added space between the if statements, and added space between '-'
2016-12-16 05:41:21 -05:00
" 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] ==? l:temp_dir
else
let l:file_is_buffer = l:error.file[0:len(l:temp_dir) - 1] ==# 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,
Elm linter shows full error ranges
2017-06-26 09:37:04 -04:00
\ 'end_lnum': l:error.region.end.line,
\ 'end_col': l:error.region.end.column,
Elm file filter & Windows bug fixes (#223) * Filters out unrelated errors in Elm linter The function now filters out errors that are unrelated to the file, those that were found in imported modules. It does this by comparing the temp directory environment variable to the file name in the elm output. If the file begins with the temp directory, then it sould be included (it's from the buffer). * Changing output to '/dev/null' Turns out the compiler only accepts /dev/null as an ignorable name. It's hard-coded here https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs Changing this allows Windows linting to work. Otherwise the compiler errors when using "nul" * Fixes for Windows Should now be able to successfully handle Windows. Windows seemed to not handle the ";" properly, so I switched it to "&&", which probably should've been done anyway to prevent false positives. Oddly, matchend(l:error.file, l:temp_dir), and various other regex solutions, couldn't properly match the two. Subsetting did though, hence the new solution. * Applying corrections Made the file check case-insensitive for Windows, case-sensitive for Unix/non-windows. Added comment explaining hard coding of 'dev/null' * Spelling correction * Minor corrections Actually uses the is_file_buffer variable now, added space between the if statements, and added space between '-'
2016-12-16 05:41:21 -05:00
\ 'type': (l:error.type ==? 'error') ? 'E' : 'W',
\ 'text': l:error.overview,
Add support for error details Some review needed.
2017-03-02 02:14:30 -05:00
\ 'detail': l:error.overview . "\n\n" . l:error.details
Elm file filter & Windows bug fixes (#223) * Filters out unrelated errors in Elm linter The function now filters out errors that are unrelated to the file, those that were found in imported modules. It does this by comparing the temp directory environment variable to the file name in the elm output. If the file begins with the temp directory, then it sould be included (it's from the buffer). * Changing output to '/dev/null' Turns out the compiler only accepts /dev/null as an ignorable name. It's hard-coded here https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs Changing this allows Windows linting to work. Otherwise the compiler errors when using "nul" * Fixes for Windows Should now be able to successfully handle Windows. Windows seemed to not handle the ";" properly, so I switched it to "&&", which probably should've been done anyway to prevent false positives. Oddly, matchend(l:error.file, l:temp_dir), and various other regex solutions, couldn't properly match the two. Subsetting did though, hence the new solution. * Applying corrections Made the file check case-insensitive for Windows, case-sensitive for Unix/non-windows. Added comment explaining hard coding of 'dev/null' * Spelling correction * Minor corrections Actually uses the is_file_buffer variable now, added space between the if statements, and added space between '-'
2016-12-16 05:41:21 -05:00
\})
endif
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
endfor
Improve elm linter (#637) * Improve elm linter Some types of errors do not return nice JSON. Show them on the first line instead of showing nothing. * Remove unnecessary properties from elm linter * Add a vader test for elm-make linter * Test non-JSON elm-make errors are shown
2017-06-25 12:12:40 -04:00
elseif l:line !=# 'Successfully generated /dev/null'
call add(l:unparsed_lines, l:line)
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
endif
endfor
Improve elm linter (#637) * Improve elm linter Some types of errors do not return nice JSON. Show them on the first line instead of showing nothing. * Remove unnecessary properties from elm linter * Add a vader test for elm-make linter * Test non-JSON elm-make errors are shown
2017-06-25 12:12:40 -04:00
if len(l:unparsed_lines) > 0
call add(l:output, {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': l:unparsed_lines[0],
\ 'detail': join(l:unparsed_lines, "\n")
\})
endif
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
return l:output
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
Move path functions to their own file
2017-04-17 18:29:02 -04:00
let l:elm_package = ale#path#FindNearestFile(a:buffer, 'elm-package.json')
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
if empty(l:elm_package)
let l:dir_set_cmd = ''
else
let l:root_dir = fnamemodify(l:elm_package, ':p:h')
#549 Temporarily revert shell escaping changes, just for Windows
2017-05-12 04:20:16 -04:00
let l:dir_set_cmd = 'cd ' . ale#Escape(l:root_dir) . ' && '
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
endif
Elm file filter & Windows bug fixes (#223) * Filters out unrelated errors in Elm linter The function now filters out errors that are unrelated to the file, those that were found in imported modules. It does this by comparing the temp directory environment variable to the file name in the elm output. If the file begins with the temp directory, then it sould be included (it's from the buffer). * Changing output to '/dev/null' Turns out the compiler only accepts /dev/null as an ignorable name. It's hard-coded here https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs Changing this allows Windows linting to work. Otherwise the compiler errors when using "nul" * Fixes for Windows Should now be able to successfully handle Windows. Windows seemed to not handle the ";" properly, so I switched it to "&&", which probably should've been done anyway to prevent false positives. Oddly, matchend(l:error.file, l:temp_dir), and various other regex solutions, couldn't properly match the two. Subsetting did though, hence the new solution. * Applying corrections Made the file check case-insensitive for Windows, case-sensitive for Unix/non-windows. Added comment explaining hard coding of 'dev/null' * Spelling correction * Minor corrections Actually uses the is_file_buffer variable now, added space between the if statements, and added space between '-'
2016-12-16 05:41:21 -05:00
" The elm-make 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.
" Source: https://github.com/elm-lang/elm-make/blob/master/src/Flags.hs
#549 Temporarily revert shell escaping changes, just for Windows
2017-05-12 04:20:16 -04:00
let l:elm_cmd = 'elm-make --report=json --output='.ale#Escape('/dev/null')
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
Replace every stdin-wrapper script with the new %t formatting support
2017-02-11 14:40:57 -05:00
return l:dir_set_cmd . ' ' . l:elm_cmd . ' %t'
Add Elm linting via elm-make (#213) * Add support for Elm linting * Adding documentation for Elm * Adjusting spacing * Addressing concerns listed in pull request Removed the s:FindRootDirectory function as it does not make much sense in this context. Adjusted the rest of the code to handle the removal of that function, including using the ale#util function to find the nearest file. Ensured that when an empty filepath is found, the code does not attempt to change directories. Ensured that the linter would take from stdin using the wrapper.
2016-12-13 04:06:04 -05:00
endfunction
call ale#linter#Define('elm', {
\ 'name': 'make',
\ 'executable': 'elm-make',
\ 'output_stream': 'both',
\ 'command_callback': 'ale_linters#elm#make#GetCommand',
\ 'callback': 'ale_linters#elm#make#Handle'
\})
Reference in New Issue Copy Permalink