diff options
| -rw-r--r-- | ale_linters/javascript/eslint.vim | 30 | ||||
| -rw-r--r-- | autoload/ale/fix.vim | 227 | ||||
| -rw-r--r-- | autoload/ale/handlers/eslint.vim | 43 |
3 files changed, 272 insertions, 28 deletions
diff --git a/ale_linters/javascript/eslint.vim b/ale_linters/javascript/eslint.vim index f1c3bb01..9fd20078 100644 --- a/ale_linters/javascript/eslint.vim +++ b/ale_linters/javascript/eslint.vim @@ -1,40 +1,14 @@ " Author: w0rp <devw0rp@gmail.com> " Description: eslint for JavaScript files -let g:ale_javascript_eslint_executable = -\ get(g:, 'ale_javascript_eslint_executable', 'eslint') - let g:ale_javascript_eslint_options = \ get(g:, 'ale_javascript_eslint_options', '') let g:ale_javascript_eslint_use_global = \ get(g:, 'ale_javascript_eslint_use_global', 0) -function! ale_linters#javascript#eslint#GetExecutable(buffer) abort - if ale#Var(a:buffer, 'javascript_eslint_use_global') - return ale#Var(a:buffer, 'javascript_eslint_executable') - endif - - " Look for the kinds of paths that create-react-app generates first. - let l:executable = ale#path#ResolveLocalPath( - \ a:buffer, - \ 'node_modules/eslint/bin/eslint.js', - \ '' - \) - - if !empty(l:executable) - return l:executable - endif - - return ale#path#ResolveLocalPath( - \ a:buffer, - \ 'node_modules/.bin/eslint', - \ ale#Var(a:buffer, 'javascript_eslint_executable') - \) -endfunction - function! ale_linters#javascript#eslint#GetCommand(buffer) abort - return ale#Escape(ale_linters#javascript#eslint#GetExecutable(a:buffer)) + return ale#handlers#eslint#GetExecutable(a:buffer) \ . ' ' . ale#Var(a:buffer, 'javascript_eslint_options') \ . ' -f unix --stdin --stdin-filename %s' endfunction @@ -103,7 +77,7 @@ endfunction call ale#linter#Define('javascript', { \ 'name': 'eslint', -\ 'executable_callback': 'ale_linters#javascript#eslint#GetExecutable', +\ 'executable_callback': 'ale#handlers#eslint#GetExecutable', \ 'command_callback': 'ale_linters#javascript#eslint#GetCommand', \ 'callback': 'ale_linters#javascript#eslint#Handle', \}) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim new file mode 100644 index 00000000..50a426bd --- /dev/null +++ b/autoload/ale/fix.vim @@ -0,0 +1,227 @@ +let s:buffer_data = {} +let s:job_info_map = {} + +function! s:GatherOutput(job_id, line) abort + if has_key(s:job_info_map, a:job_id) + call add(s:job_info_map[a:job_id].output, a:line) + endif +endfunction + +function! ale#fix#ApplyQueuedFixes() abort + let l:buffer = bufnr('') + let l:data = get(s:buffer_data, l:buffer, {'done': 0}) + + if !l:data.done + return + endif + + call remove(s:buffer_data, l:buffer) + let l:lines = getbufline(l:buffer, 1, '$') + + if l:data.lines_before != l:lines + echoerr 'The file was changed before fixing finished' + return + endif + + echom l:data.output[0] + + call setline(1, l:data.output) + + let l:start_line = len(l:data.output) + 1 + let l:end_line = len(l:lines) + + if l:end_line > l:start_line + let l:save = winsaveview() + silent execute l:start_line . ',' . l:end_line . 'd' + call winrestview(l:save) + endif +endfunction + +function! s:ApplyFixes(buffer, output) abort + call ale#fix#RemoveManagedFiles(a:buffer) + + let s:buffer_data[a:buffer].output = a:output + let s:buffer_data[a:buffer].done = 1 + + " We can only change the lines of a buffer which is currently open, + " so try and apply the fixes to the current buffer. + call ale#fix#ApplyQueuedFixes() +endfunction + +function! s:HandleExit(job_id, exit_code) abort + if !has_key(s:job_info_map, a:job_id) + return + endif + + let l:job_info = remove(s:job_info_map, a:job_id) + + if has_key(l:job_info, 'file_to_read') + let l:job_info.output = readfile(l:job_info.file_to_read) + endif + + call s:RunFixer({ + \ 'buffer': l:job_info.buffer, + \ 'input': l:job_info.output, + \ 'callback_list': l:job_info.callback_list, + \ 'callback_index': l:job_info.callback_index + 1, + \}) +endfunction + +function! ale#fix#ManageDirectory(buffer, directory) abort + call add(s:buffer_data[a:buffer].temporary_directory_list, a:directory) +endfunction + +function! ale#fix#RemoveManagedFiles(buffer) abort + if !has_key(s:buffer_data, a:buffer) + return + endif + + " We can't delete anything in a sandbox, so wait until we escape from + " it to delete temporary files and directories. + if ale#util#InSandbox() + return + endif + + " Delete directories like `rm -rf`. + " Directories are handled differently from files, so paths that are + " intended to be single files can be set up for automatic deletion without + " accidentally deleting entire directories. + for l:directory in s:buffer_data[a:buffer].temporary_directory_list + call delete(l:directory, 'rf') + endfor + + let s:buffer_data[a:buffer].temporary_directory_list = [] +endfunction + +function! s:CreateTemporaryFileForJob(buffer, temporary_file) abort + if empty(a:temporary_file) + " There is no file, so we didn't create anything. + return 0 + endif + + let l:temporary_directory = fnamemodify(a:temporary_file, ':h') + " Create the temporary directory for the file, unreadable by 'other' + " users. + call mkdir(l:temporary_directory, '', 0750) + " Automatically delete the directory later. + call ale#fix#ManageDirectory(a:buffer, l:temporary_directory) + " Write the buffer out to a file. + call writefile(getbufline(a:buffer, 1, '$'), a:temporary_file) + + return 1 +endfunction + +function! s:RunJob(options) abort + let l:buffer = a:options.buffer + let l:command = a:options.command + let l:output_stream = a:options.output_stream + let l:read_temporary_file = a:options.read_temporary_file + + let [l:temporary_file, l:command] = ale#command#FormatCommand(l:buffer, l:command, 1) + call s:CreateTemporaryFileForJob(l:buffer, l:temporary_file) + + let l:command = ale#job#PrepareCommand(l:command) + let l:job_options = { + \ 'mode': 'nl', + \ 'exit_cb': function('s:HandleExit'), + \} + + let l:job_info = { + \ 'buffer': l:buffer, + \ 'output': [], + \ 'callback_list': a:options.callback_list, + \ 'callback_index': a:options.callback_index, + \} + + if l:read_temporary_file + " TODO: Check that a temporary file is set here. + let l:job_info.file_to_read = l:temporary_file + elseif l:output_stream ==# 'stderr' + let l:job_options.err_cb = function('s:GatherOutput') + elseif l:output_stream ==# 'both' + let l:job_options.out_cb = function('s:GatherOutput') + let l:job_options.err_cb = function('s:GatherOutput') + else + let l:job_options.out_cb = function('s:GatherOutput') + endif + + let l:job_id = ale#job#Start(l:command, l:job_options) + + " TODO: Check that the job runs, and skip to the next item if it does not. + + let s:job_info_map[l:job_id] = l:job_info +endfunction + +function! s:RunFixer(options) abort + let l:buffer = a:options.buffer + let l:input = a:options.input + let l:index = a:options.callback_index + + while len(a:options.callback_list) > l:index + let l:result = function(a:options.callback_list[l:index])(l:buffer, l:input) + + if type(l:result) == type(0) && l:result == 0 + " When `0` is returned, skip this item. + let l:index += 1 + elseif type(l:result) == type([]) + let l:input = l:result + let l:index += 1 + else + " TODO: Check the return value here, and skip an index if + " the job fails. + call s:RunJob({ + \ 'buffer': l:buffer, + \ 'command': l:result.command, + \ 'output_stream': get(l:result, 'output_stream', 'stdout'), + \ 'read_temporary_file': get(l:result, 'read_temporary_file', 0), + \ 'callback_list': a:options.callback_list, + \ 'callback_index': l:index, + \}) + + " Stop here, we will handle exit later on. + return + endif + endwhile + + call s:ApplyFixes(l:buffer, l:input) +endfunction + +function! ale#fix#Fix() abort + let l:callback_list = [] + + for l:sub_type in split(&filetype, '\.') + call extend(l:callback_list, get(g:ale_fixers, l:sub_type, [])) + endfor + + if empty(l:callback_list) + echoerr 'No fixers have been defined for filetype: ' . &filetype + return + endif + + let l:buffer = bufnr('') + let l:input = getbufline(l:buffer, 1, '$') + + " Clean up any files we might have left behind from a previous run. + call ale#fix#RemoveManagedFiles(l:buffer) + + " The 'done' flag tells the function for applying changes when fixing + " is complete. + let s:buffer_data[l:buffer] = { + \ 'lines_before': l:input, + \ 'done': 0, + \ 'temporary_directory_list': [], + \} + + call s:RunFixer({ + \ 'buffer': l:buffer, + \ 'input': l:input, + \ 'callback_index': 0, + \ 'callback_list': l:callback_list, + \}) +endfunction + +" Set up an autocmd command to try and apply buffer fixes when available. +augroup ALEBufferFixGroup + autocmd! + autocmd BufEnter * call ale#fix#ApplyQueuedFixes() +augroup END diff --git a/autoload/ale/handlers/eslint.vim b/autoload/ale/handlers/eslint.vim new file mode 100644 index 00000000..a7e8ef42 --- /dev/null +++ b/autoload/ale/handlers/eslint.vim @@ -0,0 +1,43 @@ +" Author: w0rp <devw0rp@gmail.com> +" Description: eslint functions for handling and fixing errors. + +let g:ale_javascript_eslint_executable = +\ get(g:, 'ale_javascript_eslint_executable', 'eslint') + +function! ale#handlers#eslint#GetExecutable(buffer) abort + if ale#Var(a:buffer, 'javascript_eslint_use_global') + return ale#Var(a:buffer, 'javascript_eslint_executable') + endif + + " Look for the kinds of paths that create-react-app generates first. + let l:executable = ale#path#ResolveLocalPath( + \ a:buffer, + \ 'node_modules/eslint/bin/eslint.js', + \ '' + \) + + if !empty(l:executable) + return l:executable + endif + + return ale#path#ResolveLocalPath( + \ a:buffer, + \ 'node_modules/.bin/eslint', + \ ale#Var(a:buffer, 'javascript_eslint_executable') + \) +endfunction + +function! ale#handlers#eslint#Fix(buffer, lines) abort + let l:config = ale#path#FindNearestFile(a:buffer, '.eslintrc.js') + + if empty(l:config) + return 0 + endif + + return { + \ 'command': ale#Escape(ale#handlers#eslint#GetExecutable(a:buffer)) + \ . ' --config ' . ale#Escape(l:config) + \ . ' --fix %t', + \ 'read_temporary_file': 1, + \} +endfunction |