ale/ale_linters/ruby/rubocop.vim

" Author: ynonp - https://github.com/ynonp, Eddie Lebow https://github.com/elebow
" Description: RuboCop, a code style analyzer for Ruby files

call ale#Set('ruby_rubocop_executable', 'rubocop')
call ale#Set('ruby_rubocop_options', '')

function! ale_linters#ruby#rubocop#GetCommand(buffer) abort
    let l:executable = ale#Var(a:buffer, 'ruby_rubocop_executable')

    return ale#ruby#EscapeExecutable(l:executable, 'rubocop')
    \   . ' --format json --force-exclusion '
    \   . ale#Var(a:buffer, 'ruby_rubocop_options')
    \   . ' --stdin ' . ale#Escape(expand('#' . a:buffer . ':p'))
endfunction

function! ale_linters#ruby#rubocop#GetType(severity) abort
    if a:severity is? 'convention'
    \|| a:severity is? 'warning'
    \|| a:severity is? 'refactor'
        return 'W'
    endif

    return 'E'
endfunction

call ale#linter#Define('ruby', {
\   'name': 'rubocop',
\   'executable': {b -> ale#Var(b, 'ruby_rubocop_executable')},
\   'command': function('ale_linters#ruby#rubocop#GetCommand'),
\   'callback': 'ale#ruby#HandleRubocopOutput',
\})
Use rubocop's JSON output format (resolves #339) (#738) * Use rubocop's JSON output format (resolves #339) Rubocop's emacs formatter seems to have changed format in some not-so-ancient version. The JSON formatter should provide a more stable interface than parsing lines with a regex. The JSON formatter was introduced in mid-2013, so it should be safe to assume available in any reasonably-modern environment. The oldest currently-supported version of ruby (according to ruby-lang.org) was not supported by rubocop until 2014. * Rubocop: Use global function for GetType * Rubocop: Use scope prefix in GetType * Rubocop: Update command_callback test * Rubocop: add end_col to Handle 2017-07-09 14:48:04 +00:00			`" Author: ynonp - https://github.com/ynonp, Eddie Lebow https://github.com/elebow`
			`" Description: RuboCop, a code style analyzer for Ruby files`
Credit fijshion for his work in the files, and make the new linters work again by adding the now required name arguments. 2016-09-15 20:09:04 +00:00
Fix bug with RuboCop linter when options are not set 2018-09-14 16:30:28 +00:00			`call ale#Set('ruby_rubocop_executable', 'rubocop')`
			`call ale#Set('ruby_rubocop_options', '')`

Clean up the rubocop file a little 2017-05-18 08:22:34 +00:00			`function! ale_linters#ruby#rubocop#GetCommand(buffer) abort`
Return only the unescaped executables from executable callbacks 2018-09-14 12:24:59 +00:00			`let l:executable = ale#Var(a:buffer, 'ruby_rubocop_executable')`
Clean up the rubocop file a little 2017-05-18 08:22:34 +00:00
Move ale#handlers#ruby#EscapeExecutable to ale#ruby#EscapeExecutable This function is generally applicable to Ruby, not just handling linter output. 2019-08-13 05:52:13 +00:00			`return ale#ruby#EscapeExecutable(l:executable, 'rubocop')`
Use rubocop's JSON output format (resolves #339) (#738) * Use rubocop's JSON output format (resolves #339) Rubocop's emacs formatter seems to have changed format in some not-so-ancient version. The JSON formatter should provide a more stable interface than parsing lines with a regex. The JSON formatter was introduced in mid-2013, so it should be safe to assume available in any reasonably-modern environment. The oldest currently-supported version of ruby (according to ruby-lang.org) was not supported by rubocop until 2014. * Rubocop: Use global function for GetType * Rubocop: Use scope prefix in GetType * Rubocop: Update command_callback test * Rubocop: add end_col to Handle 2017-07-09 14:48:04 +00:00			`\ . ' --format json --force-exclusion '`
Clean up the rubocop file a little 2017-05-18 08:22:34 +00:00			`\ . ale#Var(a:buffer, 'ruby_rubocop_options')`
Make every test set filenames and switch directories in the same way, and fix some missing escaping for the rubocop linter 2017-07-09 21:43:25 +00:00			`\ . ' --stdin ' . ale#Escape(expand('#' . a:buffer . ':p'))`
Clean up the rubocop file a little 2017-05-18 08:22:34 +00:00			`endfunction`

Use rubocop's JSON output format (resolves #339) (#738) * Use rubocop's JSON output format (resolves #339) Rubocop's emacs formatter seems to have changed format in some not-so-ancient version. The JSON formatter should provide a more stable interface than parsing lines with a regex. The JSON formatter was introduced in mid-2013, so it should be safe to assume available in any reasonably-modern environment. The oldest currently-supported version of ruby (according to ruby-lang.org) was not supported by rubocop until 2014. * Rubocop: Use global function for GetType * Rubocop: Use scope prefix in GetType * Rubocop: Update command_callback test * Rubocop: add end_col to Handle 2017-07-09 14:48:04 +00:00			`function! ale_linters#ruby#rubocop#GetType(severity) abort`
Ban use of ==# or ==? in the codebase, and prefer is# or is? instead 2017-08-08 07:39:13 +00:00			`if a:severity is? 'convention'`
			`\\|\| a:severity is? 'warning'`
			`\\|\| a:severity is? 'refactor'`
Fix some indentation 2017-07-09 14:50:36 +00:00			`return 'W'`
Use rubocop's JSON output format (resolves #339) (#738) * Use rubocop's JSON output format (resolves #339) Rubocop's emacs formatter seems to have changed format in some not-so-ancient version. The JSON formatter should provide a more stable interface than parsing lines with a regex. The JSON formatter was introduced in mid-2013, so it should be safe to assume available in any reasonably-modern environment. The oldest currently-supported version of ruby (according to ruby-lang.org) was not supported by rubocop until 2014. * Rubocop: Use global function for GetType * Rubocop: Use scope prefix in GetType * Rubocop: Update command_callback test * Rubocop: add end_col to Handle 2017-07-09 14:48:04 +00:00			`endif`
Simplify ale_linters#ruby#rubocop#GetType 2017-07-09 14:50:12 +00:00
			`return 'E'`
Use rubocop's JSON output format (resolves #339) (#738) * Use rubocop's JSON output format (resolves #339) Rubocop's emacs formatter seems to have changed format in some not-so-ancient version. The JSON formatter should provide a more stable interface than parsing lines with a regex. The JSON formatter was introduced in mid-2013, so it should be safe to assume available in any reasonably-modern environment. The oldest currently-supported version of ruby (according to ruby-lang.org) was not supported by rubocop until 2014. * Rubocop: Use global function for GetType * Rubocop: Use scope prefix in GetType * Rubocop: Update command_callback test * Rubocop: add end_col to Handle 2017-07-09 14:48:04 +00:00			`endfunction`

First pass at optimizing ale to autoload (#80) * First pass at optimizing ale to autoload First off, the structure/function names should be revised a bit, but I will wait for @w0rp's input before unifying the naming style. Second off, the docs probably need some more work, I just did some simple find-and-replace work. With that said, this pull brings major performance gains for ale. On my slowest system, fully loading ale and all its code takes around 150ms. I have moved all of ale's autoload-able code to autoload/, and in addition, implemented lazy-loading of linters. This brings load time on that same system down to 5ms. The only downside of lazy loading is that `g:ale_linters` cannot be changed at runtime; however, it also speeds up performance at runtime by simplfying the logic greatly. Please let me know what you think! Closes #59 * Address Travis/Vint errors For some reason, ale isn't running vint for me... * Incorporate feedback, make fixes Lazy-loading logic is much improved. * Add header comments; remove incorrect workaround * Remove unneeded plugin guards * Fix lazy-loading linter logic Set the wrong variable.... * Fix capitialization 2016-10-10 18:51:29 +00:00			`call ale#linter#Define('ruby', {`
Credit fijshion for his work in the files, and make the new linters work again by adding the now required name arguments. 2016-09-15 20:09:04 +00:00			`\ 'name': 'rubocop',`
#2132 - Replace all uses of foo_callback with foo 2019-02-22 18:05:04 +00:00			`\ 'executable': {b -> ale#Var(b, 'ruby_rubocop_executable')},`
			`\ 'command': function('ale_linters#ruby#rubocop#GetCommand'),`
Adds standardrb linter (#2133) See: https://github.com/testdouble/standard StandardRB is to RuboCop what StandardJS is to ESLint. This commit naively copies the RuboCop linter and fixer to point at the standardrb executable. Any other adjustments are very minor (the only I can think of is that standardrb takes a `--fix` option instead of `--auto-correct`). This raises a confusing point to me as both developer and a user: since ale enables all linters by default, won't this run both RuboCop and StandardRB (the results of which will almost always be in conflict with one another)? How does ale already solve for this for the similar case of StandardJS and ESLint? 2018-12-10 21:02:32 +00:00			`\ 'callback': 'ale#ruby#HandleRubocopOutput',`
ADD rubocop linter 2016-09-15 07:37:53 +00:00			`\})`