From 35031a0b8a384766277a8b38f84c28ae89a17430 Mon Sep 17 00:00:00 2001 From: Kelly Fox Date: Sat, 21 Oct 2017 12:31:49 -0500 Subject: [PATCH 001/390] add rustfmt fixer --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++ autoload/ale/fixers/rustfmt.vim | 17 +++++++++ doc/ale-rust.txt | 13 +++++++ doc/ale.txt | 3 +- test/fixers/test_rustfmt_fixer_callback.vader | 38 +++++++++++++++++++ test/rust_files/testfile.rs | 0 7 files changed, 76 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/rustfmt.vim create mode 100644 test/fixers/test_rustfmt_fixer_callback.vader create mode 100644 test/rust_files/testfile.rs diff --git a/README.md b/README.md index 120177e..df5ba22 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ formatting. | reStructuredText | [proselint](http://proselint.com/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | -| Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/) | +| Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | | SASS | [sass-lint](https://www.npmjs.com/package/sass-lint), [stylelint](https://github.com/stylelint/stylelint) | | SCSS | [sass-lint](https://www.npmjs.com/package/sass-lint), [scss-lint](https://github.com/brigade/scss-lint), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | | Scala | [scalac](http://scala-lang.org), [scalastyle](http://www.scalastyle.org) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index d26c71a..07daa40 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -107,6 +107,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['typescript'], \ 'description': 'Fix typescript files with tslint --fix.', \ }, +\ 'rustfmt': { +\ 'function': 'ale#fixers#rustfmt#Fix', +\ 'suggested_filetypes': ['rust'], +\ 'description': 'Fix Rust files with Rustfmt.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/rustfmt.vim b/autoload/ale/fixers/rustfmt.vim new file mode 100644 index 0000000..fb5ac61 --- /dev/null +++ b/autoload/ale/fixers/rustfmt.vim @@ -0,0 +1,17 @@ +" Author: Kelly Fox +" Description: Integration of rustfmt with ALE. + +call ale#Set('rust_rustfmt_executable', 'rustfmt') +call ale#Set('rust_rustfmt_options', '') + +function! ale#fixers#rustfmt#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'rust_rustfmt_executable') + let l:options = ale#Var(a:buffer, 'rust_rustfmt_options') + + return { + \ 'command': ale#Escape(l:executable) + \ . (empty(l:options) ? '' : ' ' . l:options) + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 52dc3d6..e20aea2 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -22,6 +22,8 @@ Integration Information over cargo. rls implements the Language Server Protocol for incremental compilation of Rust code, and can check Rust files while you type. `rls` requires Rust files to contained in Cargo projects. + 4. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to + consistently reformat your Rust code. Only cargo is enabled by default. To switch to using rustc instead of cargo, configure |g:ale_linters| appropriately: > @@ -70,5 +72,16 @@ g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes* let g:ale_rust_ignore_error_codes = ['E0432', 'E0433'] +=============================================================================== +rustfmt *ale-rust-rustfmt* + +g:ale_rust_rustfmt_options *g:ale_rust_rustfmt_options* + *b:ale_rust_rustfmt_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the rustfmt fixer. + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index fb0b5a7..acf6428 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -142,6 +142,7 @@ CONTENTS *ale-contents* cargo...............................|ale-rust-cargo| rls.................................|ale-rust-rls| rustc...............................|ale-rust-rustc| + rustfmt.............................|ale-rust-rustfmt| sass..................................|ale-sass-options| stylelint...........................|ale-sass-stylelint| scala.................................|ale-scala-options| @@ -280,7 +281,7 @@ Notes: * reStructuredText: `proselint` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` -* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|) +* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` * SASS: `sass-lint`, `stylelint` * SCSS: `sass-lint`, `scss-lint`, `stylelint`, `prettier` * Scala: `scalac`, `scalastyle` diff --git a/test/fixers/test_rustfmt_fixer_callback.vader b/test/fixers/test_rustfmt_fixer_callback.vader new file mode 100644 index 0000000..36dd58a --- /dev/null +++ b/test/fixers/test_rustfmt_fixer_callback.vader @@ -0,0 +1,38 @@ +Before: + Save g:ale_rust_rustfmt_executable + Save g:ale_rust_rustfmt_options + + " Use an invalid global executable, so we don't match it. + let g:ale_rust_rustfmt_executable = 'xxxinvalid' + let g:ale_rust_rustfmt_options = '' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The rustfmt callback should return the correct default values): + call ale#test#SetFilename('../rust_files/testfile.rs') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' %t', + \ }, + \ ale#fixers#rustfmt#Fix(bufnr('')) + +Execute(The rustfmt callback should include custom rustfmt options): + let g:ale_rust_rustfmt_options = "--skip-children" + call ale#test#SetFilename('../rust_files/testfile.rs') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' ' . g:ale_rust_rustfmt_options + \ . ' %t', + \ }, + \ ale#fixers#rustfmt#Fix(bufnr('')) diff --git a/test/rust_files/testfile.rs b/test/rust_files/testfile.rs new file mode 100644 index 0000000..e69de29 From ed93cd14942e3b9fe3b56e9a2f54112a302ce4ef Mon Sep 17 00:00:00 2001 From: Gustav Munkby Date: Sun, 22 Oct 2017 10:42:36 +0200 Subject: [PATCH 002/390] Update test scripts to work on OS X There were a couple of issues - `paste` requires a file argument - `mktemp` requires a pattern argument - `sort` doesn't support `-h`, but `-n` is enough for sorting on numbers, and `-s` was introduced to perform a stable sort instead. The main issues were that BSD `sed` does not support: - Alternation (`\|`) - solved by splitting to multiple patterns - Bound shortcuts (`x\+`, `x\?`) - solved by replacing with `xx*` and `x\{0,1\}` respectively - Lower-casing (`\L`) - solved by piping through `tr` instead (this will lowercase everything and not only the integration names, but I assumed that wasn't too much of an issue, as a portable alternative for the selective downcasing would be much more involved). --- test/script/check-supported-tools-tables | 20 ++++++++++---------- test/script/check-toc | 11 ++++++----- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/test/script/check-supported-tools-tables b/test/script/check-supported-tools-tables index 1d0fec5..32cebb2 100755 --- a/test/script/check-supported-tools-tables +++ b/test/script/check-supported-tools-tables @@ -30,30 +30,30 @@ readme_section_size="$( \ # shellcheck disable=SC2003 readme_end_line="$(expr "$readme_start_line" + "$readme_section_size")" -doc_file="$(mktemp)" -readme_file="$(mktemp)" +doc_file="$(mktemp -t doc.XXXXXXXX)" +readme_file="$(mktemp -t readme.XXXXXXXX)" sed -n "$ale_help_start_line,$ale_help_end_line"p doc/ale.txt \ | grep '\* .*: ' \ | sed 's/^*//' \ - | sed 's/[`!^]\|([^)]*)//g' \ + | sed 's/[`!^]//g;s/([^)]*)//g' \ | sed 's/ *\([,:]\)/\1/g' \ | sed 's/ */ /g' \ - | sed 's/^ *\| *$//g' \ + | sed 's/^ *//;s/ *$//' \ | sed 's/^/ /' \ > "$doc_file" sed -n "$readme_start_line,$readme_end_line"p README.md \ | grep '| .* |' \ - | sed '/^| Language\|^| ---/d' \ + | sed '/^| Language/d;/^| ---/d' \ | sed 's/^|//' \ - | sed 's/ \?|/:/' \ - | sed 's/[`!^|]\|([^)]*)//g' \ - | sed 's/\[\|\]//g' \ - | sed 's/see[^,]*\(,\|$\)/\1/g' \ + | sed 's/ \{0,1\}|/:/' \ + | sed 's/[`!^|]//g;s/([^)]*)//g' \ + | sed 's/\[//g;s/\]//g' \ + | sed 's/see[^,]*//g' \ | sed 's/ *\([,:]\)/\1/g' \ | sed 's/ */ /g' \ - | sed 's/^ *\| *$//g' \ + | sed 's/^ *//;s/ *$//' \ | sed 's/^/ /' \ | sed 's/ *-n flag//g' \ > "$readme_file" diff --git a/test/script/check-toc b/test/script/check-toc index c4512b0..426d5a1 100755 --- a/test/script/check-toc +++ b/test/script/check-toc @@ -23,18 +23,19 @@ tagged_toc_file="$(mktemp -t ale.txt.XXXXXXXX)" sorted_toc_file="$(mktemp -t sorted-ale.txt.XXXXXXXX)" sed -n "$toc_start_line,$toc_end_line"p doc/ale.txt \ - | sed 's/^ \( *[^.]\+\)\.\+|\(.\+\)|/\1, \2/' \ + | sed 's/^ \( *[^.][^.]*\)\.\.*|\(..*\)|/\1, \2/' \ > "$toc_file" # Get all of the doc files in a natural sorted order. -doc_files="$(/bin/ls -1v doc | grep ^ale- | sed 's/^/doc\//' | paste -sd ' ')" +doc_files="$(/bin/ls -1v doc | grep ^ale- | sed 's/^/doc\//' | paste -sd ' ' -)" # shellcheck disable=SC2086 grep -h 'ale-.*-options\|^[a-z].*\*ale-.*\*$' $doc_files \ | sed 's/^/ /' \ | sed 's/ALE Shell Integration/ALE sh Integration/' \ - | sed 's/ ALE \(.*\) Integration/\L\1/' \ - | sed 's/ *\*\(.\+\)\*$/, \1/' \ + | sed 's/ ALE \(.*\) Integration/\1/' \ + | sed 's/ *\*\(..*\)\*$/, \1/' \ + | tr '[:upper:]' '[:lower:]' \ | sed 's/objective-c/objc/' \ | sed 's/c++/cpp/' \ > "$heading_file" @@ -62,7 +63,7 @@ while read -r; do done < "$toc_file" # Sort the sections and sub-sections and remove the tags. -sort -h "$tagged_toc_file" | sed 's/[0-9]\+ //' > "$sorted_toc_file" +sort -sn "$tagged_toc_file" | sed 's/[0-9][0-9]* //' > "$sorted_toc_file" echo 'Check for bad ToC sorting:' echo From 43653ef54816e5219de56cf57073a93b4ce957b8 Mon Sep 17 00:00:00 2001 From: Carlos Ramos Date: Fri, 20 Oct 2017 17:13:25 -0400 Subject: [PATCH 003/390] new fixer elixir mix format (only available in elixir > 1.6) --- autoload/ale/fix/registry.vim | 5 +++++ autoload/ale/fixers/mix_format.vim | 17 +++++++++++++++++ autoload/ale/handlers/elixir.vim | 5 +++++ test/elixir-test-files/testfile.ex | 0 test/fixers/test_elixir_fixer_callback.vader | 16 ++++++++++++++++ 5 files changed, 43 insertions(+) create mode 100644 autoload/ale/fixers/mix_format.vim create mode 100644 autoload/ale/handlers/elixir.vim create mode 100644 test/elixir-test-files/testfile.ex create mode 100644 test/fixers/test_elixir_fixer_callback.vader diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index d26c71a..598be6d 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -27,6 +27,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['javascript', 'typescript'], \ 'description': 'Apply eslint --fix to a file.', \ }, +\ 'mix_format': { +\ 'function': 'ale#fixers#mix_format#Fix', +\ 'suggested_filetypes': ['elixir'], +\ 'description': 'Apply mix format to a file.', +\ }, \ 'format': { \ 'function': 'ale#fixers#format#Fix', \ 'suggested_filetypes': ['elm'], diff --git a/autoload/ale/fixers/mix_format.vim b/autoload/ale/fixers/mix_format.vim new file mode 100644 index 0000000..905a608 --- /dev/null +++ b/autoload/ale/fixers/mix_format.vim @@ -0,0 +1,17 @@ +" Author: carakan +" Description: Fixing files with elixir formatter 'mix format'. + +call ale#Set('elixir_mix_executable', 'mix') + +function! ale#fixers#mix_format#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'elixir_mix_executable') +endfunction + +function! ale#fixers#mix_format#Fix(buffer) abort + return { + \ 'command': ale#handlers#elixir#GetExecutable(a:buffer) + \ . ale#fixers#mix_format#GetExecutable(a:buffer) + \ . ' format %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/autoload/ale/handlers/elixir.vim b/autoload/ale/handlers/elixir.vim new file mode 100644 index 0000000..be25d33 --- /dev/null +++ b/autoload/ale/handlers/elixir.vim @@ -0,0 +1,5 @@ +call ale#Set('elixir_executable', '') + +function! ale#handlers#elixir#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'elixir_executable') +endfunction diff --git a/test/elixir-test-files/testfile.ex b/test/elixir-test-files/testfile.ex new file mode 100644 index 0000000..e69de29 diff --git a/test/fixers/test_elixir_fixer_callback.vader b/test/fixers/test_elixir_fixer_callback.vader new file mode 100644 index 0000000..ff4786e --- /dev/null +++ b/test/fixers/test_elixir_fixer_callback.vader @@ -0,0 +1,16 @@ +Before: + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + call ale#test#RestoreDirectory() + +Execute(The executable path should be correct): + call ale#test#SetFilename('../elixir-test-files/testfile.ex') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': 'mix format' + \ . ' %t', + \ }, + \ ale#fixers#elixir#Fix(bufnr('')) From 3212278c91bc70d39d1affd6fc86a19ff8cee832 Mon Sep 17 00:00:00 2001 From: Carlos Ramos Date: Sun, 22 Oct 2017 09:22:16 -0400 Subject: [PATCH 004/390] fix test's and delete unused code --- autoload/ale/fixers/mix_format.vim | 3 +-- autoload/ale/handlers/elixir.vim | 5 ----- test/fixers/test_elixir_fixer_callback.vader | 16 --------------- .../test_mix_format_fixer_callback.vader | 20 +++++++++++++++++++ 4 files changed, 21 insertions(+), 23 deletions(-) delete mode 100644 autoload/ale/handlers/elixir.vim delete mode 100644 test/fixers/test_elixir_fixer_callback.vader create mode 100644 test/fixers/test_mix_format_fixer_callback.vader diff --git a/autoload/ale/fixers/mix_format.vim b/autoload/ale/fixers/mix_format.vim index 905a608..0486640 100644 --- a/autoload/ale/fixers/mix_format.vim +++ b/autoload/ale/fixers/mix_format.vim @@ -9,8 +9,7 @@ endfunction function! ale#fixers#mix_format#Fix(buffer) abort return { - \ 'command': ale#handlers#elixir#GetExecutable(a:buffer) - \ . ale#fixers#mix_format#GetExecutable(a:buffer) + \ 'command': ale#Escape(ale#fixers#mix_format#GetExecutable(a:buffer)) \ . ' format %t', \ 'read_temporary_file': 1, \} diff --git a/autoload/ale/handlers/elixir.vim b/autoload/ale/handlers/elixir.vim deleted file mode 100644 index be25d33..0000000 --- a/autoload/ale/handlers/elixir.vim +++ /dev/null @@ -1,5 +0,0 @@ -call ale#Set('elixir_executable', '') - -function! ale#handlers#elixir#GetExecutable(buffer) abort - return ale#Var(a:buffer, 'elixir_executable') -endfunction diff --git a/test/fixers/test_elixir_fixer_callback.vader b/test/fixers/test_elixir_fixer_callback.vader deleted file mode 100644 index ff4786e..0000000 --- a/test/fixers/test_elixir_fixer_callback.vader +++ /dev/null @@ -1,16 +0,0 @@ -Before: - call ale#test#SetDirectory('/testplugin/test/fixers') - -After: - call ale#test#RestoreDirectory() - -Execute(The executable path should be correct): - call ale#test#SetFilename('../elixir-test-files/testfile.ex') - - AssertEqual - \ { - \ 'read_temporary_file': 1, - \ 'command': 'mix format' - \ . ' %t', - \ }, - \ ale#fixers#elixir#Fix(bufnr('')) diff --git a/test/fixers/test_mix_format_fixer_callback.vader b/test/fixers/test_mix_format_fixer_callback.vader new file mode 100644 index 0000000..c6c97c5 --- /dev/null +++ b/test/fixers/test_mix_format_fixer_callback.vader @@ -0,0 +1,20 @@ +Before: + call ale#test#SetDirectory('/testplugin/test/fixers') + Save g:ale_elixir_mix_executable + + let g:ale_elixir_mix_executable = 'xxxinvalid' + +After: + call ale#test#RestoreDirectory() + +Execute(The mix_format callback should return the correct default values): + call ale#test#SetFilename('../elixir-test-files/testfile.ex') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' format %t', + \ }, + \ ale#fixers#mix_format#Fix(bufnr('')) + From be1377f6d7e642a8b56bb0589dc9cc48fc836c13 Mon Sep 17 00:00:00 2001 From: Carlos Ramos Date: Sun, 22 Oct 2017 19:44:44 -0400 Subject: [PATCH 005/390] add basic documentation for elixir mix --- doc/ale-elixir.txt | 17 +++++++++++++++++ doc/ale.txt | 2 ++ 2 files changed, 19 insertions(+) create mode 100644 doc/ale-elixir.txt diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt new file mode 100644 index 0000000..a5318c0 --- /dev/null +++ b/doc/ale-elixir.txt @@ -0,0 +1,17 @@ +=============================================================================== +ALE Elixir Integration *ale-elixir-options* + + +=============================================================================== +mix *ale-elixir-mix* + +g:ale_elixir_mix_options *g:ale_elixir_mix_options* + *b:ale_elixir_mix_options* + Type: |String| + Default: `'mix'` + + + This variable can be changed to specify the mix executable. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index fb0b5a7..b764fe6 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -48,6 +48,8 @@ CONTENTS *ale-contents* dartanalyzer........................|ale-dart-dartanalyzer| dockerfile............................|ale-dockerfile-options| hadolint............................|ale-dockerfile-hadolint| + elixir................................|ale-elixir-options| + mix.................................|ale-elixir-mix| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-make............................|ale-elm-elm-make| From 4884e33f8b2591cce635e171e776368184def406 Mon Sep 17 00:00:00 2001 From: aurieh Date: Tue, 24 Oct 2017 15:03:47 +0300 Subject: [PATCH 006/390] Add checkmake (resolves #866) --- ale_linters/make/checkmake.vim | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 ale_linters/make/checkmake.vim diff --git a/ale_linters/make/checkmake.vim b/ale_linters/make/checkmake.vim new file mode 100644 index 0000000..3dd8cc9 --- /dev/null +++ b/ale_linters/make/checkmake.vim @@ -0,0 +1,24 @@ +" Author: aurieh - https://github.com/aurieh + +function! ale_linters#make#checkmake#Handle(buffer, lines) abort + let l:pattern = '\v^(\d+):(.+):(.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:text = l:match[2] . ': ' . l:match[3] + call add(l:output, { + \ 'bufnr': a:buffer, + \ 'lnum': l:match[1] + 0, + \ 'type': 'E', + \ 'text': l:text, + \}) + endfor + return l:output +endfunction + +call ale#linter#Define('make', { +\ 'name': 'checkmake', +\ 'executable': 'checkmake', +\ 'command': 'checkmake %s --format="{{.LineNumber}}:{{.Rule}}:{{.Violation}}"', +\ 'callback': 'ale_linters#make#checkmake#Handle', +\}) From f0a0aef33d0f023f60605823fcf47778726ce6e1 Mon Sep 17 00:00:00 2001 From: aurieh Date: Tue, 24 Oct 2017 15:09:56 +0300 Subject: [PATCH 007/390] Update doc/ale.txt & README.md --- README.md | 1 + doc/ale.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 89fd380..b61817b 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,7 @@ formatting. | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | +| Make | [checkmake](https://github.com/mrtazz/checkmake) | | Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !! | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | diff --git a/doc/ale.txt b/doc/ale.txt index fb0b5a7..e32a03d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -261,6 +261,7 @@ Notes: * LaTeX (tex): `chktex`, `lacheck`, `proselint` * LLVM: `llc` * Lua: `luacheck` +* Make: `checkmake` * Markdown: `mdl`, `proselint`, `vale`, `remark-lint` * MATLAB: `mlint` * Nim: `nim check`!! From c96e7402ba62e4f40324e0fbf3331dd6dda64b47 Mon Sep 17 00:00:00 2001 From: Su Shangjun Date: Tue, 24 Oct 2017 08:11:56 -0500 Subject: [PATCH 008/390] example for 'rcfile' on ale_python_pylint_options Two hyphens instead of one will enable the option `rcfile`. --- doc/ale-python.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-python.txt b/doc/ale-python.txt index a8d033e..755094a 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -174,7 +174,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options* Python 3, you may want to set > let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2 - let g:ale_python_pylint_options = '-rcfile /path/to/pylint.rc' + let g:ale_python_pylint_options = '--rcfile /path/to/pylint.rc' " The virtualenv detection needs to be disabled. let g:ale_python_pylint_use_global = 0 From b172cd8b17a8d9f0573e75211963e59b37ad5c34 Mon Sep 17 00:00:00 2001 From: Diego Oliveira Date: Tue, 24 Oct 2017 19:25:02 -0200 Subject: [PATCH 009/390] Add phan as a linter for php files (#1026) Add phan for checking PHP code --- README.md | 2 +- ale_linters/php/phan.vim | 36 ++++++++++++++++++++++++ doc/ale-php.txt | 15 ++++++++++ doc/ale.txt | 3 +- test/handler/test_php_phan_handler.vader | 24 ++++++++++++++++ 5 files changed, 78 insertions(+), 2 deletions(-) create mode 100644 ale_linters/php/phan.vim create mode 100644 test/handler/test_php_phan_handler.vader diff --git a/README.md b/README.md index 813b429..742712a 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ formatting. | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | -| PHP | [hack](http://hacklang.org/), [langserver](https://github.com/felixfbecker/php-language-server), [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | +| PHP | [hack](http://hacklang.org/), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/)| | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | diff --git a/ale_linters/php/phan.vim b/ale_linters/php/phan.vim new file mode 100644 index 0000000..f3b3d48 --- /dev/null +++ b/ale_linters/php/phan.vim @@ -0,0 +1,36 @@ +" Author: diegoholiveira +" Description: static analyzer for PHP + +" Define the minimum severity +let g:ale_php_phan_minimum_severity = get(g:, 'ale_php_phan_minimum_severity', 0) + +function! ale_linters#php#phan#GetCommand(buffer) abort + return 'phan -y ' + \ . ale#Var(a:buffer, 'php_phan_minimum_severity') + \ . ' %s' +endfunction + +function! ale_linters#php#phan#Handle(buffer, lines) abort + " Matches against lines like the following: + " + " /path/to/some-filename.php:18 ERRORTYPE message + let l:pattern = '^.*:\(\d\+\)\s\(\w\+\)\s\(.\+\)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'text': l:match[3], + \ 'type': 'W', + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('php', { +\ 'name': 'phan', +\ 'executable': 'phan', +\ 'command_callback': 'ale_linters#php#phan#GetCommand', +\ 'callback': 'ale_linters#php#phan#Handle', +\}) diff --git a/doc/ale-php.txt b/doc/ale-php.txt index bae6d7d..8756d60 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -34,6 +34,21 @@ g:ale_php_langserver_use_global *g:ale_php_langserver_use_global* See: |ale-integrations-local-executables| +=============================================================================== +phan *ale-php-phan* + +WARNING: please do not use this linter if you have an configuration file +for your project because the phan will look into your entirely project and +ale will display in the current buffer warnings that may belong to other file. + +g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity* + *b:ale_php_phan_minimum_severity* + Type: |Number| + Default: `0` + + This variable defines the minimum severity level + + =============================================================================== phpcbf *ale-php-phpcbf* diff --git a/doc/ale.txt b/doc/ale.txt index 47b9543..2972381 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -115,6 +115,7 @@ CONTENTS *ale-contents* php...................................|ale-php-options| hack................................|ale-php-hack| langserver..........................|ale-php-langserver| + phan................................|ale-php-phan| phpcbf..............................|ale-php-phpcbf| phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| @@ -273,7 +274,7 @@ Notes: * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|) * Perl: `perl -c`, `perl-critic` -* PHP: `hack`, `langserver`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` +* PHP: `hack`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` diff --git a/test/handler/test_php_phan_handler.vader b/test/handler/test_php_phan_handler.vader new file mode 100644 index 0000000..68ed6d0 --- /dev/null +++ b/test/handler/test_php_phan_handler.vader @@ -0,0 +1,24 @@ +Before: + runtime ale_linters/php/phan.vim + +Execute(The php static analyzer handler should parse errors from phan): + AssertEqual + \ [ + \ { + \ 'lnum': 25, + \ 'type': 'W', + \ 'text': 'Return type of getValidator is undeclared type \Respect\Validation\Validator', + \ }, + \ { + \ 'lnum': 66, + \ 'type': 'W', + \ 'text': 'Call to method string from undeclared class \Respect\Validation\Validator', + \ }, + \ ], + \ ale_linters#php#phan#Handle(347, [ + \ "example.php:25 PhanUndeclaredTypeReturnType Return type of getValidator is undeclared type \\Respect\\Validation\\Validator", + \ "example.php:66 PhanUndeclaredClassMethod Call to method string from undeclared class \\Respect\\Validation\\Validator", + \ ]) + +After: + call ale#linter#Reset() From 07dad64acb2ac67c3ccf5582995e3377d1479aa7 Mon Sep 17 00:00:00 2001 From: Zack Kourouma Date: Tue, 24 Oct 2017 14:29:04 -0700 Subject: [PATCH 010/390] adds fixer support for hfmt (#1027) Add support for fixing Haskell with hfmt --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++++ autoload/ale/fixers/hfmt.vim | 16 +++++++++++++++ doc/ale-haskell.txt | 10 +++++++++ doc/ale.txt | 3 ++- test/fixers/test_hfmt_fixer_callback.vader | 24 ++++++++++++++++++++++ 6 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/hfmt.vim create mode 100644 test/fixers/test_hfmt_fixer_callback.vader diff --git a/README.md b/README.md index 742712a..e803b90 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ formatting. | GraphQL | [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | -| Haskell | [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools) | +| Haskell | [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | | HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index e17521f..bbdcc43 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -117,6 +117,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['rust'], \ 'description': 'Fix Rust files with Rustfmt.', \ }, +\ 'hfmt': { +\ 'function': 'ale#fixers#hfmt#Fix', +\ 'suggested_filetypes': ['haskell'], +\ 'description': 'Fix Haskell files with hfmt.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/hfmt.vim b/autoload/ale/fixers/hfmt.vim new file mode 100644 index 0000000..ea061da --- /dev/null +++ b/autoload/ale/fixers/hfmt.vim @@ -0,0 +1,16 @@ +" Author: zack +" Description: Integration of hfmt with ALE. + +call ale#Set('haskell_hfmt_executable', 'hfmt') + +function! ale#fixers#hfmt#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'haskell_hfmt_executable') + + return { + \ 'command': ale#Escape(l:executable) + \ . ' -w' + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction + diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt index bbf99fc..4a490ef 100644 --- a/doc/ale-haskell.txt +++ b/doc/ale-haskell.txt @@ -20,6 +20,16 @@ g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options* This variable can be changed to modify flags given to hdevtools. +=============================================================================== +hfmt *ale-haskell-hfmt* + +g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable* + *b:ale_haskell_hfmt_executable* + Type: |String| + Default: `'hfmt'` + + This variable can be changed to use a different executable for hfmt. + =============================================================================== stack-build *ale-haskell-stack-build* diff --git a/doc/ale.txt b/doc/ale.txt index 2972381..e0e85df 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -72,6 +72,7 @@ CONTENTS *ale-contents* ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| hdevtools...........................|ale-haskell-hdevtools| + hfmt................................|ale-haskell-hfmt| stack-build.........................|ale-haskell-stack-build| html..................................|ale-html-options| htmlhint............................|ale-html-htmlhint| @@ -255,7 +256,7 @@ Notes: * GraphQL: `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` -* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools` +* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` * HTML: `HTMLHint`, `proselint`, `tidy` * Idris: `idris` * Java: `checkstyle`, `javac` diff --git a/test/fixers/test_hfmt_fixer_callback.vader b/test/fixers/test_hfmt_fixer_callback.vader new file mode 100644 index 0000000..69cd03f --- /dev/null +++ b/test/fixers/test_hfmt_fixer_callback.vader @@ -0,0 +1,24 @@ +Before: + Save g:ale_haskell_hfmt_executable + + " Use an invalid global executable, so we don't match it. + let g:ale_haskell_hfmt_executable = 'xxxinvalid' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The hfmt callback should return the correct default values): + call ale#test#SetFilename('../haskell_files/testfile.hs') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' -w' + \ . ' %t', + \ }, + \ ale#fixers#hfmt#Fix(bufnr('')) From 1c56bebd7ca44d43badc9a63dd7dc4d88fd1b8b9 Mon Sep 17 00:00:00 2001 From: Christopher Swingley Date: Tue, 24 Oct 2017 13:34:38 -0800 Subject: [PATCH 011/390] proselint for mail files (#1037) Add proselint for mail files --- README.md | 1 + ale_linters/mail/proselint.vim | 9 +++++++++ doc/ale.txt | 1 + 3 files changed, 11 insertions(+) create mode 100644 ale_linters/mail/proselint.vim diff --git a/README.md b/README.md index e803b90..16dc22f 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,7 @@ formatting. | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | +| Mail | [proselint](http://proselint.com/) | | Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !! | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | diff --git a/ale_linters/mail/proselint.vim b/ale_linters/mail/proselint.vim new file mode 100644 index 0000000..82c8d1f --- /dev/null +++ b/ale_linters/mail/proselint.vim @@ -0,0 +1,9 @@ +" Author: Daniel M. Capella https://github.com/polyzen +" Description: proselint for mail files + +call ale#linter#Define('mail', { +\ 'name': 'proselint', +\ 'executable': 'proselint', +\ 'command': 'proselint %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index e0e85df..68e71a6 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -266,6 +266,7 @@ Notes: * LaTeX (tex): `chktex`, `lacheck`, `proselint` * LLVM: `llc` * Lua: `luacheck` +* Mail: `proselint` * Markdown: `mdl`, `proselint`, `vale`, `remark-lint` * MATLAB: `mlint` * Nim: `nim check`!! From b401772d23267f16070092d50c944872f74adff0 Mon Sep 17 00:00:00 2001 From: aurieh Date: Wed, 25 Oct 2017 00:39:54 +0300 Subject: [PATCH 012/390] Add Vader tests --- test/handler/test_checkmake_handler.vader | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 test/handler/test_checkmake_handler.vader diff --git a/test/handler/test_checkmake_handler.vader b/test/handler/test_checkmake_handler.vader new file mode 100644 index 0000000..61fe141 --- /dev/null +++ b/test/handler/test_checkmake_handler.vader @@ -0,0 +1,19 @@ +Execute(Parsing checkmake errors should work): + runtime ale_linters/make/checkmake.vim + silent file Makefile + + AssertEqual + \ [ + \ { + \ 'bufnr': 42, + \ 'lnum': 1, + \ 'type': 'E', + \ 'text': 'woops: an error has occurred', + \ } + \ ], + \ ale_linters#make#checkmake#Handle(42, [ + \ 'This shouldnt match', + \ '1:woops:an error has occurred', + \ ]) +After: + call ale#linter#Reset() From d644dc797f74e446c3301292107ffaf6ed9a6121 Mon Sep 17 00:00:00 2001 From: Su Shangjun Date: Tue, 24 Oct 2017 08:11:56 -0500 Subject: [PATCH 013/390] example for 'rcfile' on ale_python_pylint_options Two hyphens instead of one will enable the option `rcfile`. --- doc/ale-python.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-python.txt b/doc/ale-python.txt index a8d033e..755094a 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -174,7 +174,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options* Python 3, you may want to set > let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2 - let g:ale_python_pylint_options = '-rcfile /path/to/pylint.rc' + let g:ale_python_pylint_options = '--rcfile /path/to/pylint.rc' " The virtualenv detection needs to be disabled. let g:ale_python_pylint_use_global = 0 From db769fb060cd08bb1fd2135e77f21300ab4d445b Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Mon, 25 Sep 2017 22:47:46 -0600 Subject: [PATCH 014/390] #995 add vale linter for mail files --- ale_linters/mail/vale.vim | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 ale_linters/mail/vale.vim diff --git a/ale_linters/mail/vale.vim b/ale_linters/mail/vale.vim new file mode 100644 index 0000000..9b30bf6 --- /dev/null +++ b/ale_linters/mail/vale.vim @@ -0,0 +1,9 @@ +" Author: chew-z https://github.com/chew-z +" Description: vale for Markdown files + +call ale#linter#Define('mail', { +\ 'name': 'vale', +\ 'executable': 'vale', +\ 'command': 'vale --output=line %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\}) From 780844ad73d2181db81371c360185a1e0ba0cc70 Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Tue, 24 Oct 2017 17:14:42 -0600 Subject: [PATCH 015/390] #955 add documentation --- README.md | 2 +- doc/ale.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8817046..3f62fae 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ formatting. | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | -| Mail | [proselint](http://proselint.com/) | +| Mail | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | | Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !! | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | diff --git a/doc/ale.txt b/doc/ale.txt index 42f48b2..4bd8550 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -266,7 +266,7 @@ Notes: * LaTeX (tex): `chktex`, `lacheck`, `proselint` * LLVM: `llc` * Lua: `luacheck` -* Mail: `proselint` +* Mail: `proselint`, `vale` * Make: `checkmake` * Markdown: `mdl`, `proselint`, `vale`, `remark-lint` * MATLAB: `mlint` From 7ac07a30b8c54dd44da403830d4ed84992d18656 Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Wed, 25 Oct 2017 00:27:40 +0100 Subject: [PATCH 016/390] Fix #643 - Add support for write-good for many languages --- README.md | 24 +++--- ale_linters/asciidoc/write-good.vim | 9 +++ ale_linters/help/write-good.vim | 9 +++ ale_linters/html/write-good.vim | 9 +++ ale_linters/markdown/write-good.vim | 9 +++ ale_linters/nroff/write-good.vim | 9 +++ ale_linters/pod/write-good.vim | 9 +++ ale_linters/rst/write-good.vim | 9 +++ ale_linters/tex/write-good.vim | 9 +++ ale_linters/texinfo/write-good.vim | 9 +++ ale_linters/text/write-good.vim | 9 +++ ale_linters/xhtml/write-good.vim | 9 +++ autoload/ale/handlers/writegood.vim | 50 +++++++++++++ doc/ale-asciidoc.txt | 12 +++ doc/ale-html.txt | 6 ++ doc/ale-latex.txt | 12 +++ doc/ale-markdown.txt | 12 +++ doc/ale-nroff.txt | 12 +++ doc/ale-pod.txt | 12 +++ doc/ale-restructuredtext.txt | 12 +++ doc/ale-texinfo.txt | 12 +++ doc/ale-text.txt | 12 +++ doc/ale-vim-help.txt | 12 +++ doc/ale-xhtml.txt | 12 +++ doc/ale.txt | 74 ++++++++++++++++--- .../test_write_good_command_callback.vader | 65 ++++++++++++++++ .../node_modules/write-good/bin/write-good.js | 0 .../node_modules/.bin/write-good | 0 test/handler/test_write_good_handler.vader | 21 ++++++ test/script/check-toc | 2 +- 30 files changed, 437 insertions(+), 24 deletions(-) create mode 100644 ale_linters/asciidoc/write-good.vim create mode 100644 ale_linters/help/write-good.vim create mode 100644 ale_linters/html/write-good.vim create mode 100644 ale_linters/markdown/write-good.vim create mode 100644 ale_linters/nroff/write-good.vim create mode 100644 ale_linters/pod/write-good.vim create mode 100644 ale_linters/rst/write-good.vim create mode 100644 ale_linters/tex/write-good.vim create mode 100644 ale_linters/texinfo/write-good.vim create mode 100644 ale_linters/text/write-good.vim create mode 100644 ale_linters/xhtml/write-good.vim create mode 100644 autoload/ale/handlers/writegood.vim create mode 100644 doc/ale-asciidoc.txt create mode 100644 doc/ale-latex.txt create mode 100644 doc/ale-markdown.txt create mode 100644 doc/ale-nroff.txt create mode 100644 doc/ale-pod.txt create mode 100644 doc/ale-restructuredtext.txt create mode 100644 doc/ale-texinfo.txt create mode 100644 doc/ale-text.txt create mode 100644 doc/ale-vim-help.txt create mode 100644 doc/ale-xhtml.txt create mode 100644 test/command_callback/test_write_good_command_callback.vader create mode 100644 test/command_callback/write-good-node-modules-2/node_modules/write-good/bin/write-good.js create mode 100644 test/command_callback/write-good-node-modules/node_modules/.bin/write-good create mode 100644 test/handler/test_write_good_handler.vader diff --git a/README.md b/README.md index 8817046..b49afe4 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ formatting. | -------- | ----- | | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | -| AsciiDoc | [proselint](http://proselint.com/) | +| AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/) | @@ -100,34 +100,34 @@ formatting. | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | | Haskell | [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | -| HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/) | +| HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | | JavaScript | [eslint](http://eslint.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [flow](https://flowtype.org/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | -| LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/) | +| LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [proselint](http://proselint.com/) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !! | +| Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | -| nroff | [proselint](http://proselint.com/)| +| nroff | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Objective-C | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | -| Pod | [proselint](http://proselint.com/)| +| Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions | -| reStructuredText | [proselint](http://proselint.com/) | +| reStructuredText | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | | Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | @@ -141,15 +141,15 @@ formatting. | SQL | [sqlint](https://github.com/purcell/sqlint) | | Swift | [swiftlint](https://github.com/realm/SwiftLint), [swiftformat](https://github.com/nicklockwood/SwiftFormat) | | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | -| Texinfo | [proselint](http://proselint.com/)| -| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | +| Texinfo | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Thrift | [thrift](http://thrift.apache.org/) | | TypeScript | [eslint](http://eslint.org/), [tslint](https://github.com/palantir/tslint), tsserver, typecheck, [prettier](https://github.com/prettier/prettier) | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | | Vim | [vint](https://github.com/Kuniwak/vint) | -| Vim help^ | [proselint](http://proselint.com/)| -| XHTML | [proselint](http://proselint.com/)| -| XML | [xmllint](http://xmlsoft.org/xmllint.html)| +| Vim help^ | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| XHTML | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| XML | [xmllint](http://xmlsoft.org/xmllint.html) | | YAML | [swaglint](https://github.com/byCedric/swaglint), [yamllint](https://yamllint.readthedocs.io/) | diff --git a/ale_linters/asciidoc/write-good.vim b/ale_linters/asciidoc/write-good.vim new file mode 100644 index 0000000..c986cc6 --- /dev/null +++ b/ale_linters/asciidoc/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for AsciiDoc files + +call ale#linter#Define('asciidoc', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/help/write-good.vim b/ale_linters/help/write-good.vim new file mode 100644 index 0000000..11254cd --- /dev/null +++ b/ale_linters/help/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for vim Help files + +call ale#linter#Define('help', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/html/write-good.vim b/ale_linters/html/write-good.vim new file mode 100644 index 0000000..9fae882 --- /dev/null +++ b/ale_linters/html/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for nroff files + +call ale#linter#Define('html', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/markdown/write-good.vim b/ale_linters/markdown/write-good.vim new file mode 100644 index 0000000..21dbff1 --- /dev/null +++ b/ale_linters/markdown/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for Markdown files + +call ale#linter#Define('markdown', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/nroff/write-good.vim b/ale_linters/nroff/write-good.vim new file mode 100644 index 0000000..d318fb2 --- /dev/null +++ b/ale_linters/nroff/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for nroff files + +call ale#linter#Define('nroff', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/pod/write-good.vim b/ale_linters/pod/write-good.vim new file mode 100644 index 0000000..14ed5c0 --- /dev/null +++ b/ale_linters/pod/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for Pod files + +call ale#linter#Define('pod', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/rst/write-good.vim b/ale_linters/rst/write-good.vim new file mode 100644 index 0000000..12137db --- /dev/null +++ b/ale_linters/rst/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for reStructuredText files + +call ale#linter#Define('rst', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/tex/write-good.vim b/ale_linters/tex/write-good.vim new file mode 100644 index 0000000..dc59de2 --- /dev/null +++ b/ale_linters/tex/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for TeX files + +call ale#linter#Define('tex', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/texinfo/write-good.vim b/ale_linters/texinfo/write-good.vim new file mode 100644 index 0000000..8104c63 --- /dev/null +++ b/ale_linters/texinfo/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for Texinfo files + +call ale#linter#Define('texinfo', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/text/write-good.vim b/ale_linters/text/write-good.vim new file mode 100644 index 0000000..ff76ce4 --- /dev/null +++ b/ale_linters/text/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for text files + +call ale#linter#Define('text', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/ale_linters/xhtml/write-good.vim b/ale_linters/xhtml/write-good.vim new file mode 100644 index 0000000..83d1863 --- /dev/null +++ b/ale_linters/xhtml/write-good.vim @@ -0,0 +1,9 @@ +" Author: Sumner Evans +" Description: write-good for XHTML files + +call ale#linter#Define('xhtml', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/autoload/ale/handlers/writegood.vim b/autoload/ale/handlers/writegood.vim new file mode 100644 index 0000000..c26eb20 --- /dev/null +++ b/autoload/ale/handlers/writegood.vim @@ -0,0 +1,50 @@ +" Author: Sumner Evans +" Description: Error handling for errors in the write-good format. + +function! ale#handlers#writegood#ResetOptions() abort + call ale#Set('writegood_options', '') + call ale#Set('writegood_executable', 'write-good') + call ale#Set('writegood_use_global', 0) +endfunction + +" Reset the options so the tests can test how they are set. +call ale#handlers#writegood#ResetOptions() + +function! ale#handlers#writegood#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'writegood', [ + \ 'node_modules/.bin/write-good', + \ 'node_modules/write-good/bin/write-good.js', + \]) +endfunction + +function! ale#handlers#writegood#GetCommand(buffer) abort + let l:executable = ale#handlers#writegood#GetExecutable(a:buffer) + let l:options = ale#Var(a:buffer, 'writegood_options') + + return ale#node#Executable(a:buffer, l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' %t' +endfunction + +function! ale#handlers#writegood#Handle(buffer, lines) abort + " Look for lines like the following. + " + " "it is" is wordy or unneeded on line 20 at column 53 + " "easily" can weaken meaning on line 154 at column 29 + let l:pattern = '\v^(".*"\s.*)\son\sline\s(\d+)\sat\scolumn\s(\d+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + " Add the linter error. Note that we need to add 1 to the col because + " write-good reports the column corresponding to the space before the + " offending word or phrase. + call add(l:output, { + \ 'text': l:match[1], + \ 'lnum': l:match[2] + 0, + \ 'col': l:match[3] + 1, + \ 'type': 'W', + \}) + endfor + + return l:output +endfunction diff --git a/doc/ale-asciidoc.txt b/doc/ale-asciidoc.txt new file mode 100644 index 0000000..b6b64fd --- /dev/null +++ b/doc/ale-asciidoc.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE AsciiDoc Integration *ale-asciidoc-options* + + +=============================================================================== +write-good *ale-asciidoc-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-html.txt b/doc/ale-html.txt index e6f3398..14e705e 100644 --- a/doc/ale-html.txt +++ b/doc/ale-html.txt @@ -56,5 +56,11 @@ g:ale_html_tidy_options *g:ale_html_tidy_options* (mac), sjis (shiftjis), utf-16le, utf-16, utf-8 +=============================================================================== +write-good *ale-html-write-good* + +See |ale-write-good-options| + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-latex.txt b/doc/ale-latex.txt new file mode 100644 index 0000000..87fbd4e --- /dev/null +++ b/doc/ale-latex.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE LaTeX Integration *ale-latex-options* + + +=============================================================================== +write-good *ale-latex-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt new file mode 100644 index 0000000..3ce9619 --- /dev/null +++ b/doc/ale-markdown.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Markdown Integration *ale-markdown-options* + + +=============================================================================== +write-good *ale-markdown-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-nroff.txt b/doc/ale-nroff.txt new file mode 100644 index 0000000..62ec789 --- /dev/null +++ b/doc/ale-nroff.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE nroff Integration *ale-nroff-options* + + +=============================================================================== +write-good *ale-nroff-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-pod.txt b/doc/ale-pod.txt new file mode 100644 index 0000000..c7cc0bb --- /dev/null +++ b/doc/ale-pod.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Pod Integration *ale-pod-options* + + +=============================================================================== +write-good *ale-pod-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-restructuredtext.txt b/doc/ale-restructuredtext.txt new file mode 100644 index 0000000..02fbc4a --- /dev/null +++ b/doc/ale-restructuredtext.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE reStructuredText Integration *ale-restructuredtext-options* + + +=============================================================================== +write-good *ale-restructuredtext-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-texinfo.txt b/doc/ale-texinfo.txt new file mode 100644 index 0000000..f8ed342 --- /dev/null +++ b/doc/ale-texinfo.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Texinfo Integration *ale-texinfo-options* + + +=============================================================================== +write-good *ale-texinfo-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-text.txt b/doc/ale-text.txt new file mode 100644 index 0000000..a4dfa5e --- /dev/null +++ b/doc/ale-text.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Text Integration *ale-text-options* + + +=============================================================================== +write-good *ale-text-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-vim-help.txt b/doc/ale-vim-help.txt new file mode 100644 index 0000000..3cbe20d --- /dev/null +++ b/doc/ale-vim-help.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Vim help Integration *ale-vim-help-options* + + +=============================================================================== +write-good *ale-vim-help-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-xhtml.txt b/doc/ale-xhtml.txt new file mode 100644 index 0000000..3cc639e --- /dev/null +++ b/doc/ale-xhtml.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE XHTML Integration *ale-xhtml-options* + + +=============================================================================== +write-good *ale-xhtml-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 42f48b2..cac1397 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -13,7 +13,10 @@ CONTENTS *ale-contents* 5. Completion...........................|ale-completion| 6. Global Options.......................|ale-options| 6.1 Highlights........................|ale-highlights| + 6.2 Options for write-good Linter.....|ale-write-good-options| 7. Integration Documentation............|ale-integrations| + asciidoc..............................|ale-asciidoc-options| + write-good..........................|ale-asciidoc-write-good| asm...................................|ale-asm-options| gcc.................................|ale-asm-gcc| awk...................................|ale-awk-options| @@ -77,6 +80,7 @@ CONTENTS *ale-contents* html..................................|ale-html-options| htmlhint............................|ale-html-htmlhint| tidy................................|ale-html-tidy| + write-good..........................|ale-html-write-good| idris.................................|ale-idris-options| idris...............................|ale-idris-idris| java..................................|ale-java-options| @@ -98,12 +102,18 @@ CONTENTS *ale-contents* kotlin................................|ale-kotlin-options| kotlinc.............................|ale-kotlin-kotlinc| ktlint..............................|ale-kotlin-ktlint| + latex.................................|ale-latex-options| + write-good..........................|ale-latex-write-good| less..................................|ale-less-options| prettier............................|ale-less-prettier| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| lua...................................|ale-lua-options| luacheck............................|ale-lua-luacheck| + markdown..............................|ale-markdown-options| + write-good..........................|ale-markdown-write-good| + nroff.................................|ale-nroff-options| + write-good..........................|ale-nroff-write-good| objc..................................|ale-objc-options| clang...............................|ale-objc-clang| objcpp................................|ale-objcpp-options| @@ -121,6 +131,8 @@ CONTENTS *ale-contents* phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| + pod...................................|ale-pod-options| + write-good..........................|ale-pod-write-good| pug...................................|ale-pug-options| puglint.............................|ale-pug-puglint| puppet................................|ale-puppet-options| @@ -137,6 +149,8 @@ CONTENTS *ale-contents* lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| + restructuredtext......................|ale-restructuredtext-options| + write-good..........................|ale-restructuredtext-write-good| ruby..................................|ale-ruby-options| brakeman............................|ale-ruby-brakeman| rails_best_practices................|ale-ruby-rails_best_practices| @@ -170,6 +184,10 @@ CONTENTS *ale-contents* tex...................................|ale-tex-options| chktex..............................|ale-tex-chktex| lacheck.............................|ale-tex-lacheck| + texinfo...............................|ale-texinfo-options| + write-good..........................|ale-texinfo-write-good| + text..................................|ale-text-options| + write-good..........................|ale-text-write-good| thrift................................|ale-thrift-options| thrift..............................|ale-thrift-thrift| typescript............................|ale-typescript-options| @@ -182,6 +200,10 @@ CONTENTS *ale-contents* verilator...........................|ale-verilog-verilator| vim...................................|ale-vim-options| vint................................|ale-vim-vint| + vim help..............................|ale-vim-help-options| + write-good..........................|ale-vim-help-write-good| + xhtml.................................|ale-xhtml-options| + write-good..........................|ale-xhtml-write-good| xml...................................|ale-xml-options| xmllint.............................|ale-xml-xmllint| yaml..................................|ale-yaml-options| @@ -228,7 +250,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` -* AsciiDoc: `proselint` +* AsciiDoc: `proselint`, `write-good` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck` * Bourne Shell: `shell` (-n flag), `shellcheck` @@ -257,34 +279,34 @@ Notes: * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` -* HTML: `HTMLHint`, `proselint`, `tidy` +* HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` * JavaScript: `eslint`, `jscs`, `jshint`, `flow`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `chktex`, `lacheck`, `proselint` +* LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` * LLVM: `llc` * Lua: `luacheck` * Mail: `proselint` * Make: `checkmake` -* Markdown: `mdl`, `proselint`, `vale`, `remark-lint` +* Markdown: `mdl`, `proselint`, `vale`, `remark-lint`, `write-good` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` -* nroff: `proselint` +* nroff: `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|) * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` -* Pod: `proselint` +* Pod: `proselint`, `write-good` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin` -* reStructuredText: `proselint` +* reStructuredText: `proselint`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` @@ -298,14 +320,14 @@ Notes: * SQL: `sqlint` * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! -* Texinfo: `proselint` -* Text^: `proselint`, `vale` +* Texinfo: `proselint`, `write-good` +* Text^: `proselint`, `vale`, `write-good` * Thrift: `thrift` * TypeScript: `eslint`, `tslint`, `tsserver`, `typecheck`, `prettier` * Verilog: `iverilog`, `verilator` * Vim: `vint` -* Vim help^: `proselint` -* XHTML: `proselint` +* Vim help^: `proselint`, `write-good` +* XHTML: `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` @@ -1283,6 +1305,36 @@ ALEWarningSign *ALEWarningSign* The highlight used for warning signs. See |g:ale_set_signs|. +------------------------------------------------------------------------------- +6.2. 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. + +g:ale_writegood_executable *g:ale_writegood_executable* + *b:ale_writegood_executable* + Type: |String| + Default: `'writegood'` + + See |ale-integrations-local-executables| + + +g:ale_writegood_options *g:ale_writegood_options* + *b:ale_writegood_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to writegood. + + +g:ale_writegood_use_global *g:ale_writegood_use_global* + *b:ale_writegood_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== 7. Integration Documentation *ale-integrations* diff --git a/test/command_callback/test_write_good_command_callback.vader b/test/command_callback/test_write_good_command_callback.vader new file mode 100644 index 0000000..86e6f50 --- /dev/null +++ b/test/command_callback/test_write_good_command_callback.vader @@ -0,0 +1,65 @@ +Before: + Save g:ale_writegood_options + Save g:ale_writegood_executable + Save g:ale_writegood_use_global + + unlet! g:ale_writegood_options + unlet! g:ale_writegood_executable + unlet! g:ale_writegood_use_global + + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('testfile.txt') + + call ale#handlers#writegood#ResetOptions() + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The global executable should be used when the local one cannot be found): + AssertEqual 'write-good', ale#handlers#writegood#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('write-good') . ' %t', + \ ale#handlers#writegood#GetCommand(bufnr('')) + +Execute(The options should be used in the command): + let g:ale_writegood_options = '--foo --bar' + + AssertEqual + \ ale#Escape('write-good') . ' --foo --bar %t', + \ ale#handlers#writegood#GetCommand(bufnr('')) + +Execute(Should use the node_modules/.bin executable, if available): + call ale#test#SetFilename('write-good-node-modules/test.txt') + + AssertEqual + \ ale#path#Winify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good'), + \ ale#handlers#writegood#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape(ale#path#Winify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good')) + \ . ' %t', + \ ale#handlers#writegood#GetCommand(bufnr('')) + +Execute(Should use the node_modules/write-good executable, if available): + call ale#test#SetFilename('write-good-node-modules-2/test.txt') + + AssertEqual + \ ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js'), + \ ale#handlers#writegood#GetExecutable(bufnr('')) + AssertEqual + \ (has('win32') ? 'node' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js')) + \ . ' %t', + \ ale#handlers#writegood#GetCommand(bufnr('')) + +Execute(Should let users configure a global executable and override local paths): + call ale#test#SetFilename('write-good-node-modules-2/test.txt') + + let g:ale_writegood_executable = 'foo-bar' + let g:ale_writegood_use_global = 1 + + AssertEqual 'foo-bar', ale#handlers#writegood#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('foo-bar') . ' %t', + \ ale#handlers#writegood#GetCommand(bufnr('')) diff --git a/test/command_callback/write-good-node-modules-2/node_modules/write-good/bin/write-good.js b/test/command_callback/write-good-node-modules-2/node_modules/write-good/bin/write-good.js new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/write-good-node-modules/node_modules/.bin/write-good b/test/command_callback/write-good-node-modules/node_modules/.bin/write-good new file mode 100644 index 0000000..e69de29 diff --git a/test/handler/test_write_good_handler.vader b/test/handler/test_write_good_handler.vader new file mode 100644 index 0000000..b3eeb1b --- /dev/null +++ b/test/handler/test_write_good_handler.vader @@ -0,0 +1,21 @@ +Execute(The write-good handler should handle the example from the write-good README): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 1, + \ 'type': 'W', + \ 'text': '"So" adds no meaning', + \ } + \ ], + \ ale#handlers#writegood#Handle(bufnr(''), [ + \ 'In /tmp/vBYivbZ/6/test.md', + \ '=============', + \ 'So the cat was stolen.', + \ '^^', + \ '"So" adds no meaning on line 1 at column 0', + \ '-------------', + \ 'So the cat was stolen.', + \ ' ^^^^^^^^^^', + \ '"was stolen" may be passive voice on line 1 at column 11 ', + \ ]) diff --git a/test/script/check-toc b/test/script/check-toc index 426d5a1..cc2d2b9 100755 --- a/test/script/check-toc +++ b/test/script/check-toc @@ -30,7 +30,7 @@ sed -n "$toc_start_line,$toc_end_line"p doc/ale.txt \ doc_files="$(/bin/ls -1v doc | grep ^ale- | sed 's/^/doc\//' | paste -sd ' ' -)" # shellcheck disable=SC2086 -grep -h 'ale-.*-options\|^[a-z].*\*ale-.*\*$' $doc_files \ +grep -h '\*ale-.*-options\|^[a-z].*\*ale-.*\*$' $doc_files \ | sed 's/^/ /' \ | sed 's/ALE Shell Integration/ALE sh Integration/' \ | sed 's/ ALE \(.*\) Integration/\1/' \ From eec529ad9d703aae12cba6f6423d04c08ae26d0d Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 00:39:23 +0100 Subject: [PATCH 017/390] Fix the write-good tests on Windows --- test/command_callback/test_write_good_command_callback.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/command_callback/test_write_good_command_callback.vader b/test/command_callback/test_write_good_command_callback.vader index 86e6f50..d9f0049 100644 --- a/test/command_callback/test_write_good_command_callback.vader +++ b/test/command_callback/test_write_good_command_callback.vader @@ -48,7 +48,7 @@ Execute(Should use the node_modules/write-good executable, if available): \ ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js'), \ ale#handlers#writegood#GetExecutable(bufnr('')) AssertEqual - \ (has('win32') ? 'node' : '') + \ (has('win32') ? 'node.exe ' : '') \ . ale#Escape(ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js')) \ . ' %t', \ ale#handlers#writegood#GetCommand(bufnr('')) From 5029078df3d5d26d71d220d273a001a5aea9c416 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 00:58:10 +0100 Subject: [PATCH 018/390] Set better highlights for write-good --- autoload/ale/handlers/writegood.vim | 31 +++++++++++++++------- test/handler/test_write_good_handler.vader | 20 ++++++++++++-- 2 files changed, 39 insertions(+), 12 deletions(-) diff --git a/autoload/ale/handlers/writegood.vim b/autoload/ale/handlers/writegood.vim index c26eb20..f9d452e 100644 --- a/autoload/ale/handlers/writegood.vim +++ b/autoload/ale/handlers/writegood.vim @@ -31,19 +31,30 @@ function! ale#handlers#writegood#Handle(buffer, lines) abort " " "it is" is wordy or unneeded on line 20 at column 53 " "easily" can weaken meaning on line 154 at column 29 + let l:marks_pattern = '\v^ *(\^+) *$' let l:pattern = '\v^(".*"\s.*)\son\sline\s(\d+)\sat\scolumn\s(\d+)$' let l:output = [] + let l:last_len = 0 - for l:match in ale#util#GetMatches(a:lines, l:pattern) - " Add the linter error. Note that we need to add 1 to the col because - " write-good reports the column corresponding to the space before the - " offending word or phrase. - call add(l:output, { - \ 'text': l:match[1], - \ 'lnum': l:match[2] + 0, - \ 'col': l:match[3] + 1, - \ 'type': 'W', - \}) + for l:match in ale#util#GetMatches(a:lines, [l:marks_pattern, l:pattern]) + if empty(l:match[2]) + let l:last_len = len(l:match[1]) + else + let l:col = l:match[3] + 1 + + " Add the linter error. Note that we need to add 1 to the col because + " write-good reports the column corresponding to the space before the + " offending word or phrase. + call add(l:output, { + \ 'text': l:match[1], + \ 'lnum': l:match[2] + 0, + \ 'col': l:col, + \ 'end_col': l:last_len ? (l:col + l:last_len - 1) : l:col, + \ 'type': 'W', + \}) + + let l:last_len = 0 + endif endfor return l:output diff --git a/test/handler/test_write_good_handler.vader b/test/handler/test_write_good_handler.vader index b3eeb1b..8bf4b22 100644 --- a/test/handler/test_write_good_handler.vader +++ b/test/handler/test_write_good_handler.vader @@ -4,9 +4,24 @@ Execute(The write-good handler should handle the example from the write-good REA \ { \ 'lnum': 1, \ 'col': 1, + \ 'end_col': 2, \ 'type': 'W', \ 'text': '"So" adds no meaning', - \ } + \ }, + \ { + \ 'lnum': 1, + \ 'col': 12, + \ 'end_col': 21, + \ 'type': 'W', + \ 'text': '"was stolen" may be passive voice', + \ }, + \ { + \ 'lnum': 6, + \ 'col': 2, + \ 'end_col': 2, + \ 'type': 'W', + \ 'text': '"foo bar" bla', + \ }, \ ], \ ale#handlers#writegood#Handle(bufnr(''), [ \ 'In /tmp/vBYivbZ/6/test.md', @@ -17,5 +32,6 @@ Execute(The write-good handler should handle the example from the write-good REA \ '-------------', \ 'So the cat was stolen.', \ ' ^^^^^^^^^^', - \ '"was stolen" may be passive voice on line 1 at column 11 ', + \ '"was stolen" may be passive voice on line 1 at column 11', + \ '"foo bar" bla on line 6 at column 1', \ ]) From 680672117f3c89886fd49e01a5b454c14ae477d8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 01:05:48 +0100 Subject: [PATCH 019/390] Make the highlight placement test pass more often by using another shell --- test/test_highlight_placement.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/test_highlight_placement.vader b/test/test_highlight_placement.vader index de8decc..2d87b77 100644 --- a/test/test_highlight_placement.vader +++ b/test/test_highlight_placement.vader @@ -37,7 +37,7 @@ Before: call ale#linter#Define('testft', { \ 'name': 'x', \ 'executable': has('win32') ? 'cmd': 'echo', - \ 'command': 'echo', + \ 'command': has('win32') ? 'echo' : '/bin/sh -c ''echo''', \ 'callback': 'GenerateResults', \}) highlight link SomeOtherGroup SpellBad From 960ae62aaa30d26fcfff57d6593e54a34a93ec68 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 01:11:46 +0100 Subject: [PATCH 020/390] Make the sign placement test pass more often by using another shell --- test/sign/test_linting_sets_signs.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/sign/test_linting_sets_signs.vader b/test/sign/test_linting_sets_signs.vader index c2cc0db..f9bd63b 100644 --- a/test/sign/test_linting_sets_signs.vader +++ b/test/sign/test_linting_sets_signs.vader @@ -34,7 +34,7 @@ Before: \ 'name': 'testlinter', \ 'callback': 'TestCallback', \ 'executable': has('win32') ? 'cmd' : 'echo', - \ 'command': 'echo foo bar', + \ 'command': has('win32') ? 'echo foo bar' : '/bin/sh -c ''echo foo bar''', \}) From 45ed37a5d91c99c9a43093aba2ae738d4524ccdf Mon Sep 17 00:00:00 2001 From: Frank Schumacher Date: Wed, 25 Oct 2017 20:46:16 +0200 Subject: [PATCH 021/390] auto-detect .rubocop.yml and .haml-lint.yml Based on path to current file --- ale_linters/haml/hamllint.vim | 29 +++++++- .../test_haml_hamllint_command_callback.vader | 72 +++++++++++++++++++ .../haml-lint-and-rubocop/subdir/file.haml | 0 .../haml-lint-yml/subdir/file.haml | 0 .../rubocop-yml/subdir/file.haml | 0 5 files changed, 99 insertions(+), 2 deletions(-) create mode 100644 test/command_callback/test_haml_hamllint_command_callback.vader create mode 100644 test/hamllint-test-files/haml-lint-and-rubocop/subdir/file.haml create mode 100644 test/hamllint-test-files/haml-lint-yml/subdir/file.haml create mode 100644 test/hamllint-test-files/rubocop-yml/subdir/file.haml diff --git a/ale_linters/haml/hamllint.vim b/ale_linters/haml/hamllint.vim index b1a6aa5..e56da09 100644 --- a/ale_linters/haml/hamllint.vim +++ b/ale_linters/haml/hamllint.vim @@ -1,6 +1,31 @@ -" Author: Patrick Lewis - https://github.com/patricklewis +" Author: Patrick Lewis - https://github.com/patricklewis, thenoseman - https://github.com/thenoseman " Description: haml-lint for Haml files +function! ale_linters#haml#hamllint#GetCommand(buffer) abort + let l:prefix = '' + + let l:rubocop_config_file_path = ale#path#FindNearestFile(a:buffer, '.rubocop.yml') + let l:hamllint_config_file_path = ale#path#FindNearestFile(a:buffer, '.haml-lint.yml') + + " Set HAML_LINT_RUBOCOP_CONF variable as it is needed for haml-lint to + " pick up the rubocop config. + " + " See https://github.com/brigade/haml-lint/blob/master/lib/haml_lint/linter/rubocop.rb#L89 + " HamlLint::Linter::RuboCop#rubocop_flags + if !empty(l:rubocop_config_file_path) + if ale#Has('win32') + let l:prefix = 'set HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) . ' &&' + else + let l:prefix = 'HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) + endif + endif + + return (!empty(l:prefix) ? l:prefix . ' ' : '') + \ . 'haml-lint' + \ . (!empty(l:hamllint_config_file_path) ? ' --config ' . ale#Escape(l:hamllint_config_file_path) : '') + \ . ' %t' +endfunction + function! ale_linters#haml#hamllint#Handle(buffer, lines) abort " Matches patterns like the following: " :51 [W] RuboCop: Use the new Ruby 1.9 hash syntax. @@ -21,6 +46,6 @@ endfunction call ale#linter#Define('haml', { \ 'name': 'hamllint', \ 'executable': 'haml-lint', -\ 'command': 'haml-lint %t', +\ 'command_callback': 'ale_linters#haml#hamllint#GetCommand', \ 'callback': 'ale_linters#haml#hamllint#Handle' \}) diff --git a/test/command_callback/test_haml_hamllint_command_callback.vader b/test/command_callback/test_haml_hamllint_command_callback.vader new file mode 100644 index 0000000..68aa1e6 --- /dev/null +++ b/test/command_callback/test_haml_hamllint_command_callback.vader @@ -0,0 +1,72 @@ +Before: + runtime ale_linters/haml/hamllint.vim + + let g:default_command = 'haml-lint %t' + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + unlet! g:default_command + unlet! b:conf + + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(The default command should be correct): + AssertEqual g:default_command, ale_linters#haml#hamllint#GetCommand(bufnr('')) + +Execute(The command should have the .rubocop.yml prepended as an env var if one exists): + call ale#test#SetFilename('../hamllint-test-files/rubocop-yml/subdir/file.haml') + let b:conf = ale#path#Winify(g:dir . '/../hamllint-test-files/rubocop-yml/.rubocop.yml') + + if has('win32') + " Windows uses 'set var=... && command' + AssertEqual + \ 'set HAML_LINT_RUBOCOP_CONF=' + \ . ale#Escape(b:conf) + \ . ' && ' . g:default_command, + \ ale_linters#haml#hamllint#GetCommand(bufnr('')) + else + " Unix uses 'var=... command' + AssertEqual + \ 'HAML_LINT_RUBOCOP_CONF=' + \ . ale#Escape(b:conf) + \ . ' ' . g:default_command, + \ ale_linters#haml#hamllint#GetCommand(bufnr('')) + endif + +Execute(The command should have the nearest .haml-lint.yml set as --config if it exists): + call ale#test#SetFilename('../hamllint-test-files/haml-lint-yml/subdir/file.haml') + let b:conf = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-yml/.haml-lint.yml') + + AssertEqual + \ 'haml-lint --config ' + \ . ale#Escape(b:conf) + \ . ' %t', + \ ale_linters#haml#hamllint#GetCommand(bufnr('')) + +Execute(The command should include a .rubocop.yml and a .haml-lint if both are found): + call ale#test#SetFilename('../hamllint-test-files/haml-lint-and-rubocop/subdir/file.haml') + let b:conf_hamllint = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml') + let b:conf_rubocop = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml') + + if has('win32') + " Windows uses 'set var=... && command' + AssertEqual + \ 'set HAML_LINT_RUBOCOP_CONF=' + \ . ale#Escape(b:conf_rubocop) + \ . ' && haml-lint --config ' + \ . ale#Escape(b:conf_hamllint) + \ . ' %t', + \ ale_linters#haml#hamllint#GetCommand(bufnr('')) + else + " Unix uses 'var=... command' + AssertEqual + \ 'HAML_LINT_RUBOCOP_CONF=' + \ . ale#Escape(b:conf_rubocop) + \ . ' haml-lint --config ' + \ . ale#Escape(b:conf_hamllint) + \ . ' %t', + \ ale_linters#haml#hamllint#GetCommand(bufnr('')) + endif diff --git a/test/hamllint-test-files/haml-lint-and-rubocop/subdir/file.haml b/test/hamllint-test-files/haml-lint-and-rubocop/subdir/file.haml new file mode 100644 index 0000000..e69de29 diff --git a/test/hamllint-test-files/haml-lint-yml/subdir/file.haml b/test/hamllint-test-files/haml-lint-yml/subdir/file.haml new file mode 100644 index 0000000..e69de29 diff --git a/test/hamllint-test-files/rubocop-yml/subdir/file.haml b/test/hamllint-test-files/rubocop-yml/subdir/file.haml new file mode 100644 index 0000000..e69de29 From b0b91ba897e8633d6e99164384ab84cf62d68a2a Mon Sep 17 00:00:00 2001 From: Frank Schumacher Date: Wed, 25 Oct 2017 21:35:24 +0200 Subject: [PATCH 022/390] force add test fixtures for hamllint --- test/hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml | 0 test/hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml | 0 test/hamllint-test-files/haml-lint-yml/.haml-lint.yml | 0 test/hamllint-test-files/rubocop-yml/.rubocop.yml | 0 4 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 test/hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml create mode 100644 test/hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml create mode 100644 test/hamllint-test-files/haml-lint-yml/.haml-lint.yml create mode 100644 test/hamllint-test-files/rubocop-yml/.rubocop.yml diff --git a/test/hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml b/test/hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml new file mode 100644 index 0000000..e69de29 diff --git a/test/hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml b/test/hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml new file mode 100644 index 0000000..e69de29 diff --git a/test/hamllint-test-files/haml-lint-yml/.haml-lint.yml b/test/hamllint-test-files/haml-lint-yml/.haml-lint.yml new file mode 100644 index 0000000..e69de29 diff --git a/test/hamllint-test-files/rubocop-yml/.rubocop.yml b/test/hamllint-test-files/rubocop-yml/.rubocop.yml new file mode 100644 index 0000000..e69de29 From 25d2af0b2529006ba869a5906afae028f7b9f28e Mon Sep 17 00:00:00 2001 From: Gerry Agbobada <10496163+gagbo@users.noreply.github.com> Date: Wed, 25 Oct 2017 23:29:36 +0200 Subject: [PATCH 023/390] Handle multiple files localtion lists with gcc handler (#1034) Handle multiple files in the GCC handler. --- autoload/ale/handlers/gcc.vim | 76 ++++++++++++------------- test/handler/test_clang_handler.vader | 12 ++-- test/handler/test_gcc_handler.vader | 43 +++++++------- test/handler/test_vint_handler.vader | 6 ++ test/sign/test_linting_sets_signs.vader | 3 +- 5 files changed, 69 insertions(+), 71 deletions(-) diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index ad5cab3..a3f2a30 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -43,6 +43,10 @@ endfunction function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort let l:include_pattern = '\v^(In file included | *)from ([^:]*):(\d+)' + " Include pattern looks for lines like : + " + " In file included from test.h:1:0, + " from test.cpp:1: let l:include_lnum = 0 let l:include_lines = [] let l:included_filename = '' @@ -58,51 +62,42 @@ function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort let l:match = matchlist(l:line, l:pattern) if empty(l:match) - " Check for matches in includes. - " We will keep matching lines until we hit the last file, which - " is our file. let l:include_match = matchlist(l:line, l:include_pattern) - - if empty(l:include_match) - " If this isn't another include header line, then we - " need to collect it. - call add(l:include_lines, l:line) - else - " GCC and clang return the lists of files in different orders, - " so we'll only grab the line number from lines which aren't - " header files. - if !s:IsHeaderFile(l:include_match[2]) - " Get the line number out of the parsed include line, - " and reset the other variables. - let l:include_lnum = str2nr(l:include_match[3]) - endif - - let l:include_lines = [] - let l:included_filename = '' + " If the line has an 'included from' pattern, store the line to + " create a gutter sign at the appropriate location in linted file + if !empty(l:include_match) + " We don't check if l:include_match[2] is linted filename + " because the last line matching include_pattern in a group + " of contiguous lines is probably concerning the linted file + " anyway + let l:include_lnum = l:include_match[3] endif - elseif l:include_lnum > 0 - \&& (empty(l:included_filename) || l:included_filename is# l:match[1]) - " If we hit the first error after an include header, or the - " errors below have the same name as the first filename we see, - " then include these lines, and remember what that filename was. - let l:included_filename = l:match[1] - call add(l:include_lines, l:line) else - " If we hit a regular error again, then add the previously - " collected lines as one error, and reset the include variables. - call s:AddIncludedErrors(l:output, l:include_lnum, l:include_lines) - let l:include_lnum = 0 - let l:include_lines = [] - let l:included_filename = '' - + " Filter out the pragma errors if s:IsHeaderFile(bufname(bufnr(''))) \&& l:match[5][:len(s:pragma_error) - 1] is# s:pragma_error continue endif + " If the 'error type' is a note, make it detail related to + " the previous error parsed in output + if l:match[4] is# 'note' + let l:output[-1]['detail'] = get(l:output[-1], 'detail', '') + \ . s:RemoveUnicodeQuotes(l:match[0]) . "\n" + continue + endif + + " If l:include_lnum is non-null, then the error relates to + " an included file and l:include_lnum is the line number + " where a gutter sign would be needed in linted file + + " The ternary operator in filename filters out the 'dummy' + " filenames like or and leave the location + " handling to engine#FixLocList let l:item = { + \ 'filename': (l:match[1][:0] is# '<') ? '' : l:match[1], \ 'lnum': str2nr(l:match[2]), - \ 'type': l:match[4] =~# 'error' ? 'E' : 'W', + \ 'type': l:match[4] is# 'error' ? 'E' : 'W', \ 'text': s:RemoveUnicodeQuotes(l:match[5]), \} @@ -110,12 +105,17 @@ function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort let l:item.col = str2nr(l:match[3]) endif + " Finish filtering out filename : if the key exists but is empty, + " unlet it. + if get(l:item, 'filename', 'dummy_no_key_to_unlet') is# '' + unlet l:item['filename'] + endif + call add(l:output, l:item) + " Reset include_lnum after an error has been added + let l:include_lnum = 0 endif endfor - " Add remaining include errors after we go beyond the last line. - call s:AddIncludedErrors(l:output, l:include_lnum, l:include_lines) - return l:output endfunction diff --git a/test/handler/test_clang_handler.vader b/test/handler/test_clang_handler.vader index d28b9eb..278737a 100644 --- a/test/handler/test_clang_handler.vader +++ b/test/handler/test_clang_handler.vader @@ -2,15 +2,11 @@ Execute(clang errors from included files should be parsed correctly): AssertEqual \ [ \ { - \ 'lnum': 3, + \ 'lnum': 1, + \ 'col': 1, + \ 'filename': './b.h', \ 'type': 'E', - \ 'text': 'Problems were found in the header (See :ALEDetail)', - \ 'detail': join([ - \ './b.h:1:1: error: expected identifier or ''(''', - \ '{{{', - \ '^', - \ '1 error generated.', - \ ], "\n"), + \ 'text': 'expected identifier or ''(''', \ }, \ ], \ ale#handlers#gcc#HandleGCCFormat(347, [ diff --git a/test/handler/test_gcc_handler.vader b/test/handler/test_gcc_handler.vader index 2f60390..be9e90e 100644 --- a/test/handler/test_gcc_handler.vader +++ b/test/handler/test_gcc_handler.vader @@ -2,14 +2,11 @@ Execute(GCC errors from included files should be parsed correctly): AssertEqual \ [ \ { - \ 'lnum': 3, + \ 'lnum': 1, + \ 'col': 1, + \ 'filename': 'broken.h', \ 'type': 'E', - \ 'text': 'Problems were found in the header (See :ALEDetail)', - \ 'detail': join([ - \ 'broken.h:1:1: error: expected identifier or ''('' before ''{'' token', - \ ' {{{', - \ ' ^', - \ ], "\n"), + \ 'text': 'expected identifier or ''('' before ''{'' token', \ }, \ ], \ ale#handlers#gcc#HandleGCCFormat(347, [ @@ -22,14 +19,11 @@ Execute(GCC errors from included files should be parsed correctly): AssertEqual \ [ \ { - \ 'lnum': 3, + \ 'lnum': 1, + \ 'col': 1, + \ 'filename': 'b.h', \ 'type': 'E', - \ 'text': 'Problems were found in the header (See :ALEDetail)', - \ 'detail': join([ - \ 'b.h:1:1: error: expected identifier or ''('' before ''{'' token', - \ ' {{{', - \ ' ^', - \ ], "\n"), + \ 'text': 'expected identifier or ''('' before ''{'' token', \ }, \ ], \ ale#handlers#gcc#HandleGCCFormat(347, [ @@ -43,17 +37,18 @@ Execute(GCC errors from included files should be parsed correctly): AssertEqual \ [ \ { - \ 'lnum': 3, + \ 'lnum': 1, + \ 'col': 1, + \ 'filename': 'b.h', \ 'type': 'E', - \ 'text': 'Problems were found in the header (See :ALEDetail)', - \ 'detail': join([ - \ 'b.h:1:1: error: unknown type name ‘bad_type’', - \ ' bad_type x;', - \ ' ^', - \ 'b.h:2:1: error: unknown type name ‘other_bad_type’', - \ ' other_bad_type y;', - \ ' ^', - \ ], "\n"), + \ 'text': 'unknown type name ''bad_type''', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'filename': 'b.h', + \ 'type': 'E', + \ 'text': 'unknown type name ''other_bad_type''', \ }, \ ], \ ale#handlers#gcc#HandleGCCFormat(347, [ diff --git a/test/handler/test_vint_handler.vader b/test/handler/test_vint_handler.vader index 8747979..c542b4e 100644 --- a/test/handler/test_vint_handler.vader +++ b/test/handler/test_vint_handler.vader @@ -10,12 +10,14 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 1, \ 'col': 1, + \ 'filename': 'gcc.vim', \ 'text': 'Use scriptencoding when multibyte char exists (see :help :script encoding)', \ 'type': 'W', \ }, \ { \ 'lnum': 3, \ 'col': 17, + \ 'filename': 'gcc.vim', \ 'end_col': 18, \ 'text': 'Use robust operators ''==#'' or ''==?'' instead of ''=='' (see Google VimScript Style Guide (Matching))', \ 'type': 'W', @@ -23,6 +25,7 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 3, \ 'col': 8, + \ 'filename': 'gcc.vim', \ 'end_col': 15, \ 'text': 'Make the scope explicit like ''l:filename'' (see Anti-pattern of vimrc (Scope of identifier))', \ 'type': 'W', @@ -30,6 +33,7 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 7, \ 'col': 8, + \ 'filename': 'gcc.vim', \ 'end_col': 15, \ 'text': 'Undefined variable: filename (see :help E738)', \ 'type': 'W', @@ -37,6 +41,7 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 8, \ 'col': 11, + \ 'filename': 'gcc.vim', \ 'end_col': 16, \ 'text': 'E128: Function name must start with a capital or contain a colon: foobar (see ynkdir/vim-vimlparser)', \ 'type': 'E', @@ -44,6 +49,7 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 9, \ 'col': 12, + \ 'filename': 'gcc.vim', \ 'end_col': 13, \ 'text': 'Use robust operators ''=~#'' or ''=~?'' instead of ''=~'' (see Google VimScript Style Guide (Matching))', \ 'type': 'W', diff --git a/test/sign/test_linting_sets_signs.vader b/test/sign/test_linting_sets_signs.vader index f9bd63b..271540e 100644 --- a/test/sign/test_linting_sets_signs.vader +++ b/test/sign/test_linting_sets_signs.vader @@ -20,7 +20,8 @@ Before: let l:actual_sign_list = [] for l:line in split(l:output, "\n") - let l:match = matchlist(l:line, 'line=\(\d\+\).*name=\(ALE[a-zA-Z]\+\)') + let l:match = matchlist(l:line, '\m\s*line=\(\d\+\).*name=\(ALE[a-zA-Z]\+\)') + if len(l:match) > 0 call add(l:actual_sign_list, [l:match[1], l:match[2]]) From 4af7219078e4aeb2c3a65928609f44cc7d7de1e8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 22:35:21 +0100 Subject: [PATCH 024/390] Make one of the sign tests work in all locales --- test/sign/test_linting_sets_signs.vader | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/test/sign/test_linting_sets_signs.vader b/test/sign/test_linting_sets_signs.vader index 271540e..c23b400 100644 --- a/test/sign/test_linting_sets_signs.vader +++ b/test/sign/test_linting_sets_signs.vader @@ -20,8 +20,7 @@ Before: let l:actual_sign_list = [] for l:line in split(l:output, "\n") - let l:match = matchlist(l:line, '\m\s*line=\(\d\+\).*name=\(ALE[a-zA-Z]\+\)') - + let l:match = matchlist(l:line, '\v^.*\=(\d+).*\=\d+.*\=(ALE[a-zA-Z]+Sign)') if len(l:match) > 0 call add(l:actual_sign_list, [l:match[1], l:match[2]]) From 7eb16836d09f3f847165b1e48fc020ecff2e715e Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 23:07:38 +0100 Subject: [PATCH 025/390] Fix indentation for the haml-lint file --- ale_linters/haml/hamllint.vim | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/ale_linters/haml/hamllint.vim b/ale_linters/haml/hamllint.vim index e56da09..d663359 100644 --- a/ale_linters/haml/hamllint.vim +++ b/ale_linters/haml/hamllint.vim @@ -13,17 +13,17 @@ function! ale_linters#haml#hamllint#GetCommand(buffer) abort " See https://github.com/brigade/haml-lint/blob/master/lib/haml_lint/linter/rubocop.rb#L89 " HamlLint::Linter::RuboCop#rubocop_flags if !empty(l:rubocop_config_file_path) - if ale#Has('win32') - let l:prefix = 'set HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) . ' &&' - else - let l:prefix = 'HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) - endif + if ale#Has('win32') + let l:prefix = 'set HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) . ' &&' + else + let l:prefix = 'HAML_LINT_RUBOCOP_CONF=' . ale#Escape(l:rubocop_config_file_path) + endif endif return (!empty(l:prefix) ? l:prefix . ' ' : '') - \ . 'haml-lint' - \ . (!empty(l:hamllint_config_file_path) ? ' --config ' . ale#Escape(l:hamllint_config_file_path) : '') - \ . ' %t' + \ . 'haml-lint' + \ . (!empty(l:hamllint_config_file_path) ? ' --config ' . ale#Escape(l:hamllint_config_file_path) : '') + \ . ' %t' endfunction function! ale_linters#haml#hamllint#Handle(buffer, lines) abort From da365134b537b00966ba6de1b6184e9fd76e4733 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 25 Oct 2017 23:43:09 +0100 Subject: [PATCH 026/390] Fix an exception with notes with no previous message --- autoload/ale/handlers/gcc.vim | 8 ++++++-- test/handler/test_gcc_handler.vader | 8 ++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index a3f2a30..b7db09e 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -82,8 +82,12 @@ function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort " If the 'error type' is a note, make it detail related to " the previous error parsed in output if l:match[4] is# 'note' - let l:output[-1]['detail'] = get(l:output[-1], 'detail', '') - \ . s:RemoveUnicodeQuotes(l:match[0]) . "\n" + if !empty(l:output) + let l:output[-1]['detail'] = + \ get(l:output[-1], 'detail', '') + \ . s:RemoveUnicodeQuotes(l:match[0]) . "\n" + endif + continue endif diff --git a/test/handler/test_gcc_handler.vader b/test/handler/test_gcc_handler.vader index be9e90e..321dbc6 100644 --- a/test/handler/test_gcc_handler.vader +++ b/test/handler/test_gcc_handler.vader @@ -128,3 +128,11 @@ Execute(The GCC handler should handle syntax errors): \ ':4: error: ''cat'' was not declared in this scope', \ ':12: error: expected `;'' before ''o''', \ ]) + +Execute(The GCC handler should handle notes with no previous message): + AssertEqual + \ [], + \ ale#handlers#gcc#HandleGCCFormat(347, [ + \ ':1:1: note: x', + \ ':1:1: note: x', + \ ]) From 2f5b94e07d3a9a2fbd7ebf26dc15cbe158eb738f Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 00:09:26 +0100 Subject: [PATCH 027/390] Remove redundant code for the GCC handler, and fix bugs with errors for - not being parsed --- autoload/ale/handlers/gcc.vim | 114 +++++++++------------------- test/handler/test_gcc_handler.vader | 23 ++++++ 2 files changed, 58 insertions(+), 79 deletions(-) diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index b7db09e..256cd01 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -5,17 +5,6 @@ scriptencoding utf-8 let s:pragma_error = '#pragma once in main file' -function! s:AddIncludedErrors(output, include_lnum, include_lines) abort - if a:include_lnum > 0 - call add(a:output, { - \ 'lnum': a:include_lnum, - \ 'type': 'E', - \ 'text': 'Problems were found in the header (See :ALEDetail)', - \ 'detail': join(a:include_lines, "\n"), - \}) - endif -endfunction - function! s:IsHeaderFile(filename) abort return a:filename =~? '\v\.(h|hpp)$' endfunction @@ -42,14 +31,6 @@ function! ale#handlers#gcc#ParseGCCVersion(lines) abort endfunction function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort - let l:include_pattern = '\v^(In file included | *)from ([^:]*):(\d+)' - " Include pattern looks for lines like : - " - " In file included from test.h:1:0, - " from test.cpp:1: - let l:include_lnum = 0 - let l:include_lines = [] - let l:included_filename = '' " Look for lines like the following. " " :8:5: warning: conversion lacks type at end of format [-Wformat=] @@ -58,67 +39,42 @@ function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+)$' let l:output = [] - for l:line in a:lines - let l:match = matchlist(l:line, l:pattern) - - if empty(l:match) - let l:include_match = matchlist(l:line, l:include_pattern) - " If the line has an 'included from' pattern, store the line to - " create a gutter sign at the appropriate location in linted file - if !empty(l:include_match) - " We don't check if l:include_match[2] is linted filename - " because the last line matching include_pattern in a group - " of contiguous lines is probably concerning the linted file - " anyway - let l:include_lnum = l:include_match[3] - endif - else - " Filter out the pragma errors - if s:IsHeaderFile(bufname(bufnr(''))) - \&& l:match[5][:len(s:pragma_error) - 1] is# s:pragma_error - continue - endif - - " If the 'error type' is a note, make it detail related to - " the previous error parsed in output - if l:match[4] is# 'note' - if !empty(l:output) - let l:output[-1]['detail'] = - \ get(l:output[-1], 'detail', '') - \ . s:RemoveUnicodeQuotes(l:match[0]) . "\n" - endif - - continue - endif - - " If l:include_lnum is non-null, then the error relates to - " an included file and l:include_lnum is the line number - " where a gutter sign would be needed in linted file - - " The ternary operator in filename filters out the 'dummy' - " filenames like or and leave the location - " handling to engine#FixLocList - let l:item = { - \ 'filename': (l:match[1][:0] is# '<') ? '' : l:match[1], - \ 'lnum': str2nr(l:match[2]), - \ 'type': l:match[4] is# 'error' ? 'E' : 'W', - \ 'text': s:RemoveUnicodeQuotes(l:match[5]), - \} - - if !empty(l:match[3]) - let l:item.col = str2nr(l:match[3]) - endif - - " Finish filtering out filename : if the key exists but is empty, - " unlet it. - if get(l:item, 'filename', 'dummy_no_key_to_unlet') is# '' - unlet l:item['filename'] - endif - - call add(l:output, l:item) - " Reset include_lnum after an error has been added - let l:include_lnum = 0 + for l:match in ale#util#GetMatches(a:lines, l:pattern) + " Filter out the pragma errors + if s:IsHeaderFile(bufname(bufnr(''))) + \&& l:match[5][:len(s:pragma_error) - 1] is# s:pragma_error + continue endif + + " If the 'error type' is a note, make it detail related to + " the previous error parsed in output + if l:match[4] is# 'note' + if !empty(l:output) + let l:output[-1]['detail'] = + \ get(l:output[-1], 'detail', '') + \ . s:RemoveUnicodeQuotes(l:match[0]) . "\n" + endif + + continue + endif + + let l:item = { + \ 'lnum': str2nr(l:match[2]), + \ 'type': l:match[4] is# 'error' ? 'E' : 'W', + \ 'text': s:RemoveUnicodeQuotes(l:match[5]), + \} + + if !empty(l:match[3]) + let l:item.col = str2nr(l:match[3]) + endif + + " If the filename is something like , or -, then + " this is an error for the file we checked. + if l:match[1] isnot# '-' && l:match[1][0] isnot# '<' + let l:item['filename'] = l:match[1] + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_gcc_handler.vader b/test/handler/test_gcc_handler.vader index 321dbc6..9324273 100644 --- a/test/handler/test_gcc_handler.vader +++ b/test/handler/test_gcc_handler.vader @@ -1,3 +1,12 @@ +Execute(The GCC handler should ignore other lines of output): + AssertEqual + \ [], + \ ale#handlers#gcc#HandleGCCFormat(347, [ + \ 'foo', + \ 'bar', + \ 'baz', + \ ]) + Execute(GCC errors from included files should be parsed correctly): AssertEqual \ [ @@ -136,3 +145,17 @@ Execute(The GCC handler should handle notes with no previous message): \ ':1:1: note: x', \ ':1:1: note: x', \ ]) + +Execute(The GCC handler should interpret - as being the current file): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 12, + \ 'type': 'E', + \ 'text': 'Some error', + \ }, + \ ], + \ ale#handlers#gcc#HandleGCCFormat(347, [ + \ '-:6:12: error: Some error', + \ ]) From 5917de565d4e89c73e69727848b7fba3e2730c57 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 00:48:51 +0100 Subject: [PATCH 028/390] Fix #491 - Use -x for shellcheck for checking files with sourced files --- ale_linters/sh/shellcheck.vim | 5 +++-- .../test_shellcheck_command_callback.vader | 22 ++++++++++++++----- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index b47ba19..68844a0 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -43,11 +43,12 @@ function! ale_linters#sh#shellcheck#GetCommand(buffer) abort let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions') let l:dialect = ale_linters#sh#shellcheck#GetDialectArgument(a:buffer) - return ale_linters#sh#shellcheck#GetExecutable(a:buffer) + return ale#path#BufferCdString(a:buffer) + \ . ale#Escape(ale_linters#sh#shellcheck#GetExecutable(a:buffer)) \ . (!empty(l:dialect) ? ' -s ' . l:dialect : '') \ . (!empty(l:options) ? ' ' . l:options : '') \ . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '') - \ . ' -f gcc -' + \ . ' -x -f gcc -' endfunction call ale#linter#Define('sh', { diff --git a/test/command_callback/test_shellcheck_command_callback.vader b/test/command_callback/test_shellcheck_command_callback.vader index 8e22905..13e9a2c 100644 --- a/test/command_callback/test_shellcheck_command_callback.vader +++ b/test/command_callback/test_shellcheck_command_callback.vader @@ -9,6 +9,12 @@ Before: runtime ale_linters/sh/shellcheck.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('test.sh') + + let b:prefix = 'cd ' . ale#Escape(ale#path#Winify(g:dir)) . ' && ' + let b:suffix = ' -x -f gcc -' + After: Restore @@ -16,19 +22,22 @@ After: unlet! b:ale_sh_shellcheck_executable unlet! b:ale_sh_shellcheck_options unlet! b:is_bash + unlet! b:prefix + + call ale#test#RestoreDirectory() call ale#linter#Reset() Execute(The default shellcheck command should be correct): AssertEqual - \ 'shellcheck -f gcc -', + \ b:prefix . ale#Escape('shellcheck') . b:suffix, \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) Execute(The shellcheck command should accept options): let b:ale_sh_shellcheck_options = '--foobar' AssertEqual - \ 'shellcheck --foobar -f gcc -', + \ b:prefix . ale#Escape('shellcheck') . ' --foobar' . b:suffix, \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) Execute(The shellcheck command should accept options and exclusions): @@ -36,14 +45,14 @@ Execute(The shellcheck command should accept options and exclusions): let b:ale_sh_shellcheck_exclusions = 'foo,bar' AssertEqual - \ 'shellcheck --foobar -e foo,bar -f gcc -', + \ b:prefix . ale#Escape('shellcheck') . ' --foobar -e foo,bar' . b:suffix, \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) Execute(The shellcheck command should include the dialect): let b:is_bash = 1 AssertEqual - \ 'shellcheck -s bash -f gcc -', + \ b:prefix . ale#Escape('shellcheck') . ' -s bash' . b:suffix, \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) Execute(The shellcheck command should include the dialect before options and exclusions): @@ -52,5 +61,8 @@ Execute(The shellcheck command should include the dialect before options and exc let b:ale_sh_shellcheck_exclusions = 'foo,bar' AssertEqual - \ 'shellcheck -s bash --foobar -e foo,bar -f gcc -', + \ b:prefix + \ . ale#Escape('shellcheck') + \ . ' -s bash --foobar -e foo,bar' + \ . b:suffix, \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) From 0702cb59b7099bc2f0ea224457d3c0d31bddf8ca Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 10:03:10 +0100 Subject: [PATCH 029/390] Fix #1045 - Handle both output streams for Cargo --- ale_linters/rust/cargo.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index f19061a..c887ea7 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -26,6 +26,6 @@ call ale#linter#Define('rust', { \ 'executable_callback': 'ale_linters#rust#cargo#GetCargoExecutable', \ 'command_callback': 'ale_linters#rust#cargo#GetCommand', \ 'callback': 'ale#handlers#rust#HandleRustErrors', -\ 'output_stream': 'stdout', +\ 'output_stream': 'both', \ 'lint_file': 1, \}) From f15c8f41279b8b8d9e397e55021d31ca983da3b0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 12:26:16 +0100 Subject: [PATCH 030/390] #1049 Do not modify runtimepath if the conflict warnings are disabled --- doc/ale.txt | 5 +++++ plugin/ale.vim | 12 +++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index 4480ce9..1bc639b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -624,6 +624,11 @@ g:ale_emit_conflict_warnings *g:ale_emit_conflict_warnings* When set to `0`, ALE will not emit any warnings on startup about conflicting plugins. ALE will probably not work if other linting plugins are installed. + When this option is set to `1`, ALE will add its `after` directory to + |runtimepath| automatically, so the checks can be applied. Setting this + option to `0` before ALE is loaded will prevent ALE from modifying + |runtimepath|. + g:ale_enabled *g:ale_enabled* *b:ale_enabled* diff --git a/plugin/ale.vim b/plugin/ale.vim index a0d9b27..52b3059 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -32,8 +32,13 @@ if !s:has_features finish endif -" Add the after directory to the runtimepath -let &runtimepath .= ',' . expand(':p:h:h') . '/after' +" This flag can be set to 0 to disable emitting conflict warnings. +let g:ale_emit_conflict_warnings = get(g:, 'ale_emit_conflict_warnings', 1) + +if g:ale_emit_conflict_warnings + " Add the after directory to the runtimepath + let &runtimepath .= ',' . expand(':p:h:h') . '/after' +endif " Set this flag so that other plugins can use it, like airline. let g:loaded_ale = 1 @@ -44,9 +49,6 @@ if has('unix') && empty($TMPDIR) let $TMPDIR = '/tmp' endif -" This flag can be set to 0 to disable emitting conflict warnings. -let g:ale_emit_conflict_warnings = get(g:, 'ale_emit_conflict_warnings', 1) - " This global variable is used internally by ALE for tracking information for " each buffer which linters are being run against. let g:ale_buffer_info = {} From aca66a54a5876eb9979e004742be6a8863c5cdf8 Mon Sep 17 00:00:00 2001 From: Payton Swick Date: Wed, 18 Oct 2017 19:07:29 -0400 Subject: [PATCH 031/390] Include sniff code in message --- ale_linters/php/phpcs.vim | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/ale_linters/php/phpcs.vim b/ale_linters/php/phpcs.vim index ddaf171..399fbd2 100644 --- a/ale_linters/php/phpcs.vim +++ b/ale_linters/php/phpcs.vim @@ -29,11 +29,12 @@ function! ale_linters#php#phpcs#Handle(buffer, lines) abort " Matches against lines like the following: " " /path/to/some-filename.php:18:3: error - Line indented incorrectly; expected 4 spaces, found 2 (Generic.WhiteSpace.ScopeIndent.IncorrectExact) - let l:pattern = '^.*:\(\d\+\):\(\d\+\): \(.\+\) - \(.\+\) \(\(.\+\)\)$' + let l:pattern = '^.*:\(\d\+\):\(\d\+\): \(.\+\) - \(.\+\) (\(.\+\))$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - let l:text = l:match[4] + let l:code = l:match[5] + let l:text = l:match[4] . ' (' . l:code . ')' let l:type = l:match[3] call add(l:output, { From 40f5e541984f7520aab6f627620ed4823ab8943b Mon Sep 17 00:00:00 2001 From: Payton Swick Date: Thu, 26 Oct 2017 12:20:53 -0400 Subject: [PATCH 032/390] Add test for phpcs error code --- test/test_phpcs_include_code.vader | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 test/test_phpcs_include_code.vader diff --git a/test/test_phpcs_include_code.vader b/test/test_phpcs_include_code.vader new file mode 100644 index 0000000..1cff191 --- /dev/null +++ b/test/test_phpcs_include_code.vader @@ -0,0 +1,7 @@ +Execute(errors should include code): + AssertEqual + \ [{'lnum': 18, 'col': 3, 'type': 'E', 'text': 'Line indented incorrectly; expected 4 spaces, found 2 (Generic.WhiteSpace.ScopeIndent.IncorrectExact)'}], + \ ale_linters#php#phpcs#Handle(bufnr(''), [ + \ '/path/to/some-filename.php:18:3: error - Line indented incorrectly; expected 4 spaces, found 2 (Generic.WhiteSpace.ScopeIndent.IncorrectExact)', + \ ]) + From e4456a4e0e9622baf2af30acd34a28963df5f4fa Mon Sep 17 00:00:00 2001 From: Nathaniel Williams Date: Thu, 26 Oct 2017 19:32:33 +0100 Subject: [PATCH 033/390] Add tflint fot Terraform --- README.md | 1 + ale_linters/terraform/tflint.vim | 61 +++++++++++++++++++ doc/ale-terraform.txt | 29 +++++++++ doc/ale.txt | 3 + ...st_terraform_tflint_command_callback.vader | 32 ++++++++++ test/handler/test_tflint_handler.vader | 28 +++++++++ test/test_tflint_config_detection.vader | 18 ++++++ test/tflint-test-files/foo/.tflint.hcl | 0 test/tflint-test-files/foo/bar.tf | 0 9 files changed, 172 insertions(+) create mode 100644 ale_linters/terraform/tflint.vim create mode 100644 doc/ale-terraform.txt create mode 100644 test/command_callback/test_terraform_tflint_command_callback.vader create mode 100644 test/handler/test_tflint_handler.vader create mode 100644 test/test_tflint_config_detection.vader create mode 100644 test/tflint-test-files/foo/.tflint.hcl create mode 100644 test/tflint-test-files/foo/bar.tf diff --git a/README.md b/README.md index a890178..10c63b8 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,7 @@ formatting. | SQL | [sqlint](https://github.com/purcell/sqlint) | | Swift | [swiftlint](https://github.com/realm/SwiftLint), [swiftformat](https://github.com/nicklockwood/SwiftFormat) | | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | +| Terraform | [tflint](https://github.com/wata727/tflint) | | Texinfo | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Thrift | [thrift](http://thrift.apache.org/) | diff --git a/ale_linters/terraform/tflint.vim b/ale_linters/terraform/tflint.vim new file mode 100644 index 0000000..f66a963 --- /dev/null +++ b/ale_linters/terraform/tflint.vim @@ -0,0 +1,61 @@ +" Author: Nat Williams +" Description: tflint for Terraform files +" +" See: https://www.terraform.io/ +" https://github.com/wata727/tflint + +call ale#Set('terraform_tflint_options', '') +call ale#Set('terraform_tflint_executable', 'tflint') + +function! ale_linters#terraform#tflint#Handle(buffer, lines) abort + let l:output = [] + + for l:error in ale#util#FuzzyJSONDecode(a:lines, []) + if l:error.type is# 'ERROR' + let l:type = 'E' + elseif l:error.type is# 'NOTICE' + let l:type = 'I' + else + let l:type = 'W' + endif + + call add(l:output, { + \ 'lnum': l:error.line, + \ 'text': l:error.message, + \ 'type': l:type, + \}) + endfor + + return l:output +endfunction + +function! ale_linters#terraform#tflint#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'terraform_tflint_executable') +endfunction + +function! ale_linters#terraform#tflint#GetCommand(buffer) abort + let l:cmd = ale#Escape(ale#Var(a:buffer, 'terraform_tflint_executable')) + + let l:config_file = ale#path#FindNearestFile(a:buffer, '.tflint.hcl') + if !empty(l:config_file) + let l:cmd .= ' --config ' . ale#Escape(l:config_file) + endif + + let l:opts = ale#Var(a:buffer, 'terraform_tflint_options') + if !empty(l:opts) + let l:cmd .= ' ' . l:opts + endif + + let l:cmd .= ' -f json' + + return l:cmd +endfunction + +call ale#linter#Define('terraform', { +\ 'name': 'tflint', +\ 'executable_callback': 'ale_linters#terraform#tflint#GetExecutable', +\ 'command_callback': 'ale_linters#terraform#tflint#GetCommand', +\ 'callback': 'ale_linters#terraform#tflint#Handle', +\}) + +" vim:sw=4 diff --git a/doc/ale-terraform.txt b/doc/ale-terraform.txt new file mode 100644 index 0000000..ec86e9a --- /dev/null +++ b/doc/ale-terraform.txt @@ -0,0 +1,29 @@ +=============================================================================== +ALE Terraform Integration *ale-terraform-options* + + +=============================================================================== +tflint *ale-terraform-tflint* + +g:ale_terraform_tflint_executable *g:ale_terraform_tflint_executable* + *b:ale_terraform_tflint_executable* + + Type: |String| + Default: `'tflint'` + + This variable can be changed to use a different executable for tflint. + + +g:ale_terraform_tflint_options *g:ale_terraform_tflint_options* + *b:ale_terraform_tflint_options* + Type: |String| + Default: `'-f json'` + + This variable can be changed to pass different options to tflint. Ale does + expect json output from tflint, so if you change this, you'll probably want + to include '-f json' in your new value. + + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: + diff --git a/doc/ale.txt b/doc/ale.txt index 1bc639b..8aea7f8 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -181,6 +181,8 @@ CONTENTS *ale-contents* stylelint...........................|ale-stylus-stylelint| tcl...................................|ale-tcl-options| nagelfar............................|ale-tcl-nagelfar| + terraform.............................|ale-terraform-options| + tflint..............................|ale-terraform-tflint| tex...................................|ale-tex-options| chktex..............................|ale-tex-chktex| lacheck.............................|ale-tex-lacheck| @@ -320,6 +322,7 @@ Notes: * SQL: `sqlint` * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! +* Terraform: `tflint` * Texinfo: `proselint`, `write-good` * Text^: `proselint`, `vale`, `write-good` * Thrift: `thrift` diff --git a/test/command_callback/test_terraform_tflint_command_callback.vader b/test/command_callback/test_terraform_tflint_command_callback.vader new file mode 100644 index 0000000..ba76815 --- /dev/null +++ b/test/command_callback/test_terraform_tflint_command_callback.vader @@ -0,0 +1,32 @@ +Before: + + Save g:ale_terraform_tflint_executable + Save g:ale_terraform_tflint_options + + runtime ale_linters/terraform/tflint.vim + + +After: + Restore + call ale#linter#Reset() + + +Execute(The default executable should be configurable): + AssertEqual 'tflint', ale_linters#terraform#tflint#GetExecutable(bufnr('')) + + let g:ale_terraform_tflint_executable = 'asdf' + + AssertEqual 'asdf', ale_linters#terraform#tflint#GetExecutable(bufnr('')) + +Execute(The default command should be good): + let g:ale_terraform_tflint_executable = 'tflint' + AssertEqual + \ ale#Escape('tflint') . ' -f json', + \ ale_linters#terraform#tflint#GetCommand(bufnr('')) + +Execute(Overriding things should work): + let g:ale_terraform_tflint_executable = 'fnord' + let g:ale_terraform_tflint_options = '--whatever' + AssertEqual + \ ale#Escape('fnord') . ' --whatever -f json', + \ ale_linters#terraform#tflint#GetCommand(bufnr('')) diff --git a/test/handler/test_tflint_handler.vader b/test/handler/test_tflint_handler.vader new file mode 100644 index 0000000..95671b8 --- /dev/null +++ b/test/handler/test_tflint_handler.vader @@ -0,0 +1,28 @@ +Before: + runtime! ale_linters/terraform/tflint.vim + +After: + call ale#linter#Reset() + +Execute(The tflint handler should parse items correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 12, + \ 'text': 'be warned, traveller', + \ 'type': 'W', + \ }, + \ { + \ 'lnum': 9, + \ 'text': 'error message', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 5, + \ 'text': 'just so ya know', + \ 'type': 'I', + \ }, + \ ], + \ ale_linters#terraform#tflint#Handle(123, [ + \ '[ { "detector": "aws_db_instance_readable_password", "type": "WARNING", "message": "be warned, traveller", "line": 12, "file": "github.com/wata727/example-module/aws_db_instance.tf", "link": "https://github.com/wata727/tflint/blob/master/docs/aws_db_instance_readable_password.md" }, { "detector": "aws_elasticache_cluster_invalid_type", "type": "ERROR", "message": "error message", "line": 9, "file": "github.com/wata727/example-module/aws_elasticache_cluster.tf", "link": "https://github.com/wata727/tflint/blob/master/docs/aws_elasticache_cluster_invalid_type.md" }, { "detector": "aws_instance_not_specified_iam_profile", "type": "NOTICE", "message": "just so ya know", "line": 5, "file": "github.com/wata727/example-module/aws_instance.tf", "link": "https://github.com/wata727/tflint/blob/master/docs/aws_instance_not_specified_iam_profile.md" } ]' + \ ]) diff --git a/test/test_tflint_config_detection.vader b/test/test_tflint_config_detection.vader new file mode 100644 index 0000000..ac64c03 --- /dev/null +++ b/test/test_tflint_config_detection.vader @@ -0,0 +1,18 @@ +Before: + call ale#test#SetDirectory('/testplugin/test') + runtime ale_linters/terraform/tflint.vim + +After: + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(adjacent config file should be found): + call ale#test#SetFilename('tflint-test-files/foo/bar.tf') + AssertEqual + \ ( + \ ale#Escape('tflint') + \ . ' --config ' + \ . ale#Escape(ale#path#Winify(g:dir . '/tflint-test-files/foo/.tflint.hcl')) + \ . ' -f json' + \ ), + \ ale_linters#terraform#tflint#GetCommand(bufnr('')) diff --git a/test/tflint-test-files/foo/.tflint.hcl b/test/tflint-test-files/foo/.tflint.hcl new file mode 100644 index 0000000..e69de29 diff --git a/test/tflint-test-files/foo/bar.tf b/test/tflint-test-files/foo/bar.tf new file mode 100644 index 0000000..e69de29 From 22e8050639cc81a35c49479839a4c3e6ea9d9cc0 Mon Sep 17 00:00:00 2001 From: Nathaniel Williams Date: Thu, 26 Oct 2017 14:14:28 -0500 Subject: [PATCH 034/390] don't use stdin with tflint --- ale_linters/terraform/tflint.vim | 2 +- .../test_terraform_tflint_command_callback.vader | 4 ++-- test/test_tflint_config_detection.vader | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ale_linters/terraform/tflint.vim b/ale_linters/terraform/tflint.vim index f66a963..894be22 100644 --- a/ale_linters/terraform/tflint.vim +++ b/ale_linters/terraform/tflint.vim @@ -46,7 +46,7 @@ function! ale_linters#terraform#tflint#GetCommand(buffer) abort let l:cmd .= ' ' . l:opts endif - let l:cmd .= ' -f json' + let l:cmd .= ' -f json %t' return l:cmd endfunction diff --git a/test/command_callback/test_terraform_tflint_command_callback.vader b/test/command_callback/test_terraform_tflint_command_callback.vader index ba76815..b0b4c95 100644 --- a/test/command_callback/test_terraform_tflint_command_callback.vader +++ b/test/command_callback/test_terraform_tflint_command_callback.vader @@ -21,12 +21,12 @@ Execute(The default executable should be configurable): Execute(The default command should be good): let g:ale_terraform_tflint_executable = 'tflint' AssertEqual - \ ale#Escape('tflint') . ' -f json', + \ ale#Escape('tflint') . ' -f json %t', \ ale_linters#terraform#tflint#GetCommand(bufnr('')) Execute(Overriding things should work): let g:ale_terraform_tflint_executable = 'fnord' let g:ale_terraform_tflint_options = '--whatever' AssertEqual - \ ale#Escape('fnord') . ' --whatever -f json', + \ ale#Escape('fnord') . ' --whatever -f json %t', \ ale_linters#terraform#tflint#GetCommand(bufnr('')) diff --git a/test/test_tflint_config_detection.vader b/test/test_tflint_config_detection.vader index ac64c03..65c364e 100644 --- a/test/test_tflint_config_detection.vader +++ b/test/test_tflint_config_detection.vader @@ -13,6 +13,6 @@ Execute(adjacent config file should be found): \ ale#Escape('tflint') \ . ' --config ' \ . ale#Escape(ale#path#Winify(g:dir . '/tflint-test-files/foo/.tflint.hcl')) - \ . ' -f json' + \ . ' -f json %t' \ ), \ ale_linters#terraform#tflint#GetCommand(bufnr('')) From 3ac92ea529e41fa733647692e40b6ee5c0622e1d Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 20:29:23 +0100 Subject: [PATCH 035/390] Fix #1048 - Do not lint files named "." --- autoload/ale.vim | 6 ++++++ test/test_should_do_nothing_conditions.vader | 14 ++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/autoload/ale.vim b/autoload/ale.vim index 6500b30..15fb53d 100644 --- a/autoload/ale.vim +++ b/autoload/ale.vim @@ -61,6 +61,12 @@ function! ale#ShouldDoNothing(buffer) abort return 1 endif + let l:filename = fnamemodify(bufname(a:buffer), ':t') + + if l:filename is# '.' + return 1 + endif + " Do nothing if running in the sandbox if ale#util#InSandbox() return 1 diff --git a/test/test_should_do_nothing_conditions.vader b/test/test_should_do_nothing_conditions.vader index 3afa11a..23ebd92 100644 --- a/test/test_should_do_nothing_conditions.vader +++ b/test/test_should_do_nothing_conditions.vader @@ -1,6 +1,8 @@ Before: Save &l:statusline + call ale#test#SetDirectory('/testplugin/test') + let b:funky_command_created = 0 " We will test for the existence of this command, so create one if needed. @@ -10,6 +12,8 @@ Before: endif After: + call ale#test#RestoreDirectory() + if b:funky_command_created delcommand CtrlPFunky let b:funky_command_created = 0 @@ -25,3 +29,13 @@ Execute(ALE shouldn't do much of anything for ctrlp-funky buffers): let &l:statusline = '%#CtrlPMode2# prt %*%#CtrlPMode1# line %* ={%#CtrlPMode1# funky %*}= <-> %=%<%#CtrlPMode2# %{getcwd()} %*' Assert ale#ShouldDoNothing(bufnr('')) + +Execute(ALE shouldn't try to check buffers with '.' as the filename): + AssertEqual + \ 0, + \ ale#ShouldDoNothing(bufnr('')), + \ 'ShouldDoNothing() was 1 for some other reason' + + silent! noautocmd file . + + Assert ale#ShouldDoNothing(bufnr('')) From 33c2c20e66f694daf899963d778c47f824cda732 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 21:17:47 +0100 Subject: [PATCH 036/390] Fix #1051 - Support ash and dash for shellcheck and the sh linter --- ale_linters/sh/shellcheck.vim | 11 ++++++++--- autoload/ale/handlers/sh.vim | 2 +- test/test_shell_detection.vader | 20 ++++++++++++++++++++ 3 files changed, 29 insertions(+), 4 deletions(-) diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 68844a0..32b47e2 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -23,15 +23,20 @@ function! ale_linters#sh#shellcheck#GetDialectArgument(buffer) abort let l:shell_type = ale#handlers#sh#GetShellType(a:buffer) if !empty(l:shell_type) + " Use the dash dialect for /bin/ash, etc. + if l:shell_type is# 'ash' + return 'dash' + endif + return l:shell_type endif " If there's no hashbang, try using Vim's buffer variables. - if get(b:, 'is_bash') + if getbufvar(a:buffer, 'is_bash', 0) return 'bash' - elseif get(b:, 'is_sh') + elseif getbufvar(a:buffer, 'is_sh', 0) return 'sh' - elseif get(b:, 'is_kornshell') + elseif getbufvar(a:buffer, 'is_kornshell', 0) return 'ksh' endif diff --git a/autoload/ale/handlers/sh.vim b/autoload/ale/handlers/sh.vim index 894879e..e96dd3c 100644 --- a/autoload/ale/handlers/sh.vim +++ b/autoload/ale/handlers/sh.vim @@ -9,7 +9,7 @@ function! ale#handlers#sh#GetShellType(buffer) abort " Remove options like -e, etc. let l:command = substitute(l:bang_line, ' --\?[a-zA-Z0-9]\+', '', 'g') - for l:possible_shell in ['bash', 'tcsh', 'csh', 'zsh', 'sh'] + for l:possible_shell in ['bash', 'dash', 'ash', 'tcsh', 'csh', 'zsh', 'sh'] if l:command =~# l:possible_shell . '\s*$' return l:possible_shell endif diff --git a/test/test_shell_detection.vader b/test/test_shell_detection.vader index 37cf43c..adb8d70 100644 --- a/test/test_shell_detection.vader +++ b/test/test_shell_detection.vader @@ -81,3 +81,23 @@ Execute(The ksh dialect should be used for shellcheck if b:is_kornshell is 1): let b:is_kornshell = 1 AssertEqual 'ksh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr('')) + +Given(A file with /bin/ash): + #!/bin/ash + +Execute(The ash dialect should be used for the shell and the base function): + AssertEqual 'ash', ale#handlers#sh#GetShellType(bufnr('')) + AssertEqual 'ash', ale_linters#sh#shell#GetExecutable(bufnr('')) + +Execute(dash should be used for shellcheck, which has no ash dialect): + AssertEqual 'dash', ale_linters#sh#shellcheck#GetDialectArgument(bufnr('')) + +Given(A file with /bin/dash): + #!/bin/dash + +Execute(The dash dialect should be used for the shell and the base function): + AssertEqual 'dash', ale#handlers#sh#GetShellType(bufnr('')) + AssertEqual 'dash', ale_linters#sh#shell#GetExecutable(bufnr('')) + +Execute(dash should be used for shellcheck): + AssertEqual 'dash', ale_linters#sh#shellcheck#GetDialectArgument(bufnr('')) From 6490d3a5e69c188cbd2b2206916f98409cfb230c Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 23:18:12 +0100 Subject: [PATCH 037/390] Fix #1041 - Do not request completions shortly after CompleteDone --- autoload/ale/completion.vim | 10 ++++++++++ test/test_completion.vader | 36 ++++++++++++++++++++++++------------ 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index 9f4e3c2..90c9ae2 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -283,6 +283,13 @@ function! s:TimerHandler(...) abort endfunction function! ale#completion#Queue() abort + let l:time = get(b:, 'ale_complete_done_time', 0) + + if l:time && ale#util#ClockMilliseconds() - l:time < 100 + " Do not ask for completions shortly after we just closed the menu. + return + endif + let s:timer_pos = getcurpos()[1:2] " If we changed the text again while we're still waiting for a response, @@ -311,6 +318,9 @@ function! ale#completion#Done() abort let &l:completeopt = b:ale_old_completopt unlet b:ale_old_completopt endif + + " Set a timestamp, so we can avoid requesting completions again. + let b:ale_complete_done_time = ale#util#ClockMilliseconds() endfunction function! s:Setup(enabled) abort diff --git a/test/test_completion.vader b/test/test_completion.vader index 811a264..18e50f5 100644 --- a/test/test_completion.vader +++ b/test/test_completion.vader @@ -13,6 +13,21 @@ Before: call add(g:test_vars.feedkeys_calls, [a:string, a:mode]) endfunction + function! CheckCompletionCalled(expect_success) abort + let g:test_vars.get_completions_called = 0 + + " We just want to check if the function is called. + function! ale#completion#GetCompletions() + let g:test_vars.get_completions_called = 1 + endfunction + + let g:ale_completion_delay = 0 + call ale#completion#Queue() + sleep 1m + + AssertEqual a:expect_success, g:test_vars.get_completions_called + endfunction + After: Restore @@ -22,6 +37,9 @@ After: unlet! b:ale_completion_info unlet! b:ale_completion_response unlet! b:ale_completion_parser + unlet! b:ale_complete_done_time + + delfunction CheckCompletionCalled runtime autoload/ale/completion.vim runtime autoload/ale/lsp.vim @@ -294,18 +312,7 @@ Execute(b:ale_completion_info should be set up correctly when requesting complet \ b:ale_completion_info Execute(ale#completion#GetCompletions should be called when the cursor position stays the same): - let g:test_vars.get_completions_called = 0 - - " We just want to check if the function is called. - function! ale#completion#GetCompletions() - let g:test_vars.get_completions_called = 1 - endfunction - - let g:ale_completion_delay = 0 - call ale#completion#Queue() - sleep 1m - - Assert g:test_vars.get_completions_called + call CheckCompletionCalled(1) Execute(ale#completion#GetCompletions should not be called when the cursor position changes): call setpos('.', [bufnr(''), 1, 2, 0]) @@ -326,3 +333,8 @@ Execute(ale#completion#GetCompletions should not be called when the cursor posit sleep 1m Assert !g:test_vars.get_completions_called + +Execute(Completion should not be done shortly after the CompleteDone function): + call CheckCompletionCalled(1) + call ale#completion#Done() + call CheckCompletionCalled(0) From d4d939bea9a51f13fb78a5ab1d7367866a180768 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 26 Oct 2017 23:31:07 +0100 Subject: [PATCH 038/390] Fix #1039 - Only check the file on disk for dartanalyzer --- README.md | 2 +- ale_linters/dart/dartanalyzer.vim | 3 ++- doc/ale-dart.txt | 2 ++ doc/ale.txt | 2 +- .../test_dartanalyzer_command_callback.vader | 6 +++--- 5 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 10c63b8..7d154ce 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ formatting. | CSS | [csslint](http://csslint.net/), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | | Cython (pyrex filetype) | [cython](http://cython.org/) | | D | [dmd](https://dlang.org/dmd-linux.html) | -| Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) | +| Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !! | | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | diff --git a/ale_linters/dart/dartanalyzer.vim b/ale_linters/dart/dartanalyzer.vim index f7b82c4..ef33c9d 100644 --- a/ale_linters/dart/dartanalyzer.vim +++ b/ale_linters/dart/dartanalyzer.vim @@ -13,7 +13,7 @@ function! ale_linters#dart#dartanalyzer#GetCommand(buffer) abort return ale#Escape(l:executable) \ . (!empty(l:path) ? ' --packages ' . ale#Escape(l:path) : '') - \ . ' %t' + \ . ' %s' endfunction function! ale_linters#dart#dartanalyzer#Handle(buffer, lines) abort @@ -37,4 +37,5 @@ call ale#linter#Define('dart', { \ 'executable_callback': 'ale_linters#dart#dartanalyzer#GetExecutable', \ 'command_callback': 'ale_linters#dart#dartanalyzer#GetCommand', \ 'callback': 'ale_linters#dart#dartanalyzer#Handle', +\ 'lint_file': 1, \}) diff --git a/doc/ale-dart.txt b/doc/ale-dart.txt index 37ba6fa..c6faa5c 100644 --- a/doc/ale-dart.txt +++ b/doc/ale-dart.txt @@ -20,6 +20,8 @@ If you have installed Dart on Linux, you can also try the following: > ... or similarly for wherever your Dart SDK lives. This should work without having to modify `$PATH`. +ALE can only check for problems with `dartanalyzer` with the file on disk. +See |ale-lint-file-linters| Options ------------------------------------------------------------------------------- diff --git a/doc/ale.txt b/doc/ale.txt index 8aea7f8..fb5a634 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -267,7 +267,7 @@ Notes: * CSS: `csslint`, `stylelint`, `prettier` * Cython (pyrex filetype): `cython` * D: `dmd` -* Dart: `dartanalyzer` +* Dart: `dartanalyzer`!! * Dockerfile: `hadolint` * Elixir: `credo`, `dogma`!! * Elm: `elm-format, elm-make` diff --git a/test/command_callback/test_dartanalyzer_command_callback.vader b/test/command_callback/test_dartanalyzer_command_callback.vader index dbd8290..6685ab4 100644 --- a/test/command_callback/test_dartanalyzer_command_callback.vader +++ b/test/command_callback/test_dartanalyzer_command_callback.vader @@ -17,7 +17,7 @@ Execute(The default command and executable should be correct): \ 'dartanalyzer', \ ale_linters#dart#dartanalyzer#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape('dartanalyzer') . ' %t', + \ ale#Escape('dartanalyzer') . ' %s', \ ale_linters#dart#dartanalyzer#GetCommand(bufnr('')) Execute(The executable should be configurable): @@ -27,7 +27,7 @@ Execute(The executable should be configurable): \ '/usr/lib/dart/bin/dartanalyzer', \ ale_linters#dart#dartanalyzer#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape('/usr/lib/dart/bin/dartanalyzer') . ' %t', + \ ale#Escape('/usr/lib/dart/bin/dartanalyzer') . ' %s', \ ale_linters#dart#dartanalyzer#GetCommand(bufnr('')) Execute(The .packages file should be set if detected): @@ -36,5 +36,5 @@ Execute(The .packages file should be set if detected): AssertEqual \ ale#Escape('dartanalyzer') \ . ' --packages ' . ale#Escape(ale#path#Winify(g:dir . '/dart_paths/.packages')) - \ . ' %t', + \ . ' %s', \ ale_linters#dart#dartanalyzer#GetCommand(bufnr('')) From 73b8181ce65ab8386d0fb900954757d740b600d2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 27 Oct 2017 09:53:13 +0100 Subject: [PATCH 039/390] #1054 - Prevent ALE from adding the after directory to runtimepath too much --- plugin/ale.vim | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugin/ale.vim b/plugin/ale.vim index 52b3059..23e8572 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -36,7 +36,9 @@ endif let g:ale_emit_conflict_warnings = get(g:, 'ale_emit_conflict_warnings', 1) if g:ale_emit_conflict_warnings +\&& match(&runtimepath, '[/\\]ale[/\\]after') < 0 " Add the after directory to the runtimepath + " This is only done if the after directory isn't already in runtimepath let &runtimepath .= ',' . expand(':p:h:h') . '/after' endif From 36898436b53f8f7df7790ce3ce0681cfd4c9bdb6 Mon Sep 17 00:00:00 2001 From: Sam Howie Date: Thu, 26 Oct 2017 16:11:02 -0700 Subject: [PATCH 040/390] Add hackfmt fixer --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++ autoload/ale/fixers/hackfmt.vim | 18 +++++++++ doc/ale-php.txt | 11 ++++++ doc/ale.txt | 3 +- test/fixers/test_hackfmt_fixer_callback.vader | 37 +++++++++++++++++++ test/hack_files/testfile.php | 0 7 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/hackfmt.vim create mode 100644 test/fixers/test_hackfmt_fixer_callback.vader create mode 100644 test/hack_files/testfile.php diff --git a/README.md b/README.md index 7d154ce..adf4965 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ formatting. | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | -| PHP | [hack](http://hacklang.org/), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | +| PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index bbdcc43..5aa78ac 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -117,6 +117,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['rust'], \ 'description': 'Fix Rust files with Rustfmt.', \ }, +\ 'hackfmt': { +\ 'function': 'ale#fixers#hackfmt#Fix', +\ 'suggested_filetypes': ['php'], +\ 'description': 'Fix Hack files with hackfmt.', +\ }, \ 'hfmt': { \ 'function': 'ale#fixers#hfmt#Fix', \ 'suggested_filetypes': ['haskell'], diff --git a/autoload/ale/fixers/hackfmt.vim b/autoload/ale/fixers/hackfmt.vim new file mode 100644 index 0000000..b5bf0dc --- /dev/null +++ b/autoload/ale/fixers/hackfmt.vim @@ -0,0 +1,18 @@ +" Author: Sam Howie +" Description: Integration of hackfmt with ALE. + +call ale#Set('php_hackfmt_executable', 'hackfmt') +call ale#Set('php_hackfmt_options', '') + +function! ale#fixers#hackfmt#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'php_hackfmt_executable') + let l:options = ale#Var(a:buffer, 'php_hackfmt_options') + + return { + \ 'command': ale#Escape(l:executable) + \ . ' -i' + \ . (empty(l:options) ? '' : ' ' . l:options) + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/doc/ale-php.txt b/doc/ale-php.txt index 8756d60..f09c95f 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -8,6 +8,17 @@ hack *ale-php-hack* There are no options for this linter. +=============================================================================== +hackfmt *ale-php-hackfmt* + +g:ale_php_hackfmt_options *g:ale_php_hackfmt_options* + *b:ale_php_hackfmt_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the hackfmt fixer. + + =============================================================================== langserver *ale-php-langserver* diff --git a/doc/ale.txt b/doc/ale.txt index fb5a634..c90ab1d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -125,6 +125,7 @@ CONTENTS *ale-contents* perlcritic..........................|ale-perl-perlcritic| php...................................|ale-php-options| hack................................|ale-php-hack| + hackfmt.............................|ale-php-hackfmt| langserver..........................|ale-php-langserver| phan................................|ale-php-phan| phpcbf..............................|ale-php-phpcbf| @@ -301,7 +302,7 @@ Notes: * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|) * Perl: `perl -c`, `perl-critic` -* PHP: `hack`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` +* PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint`, `write-good` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` diff --git a/test/fixers/test_hackfmt_fixer_callback.vader b/test/fixers/test_hackfmt_fixer_callback.vader new file mode 100644 index 0000000..ed78fc8 --- /dev/null +++ b/test/fixers/test_hackfmt_fixer_callback.vader @@ -0,0 +1,37 @@ +Before: + Save g:ale_php_hackfmt_executable + Save g:ale_php_hackfmt_options + + " Use an invalid global executable, so we don't match it. + let g:ale_php_hackfmt_executable = 'xxxinvalid' + let g:ale_php_hackfmt_options = '' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The hackfmt callback should return the correct default values): + call ale#test#SetFilename('../hack_files/testfile.php') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' -i %t', + \ }, + \ ale#fixers#hackfmt#Fix(bufnr('')) + +Execute(The hackfmt callback should include custom hackfmt options): + let g:ale_php_hackfmt_options = "--some-option" + call ale#test#SetFilename('../hack_files/testfile.php') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' -i --some-option %t', + \ }, + \ ale#fixers#hackfmt#Fix(bufnr('')) diff --git a/test/hack_files/testfile.php b/test/hack_files/testfile.php new file mode 100644 index 0000000..e69de29 From 6e681d9066bde1f2a6b7583fa91e9c94cfffb11e Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 28 Oct 2017 12:11:33 +0100 Subject: [PATCH 041/390] Fix #971 - Add an option for turning errors about missing eslint config files off. --- autoload/ale/handlers/eslint.vim | 31 ++++-- doc/ale-javascript.txt | 17 +++- test/handler/test_eslint_handler.vader | 126 +++++++++++++++++++++++-- 3 files changed, 157 insertions(+), 17 deletions(-) diff --git a/autoload/ale/handlers/eslint.vim b/autoload/ale/handlers/eslint.vim index 3397ab5..d1a3b60 100644 --- a/autoload/ale/handlers/eslint.vim +++ b/autoload/ale/handlers/eslint.vim @@ -7,6 +7,7 @@ call ale#Set('javascript_eslint_options', '') call ale#Set('javascript_eslint_executable', 'eslint') call ale#Set('javascript_eslint_use_global', 0) call ale#Set('javascript_eslint_suppress_eslintignore', 0) +call ale#Set('javascript_eslint_suppress_missing_config', 0) function! ale#handlers#eslint#FindConfig(buffer) abort for l:path in ale#path#Upwards(expand('#' . a:buffer . ':p:h')) @@ -64,7 +65,7 @@ function! s:AddHintsForTypeScriptParsingErrors(output) abort endfor endfunction -function! ale#handlers#eslint#Handle(buffer, lines) abort +function! s:CheckForBadConfig(buffer, lines) abort let l:config_error_pattern = '\v^ESLint couldn''t find a configuration file' \ . '|^Cannot read config file' \ . '|^.*Configuration for rule .* is invalid' @@ -73,15 +74,31 @@ function! ale#handlers#eslint#Handle(buffer, lines) abort " Look for a message in the first few lines which indicates that " a configuration file couldn't be found. for l:line in a:lines[:10] - if len(matchlist(l:line, l:config_error_pattern)) > 0 - return [{ - \ 'lnum': 1, - \ 'text': 'eslint configuration error (type :ALEDetail for more information)', - \ 'detail': join(a:lines, "\n"), - \}] + let l:match = matchlist(l:line, l:config_error_pattern) + + if len(l:match) > 0 + " Don't show the missing config error if we've disabled it. + if ale#Var(a:buffer, 'javascript_eslint_suppress_missing_config') + \&& l:match[0] is# 'ESLint couldn''t find a configuration file' + return 0 + endif + + return 1 endif endfor + return 0 +endfunction + +function! ale#handlers#eslint#Handle(buffer, lines) abort + if s:CheckForBadConfig(a:buffer, a:lines) + return [{ + \ 'lnum': 1, + \ 'text': 'eslint configuration error (type :ALEDetail for more information)', + \ 'detail': join(a:lines, "\n"), + \}] + endif + " Matches patterns line the following: " " /path/to/some-filename.js:47:14: Missing trailing comma. [Warning/comma-dangle] diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 8bf1a0d..1b8e3f5 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -56,8 +56,21 @@ g:ale_javascript_eslint_suppress_eslintignore Type: |Number| Default: `0` - This variable can be set to disable the warning that linting is disabled on - the current file due to being covered by `.eslintignore`. + This variable can be set to `1` to disable warnings for files being ignored + by eslint. + + +g:ale_javascript_eslint_suppress_missing_config + *g:ale_javascript_eslint_suppress_missing_config* + *b:ale_javascript_eslint_suppress_missing_config* + Type: |Number| + Default: `0` + + This variable can be set to `1` to disable errors for missing eslint + configuration files. + + When turning this option on, eslint will not report any problems when no + configuration files are found. =============================================================================== diff --git a/test/handler/test_eslint_handler.vader b/test/handler/test_eslint_handler.vader index 943e177..0ebeb38 100644 --- a/test/handler/test_eslint_handler.vader +++ b/test/handler/test_eslint_handler.vader @@ -1,11 +1,16 @@ Before: Save g:ale_javascript_eslint_suppress_eslintignore + Save g:ale_javascript_eslint_suppress_missing_config let g:ale_javascript_eslint_suppress_eslintignore = 0 + let b:ale_javascript_eslint_suppress_missing_config = 0 + + unlet! b:ale_javascript_eslint_suppress_missing_config After: Restore + unlet! b:ale_javascript_eslint_suppress_missing_config unlet! g:config_error_lines Execute(The eslint handler should parse lines correctly): @@ -30,7 +35,7 @@ Execute(The eslint handler should parse lines correctly): \ 'type': 'E', \ }, \ ], - \ ale#handlers#eslint#Handle(347, [ + \ ale#handlers#eslint#Handle(bufnr(''), [ \ 'This line should be ignored completely', \ '/path/to/some-filename.js:47:14: Missing trailing comma. [Warning/comma-dangle]', \ '/path/to/some-filename.js:56:41: Missing semicolon. [Error/semi]', @@ -58,7 +63,26 @@ Execute(The eslint handler should print a message about a missing configuration \ 'text': 'eslint configuration error (type :ALEDetail for more information)', \ 'detail': join(g:config_error_lines, "\n"), \ }], - \ ale#handlers#eslint#Handle(347, g:config_error_lines[:]) + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) + +Execute(The eslint handler should allow the missing config error to be suppressed): + let b:ale_javascript_eslint_suppress_missing_config = 1 + let g:config_error_lines = [ + \ '', + \ 'Oops! Something went wrong! :(', + \ '', + \ 'ESLint couldn''t find a configuration file. To set up a configuration file for this project, please run:', + \ ' eslint --init', + \ '', + \ 'ESLint looked for configuration files in /some/path/or/other and its ancestors.', + \ '', + \ 'If you think you already have a configuration file or if you need more help, please stop by the ESLint chat room: https://gitter.im/eslint/eslint', + \ '', + \ ] + + AssertEqual + \ [], + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) Execute(The eslint handler should print a message for config parsing errors): let g:config_error_lines = [ @@ -86,7 +110,36 @@ Execute(The eslint handler should print a message for config parsing errors): \ 'text': 'eslint configuration error (type :ALEDetail for more information)', \ 'detail': join(g:config_error_lines, "\n"), \ }], - \ ale#handlers#eslint#Handle(347, g:config_error_lines[:]) + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) + +Execute(Suppressing missing configs shouldn't suppress parsing errors): + let b:ale_javascript_eslint_suppress_missing_config = 1 + let g:config_error_lines = [ + \ 'Cannot read config file: /some/path/or/other/.eslintrc.js', + \ 'Error: Unexpected token <<', + \ '/some/path/or/other/.eslintrc.js:1', + \ '(function (exports, require, module, __filename, __dirname) { <<<>>>', + \ ' ^^', + \ 'SyntaxError: Unexpected token <<', + \ ' at Object.exports.runInThisContext (vm.js:76:16)', + \ ' at Module._compile (module.js:528:28)', + \ ' at Object.Module._extensions..js (module.js:565:10)', + \ ' at Module.load (module.js:473:32)', + \ ' at tryModuleLoad (module.js:432:12)', + \ ' at Function.Module._load (module.js:424:3)', + \ ' at Module.require (module.js:483:17)', + \ ' at require (internal/module.js:20:19)', + \ ' at module.exports (/usr/local/lib/node_modules/eslint/node_modules/require-uncached/index.js:14:12)', + \ ' at loadJSConfigFile (/usr/local/lib/node_modules/eslint/lib/config/config-file.js:160:16)', + \] + + AssertEqual + \ [{ + \ 'lnum': 1, + \ 'text': 'eslint configuration error (type :ALEDetail for more information)', + \ 'detail': join(g:config_error_lines, "\n"), + \ }], + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) Execute(The eslint handler should print a message for invalid configuration settings): let g:config_error_lines = [ @@ -116,7 +169,38 @@ Execute(The eslint handler should print a message for invalid configuration sett \ 'text': 'eslint configuration error (type :ALEDetail for more information)', \ 'detail': join(g:config_error_lines, "\n"), \ }], - \ ale#handlers#eslint#Handle(347, g:config_error_lines[:]) + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) + +Execute(Suppressing missing configs shouldn't suppress invalid config errors): + let b:ale_javascript_eslint_suppress_missing_config = 1 + let g:config_error_lines = [ + \ '/home/w0rp/git/wazoku/wazoku-spotlight/.eslintrc.js:', + \ ' Configuration for rule "indent" is invalid:', + \ ' Value "off" is the wrong type.', + \ '', + \ 'Error: /home/w0rp/git/wazoku/wazoku-spotlight/.eslintrc.js:', + \ ' Configuration for rule "indent" is invalid:', + \ ' Value "off" is the wrong type.', + \ '', + \ ' at validateRuleOptions (/usr/local/lib/node_modules/eslint/lib/config/config-validator.js:115:15)', + \ ' at /usr/local/lib/node_modules/eslint/lib/config/config-validator.js:162:13', + \ ' at Array.forEach (native)', + \ ' at Object.validate (/usr/local/lib/node_modules/eslint/lib/config/config-validator.js:161:35)', + \ ' at Object.load (/usr/local/lib/node_modules/eslint/lib/config/config-file.js:522:19)', + \ ' at loadConfig (/usr/local/lib/node_modules/eslint/lib/config.js:63:33)', + \ ' at getLocalConfig (/usr/local/lib/node_modules/eslint/lib/config.js:130:29)', + \ ' at Config.getConfig (/usr/local/lib/node_modules/eslint/lib/config.js:256:22)', + \ ' at processText (/usr/local/lib/node_modules/eslint/lib/cli-engine.js:224:33)', + \ ' at CLIEngine.executeOnText (/usr/local/lib/node_modules/eslint/lib/cli-engine.js:756:26)', + \] + + AssertEqual + \ [{ + \ 'lnum': 1, + \ 'text': 'eslint configuration error (type :ALEDetail for more information)', + \ 'detail': join(g:config_error_lines, "\n"), + \ }], + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) Execute(The eslint handler should print a message when import is not used in a module): let g:config_error_lines = [ @@ -140,7 +224,33 @@ Execute(The eslint handler should print a message when import is not used in a m \ 'text': 'eslint configuration error (type :ALEDetail for more information)', \ 'detail': join(g:config_error_lines, "\n"), \ }], - \ ale#handlers#eslint#Handle(347, g:config_error_lines[:]) + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) + +Execute(Suppressing missing configs shouldn't suppress module import errors): + let b:ale_javascript_eslint_suppress_missing_config = 1 + let g:config_error_lines = [ + \ 'ImportDeclaration should appear when the mode is ES6 and in the module context.', + \ 'AssertionError: ImportDeclaration should appear when the mode is ES6 and in the module context.', + \ ' at Referencer.ImportDeclaration (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint-scope/lib/referencer.js:597:9)', + \ ' at Referencer.Visitor.visit (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/esrecurse/esrecurse.js:122:34)', + \ ' at Referencer.Visitor.visitChildren (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/esrecurse/esrecurse.js:101:38)', + \ ' at Referencer.Program (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint-scope/lib/referencer.js:449:14)', + \ ' at Referencer.Visitor.visit (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/esrecurse/esrecurse.js:122:34)', + \ ' at Object.analyze (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint-scope/lib/index.js:138:16)', + \ ' at EventEmitter.module.exports.api.verify (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint/lib/eslint.js:887:40)', + \ ' at processText (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint/lib/cli-engine.js:278:31)', + \ ' at CLIEngine.executeOnText (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint/lib/cli-engine.js:734:26)', + \ ' at Object.execute (/home/w0rp/git/wazoku/wazoku-spotlight/spotlight/static/node_modules/eslint/lib/cli.js:171:42) ', + \] + + AssertEqual + \ [{ + \ 'lnum': 1, + \ 'text': 'eslint configuration error (type :ALEDetail for more information)', + \ 'detail': join(g:config_error_lines, "\n"), + \ }], + \ ale#handlers#eslint#Handle(bufnr(''), g:config_error_lines[:]) + Execute(The eslint handler should output end_col values where appropriate): AssertEqual @@ -188,7 +298,7 @@ Execute(The eslint handler should output end_col values where appropriate): \ 'type': 'E', \ }, \ ], - \ ale#handlers#eslint#Handle(347, [ + \ ale#handlers#eslint#Handle(bufnr(''), [ \ 'app.js:4:3: Parsing error: Unexpected token ''some string'' [Error]', \ 'app.js:70:3: ''foo'' is not defined. [Error/no-undef]', \ 'app.js:71:2: Unexpected `await` inside a loop. [Error/no-await-in-loop]', @@ -222,7 +332,7 @@ Execute(eslint should warn about ignored files by default): \ 'type': 'W', \ 'text': 'File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]' \ }], - \ ale#handlers#eslint#Handle(347, [ + \ ale#handlers#eslint#Handle(bufnr(''), [ \ '/path/to/some/ignored.js:0:0: File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]', \ ]) @@ -231,6 +341,6 @@ Execute(eslint should not warn about ignored files when explicitly disabled): AssertEqual \ [], - \ ale#handlers#eslint#Handle(347, [ + \ ale#handlers#eslint#Handle(bufnr(''), [ \ '/path/to/some/ignored.js:0:0: File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]', \ ]) From ea3a8e3c62d3051fee9342ece2e04bcd04b392b6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 28 Oct 2017 15:41:14 +0100 Subject: [PATCH 042/390] #817 Move code for toggling ALE to its own file --- autoload/ale/toggle.vim | 140 +++++++++++++++++++++++++++++++ plugin/ale.vim | 140 ++----------------------------- test/test_ale_toggle.vader | 29 +++++++ test/test_autocmd_commands.vader | 5 +- 4 files changed, 178 insertions(+), 136 deletions(-) create mode 100644 autoload/ale/toggle.vim diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim new file mode 100644 index 0000000..acddea4 --- /dev/null +++ b/autoload/ale/toggle.vim @@ -0,0 +1,140 @@ +function! ale#toggle#InitAuGroups() abort + " This value used to be a Boolean as a Number, and is now a String. + let l:text_changed = '' . g:ale_lint_on_text_changed + + augroup ALEPatternOptionsGroup + autocmd! + if g:ale_enabled && g:ale_pattern_options_enabled + autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions() + endif + augroup END + + augroup ALERunOnTextChangedGroup + autocmd! + if g:ale_enabled + if l:text_changed is? 'always' || l:text_changed is# '1' + autocmd TextChanged,TextChangedI * call ale#Queue(g:ale_lint_delay) + elseif l:text_changed is? 'normal' + autocmd TextChanged * call ale#Queue(g:ale_lint_delay) + elseif l:text_changed is? 'insert' + autocmd TextChangedI * call ale#Queue(g:ale_lint_delay) + endif + endif + augroup END + + augroup ALERunOnEnterGroup + autocmd! + if g:ale_enabled + " Handle everything that needs to happen when buffers are entered. + autocmd BufEnter * call ale#events#EnterEvent(str2nr(expand(''))) + endif + if g:ale_enabled && g:ale_lint_on_enter + autocmd BufWinEnter,BufRead * call ale#Queue(0, 'lint_file', str2nr(expand(''))) + " Track when the file is changed outside of Vim. + autocmd FileChangedShellPost * call ale#events#FileChangedEvent(str2nr(expand(''))) + endif + augroup END + + augroup ALERunOnFiletypeChangeGroup + autocmd! + if g:ale_enabled && g:ale_lint_on_filetype_changed + " Only start linting if the FileType actually changes after + " opening a buffer. The FileType will fire when buffers are opened. + autocmd FileType * call ale#events#FileTypeEvent( + \ str2nr(expand('')), + \ expand('') + \) + endif + augroup END + + augroup ALERunOnSaveGroup + autocmd! + if (g:ale_enabled && g:ale_lint_on_save) || g:ale_fix_on_save + autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand(''))) + endif + augroup END + + augroup ALERunOnInsertLeave + autocmd! + if g:ale_enabled && g:ale_lint_on_insert_leave + autocmd InsertLeave * call ale#Queue(0) + endif + augroup END + + augroup ALECursorGroup + autocmd! + if g:ale_enabled && g:ale_echo_cursor + autocmd CursorMoved,CursorHold * call ale#cursor#EchoCursorWarningWithDelay() + " Look for a warning to echo as soon as we leave Insert mode. + " The script's position variable used when moving the cursor will + " not be changed here. + autocmd InsertLeave * call ale#cursor#EchoCursorWarning() + endif + augroup END + + if !g:ale_enabled + if !g:ale_fix_on_save + augroup! ALERunOnSaveGroup + endif + + augroup! ALEPatternOptionsGroup + augroup! ALERunOnTextChangedGroup + augroup! ALERunOnEnterGroup + augroup! ALERunOnInsertLeave + augroup! ALECursorGroup + endif +endfunction + +function! ale#toggle#Toggle() abort + let g:ale_enabled = !get(g:, 'ale_enabled') + + if g:ale_enabled + " Set pattern options again, if enabled. + if g:ale_pattern_options_enabled + call ale#pattern_options#SetOptions() + endif + + " Lint immediately, including running linters against the file. + call ale#Queue(0, 'lint_file') + + if g:ale_set_balloons + call ale#balloon#Enable() + endif + else + for l:key in keys(g:ale_buffer_info) + " The key could be a filename or a buffer number, so try and + " convert it to a number. We need a number for the other + " functions. + let l:buffer = str2nr(l:key) + + if l:buffer > 0 + " Stop all jobs and clear the results for everything, and delete + " all of the data we stored for the buffer. + call ale#engine#Cleanup(l:buffer) + endif + endfor + + " Remove highlights for the current buffer now. + if g:ale_set_highlights + call ale#highlight#UpdateHighlights() + endif + + if g:ale_set_balloons + call ale#balloon#Disable() + endif + endif + + call ale#toggle#InitAuGroups() +endfunction + +function! ale#toggle#Enable() abort + if !g:ale_enabled + call ale#toggle#Toggle() + endif +endfunction + +function! ale#toggle#Disable() abort + if g:ale_enabled + call ale#toggle#Toggle() + endif +endfunction diff --git a/plugin/ale.vim b/plugin/ale.vim index 23e8572..83ca2dd 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -201,137 +201,6 @@ call ale#Set('completion_enabled', 0) call ale#Set('completion_delay', 100) call ale#Set('completion_max_suggestions', 50) -function! ALEInitAuGroups() abort - " This value used to be a Boolean as a Number, and is now a String. - let l:text_changed = '' . g:ale_lint_on_text_changed - - augroup ALEPatternOptionsGroup - autocmd! - if g:ale_enabled && g:ale_pattern_options_enabled - autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions() - endif - augroup END - - augroup ALERunOnTextChangedGroup - autocmd! - if g:ale_enabled - if l:text_changed is? 'always' || l:text_changed is# '1' - autocmd TextChanged,TextChangedI * call ale#Queue(g:ale_lint_delay) - elseif l:text_changed is? 'normal' - autocmd TextChanged * call ale#Queue(g:ale_lint_delay) - elseif l:text_changed is? 'insert' - autocmd TextChangedI * call ale#Queue(g:ale_lint_delay) - endif - endif - augroup END - - augroup ALERunOnEnterGroup - autocmd! - if g:ale_enabled - " Handle everything that needs to happen when buffers are entered. - autocmd BufEnter * call ale#events#EnterEvent(str2nr(expand(''))) - endif - if g:ale_enabled && g:ale_lint_on_enter - autocmd BufWinEnter,BufRead * call ale#Queue(0, 'lint_file', str2nr(expand(''))) - " Track when the file is changed outside of Vim. - autocmd FileChangedShellPost * call ale#events#FileChangedEvent(str2nr(expand(''))) - endif - augroup END - - augroup ALERunOnFiletypeChangeGroup - autocmd! - if g:ale_enabled && g:ale_lint_on_filetype_changed - " Only start linting if the FileType actually changes after - " opening a buffer. The FileType will fire when buffers are opened. - autocmd FileType * call ale#events#FileTypeEvent( - \ str2nr(expand('')), - \ expand('') - \) - endif - augroup END - - augroup ALERunOnSaveGroup - autocmd! - if (g:ale_enabled && g:ale_lint_on_save) || g:ale_fix_on_save - autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand(''))) - endif - augroup END - - augroup ALERunOnInsertLeave - autocmd! - if g:ale_enabled && g:ale_lint_on_insert_leave - autocmd InsertLeave * call ale#Queue(0) - endif - augroup END - - augroup ALECursorGroup - autocmd! - if g:ale_enabled && g:ale_echo_cursor - autocmd CursorMoved,CursorHold * call ale#cursor#EchoCursorWarningWithDelay() - " Look for a warning to echo as soon as we leave Insert mode. - " The script's position variable used when moving the cursor will - " not be changed here. - autocmd InsertLeave * call ale#cursor#EchoCursorWarning() - endif - augroup END - - if !g:ale_enabled - if !g:ale_fix_on_save - augroup! ALERunOnSaveGroup - endif - - augroup! ALEPatternOptionsGroup - augroup! ALERunOnTextChangedGroup - augroup! ALERunOnEnterGroup - augroup! ALERunOnInsertLeave - augroup! ALECursorGroup - endif -endfunction - -function! s:ALEToggle() abort - let g:ale_enabled = !get(g:, 'ale_enabled') - - if g:ale_enabled - " Set pattern options again, if enabled. - if g:ale_pattern_options_enabled - call ale#pattern_options#SetOptions() - endif - - " Lint immediately, including running linters against the file. - call ale#Queue(0, 'lint_file') - - if g:ale_set_balloons - call ale#balloon#Enable() - endif - else - for l:key in keys(g:ale_buffer_info) - " The key could be a filename or a buffer number, so try and - " convert it to a number. We need a number for the other - " functions. - let l:buffer = str2nr(l:key) - - if l:buffer > 0 - " Stop all jobs and clear the results for everything, and delete - " all of the data we stored for the buffer. - call ale#engine#Cleanup(l:buffer) - endif - endfor - - " Remove highlights for the current buffer now. - if g:ale_set_highlights - call ale#highlight#UpdateHighlights() - endif - - if g:ale_set_balloons - call ale#balloon#Disable() - endif - endif - - call ALEInitAuGroups() -endfunction - -call ALEInitAuGroups() - if g:ale_set_balloons call ale#balloon#Enable() endif @@ -352,9 +221,9 @@ command! -bar ALELast :call ale#loclist_jumping#JumpToIndex(-1) command! -bar ALEDetail :call ale#cursor#ShowCursorDetail() " Define commands for turning ALE on or off. -command! -bar ALEToggle :call s:ALEToggle() -command! -bar ALEEnable :if !g:ale_enabled | ALEToggle | endif -command! -bar ALEDisable :if g:ale_enabled | ALEToggle | endif +command! -bar ALEToggle :call ale#toggle#Toggle() +command! -bar ALEEnable :call ale#toggle#Enable() +command! -bar ALEDisable :call ale#toggle#Disable() " A command for linting manually. command! -bar ALELint :call ale#Queue(0, 'lint_file') @@ -381,6 +250,9 @@ nnoremap (ale_lint) :ALELint nnoremap (ale_detail) :ALEDetail nnoremap (ale_fix) :ALEFix +" Set up autocmd groups now. +call ale#toggle#InitAuGroups() + " Housekeeping augroup ALECleanupGroup diff --git a/test/test_ale_toggle.vader b/test/test_ale_toggle.vader index f3dbf10..733ae35 100644 --- a/test/test_ale_toggle.vader +++ b/test/test_ale_toggle.vader @@ -2,6 +2,7 @@ Before: Save g:ale_buffer_info Save g:ale_set_signs Save g:ale_set_lists_synchronously + Save g:ale_run_synchronously let g:ale_set_signs = 1 let g:ale_set_lists_synchronously = 1 @@ -175,3 +176,31 @@ Execute(ALEToggle should skip filename keys and preserve them): \ 'history': [], \ }, \ get(g:ale_buffer_info, '/foo/bar/baz.txt', {}) + +Execute(ALEDisable should reset everything and stay disabled): + " We can just lint sychronously for these tests. + let g:ale_run_synchronously = 1 + + call ale#Lint() + + AssertEqual g:expected_loclist, getloclist(0) + + ALEDisable + + AssertEqual [], getloclist(0) + AssertEqual 0, g:ale_enabled + + ALEDisable + + AssertEqual [], getloclist(0) + AssertEqual 0, g:ale_enabled + +Execute(ALEEnable should enable ALE and lint again): + " We can just lint sychronously for these tests. + let g:ale_enabled = 0 + let g:ale_run_synchronously = 1 + + ALEEnable + + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual 1, g:ale_enabled diff --git a/test/test_autocmd_commands.vader b/test/test_autocmd_commands.vader index 17e3b16..6bc3f5c 100644 --- a/test/test_autocmd_commands.vader +++ b/test/test_autocmd_commands.vader @@ -1,6 +1,7 @@ Before: function! CheckAutocmd(group) - call ALEInitAuGroups() + call ale#toggle#InitAuGroups() + redir => l:output execute 'silent! autocmd ' . a:group redir END @@ -58,7 +59,7 @@ After: call ale#completion#Disable() endif - call ALEInitAuGroups() + call ale#toggle#InitAuGroups() Execute (g:ale_lint_on_text_changed = 0 should bind no events): let g:ale_lint_on_text_changed = 0 From 5fc2b98b73b74a0d57037683f0c809eac41368f0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 28 Oct 2017 19:36:16 +0100 Subject: [PATCH 043/390] #817 Add commands for toggling ALE for only the current buffer --- autoload/ale/highlight.vim | 4 +- autoload/ale/toggle.vim | 88 ++++++++++++++++++++++------ plugin/ale.vim | 4 ++ test/test_ale_toggle.vader | 91 +++++++++++++++++++++++++++-- test/test_highlight_placement.vader | 28 ++++++++- 5 files changed, 188 insertions(+), 27 deletions(-) diff --git a/autoload/ale/highlight.vim b/autoload/ale/highlight.vim index 5c01e7a..47256f0 100644 --- a/autoload/ale/highlight.vim +++ b/autoload/ale/highlight.vim @@ -58,7 +58,7 @@ function! ale#highlight#RemoveHighlights() abort endfunction function! ale#highlight#UpdateHighlights() abort - let l:item_list = g:ale_enabled + let l:item_list = get(b:, 'ale_enabled', 1) && g:ale_enabled \ ? get(b:, 'ale_highlight_items', []) \ : [] @@ -106,7 +106,7 @@ augroup ALEHighlightBufferGroup augroup END function! ale#highlight#SetHighlights(buffer, loclist) abort - let l:new_list = g:ale_enabled + let l:new_list = getbufvar(a:buffer, 'ale_enabled', 1) && g:ale_enabled \ ? filter(copy(a:loclist), 'v:val.bufnr == a:buffer && v:val.col > 0') \ : [] diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index acddea4..8e54dc2 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -85,21 +85,36 @@ function! ale#toggle#InitAuGroups() abort endif endfunction +function! s:EnablePreamble() abort + " Set pattern options again, if enabled. + if g:ale_pattern_options_enabled + call ale#pattern_options#SetOptions() + endif + + " Lint immediately, including running linters against the file. + call ale#Queue(0, 'lint_file') + + if g:ale_set_balloons + call ale#balloon#Enable() + endif +endfunction + +function! s:DisablePostamble() abort + " Remove highlights for the current buffer now. + if g:ale_set_highlights + call ale#highlight#UpdateHighlights() + endif + + if g:ale_set_balloons + call ale#balloon#Disable() + endif +endfunction + function! ale#toggle#Toggle() abort let g:ale_enabled = !get(g:, 'ale_enabled') if g:ale_enabled - " Set pattern options again, if enabled. - if g:ale_pattern_options_enabled - call ale#pattern_options#SetOptions() - endif - - " Lint immediately, including running linters against the file. - call ale#Queue(0, 'lint_file') - - if g:ale_set_balloons - call ale#balloon#Enable() - endif + call s:EnablePreamble() else for l:key in keys(g:ale_buffer_info) " The key could be a filename or a buffer number, so try and @@ -114,14 +129,7 @@ function! ale#toggle#Toggle() abort endif endfor - " Remove highlights for the current buffer now. - if g:ale_set_highlights - call ale#highlight#UpdateHighlights() - endif - - if g:ale_set_balloons - call ale#balloon#Disable() - endif + call s:DisablePostamble() endif call ale#toggle#InitAuGroups() @@ -129,6 +137,11 @@ endfunction function! ale#toggle#Enable() abort if !g:ale_enabled + " Set pattern options again, if enabled. + if g:ale_pattern_options_enabled + call ale#pattern_options#SetOptions() + endif + call ale#toggle#Toggle() endif endfunction @@ -138,3 +151,40 @@ function! ale#toggle#Disable() abort call ale#toggle#Toggle() endif endfunction + +function! ale#toggle#ToggleBuffer(buffer) abort + " Get the new value for the toggle. + let l:enabled = !getbufvar(a:buffer, 'ale_enabled', 1) + + " Disabling ALE globally removes autocmd events, so we cannot enable + " linting locally when linting is disabled globally + if l:enabled && !g:ale_enabled + echom 'ALE cannot be enabled locally when disabled globally' + return + endif + + call setbufvar(a:buffer, 'ale_enabled', l:enabled) + + if l:enabled + call s:EnablePreamble() + else + " Stop all jobs and clear the results for everything, and delete + " all of the data we stored for the buffer. + call ale#engine#Cleanup(a:buffer) + + call s:DisablePostamble() + endif +endfunction + +function! ale#toggle#EnableBuffer(buffer) abort + " ALE is enabled by default for all buffers. + if !getbufvar(a:buffer, 'ale_enabled', 1) + call ale#toggle#ToggleBuffer(a:buffer) + endif +endfunction + +function! ale#toggle#DisableBuffer(buffer) abort + if getbufvar(a:buffer, 'ale_enabled', 1) + call ale#toggle#ToggleBuffer(a:buffer) + endif +endfunction diff --git a/plugin/ale.vim b/plugin/ale.vim index 83ca2dd..3e1803e 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -224,6 +224,10 @@ command! -bar ALEDetail :call ale#cursor#ShowCursorDetail() command! -bar ALEToggle :call ale#toggle#Toggle() command! -bar ALEEnable :call ale#toggle#Enable() command! -bar ALEDisable :call ale#toggle#Disable() +" Commands for turning ALE on or off for a buffer. +command! -bar ALEToggleBuffer :call ale#toggle#ToggleBuffer(bufnr('')) +command! -bar ALEEnableBuffer :call ale#toggle#EnableBuffer(bufnr('')) +command! -bar ALEDisableBuffer :call ale#toggle#DisableBuffer(bufnr('')) " A command for linting manually. command! -bar ALELint :call ale#Queue(0, 'lint_file') diff --git a/test/test_ale_toggle.vader b/test/test_ale_toggle.vader index 733ae35..d8de398 100644 --- a/test/test_ale_toggle.vader +++ b/test/test_ale_toggle.vader @@ -6,6 +6,9 @@ Before: let g:ale_set_signs = 1 let g:ale_set_lists_synchronously = 1 + let g:ale_run_synchronously = 1 + + unlet! b:ale_enabled let g:ale_buffer_info = {} let g:expected_loclist = [{ @@ -80,6 +83,8 @@ After: unlet! g:expected_loclist unlet! g:expected_groups + unlet! b:ale_enabled + unlet! g:output call ale#linter#Reset() @@ -91,12 +96,19 @@ After: delfunction ToggleTestCallback delfunction ParseAuGroups + call setloclist(0, []) + sign unplace * + call clearmatches() + Given foobar (Some imaginary filetype): foo bar baz Execute(ALEToggle should reset everything and then run again): + " Run this test asynchrously. + let g:ale_run_synchronously = 0 + AssertEqual 'foobar', &filetype call ale#Lint() @@ -134,6 +146,9 @@ Execute(ALEToggle should reset everything and then run again): AssertEqual [{'lnum': 2, 'bufnr': bufnr(''), 'col': 3, 'linter_name': 'testlinter', 'vcol': 0, 'nr': -1, 'type': 'E', 'text': 'foo bar', 'sign_id': 1000001}], g:ale_buffer_info[bufnr('')].loclist Execute(ALEToggle should skip filename keys and preserve them): + " Run this test asynchrously. + let g:ale_run_synchronously = 0 + AssertEqual 'foobar', &filetype let g:ale_buffer_info['/foo/bar/baz.txt'] = { @@ -178,9 +193,6 @@ Execute(ALEToggle should skip filename keys and preserve them): \ get(g:ale_buffer_info, '/foo/bar/baz.txt', {}) Execute(ALEDisable should reset everything and stay disabled): - " We can just lint sychronously for these tests. - let g:ale_run_synchronously = 1 - call ale#Lint() AssertEqual g:expected_loclist, getloclist(0) @@ -196,11 +208,80 @@ Execute(ALEDisable should reset everything and stay disabled): AssertEqual 0, g:ale_enabled Execute(ALEEnable should enable ALE and lint again): - " We can just lint sychronously for these tests. let g:ale_enabled = 0 - let g:ale_run_synchronously = 1 ALEEnable AssertEqual g:expected_loclist, getloclist(0) AssertEqual 1, g:ale_enabled + +Execute(ALEToggleBuffer should reset everything and then run again): + " Run this test asynchrously. + let g:ale_run_synchronously = 0 + + AssertEqual 'foobar', &filetype + + call ale#Lint() + call ale#engine#WaitForJobs(2000) + + " First check that everything is there... + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%')) + AssertEqual + \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], + \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') + AssertEqual [{'lnum': 2, 'bufnr': bufnr(''), 'col': 3, 'linter_name': 'testlinter', 'vcol': 0, 'nr': -1, 'type': 'E', 'text': 'foo bar', 'sign_id': 1000001}], g:ale_buffer_info[bufnr('')].loclist + + " Now Toggle ALE off. + ALEToggleBuffer + + " Everything should be cleared. + Assert !has_key(g:ale_buffer_info, bufnr('')), 'The g:ale_buffer_info Dictionary was not removed' + AssertEqual [], getloclist(0), 'The loclist was not cleared' + AssertEqual [0, []], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared' + AssertEqual [], getmatches(), 'The highlights were not cleared' + + " Toggle ALE on, everything should be set up and run again. + ALEToggleBuffer + call ale#engine#WaitForJobs(2000) + + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%')) + AssertEqual + \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], + \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') + AssertEqual g:expected_groups, ParseAuGroups() + AssertEqual [{'lnum': 2, 'bufnr': bufnr(''), 'col': 3, 'linter_name': 'testlinter', 'vcol': 0, 'nr': -1, 'type': 'E', 'text': 'foo bar', 'sign_id': 1000001}], g:ale_buffer_info[bufnr('')].loclist + +Execute(ALEDisableBuffer should reset everything and stay disabled): + call ale#Lint() + + AssertEqual g:expected_loclist, getloclist(0) + + ALEDisableBuffer + + AssertEqual [], getloclist(0) + AssertEqual 0, b:ale_enabled + +Execute(ALEEnableBuffer should enable ALE and lint again): + let b:ale_enabled = 0 + + ALEEnableBuffer + + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual 1, b:ale_enabled + +Execute(ALEEnableBuffer should complain when ALE is disabled globally): + let g:ale_enabled = 0 + let b:ale_enabled = 0 + + redir => g:output + ALEEnableBuffer + redir END + + AssertEqual [], getloclist(0) + AssertEqual 0, b:ale_enabled + AssertEqual 0, g:ale_enabled + AssertEqual + \ 'ALE cannot be enabled locally when disabled globally', + \ join(split(g:output)) diff --git a/test/test_highlight_placement.vader b/test/test_highlight_placement.vader index 2d87b77..6a84e57 100644 --- a/test/test_highlight_placement.vader +++ b/test/test_highlight_placement.vader @@ -1,4 +1,6 @@ Before: + Save g:ale_enabled + function! GenerateResults(buffer, output) return [ \ { @@ -43,7 +45,10 @@ Before: highlight link SomeOtherGroup SpellBad After: + Restore + unlet! g:items + unlet! b:ale_enabled delfunction GenerateResults call ale#linter#Reset() @@ -206,7 +211,7 @@ Execute(Highlighting should support errors spanning many lines): \ }, \ ], \ GetMatchesWithoutIDs() - \ + Execute(Highlights should always be cleared when the buffer highlight list is empty): " Add our highlights and something else. call matchaddpos('ALEError', [[1, 1, 1]]) @@ -232,3 +237,24 @@ Execute(Highlights should always be cleared when the buffer highlight list is em \ {'group': 'SomeOtherGroup', 'priority': 10, 'pos1': [1, 1, 1]}, \ ], \ GetMatchesWithoutIDs() + +Execute(Highlights should be cleared when ALE is disabled): + let g:ale_enabled = 1 + call ale#highlight#SetHighlights(bufnr(''), [ + \ {'bufnr': bufnr(''), 'type': 'E', 'lnum': 1, 'col': 1, 'end_lnum': 10, 'end_col': 3}, + \]) + + let g:ale_enabled = 0 + call ale#highlight#UpdateHighlights() + + AssertEqual [], GetMatchesWithoutIDs() + + let g:ale_enabled = 1 + call ale#highlight#SetHighlights(bufnr(''), [ + \ {'bufnr': bufnr(''), 'type': 'E', 'lnum': 1, 'col': 1, 'end_lnum': 10, 'end_col': 3}, + \]) + + let b:ale_enabled = 0 + call ale#highlight#UpdateHighlights() + + AssertEqual [], GetMatchesWithoutIDs() From 1aa737cdc9b6e92b51823df93f356b4ec37beab3 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 29 Oct 2017 10:55:02 +0000 Subject: [PATCH 044/390] #817 - Document the buffer toggling options, and define plug mappings for everything --- doc/ale.txt | 33 ++++++++++++++++++++++++++++----- plugin/ale.vim | 5 +++++ 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index c90ab1d..2026978 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1447,13 +1447,36 @@ ALELast *ALELast* ALEToggle *ALEToggle* ALEEnable *ALEEnable* ALEDisable *ALEDisable* +ALEToggleBuffer *ALEToggleBuffer* +ALEEnableBuffer *ALEEnableBuffer* +ALEDisableBuffer *ALEDisableBuffer* - Enable or disable ALE, including all of its autocmd events, loclist items, - quickfix items, signs, current jobs, etc. Executing any of those commands - will change the |g:ale_enabled| variable. + `ALEToggle`, `ALEEnable`, and `ALEDisable` enable or disable ALE linting, + including all of its autocmd events, loclist items, quickfix items, signs, + current jobs, etc., globally. Executing any of these commands will change + the |g:ale_enabled| variable. - For convenience, a plug mapping `(ale_toggle)` is defined for the - |ALEToggle| command. + ALE can be disabled or enabled for only a single buffer with + `ALEToggleBuffer`, `ALEEnableBuffer`, and `ALEDisableBuffer`. Disabling ALE + for a buffer will not remove autocmd events, but will prevent ALE from + checking for problems and reporting problems for whatever buffer the + `ALEDisableBuffer` or `ALEToggleBuffer` command is executed from. These + commands can be used for temporarily disabling ALE for a buffer. These + commands will modify the |b:ale_enabled| variable. + + ALE linting cannot be enabled for a single buffer when it is disabled + globally, as disabling ALE globally removes the autocmd events needed to + perform linting with. + + The following plug mappings are defined, for conveniently defining + keybinds: + + |ALEToggle| - `(ale_toggle)` + |ALEEnable| - `(ale_enable)` + |ALEDisable| - `(ale_disable)` + |ALEToggleBuffer| - `(ale_toggle_buffer)` + |ALEEnableBuffer| - `(ale_enable_buffer)` + |ALEDisableBuffer| - `(ale_disable_buffer)` ALEDetail *ALEDetail* diff --git a/plugin/ale.vim b/plugin/ale.vim index 3e1803e..f700aff 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -250,6 +250,11 @@ nnoremap (ale_next_wrap) :ALENextWrap nnoremap (ale_first) :ALEFirst nnoremap (ale_last) :ALELast nnoremap (ale_toggle) :ALEToggle +nnoremap (ale_enable) :ALEEnable +nnoremap (ale_disable) :ALEDisable +nnoremap (ale_toggle_buffer) :ALEToggleBuffer +nnoremap (ale_enable_buffer) :ALEEnableBuffer +nnoremap (ale_disable_buffer) :ALEDisableBuffer nnoremap (ale_lint) :ALELint nnoremap (ale_detail) :ALEDetail nnoremap (ale_fix) :ALEFix From daecbad543c68de1c0a2d8c368e4edde2f90461e Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 29 Oct 2017 17:03:29 +0000 Subject: [PATCH 045/390] Fix #719 - Add ALEReset and ALEResetBuffer for removing problems for all buffers or one buffer --- autoload/ale/toggle.vim | 40 ++++++++++++++++++++----------- doc/ale.txt | 23 ++++++++++++++++-- plugin/ale.vim | 4 ++++ test/test_ale_toggle.vader | 49 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 100 insertions(+), 16 deletions(-) diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index 8e54dc2..e8cb83a 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -110,25 +110,28 @@ function! s:DisablePostamble() abort endif endfunction +function! s:CleanupEveryBuffer() abort + for l:key in keys(g:ale_buffer_info) + " The key could be a filename or a buffer number, so try and + " convert it to a number. We need a number for the other + " functions. + let l:buffer = str2nr(l:key) + + if l:buffer > 0 + " Stop all jobs and clear the results for everything, and delete + " all of the data we stored for the buffer. + call ale#engine#Cleanup(l:buffer) + endif + endfor +endfunction + function! ale#toggle#Toggle() abort let g:ale_enabled = !get(g:, 'ale_enabled') if g:ale_enabled call s:EnablePreamble() else - for l:key in keys(g:ale_buffer_info) - " The key could be a filename or a buffer number, so try and - " convert it to a number. We need a number for the other - " functions. - let l:buffer = str2nr(l:key) - - if l:buffer > 0 - " Stop all jobs and clear the results for everything, and delete - " all of the data we stored for the buffer. - call ale#engine#Cleanup(l:buffer) - endif - endfor - + call s:CleanupEveryBuffer() call s:DisablePostamble() endif @@ -152,6 +155,11 @@ function! ale#toggle#Disable() abort endif endfunction +function! ale#toggle#Reset() abort + call s:CleanupEveryBuffer() + call ale#highlight#UpdateHighlights() +endfunction + function! ale#toggle#ToggleBuffer(buffer) abort " Get the new value for the toggle. let l:enabled = !getbufvar(a:buffer, 'ale_enabled', 1) @@ -171,7 +179,6 @@ function! ale#toggle#ToggleBuffer(buffer) abort " Stop all jobs and clear the results for everything, and delete " all of the data we stored for the buffer. call ale#engine#Cleanup(a:buffer) - call s:DisablePostamble() endif endfunction @@ -188,3 +195,8 @@ function! ale#toggle#DisableBuffer(buffer) abort call ale#toggle#ToggleBuffer(a:buffer) endif endfunction + +function! ale#toggle#ResetBuffer(buffer) abort + call ale#engine#Cleanup(a:buffer) + call ale#highlight#UpdateHighlights() +endfunction diff --git a/doc/ale.txt b/doc/ale.txt index 2026978..340d7fa 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1468,8 +1468,7 @@ ALEDisableBuffer *ALEDisableBuffer* globally, as disabling ALE globally removes the autocmd events needed to perform linting with. - The following plug mappings are defined, for conveniently defining - keybinds: + The following plug mappings are defined, for conveniently defining keybinds: |ALEToggle| - `(ale_toggle)` |ALEEnable| - `(ale_enable)` @@ -1478,6 +1477,8 @@ ALEDisableBuffer *ALEDisableBuffer* |ALEEnableBuffer| - `(ale_enable_buffer)` |ALEDisableBuffer| - `(ale_disable_buffer)` + For removing problems reported by ALE, but leaving ALE enabled, see + |ALEReset| and |ALEResetBuffer|. ALEDetail *ALEDetail* @@ -1505,6 +1506,24 @@ ALEInfoToClipboard *ALEInfoToClipboard* your clipboard. This might not work on every machine. +ALEReset *ALEReset* +ALEResetBuffer *ALEResetBuffer* + + `ALEReset` will remove all problems reported by ALE for all buffers. + `ALEResetBuffer` will remove all problems reported for a single buffer. + + Either command will leave ALE linting enabled, so ALE will report problems + when linting is performed again. See |ale-lint| for more information. + + The following plug mappings are defined, for conveniently defining keybinds: + + |ALEReset| - `(ale_reset)` + |ALEResetBuffer| - `(ale_reset_buffer)` + + ALE can be disabled globally or for a buffer with |ALEDisable| or + |ALEDisableBuffer|. + + =============================================================================== 9. API *ale-api* diff --git a/plugin/ale.vim b/plugin/ale.vim index f700aff..0b5ac78 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -224,10 +224,12 @@ command! -bar ALEDetail :call ale#cursor#ShowCursorDetail() command! -bar ALEToggle :call ale#toggle#Toggle() command! -bar ALEEnable :call ale#toggle#Enable() command! -bar ALEDisable :call ale#toggle#Disable() +command! -bar ALEReset :call ale#toggle#Reset() " Commands for turning ALE on or off for a buffer. command! -bar ALEToggleBuffer :call ale#toggle#ToggleBuffer(bufnr('')) command! -bar ALEEnableBuffer :call ale#toggle#EnableBuffer(bufnr('')) command! -bar ALEDisableBuffer :call ale#toggle#DisableBuffer(bufnr('')) +command! -bar ALEResetBuffer :call ale#toggle#ResetBuffer(bufnr('')) " A command for linting manually. command! -bar ALELint :call ale#Queue(0, 'lint_file') @@ -252,9 +254,11 @@ nnoremap (ale_last) :ALELast nnoremap (ale_toggle) :ALEToggle nnoremap (ale_enable) :ALEEnable nnoremap (ale_disable) :ALEDisable +nnoremap (ale_reset) :ALEReset nnoremap (ale_toggle_buffer) :ALEToggleBuffer nnoremap (ale_enable_buffer) :ALEEnableBuffer nnoremap (ale_disable_buffer) :ALEDisableBuffer +nnoremap (ale_reset_buffer) :ALEResetBuffer nnoremap (ale_lint) :ALELint nnoremap (ale_detail) :ALEDetail nnoremap (ale_fix) :ALEFix diff --git a/test/test_ale_toggle.vader b/test/test_ale_toggle.vader index d8de398..c3bd2f5 100644 --- a/test/test_ale_toggle.vader +++ b/test/test_ale_toggle.vader @@ -215,6 +215,30 @@ Execute(ALEEnable should enable ALE and lint again): AssertEqual g:expected_loclist, getloclist(0) AssertEqual 1, g:ale_enabled +Execute(ALEReset should reset everything for a buffer): + AssertEqual 'foobar', &filetype + + call ale#Lint() + + " First check that everything is there... + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%')) + AssertEqual + \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], + \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') + AssertEqual [{'lnum': 2, 'bufnr': bufnr(''), 'col': 3, 'linter_name': 'testlinter', 'vcol': 0, 'nr': -1, 'type': 'E', 'text': 'foo bar', 'sign_id': 1000001}], g:ale_buffer_info[bufnr('')].loclist + + " Now Toggle ALE off. + ALEReset + + " Everything should be cleared. + Assert !has_key(g:ale_buffer_info, bufnr('')), 'The g:ale_buffer_info Dictionary was not removed' + AssertEqual [], getloclist(0), 'The loclist was not cleared' + AssertEqual [0, []], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared' + AssertEqual [], getmatches(), 'The highlights were not cleared' + + AssertEqual 1, g:ale_enabled + Execute(ALEToggleBuffer should reset everything and then run again): " Run this test asynchrously. let g:ale_run_synchronously = 0 @@ -285,3 +309,28 @@ Execute(ALEEnableBuffer should complain when ALE is disabled globally): AssertEqual \ 'ALE cannot be enabled locally when disabled globally', \ join(split(g:output)) + +Execute(ALEResetBuffer should reset everything for a buffer): + AssertEqual 'foobar', &filetype + + call ale#Lint() + + " First check that everything is there... + AssertEqual g:expected_loclist, getloclist(0) + AssertEqual [0, [[2, 1000001, 'ALEErrorSign']]], ale#sign#FindCurrentSigns(bufnr('%')) + AssertEqual + \ [{'group': 'ALEError', 'pos1': [2, 3, 1]}], + \ map(getmatches(), '{''group'': v:val.group, ''pos1'': v:val.pos1}') + AssertEqual [{'lnum': 2, 'bufnr': bufnr(''), 'col': 3, 'linter_name': 'testlinter', 'vcol': 0, 'nr': -1, 'type': 'E', 'text': 'foo bar', 'sign_id': 1000001}], g:ale_buffer_info[bufnr('')].loclist + + " Now Toggle ALE off. + ALEResetBuffer + + " Everything should be cleared. + Assert !has_key(g:ale_buffer_info, bufnr('')), 'The g:ale_buffer_info Dictionary was not removed' + AssertEqual [], getloclist(0), 'The loclist was not cleared' + AssertEqual [0, []], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared' + AssertEqual [], getmatches(), 'The highlights were not cleared' + + AssertEqual 1, g:ale_enabled + AssertEqual 1, get(b:, 'ale_enabled', 1) From 634eb1920cf6f22bf5a121928511ad873656b819 Mon Sep 17 00:00:00 2001 From: Ahmed El Gabri Date: Sun, 29 Oct 2017 16:27:52 +0100 Subject: [PATCH 046/390] refmt fixer for ReasonML --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++ autoload/ale/fixers/refmt.vim | 18 +++++++++ doc/ale-reasonml.txt | 16 ++++++++ doc/ale.txt | 3 +- test/fixers/test_refmt_fixer_callback.vader | 41 +++++++++++++++++++++ test/reasonml_files/testfile.re | 0 7 files changed, 83 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/refmt.vim create mode 100644 test/fixers/test_refmt_fixer_callback.vader create mode 100644 test/reasonml_files/testfile.re diff --git a/README.md b/README.md index adf4965..6e5ef26 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ formatting. | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | -| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions | +| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 5aa78ac..37bbee9 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -127,6 +127,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['haskell'], \ 'description': 'Fix Haskell files with hfmt.', \ }, +\ 'refmt': { +\ 'function': 'ale#fixers#refmt#Fix', +\ 'suggested_filetypes': ['reason'], +\ 'description': 'Fix ReasonML files with refmt.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/refmt.vim b/autoload/ale/fixers/refmt.vim new file mode 100644 index 0000000..514f950 --- /dev/null +++ b/autoload/ale/fixers/refmt.vim @@ -0,0 +1,18 @@ +" Author: Ahmed El Gabri <@ahmedelgabri> +" Description: Integration of refmt with ALE. + +call ale#Set('reasonml_refmt_executable', 'refmt') +call ale#Set('reasonml_refmt_options', '') + +function! ale#fixers#refmt#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'reasonml_refmt_executable') + let l:options = ale#Var(a:buffer, 'reasonml_refmt_options') + + return { + \ 'command': ale#Escape(l:executable) + \ . (empty(l:options) ? '' : ' ' . l:options) + \ . ' --in-place' + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/doc/ale-reasonml.txt b/doc/ale-reasonml.txt index 17a7b2e..d533d85 100644 --- a/doc/ale-reasonml.txt +++ b/doc/ale-reasonml.txt @@ -10,6 +10,22 @@ merlin *ale-reasonml-merlin* detailed instructions (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). +=============================================================================== +refmt *ale-reasonml-refmt* + +g:ale_reasonml_refmt_executable *g:ale_reasonml_refmt_executable* + *b:ale_reasonml_refmt_executable* + Type: |String| + Default: `'refmt'` + + This variable can be set to pass the path of the refmt fixer. + +g:ale_reasonml_refmt_options *g:ale_reasonml_refmt_options* + *b:ale_reasonml_refmt_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the refmt fixer. =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 2026978..58a58e3 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -150,6 +150,7 @@ CONTENTS *ale-contents* lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| + refmt...............................|ale-reasonml-refmt| restructuredtext......................|ale-restructuredtext-options| write-good..........................|ale-restructuredtext-write-good| ruby..................................|ale-ruby-options| @@ -308,7 +309,7 @@ Notes: * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pylint`!!, `yapf` * R: `lintr` -* ReasonML: `merlin` +* ReasonML: `merlin`, `refmt` * reStructuredText: `proselint`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` diff --git a/test/fixers/test_refmt_fixer_callback.vader b/test/fixers/test_refmt_fixer_callback.vader new file mode 100644 index 0000000..9ec331e --- /dev/null +++ b/test/fixers/test_refmt_fixer_callback.vader @@ -0,0 +1,41 @@ +Before: + Save g:ale_reasonml_refmt_executable + Save g:ale_reasonml_refmt_options + + " Use an invalid global executable, so we don't match it. + let g:ale_reasonml_refmt_executable = 'xxxinvalid' + let g:ale_reasonml_refmt_options = '' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The refmt callback should return the correct default values): + call ale#test#SetFilename('../reasonml_files/testfile.re') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' --in-place' + \ . ' %t', + \ }, + \ ale#fixers#refmt#Fix(bufnr('')) + +Execute(The refmt callback should include custom refmt options): + let g:ale_reasonml_refmt_options = "-w 80" + call ale#test#SetFilename('../reasonml_files/testfile.re') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' ' . g:ale_reasonml_refmt_options + \ . ' --in-place' + \ . ' %t', + \ }, + \ ale#fixers#refmt#Fix(bufnr('')) + diff --git a/test/reasonml_files/testfile.re b/test/reasonml_files/testfile.re new file mode 100644 index 0000000..e69de29 From 50f7ad35529e0672e4161e3c74be5cb87196a2f1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 30 Oct 2017 22:19:57 +0000 Subject: [PATCH 047/390] #857 - Add b:ale_fix_on_save for controlling fixing on save for specific buffers --- autoload/ale/events.vim | 10 ++++++---- autoload/ale/toggle.vim | 8 +------- doc/ale.txt | 4 ++++ test/test_ale_fix.vader | 24 ++++++++++++++++++++++++ test/test_ale_toggle.vader | 8 +++++++- test/test_autocmd_commands.vader | 26 ++------------------------ test/test_lint_file_linters.vader | 15 ++++++++++++++- 7 files changed, 58 insertions(+), 37 deletions(-) diff --git a/autoload/ale/events.vim b/autoload/ale/events.vim index a7f6b37..c7d17ea 100644 --- a/autoload/ale/events.vim +++ b/autoload/ale/events.vim @@ -12,11 +12,13 @@ function! ale#events#QuitRecently(buffer) abort endfunction function! ale#events#SaveEvent(buffer) abort - call setbufvar(a:buffer, 'ale_save_event_fired', 1) - let l:should_lint = ale#Var(a:buffer, 'enabled') - \ && g:ale_lint_on_save + let l:should_lint = ale#Var(a:buffer, 'enabled') && g:ale_lint_on_save - if g:ale_fix_on_save + if l:should_lint + call setbufvar(a:buffer, 'ale_save_event_fired', 1) + endif + + if ale#Var(a:buffer, 'fix_on_save') let l:will_fix = ale#fix#Fix('save_file') let l:should_lint = l:should_lint && !l:will_fix endif diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index e8cb83a..6809edd 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -49,9 +49,7 @@ function! ale#toggle#InitAuGroups() abort augroup ALERunOnSaveGroup autocmd! - if (g:ale_enabled && g:ale_lint_on_save) || g:ale_fix_on_save - autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand(''))) - endif + autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand(''))) augroup END augroup ALERunOnInsertLeave @@ -73,10 +71,6 @@ function! ale#toggle#InitAuGroups() abort augroup END if !g:ale_enabled - if !g:ale_fix_on_save - augroup! ALERunOnSaveGroup - endif - augroup! ALEPatternOptionsGroup augroup! ALERunOnTextChangedGroup augroup! ALERunOnEnterGroup diff --git a/doc/ale.txt b/doc/ale.txt index 368ba9e..9b18d3d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -669,6 +669,7 @@ g:ale_fixers *g:ale_fixers* g:ale_fix_on_save *g:ale_fix_on_save* +b:ale_fix_on_save *b:ale_fix_on_save* Type: |Number| Default: `0` @@ -679,6 +680,9 @@ g:ale_fix_on_save *g:ale_fix_on_save* after files are fixed, only when the buffer is open, or re-opened. Changes to the file will be saved to the file on disk. + Fixing files can be disabled or enabled for individual buffers by setting + `b:ale_fix_on_save` to `0` or `1`. + g:ale_history_enabled *g:ale_history_enabled* diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index 9968c4a..fac9a25 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -77,6 +77,7 @@ After: unlet! g:ale_set_lists_synchronously unlet! g:ale_emulate_job_failure unlet! b:ale_fixers + unlet! b:ale_fix_on_save delfunction AddCarets delfunction AddDollars delfunction DoNothing @@ -412,6 +413,29 @@ Expect(There should be only two lines): a b +Execute(b:ale_fix_on_save = 1 should override g:ale_fix_on_save = 0): + let g:ale_fix_on_save = 0 + let b:ale_fix_on_save = 1 + + let g:ale_fixers.testft = ['RemoveLastLineOneArg'] + call ale#events#SaveEvent(bufnr('')) + +Expect(There should be only two lines): + a + b + +Execute(b:ale_fix_on_save = 0 should override g:ale_fix_on_save = 1): + let g:ale_fix_on_save = 1 + let b:ale_fix_on_save = 0 + + let g:ale_fixers.testft = ['RemoveLastLineOneArg'] + call ale#events#SaveEvent(bufnr('')) + +Expect(The lines should be the same): + a + b + c + Execute(ALEFix functions returning jobs should be able to accept one argument): if has('win32') " Just skip this test on Windows, we can't run it. diff --git a/test/test_ale_toggle.vader b/test/test_ale_toggle.vader index c3bd2f5..a57546f 100644 --- a/test/test_ale_toggle.vader +++ b/test/test_ale_toggle.vader @@ -131,7 +131,13 @@ Execute(ALEToggle should reset everything and then run again): AssertEqual [], getloclist(0), 'The loclist was not cleared' AssertEqual [0, []], ale#sign#FindCurrentSigns(bufnr('%')), 'The signs were not cleared' AssertEqual [], getmatches(), 'The highlights were not cleared' - AssertEqual ['ALECleanupGroup', 'ALEHighlightBufferGroup'], ParseAuGroups() + AssertEqual + \ [ + \ 'ALECleanupGroup', + \ 'ALEHighlightBufferGroup', + \ 'ALERunOnSaveGroup', + \ ], + \ ParseAuGroups() " Toggle ALE on, everything should be set up and run again. ALEToggle diff --git a/test/test_autocmd_commands.vader b/test/test_autocmd_commands.vader index 6bc3f5c..88504a9 100644 --- a/test/test_autocmd_commands.vader +++ b/test/test_autocmd_commands.vader @@ -155,32 +155,10 @@ Execute (g:ale_lint_on_filetype_changed = 1 should bind the FileType event): \ ], \ CheckAutocmd('ALERunOnFiletypeChangeGroup') -Execute (g:ale_lint_on_save = 0 should bind no events): - let g:ale_lint_on_save = 0 - let g:ale_fix_on_save = 0 - - AssertEqual [], CheckAutocmd('ALERunOnSaveGroup') - -Execute (g:ale_lint_on_save = 1 should bind no events): - let g:ale_lint_on_save = 1 - let g:ale_fix_on_save = 0 - - AssertEqual [ - \ 'BufWritePost * call ale#events#SaveEvent(str2nr(expand('''')))', - \], CheckAutocmd('ALERunOnSaveGroup') - -Execute (g:ale_lint_on_save = 0 and g:ale_fix_on_save = 1 should bind events): - let g:ale_lint_on_save = 0 - let g:ale_fix_on_save = 1 - - AssertEqual [ - \ 'BufWritePost * call ale#events#SaveEvent(str2nr(expand('''')))', - \], CheckAutocmd('ALERunOnSaveGroup') - -Execute (g:ale_fix_on_save = 1 should bind events even when ALE is disabled): +Execute (The SaveEvent should always be bound): let g:ale_enabled = 0 let g:ale_lint_on_save = 0 - let g:ale_fix_on_save = 1 + let g:ale_fix_on_save = 0 AssertEqual [ \ 'BufWritePost * call ale#events#SaveEvent(str2nr(expand('''')))', diff --git a/test/test_lint_file_linters.vader b/test/test_lint_file_linters.vader index bea8c3f..2e992e1 100644 --- a/test/test_lint_file_linters.vader +++ b/test/test_lint_file_linters.vader @@ -1,4 +1,6 @@ Before: + Save g:ale_fix_on_save + Save g:ale_enabled Save g:ale_run_synchronously Save g:ale_set_lists_synchronously Save g:ale_buffer_info @@ -7,6 +9,7 @@ Before: let g:ale_buffer_info = {} let g:ale_run_synchronously = 1 let g:ale_set_lists_synchronously = 1 + let b:ale_save_event_fired = 0 call ale#ResetLintFileMarkers() let g:buffer_result = [ @@ -261,7 +264,10 @@ Execute(The Save event should respect the buffer number): \], GetSimplerLoclist() Execute(The Save event should set b:ale_save_event_fired to 1): - let b:ale_enabled = 0 + let g:ale_lint_on_save = 1 + let b:ale_enabled = 1 + + call ale#linter#Reset() call ale#events#SaveEvent(bufnr('')) " This flag needs to be set so windows can be opened, etc. @@ -289,3 +295,10 @@ Execute(lint_file linters should stay running after checking without them): AssertEqual 2, len(g:ale_buffer_info[bufnr('')].job_list) call ale#engine#WaitForJobs(2000) + +Execute(The save event should not lint the buffer when ALE is disabled): + let g:ale_enabled = 0 + call ale#events#SaveEvent(bufnr('')) + + AssertEqual [], GetSimplerLoclist() + AssertEqual 0, b:ale_save_event_fired From 0ed639a11628fc7c31e3eae441d28288d84d604e Mon Sep 17 00:00:00 2001 From: Maxim Baz Date: Tue, 31 Oct 2017 13:26:12 +0100 Subject: [PATCH 048/390] Put info about lightline-ale in README.md (fixes #1065) --- README.md | 56 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 6e5ef26..7bdaeeb 100644 --- a/README.md +++ b/README.md @@ -418,61 +418,9 @@ See `:help ale#statusline#Count()` for more information. ### 5.v. How can I show errors or warnings in my lightline? [lightline](https://github.com/itchyny/lightline.vim) does not have built-in -support for ALE, nevertheless it's easy to do it yourself: +support for ALE, nevertheless there is a plugin that adds this functionality: [maximbaz/lightline-ale](https://github.com/maximbaz/lightline-ale). -```vim -" This is regular lightline configuration, we just added -" 'linter_warnings', 'linter_errors' and 'linter_ok' to -" the active right panel. Feel free to move it anywhere. -" `component_expand' and `component_type' are required. -" -" For more info on how this works, see lightline documentation. -let g:lightline = { - \ 'active': { - \ 'right': [ [ 'lineinfo' ], - \ [ 'percent' ], - \ [ 'linter_warnings', 'linter_errors', 'linter_ok' ], - \ [ 'fileformat', 'fileencoding', 'filetype' ] ] - \ }, - \ 'component_expand': { - \ 'linter_warnings': 'LightlineLinterWarnings', - \ 'linter_errors': 'LightlineLinterErrors', - \ 'linter_ok': 'LightlineLinterOK' - \ }, - \ 'component_type': { - \ 'linter_warnings': 'warning', - \ 'linter_errors': 'error', - \ 'linter_ok': 'ok' - \ }, - \ } - -autocmd User ALELint call lightline#update() - -" ale + lightline -function! LightlineLinterWarnings() abort - let l:counts = ale#statusline#Count(bufnr('')) - let l:all_errors = l:counts.error + l:counts.style_error - let l:all_non_errors = l:counts.total - l:all_errors - return l:counts.total == 0 ? '' : printf('%d --', all_non_errors) -endfunction - -function! LightlineLinterErrors() abort - let l:counts = ale#statusline#Count(bufnr('')) - let l:all_errors = l:counts.error + l:counts.style_error - let l:all_non_errors = l:counts.total - l:all_errors - return l:counts.total == 0 ? '' : printf('%d >>', all_errors) -endfunction - -function! LightlineLinterOK() abort - let l:counts = ale#statusline#Count(bufnr('')) - let l:all_errors = l:counts.error + l:counts.style_error - let l:all_non_errors = l:counts.total - l:all_errors - return l:counts.total == 0 ? '✓' : '' -endfunction -``` - -See `:help ale#statusline#Count()` and [lightline documentation](https://github.com/itchyny/lightline.vim#advanced-configuration) -for more information. +For more information, check out the sources of that plugin, `:help ale#statusline#Count()` and [lightline documentation](https://github.com/itchyny/lightline.vim#advanced-configuration). From 9cd0d75c4f001527d34c0a108bb560ffc352eaf7 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 31 Oct 2017 13:00:55 +0000 Subject: [PATCH 049/390] Fix #936 - Check the actual files for gosimple and staticcheck --- README.md | 2 +- ale_linters/go/gosimple.vim | 5 +++-- ale_linters/go/staticcheck.vim | 5 +++-- doc/ale.txt | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e5ef26..1ac6d05 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ formatting. | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang) | -| Go | [gofmt](https://golang.org/cmd/gofmt/), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple), [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) | +| Go | [gofmt](https://golang.org/cmd/gofmt/), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | diff --git a/ale_linters/go/gosimple.vim b/ale_linters/go/gosimple.vim index 9188e0d..8a4c01e 100644 --- a/ale_linters/go/gosimple.vim +++ b/ale_linters/go/gosimple.vim @@ -4,7 +4,8 @@ call ale#linter#Define('go', { \ 'name': 'gosimple', \ 'executable': 'gosimple', -\ 'command': 'gosimple %t', +\ 'command': 'gosimple %s', \ 'callback': 'ale#handlers#unix#HandleAsWarning', -\ 'output_stream': 'both' +\ 'output_stream': 'both', +\ 'lint_file': 1, \}) diff --git a/ale_linters/go/staticcheck.vim b/ale_linters/go/staticcheck.vim index cb4a5c7..255fd17 100644 --- a/ale_linters/go/staticcheck.vim +++ b/ale_linters/go/staticcheck.vim @@ -4,7 +4,8 @@ call ale#linter#Define('go', { \ 'name': 'staticcheck', \ 'executable': 'staticcheck', -\ 'command': 'staticcheck %t', +\ 'command': 'staticcheck %s', \ 'callback': 'ale#handlers#unix#HandleAsWarning', -\ 'output_stream': 'both' +\ 'output_stream': 'both', +\ 'lint_file': 1, \}) diff --git a/doc/ale.txt b/doc/ale.txt index 9b18d3d..bedf0cf 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -278,7 +278,7 @@ Notes: * Fortran: `gcc` * FusionScript: `fusion-lint` * GLSL: glslang -* Go: `gofmt`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`, `staticcheck` +* Go: `gofmt`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` From a786e011278a152271f7037f6e5edab9737a8c1a Mon Sep 17 00:00:00 2001 From: Derrick Nelson Date: Tue, 31 Oct 2017 20:02:59 -0400 Subject: [PATCH 050/390] Prevent logging of errors in the php linter. --- ale_linters/php/php.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/php/php.vim b/ale_linters/php/php.vim index 7158c95..b263c5f 100644 --- a/ale_linters/php/php.vim +++ b/ale_linters/php/php.vim @@ -30,6 +30,6 @@ call ale#linter#Define('php', { \ 'name': 'php', \ 'executable': 'php', \ 'output_stream': 'stdout', -\ 'command': 'php -l -d error_reporting=E_ALL -d display_errors=1 --', +\ 'command': 'php -l -d error_reporting=E_ALL -d display_errors=1 -d log_errors=0 --', \ 'callback': 'ale_linters#php#php#Handle', \}) From 1752ad9ad1cd1263dffaae57b69425f1705b989f Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 2 Nov 2017 10:39:40 +0000 Subject: [PATCH 051/390] #1074 #1077 Add highlight configuration to the FAQ --- README.md | 58 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 40 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 648371b..f10aa5d 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,16 @@ servers with similar enough protocols, like `tsserver`. 1. [How do I disable particular linters?](#faq-disable-linters) 2. [How can I keep the sign gutter open?](#faq-keep-signs) 3. [How can I change the signs ALE uses?](#faq-change-signs) - 4. [How can I show errors or warnings in my statusline?](#faq-statusline) - 5. [How can I show errors or warnings in my lightline?](#faq-lightline) - 6. [How can I change the format for echo messages?](#faq-echo-format) - 7. [How can I execute some code when ALE stops linting?](#faq-autocmd) - 8. [How can I navigate between errors quickly?](#faq-navigation) - 9. [How can I run linters only when I save files?](#faq-lint-on-save) - 10. [How can I use the quickfix list instead of the loclist?](#faq-quickfix) - 11. [How can I check JSX files with both stylelint and eslint?](#faq-jsx-stylelint-eslint) - 12. [Will this plugin eat all of my laptop battery power?](#faq-my-battery-is-sad) + 4. [How can I change or disable the highlights ALE uses?](#faq-change-highlights) + 5. [How can I show errors or warnings in my statusline?](#faq-statusline) + 6. [How can I show errors or warnings in my lightline?](#faq-lightline) + 7. [How can I change the format for echo messages?](#faq-echo-format) + 8. [How can I execute some code when ALE stops linting?](#faq-autocmd) + 9. [How can I navigate between errors quickly?](#faq-navigation) + 10. [How can I run linters only when I save files?](#faq-lint-on-save) + 11. [How can I use the quickfix list instead of the loclist?](#faq-quickfix) + 12. [How can I check JSX files with both stylelint and eslint?](#faq-jsx-stylelint-eslint) + 13. [Will this plugin eat all of my laptop battery power?](#faq-my-battery-is-sad) @@ -373,9 +374,30 @@ highlight clear ALEErrorSign highlight clear ALEWarningSign ``` + + +### 5.iv. How can I change or disable the highlights ALE uses? + +ALE's highlights problems with highlight groups which link to `SpellBad`, +`SpellCap`, `error`, and `todo` groups by default. The characters that are +highlighted depend on the linters being used, and the information provided to +ALE. + +Highlighting can be disabled completely by setting `g:ale_set_highlights` to +`0`. + +```vim +" Set this in your vimrc file to disabling highlighting +let g:ale_set_highlights = 0 +``` + +You can control all of the highlights ALE uses, say if you are using a different +color scheme which produces ugly highlights. See `:help ale-highlights` for more +information. + -### 5.iv. How can I show errors or warnings in my statusline? +### 5.v. How can I show errors or warnings in my statusline? [vim-airline](https://github.com/vim-airline/vim-airline) integrates with ALE for displaying error information in the status bar. If you want to see the @@ -415,7 +437,7 @@ See `:help ale#statusline#Count()` for more information. -### 5.v. How can I show errors or warnings in my lightline? +### 5.vi. How can I show errors or warnings in my lightline? [lightline](https://github.com/itchyny/lightline.vim) does not have built-in support for ALE, nevertheless there is a plugin that adds this functionality: [maximbaz/lightline-ale](https://github.com/maximbaz/lightline-ale). @@ -424,7 +446,7 @@ For more information, check out the sources of that plugin, `:help ale#statuslin -### 5.vi. How can I change the format for echo messages? +### 5.vii. How can I change the format for echo messages? There are 3 global options that allow customizing the echoed message. @@ -449,7 +471,7 @@ Will give you: -### 5.vii. How can I execute some code when ALE stops linting? +### 5.viii. How can I execute some code when ALE stops linting? ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html) event whenever has a linter has been successfully executed and processed. This @@ -464,7 +486,7 @@ augroup END -### 5.viii. How can I navigate between errors quickly? +### 5.ix. How can I navigate between errors quickly? ALE offers some commands with `` keybinds for moving between warnings and errors quickly. You can map the keys Ctrl+j and Ctrl+k to moving between errors @@ -480,7 +502,7 @@ For more information, consult the online documentation with -### 5.ix. How can I run linters only when I save files? +### 5.x. How can I run linters only when I save files? ALE offers an option `g:ale_lint_on_save` for enabling running the linters when files are saved. This option is enabled by default. If you only @@ -500,7 +522,7 @@ files, you can set `g:ale_lint_on_save` to `0`. -### 5.x. How can I use the quickfix list instead of the loclist? +### 5.xi. How can I use the quickfix list instead of the loclist? The quickfix list can be enabled by turning the `g:ale_set_quickfix` option on. If you wish to also disable the loclist, you can disable @@ -527,7 +549,7 @@ let g:ale_keep_list_window_open = 1 -### 5.xi. How can I check JSX files with both stylelint and eslint? +### 5.xii. How can I check JSX files with both stylelint and eslint? If you configure ALE options correctly in your vimrc file, and install the right tools, you can check JSX files with stylelint and eslint. @@ -560,7 +582,7 @@ no linter will be run twice for the same file. -### 5.xii. Will this plugin eat all of my laptop battery power? +### 5.xiii. Will this plugin eat all of my laptop battery power? ALE takes advantage of the power of various tools to check your code. This of course means that CPU time will be used to continuously check your code. If you From 54f44c2d0f61211c5d2643a9f8b9edbc4c6c5e5e Mon Sep 17 00:00:00 2001 From: Antoine Reilles Date: Fri, 3 Nov 2017 19:56:34 +0100 Subject: [PATCH 052/390] windows compatible warning match pattern for erlc (#1071) * windows compatible warning match pattern for erlc --- ale_linters/erlang/erlc.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/erlang/erlc.vim b/ale_linters/erlang/erlc.vim index 559dc67..bddb175 100644 --- a/ale_linters/erlang/erlc.vim +++ b/ale_linters/erlang/erlc.vim @@ -17,7 +17,7 @@ function! ale_linters#erlang#erlc#Handle(buffer, lines) abort " error.erl:4: variable 'B' is unbound " error.erl:3: Warning: function main/0 is unused " error.erl:4: Warning: variable 'A' is unused - let l:pattern = '\v^([^:]+):(\d+): (Warning: )?(.+)$' + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+): (Warning: )?(.+)$' " parse_transforms are a special case. The error message does not indicate a location: " error.erl: undefined parse transform 'some_parse_transform' From c26e5e277e0a0e0849d416775b63753e3aae4be6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 3 Nov 2017 22:08:26 +0000 Subject: [PATCH 053/390] Fix #491 - Only set -x for shellcheck for versions which support the option --- ale_linters/sh/shellcheck.vim | 46 +++++++++++- .../test_shellcheck_command_callback.vader | 73 +++++++++++++++++-- 2 files changed, 109 insertions(+), 10 deletions(-) diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 32b47e2..1f6bdf8 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -15,6 +15,8 @@ let g:ale_sh_shellcheck_executable = let g:ale_sh_shellcheck_options = \ get(g:, 'ale_sh_shellcheck_options', '') +let s:version_cache = {} + function! ale_linters#sh#shellcheck#GetExecutable(buffer) abort return ale#Var(a:buffer, 'sh_shellcheck_executable') endfunction @@ -43,22 +45,58 @@ function! ale_linters#sh#shellcheck#GetDialectArgument(buffer) abort return '' endfunction -function! ale_linters#sh#shellcheck#GetCommand(buffer) abort +function! ale_linters#sh#shellcheck#VersionCheck(buffer) abort + let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) + + " Don't check the version again if we've already cached it. + if has_key(s:version_cache, l:executable) + return '' + endif + + return ale#Escape(l:executable) . ' --version' +endfunction + +" Get the shellcheck version from the cache, or parse it and cache it. +function! s:GetVersion(executable, output) abort + let l:version = get(s:version_cache, a:executable, []) + + for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') + let l:version = ale#semver#Parse(l:match[0]) + let s:version_cache[a:executable] = l:version + endfor + + return l:version +endfunction + +function! s:CanUseExternalOption(version) abort + return !empty(a:version) + \ && ale#semver#GreaterOrEqual(a:version, [0, 4, 0]) +endfunction + +function! ale_linters#sh#shellcheck#GetCommand(buffer, version_output) abort + let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) + let l:version = s:GetVersion(l:executable, a:version_output) + let l:options = ale#Var(a:buffer, 'sh_shellcheck_options') let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions') let l:dialect = ale_linters#sh#shellcheck#GetDialectArgument(a:buffer) + let l:external_option = s:CanUseExternalOption(l:version) ? ' -x' : '' return ale#path#BufferCdString(a:buffer) - \ . ale#Escape(ale_linters#sh#shellcheck#GetExecutable(a:buffer)) + \ . ale#Escape(l:executable) \ . (!empty(l:dialect) ? ' -s ' . l:dialect : '') \ . (!empty(l:options) ? ' ' . l:options : '') \ . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '') - \ . ' -x -f gcc -' + \ . l:external_option + \ . ' -f gcc -' endfunction call ale#linter#Define('sh', { \ 'name': 'shellcheck', \ 'executable_callback': 'ale_linters#sh#shellcheck#GetExecutable', -\ 'command_callback': 'ale_linters#sh#shellcheck#GetCommand', +\ 'command_chain': [ +\ {'callback': 'ale_linters#sh#shellcheck#VersionCheck'}, +\ {'callback': 'ale_linters#sh#shellcheck#GetCommand'}, +\ ], \ 'callback': 'ale#handlers#gcc#HandleGCCFormat', \}) diff --git a/test/command_callback/test_shellcheck_command_callback.vader b/test/command_callback/test_shellcheck_command_callback.vader index 13e9a2c..bf422b2 100644 --- a/test/command_callback/test_shellcheck_command_callback.vader +++ b/test/command_callback/test_shellcheck_command_callback.vader @@ -13,7 +13,7 @@ Before: call ale#test#SetFilename('test.sh') let b:prefix = 'cd ' . ale#Escape(ale#path#Winify(g:dir)) . ' && ' - let b:suffix = ' -x -f gcc -' + let b:suffix = ' -f gcc -' After: Restore @@ -31,14 +31,14 @@ After: Execute(The default shellcheck command should be correct): AssertEqual \ b:prefix . ale#Escape('shellcheck') . b:suffix, - \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) Execute(The shellcheck command should accept options): let b:ale_sh_shellcheck_options = '--foobar' AssertEqual \ b:prefix . ale#Escape('shellcheck') . ' --foobar' . b:suffix, - \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) Execute(The shellcheck command should accept options and exclusions): let b:ale_sh_shellcheck_options = '--foobar' @@ -46,14 +46,14 @@ Execute(The shellcheck command should accept options and exclusions): AssertEqual \ b:prefix . ale#Escape('shellcheck') . ' --foobar -e foo,bar' . b:suffix, - \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) Execute(The shellcheck command should include the dialect): let b:is_bash = 1 AssertEqual \ b:prefix . ale#Escape('shellcheck') . ' -s bash' . b:suffix, - \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) Execute(The shellcheck command should include the dialect before options and exclusions): let b:is_bash = 1 @@ -65,4 +65,65 @@ Execute(The shellcheck command should include the dialect before options and exc \ . ale#Escape('shellcheck') \ . ' -s bash --foobar -e foo,bar' \ . b:suffix, - \ ale_linters#sh#shellcheck#GetCommand(bufnr('')) + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) + +Execute(The VersionCheck function should return the --version command): + AssertEqual + \ ale#Escape('shellcheck') . ' --version', + \ ale_linters#sh#shellcheck#VersionCheck(bufnr('')) + + let g:ale_sh_shellcheck_executable = 'foobar' + + AssertEqual + \ ale#Escape('foobar') . ' --version', + \ ale_linters#sh#shellcheck#VersionCheck(bufnr('')) + +Execute(The -x option should be added when the version is new enough): + AssertEqual + \ b:prefix . ale#Escape('shellcheck') . ' -x' . b:suffix, + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), [ + \ 'ShellCheck - shell script analysis tool', + \ 'version: 0.4.4', + \ 'license: GNU General Public License, version 3', + \ 'website: http://www.shellcheck.net', + \ ]) + + " We should cache the version check + AssertEqual + \ b:prefix . ale#Escape('shellcheck') . ' -x' . b:suffix, + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#sh#shellcheck#VersionCheck(bufnr('')) + +Execute(The version check shouldn't be run again for new versions): + call ale_linters#sh#shellcheck#GetCommand(bufnr(''), [ + \ 'ShellCheck - shell script analysis tool', + \ 'version: 0.4.4', + \ 'license: GNU General Public License, version 3', + \ 'website: http://www.shellcheck.net', + \]) + +Execute(The -x option should not be added when the version is too old): + AssertEqual + \ b:prefix . ale#Escape('shellcheck') . b:suffix, + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), [ + \ 'ShellCheck - shell script analysis tool', + \ 'version: 0.3.9', + \ 'license: GNU General Public License, version 3', + \ 'website: http://www.shellcheck.net', + \ ]) + + " We should cache the version check + AssertEqual + \ b:prefix . ale#Escape('shellcheck') . b:suffix, + \ ale_linters#sh#shellcheck#GetCommand(bufnr(''), []) + +Execute(The version check shouldn't be run again for old versions): + call ale_linters#sh#shellcheck#GetCommand(bufnr(''), [ + \ 'ShellCheck - shell script analysis tool', + \ 'version: 0.3.9', + \ 'license: GNU General Public License, version 3', + \ 'website: http://www.shellcheck.net', + \]) + + AssertEqual '', ale_linters#sh#shellcheck#VersionCheck(bufnr('')) From 9010458581c4a69f6c987830254391d9c041b236 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 4 Nov 2017 10:41:08 +0000 Subject: [PATCH 054/390] #1081 Use executable() for Python executables on Windows, and rename the test files to .exe so they will pass the executable() check --- autoload/ale/python.vim | 2 +- .../with_virtualenv/env/Scripts/{autopep8 => autopep8.exe} | 0 .../with_virtualenv/env/Scripts/{flake8 => flake8.exe} | 0 .../with_virtualenv/env/Scripts/{isort => isort.exe} | 0 .../python_paths/with_virtualenv/env/Scripts/{mypy => mypy.exe} | 0 .../with_virtualenv/env/Scripts/{pylint => pylint.exe} | 0 .../python_paths/with_virtualenv/env/Scripts/{yapf => yapf.exe} | 0 7 files changed, 1 insertion(+), 1 deletion(-) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{autopep8 => autopep8.exe} (100%) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{flake8 => flake8.exe} (100%) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{isort => isort.exe} (100%) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{mypy => mypy.exe} (100%) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{pylint => pylint.exe} (100%) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{yapf => yapf.exe} (100%) diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index d788b77..4734ac4 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -77,7 +77,7 @@ endfunction " Run an executable check for Python scripts. " On Windows, 1 will be returned if the file is merely readable. function! ale#python#IsExecutable(path) abort - return has('win32') ? filereadable(a:path) : executable(a:path) + return executable(a:path) endfunction " Given a buffer number and a command name, find the path to the executable. diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/autopep8 b/test/command_callback/python_paths/with_virtualenv/env/Scripts/autopep8.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/autopep8 rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/autopep8.exe diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/flake8 b/test/command_callback/python_paths/with_virtualenv/env/Scripts/flake8.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/flake8 rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/flake8.exe diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/isort b/test/command_callback/python_paths/with_virtualenv/env/Scripts/isort.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/isort rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/isort.exe diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/mypy b/test/command_callback/python_paths/with_virtualenv/env/Scripts/mypy.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/mypy rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/mypy.exe diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/pylint b/test/command_callback/python_paths/with_virtualenv/env/Scripts/pylint.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/pylint rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/pylint.exe diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/yapf b/test/command_callback/python_paths/with_virtualenv/env/Scripts/yapf.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/yapf rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/yapf.exe From 9c0a5635df6b3d5241f424ab4bfea2817ba89ddc Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 4 Nov 2017 10:46:19 +0000 Subject: [PATCH 055/390] #1081 Remove the ale#python#IsExecutable function --- autoload/ale/fixers/autopep8.vim | 2 +- autoload/ale/fixers/isort.vim | 2 +- autoload/ale/fixers/yapf.vim | 2 +- autoload/ale/python.vim | 8 +------- 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/autoload/ale/fixers/autopep8.vim b/autoload/ale/fixers/autopep8.vim index e0e6205..e2dd7bf 100644 --- a/autoload/ale/fixers/autopep8.vim +++ b/autoload/ale/fixers/autopep8.vim @@ -12,7 +12,7 @@ function! ale#fixers#autopep8#Fix(buffer) abort \ ['autopep8'], \) - if !ale#python#IsExecutable(l:executable) + if !executable(l:executable) return 0 endif diff --git a/autoload/ale/fixers/isort.vim b/autoload/ale/fixers/isort.vim index ddd9561..00d968f 100644 --- a/autoload/ale/fixers/isort.vim +++ b/autoload/ale/fixers/isort.vim @@ -11,7 +11,7 @@ function! ale#fixers#isort#Fix(buffer) abort \ ['isort'], \) - if !ale#python#IsExecutable(l:executable) + if !executable(l:executable) return 0 endif diff --git a/autoload/ale/fixers/yapf.vim b/autoload/ale/fixers/yapf.vim index b15e481..ba7453b 100644 --- a/autoload/ale/fixers/yapf.vim +++ b/autoload/ale/fixers/yapf.vim @@ -11,7 +11,7 @@ function! ale#fixers#yapf#Fix(buffer) abort \ ['yapf'], \) - if !ale#python#IsExecutable(l:executable) + if !executable(l:executable) return 0 endif diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index 4734ac4..2a15f45 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -74,12 +74,6 @@ function! ale#python#FindVirtualenv(buffer) abort return $VIRTUAL_ENV endfunction -" Run an executable check for Python scripts. -" On Windows, 1 will be returned if the file is merely readable. -function! ale#python#IsExecutable(path) abort - return executable(a:path) -endfunction - " Given a buffer number and a command name, find the path to the executable. " First search on a virtualenv for Python, if nothing is found, try the global " command. Returns an empty string if cannot find the executable @@ -96,7 +90,7 @@ function! ale#python#FindExecutable(buffer, base_var_name, path_list) abort \ join([l:virtualenv, s:bin_dir, l:path], s:sep) \) - if ale#python#IsExecutable(l:ve_executable) + if executable(l:ve_executable) return l:ve_executable endif endfor From d851f399c054d487232294d9f1c3a6974215f4a8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 4 Nov 2017 10:54:06 +0000 Subject: [PATCH 056/390] Fix #1058 - Ignore all errors with bad calls to jobstop() in NeoVim --- autoload/ale/job.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/job.vim b/autoload/ale/job.vim index 254f4ee..0f6b857 100644 --- a/autoload/ale/job.vim +++ b/autoload/ale/job.vim @@ -290,7 +290,7 @@ function! ale#job#Stop(job_id) abort " FIXME: NeoVim kills jobs on a timer, but will not kill any processes " which are child processes on Unix. Some work needs to be done to " kill child processes to stop long-running processes like pylint. - call jobstop(a:job_id) + silent! call jobstop(a:job_id) else let l:job = s:job_map[a:job_id].job From 34674e088d7d990d21a4cee5e289200cee5f9d6c Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 5 Nov 2017 15:33:31 +0000 Subject: [PATCH 057/390] Fix #1061 - Handle the filenames returned by javac --- ale_linters/java/javac.vim | 17 ++++++---- .../test_javac_command_callback.vader | 22 +++++++----- test/handler/test_javac_handler.vader | 34 +++++++++++++++++-- 3 files changed, 57 insertions(+), 16 deletions(-) diff --git a/ale_linters/java/javac.vim b/ale_linters/java/javac.vim index d83da18..f7da560 100644 --- a/ale_linters/java/javac.vim +++ b/ale_linters/java/javac.vim @@ -49,7 +49,10 @@ function! ale_linters#java#javac#GetCommand(buffer, import_paths) abort " Create .class files in a temporary directory, which we will delete later. let l:class_file_directory = ale#engine#CreateDirectory(a:buffer) - return 'javac -Xlint' + " Always run javac from the directory the file is in, so we can resolve + " relative paths correctly. + return ale#path#BufferCdString(a:buffer) + \ . 'javac -Xlint' \ . ' ' . l:cp_option \ . ' ' . l:sp_option \ . ' -d ' . ale#Escape(l:class_file_directory) @@ -63,14 +66,15 @@ function! ale_linters#java#javac#Handle(buffer, lines) abort " Main.java:13: warning: [deprecation] donaught() in Testclass has been deprecated " Main.java:16: error: ';' expected - let l:pattern = '\v^.*:(\d+): (.+):(.+)$' + let l:directory = expand('#' . a:buffer . ':p:h') + let l:pattern = '\v^(.*):(\d+): (.+):(.+)$' let l:col_pattern = '\v^(\s*\^)$' let l:symbol_pattern = '\v^ +symbol: *(class|method) +([^ ]+)' let l:output = [] for l:match in ale#util#GetMatches(a:lines, [l:pattern, l:col_pattern, l:symbol_pattern]) if empty(l:match[2]) && empty(l:match[3]) - let l:output[-1].col = len(l:match[1]) + let l:output[-1].col = len(l:match[1]) elseif empty(l:match[3]) " Add symbols to 'cannot find symbol' errors. if l:output[-1].text is# 'error: cannot find symbol' @@ -78,9 +82,10 @@ function! ale_linters#java#javac#Handle(buffer, lines) abort endif else call add(l:output, { - \ 'lnum': l:match[1] + 0, - \ 'text': l:match[2] . ':' . l:match[3], - \ 'type': l:match[2] is# 'error' ? 'E' : 'W', + \ 'filename': ale#path#GetAbsPath(l:directory, l:match[1]), + \ 'lnum': l:match[2] + 0, + \ 'text': l:match[3] . ':' . l:match[4], + \ 'type': l:match[3] is# 'error' ? 'E' : 'W', \}) endif endfor diff --git a/test/command_callback/test_javac_command_callback.vader b/test/command_callback/test_javac_command_callback.vader index 8033e4f..77be1d5 100644 --- a/test/command_callback/test_javac_command_callback.vader +++ b/test/command_callback/test_javac_command_callback.vader @@ -28,12 +28,15 @@ Before: call ale#test#SetFilename('dummy.java') + let g:prefix = 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' + After: call ale#test#RestoreDirectory() Restore unlet! g:cp_sep + unlet! g:prefix delfunction GetCommand @@ -43,20 +46,21 @@ After: call ale#engine#Cleanup(bufnr('')) Execute(The javac callback should return the correct default value): - AssertEqual 'javac -Xlint -d TEMP %t', GetCommand([]) + AssertEqual g:prefix . ' -d TEMP %t', GetCommand([]) Execute(The javac callback should use g:ale_java_javac_classpath correctly): let g:ale_java_javac_classpath = 'foo.jar' AssertEqual - \ 'javac -Xlint' + \ g:prefix \ . ' -cp ' . ale#Escape('foo.jar') \ . ' -d TEMP %t', \ GetCommand([]) Execute(The javac callback should include discovered classpaths): AssertEqual - \ 'javac -Xlint -cp ' + \ g:prefix + \ . ' -cp ' \ . ale#Escape(join(['/foo/bar.jar', '/xyz/abc.jar'], g:cp_sep)) \ . ' -d TEMP %t', \ GetCommand([ @@ -70,7 +74,8 @@ Execute(The javac callback should combine discovered classpaths and manual ones) let g:ale_java_javac_classpath = 'configured.jar' AssertEqual - \ 'javac -Xlint -cp ' + \ g:prefix + \ . ' -cp ' \ . ale#Escape(join( \ [ \ '/foo/bar.jar', @@ -90,7 +95,8 @@ Execute(The javac callback should combine discovered classpaths and manual ones) let g:ale_java_javac_classpath = 'configured.jar' . g:cp_sep . 'configured2.jar' AssertEqual - \ 'javac -Xlint -cp ' + \ g:prefix + \ . ' -cp ' \ . ale#Escape(join( \ [ \ '/foo/bar.jar', @@ -114,7 +120,7 @@ Execute(The javac callback should detect source directories): call ale#engine#InitBufferInfo(bufnr('')) AssertEqual - \ 'javac -Xlint' + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -sourcepath ' . ale#Escape( \ ale#path#Winify(g:dir . '/java_paths/src/main/java/') \ ) @@ -127,7 +133,7 @@ Execute(The javac callback should combine detected source directories and classp call ale#engine#InitBufferInfo(bufnr('')) AssertEqual - \ 'javac -Xlint' + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -cp ' . ale#Escape(join(['/foo/bar.jar', '/xyz/abc.jar'], g:cp_sep)) \ . ' -sourcepath ' . ale#Escape( \ ale#path#Winify(g:dir . '/java_paths/src/main/java/') @@ -146,6 +152,6 @@ Execute(The javac callback should use g:ale_java_javac_options correctly): let b:command = ale_linters#java#javac#GetCommand(bufnr(''), []) AssertEqual - \ 'javac -Xlint' + \ g:prefix \ . ' -d TEMP --anything --else %t', \ GetCommand([]) diff --git a/test/handler/test_javac_handler.vader b/test/handler/test_javac_handler.vader index 2cf3207..3997b42 100644 --- a/test/handler/test_javac_handler.vader +++ b/test/handler/test_javac_handler.vader @@ -1,42 +1,51 @@ Before: runtime ale_linters/java/javac.vim + call ale#test#SetDirectory('/testplugin/test') + call ale#test#SetFilename('dummy.java') + After: + call ale#test#RestoreDirectory() call ale#linter#Reset() Execute(The javac handler should handle cannot find symbol errors): AssertEqual \ [ \ { + \ 'filename': '/tmp/vLPr4Q5/33/foo.java', \ 'lnum': 1, \ 'text': 'error: some error', \ 'type': 'E', \ }, \ { + \ 'filename': '/tmp/vLPr4Q5/33/foo.java', \ 'lnum': 2, \ 'col': 5, \ 'text': 'error: cannot find symbol: BadName', \ 'type': 'E', \ }, \ { + \ 'filename': '/tmp/vLPr4Q5/33/foo.java', \ 'lnum': 34, \ 'col': 5, \ 'text': 'error: cannot find symbol: BadName2', \ 'type': 'E', \ }, \ { + \ 'filename': '/tmp/vLPr4Q5/33/foo.java', \ 'lnum': 37, \ 'text': 'warning: some warning', \ 'type': 'W', \ }, \ { + \ 'filename': '/tmp/vLPr4Q5/33/foo.java', \ 'lnum': 42, \ 'col': 11, \ 'text': 'error: cannot find symbol: bar()', \ 'type': 'E', \ }, \ ], - \ ale_linters#java#javac#Handle(347, [ + \ ale_linters#java#javac#Handle(bufnr(''), [ \ '/tmp/vLPr4Q5/33/foo.java:1: error: some error', \ '/tmp/vLPr4Q5/33/foo.java:2: error: cannot find symbol', \ ' BadName foo() {', @@ -49,9 +58,30 @@ Execute(The javac handler should handle cannot find symbol errors): \ ' symbol: class BadName2', \ ' location: class Bar', \ '/tmp/vLPr4Q5/33/foo.java:37: warning: some warning', - \ '/tmp/vLPr4Q5/264/foo.java:42: error: cannot find symbol', + \ '/tmp/vLPr4Q5/33/foo.java:42: error: cannot find symbol', \ ' this.bar();', \ ' ^', \ ' symbol: method bar()', \ '5 errors', \ ]) + +Execute(The javac handler should resolve files from different directories): + AssertEqual + \ [ + \ { + \ 'filename': ale#path#Winify(g:dir . '/Foo.java'), + \ 'lnum': 1, + \ 'text': 'error: some error', + \ 'type': 'E', + \ }, + \ { + \ 'filename': ale#path#Winify(g:dir . '/Bar.java'), + \ 'lnum': 1, + \ 'text': 'error: some error', + \ 'type': 'E', + \ }, + \ ], + \ ale_linters#java#javac#Handle(bufnr(''), [ + \ './Foo.java:1: error: some error', + \ './Bar.java:1: error: some error', + \ ]) From caed406e16b1c6c4212553b0feec992ca289daac Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 5 Nov 2017 17:34:36 +0000 Subject: [PATCH 058/390] Fix #1062 - Use for the ALELint autocmd, so we don not mess with folds, etc. --- autoload/ale/engine.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 1b22df4..f2553b2 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -312,7 +312,7 @@ function! ale#engine#SetResults(buffer, loclist) abort call ale#engine#RemoveManagedFiles(a:buffer) " Call user autocommands. This allows users to hook into ALE's lint cycle. - silent doautocmd User ALELint + silent doautocmd User ALELint endif endfunction From 7b5108d934d8682490ab3d9af25361e06a3df3f8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 5 Nov 2017 18:37:44 +0000 Subject: [PATCH 059/390] Fix #626 - Automatically use `cargo check` and `cargo check --all-targets` for cargo versions that are new enough --- ale_linters/rust/cargo.vim | 65 +++++++++- doc/ale-rust.txt | 18 ++- test/command_callback/cargo_paths/Cargo.toml | 0 .../test_cargo_command_callbacks.vader | 115 ++++++++++++++++++ 4 files changed, 190 insertions(+), 8 deletions(-) create mode 100644 test/command_callback/cargo_paths/Cargo.toml create mode 100644 test/command_callback/test_cargo_command_callbacks.vader diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index c887ea7..f41cb4b 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -1,7 +1,10 @@ " Author: Daniel Schemala " Description: rustc invoked by cargo for rust files -let g:ale_rust_cargo_use_check = get(g:, 'ale_rust_cargo_use_check', 0) +call ale#Set('rust_cargo_use_check', 1) +call ale#Set('rust_cargo_check_all_targets', 1) + +let s:version_cache = {} function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# '' @@ -13,18 +16,70 @@ function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort endif endfunction -function! ale_linters#rust#cargo#GetCommand(buffer) abort - let l:command = ale#Var(a:buffer, 'rust_cargo_use_check') +function! ale_linters#rust#cargo#VersionCheck(buffer) abort + if has_key(s:version_cache, 'cargo') + return '' + endif + + return 'cargo --version' +endfunction + +function! s:GetVersion(executable, output) abort + let l:version = get(s:version_cache, a:executable, []) + + for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') + let l:version = ale#semver#Parse(l:match[0]) + let s:version_cache[a:executable] = l:version + endfor + + return l:version +endfunction + +function! s:CanUseCargoCheck(buffer, version) abort + " Allow `cargo check` to be disabled. + if !ale#Var(a:buffer, 'rust_cargo_use_check') + return 0 + endif + + return !empty(a:version) + \ && ale#semver#GreaterOrEqual(a:version, [0, 17, 0]) +endfunction + +function! s:CanUseAllTargets(buffer, version) abort + if !ale#Var(a:buffer, 'rust_cargo_use_check') + return 0 + endif + + if !ale#Var(a:buffer, 'rust_cargo_check_all_targets') + return 0 + endif + + return !empty(a:version) + \ && ale#semver#GreaterOrEqual(a:version, [0, 22, 0]) +endfunction + +function! ale_linters#rust#cargo#GetCommand(buffer, version_output) abort + let l:version = s:GetVersion('cargo', a:version_output) + let l:command = s:CanUseCargoCheck(a:buffer, l:version) \ ? 'check' \ : 'build' + let l:all_targets = s:CanUseAllTargets(a:buffer, l:version) + \ ? ' --all-targets' + \ : '' - return 'cargo ' . l:command . ' --frozen --message-format=json -q' + return 'cargo ' + \ . l:command + \ . l:all_targets + \ . ' --frozen --message-format=json -q' endfunction call ale#linter#Define('rust', { \ 'name': 'cargo', \ 'executable_callback': 'ale_linters#rust#cargo#GetCargoExecutable', -\ 'command_callback': 'ale_linters#rust#cargo#GetCommand', +\ 'command_chain': [ +\ {'callback': 'ale_linters#rust#cargo#VersionCheck'}, +\ {'callback': 'ale_linters#rust#cargo#GetCommand'}, +\ ], \ 'callback': 'ale#handlers#rust#HandleRustErrors', \ 'output_stream': 'both', \ 'lint_file': 1, diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index e20aea2..15ffef0 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -41,10 +41,22 @@ cargo *ale-rust-cargo* g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check* *b:ale_rust_cargo_use_check* Type: |Number| - Default: `0` + Default: `1` - When set to `1`, this option will cause ALE to use "cargo check" instead of - "cargo build". "cargo check" is supported since version 1.16.0 of Rust. + When set to `1`, this option will cause ALE to use `cargo check` instead of + `cargo build` . `cargo check` is supported since version 1.16.0 of Rust. + + ALE will never use `cargo check` when the version of `cargo` is less than + 0.17.0. + + +g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets* + *b:ale_rust_cargo_check_all_targets* + Type: |Number| + Default: `1` + + When set to `1`, ALE will set the `--all-targets` option when `cargo check` + is used. See |g:ale_rust_cargo_use_check|, =============================================================================== diff --git a/test/command_callback/cargo_paths/Cargo.toml b/test/command_callback/cargo_paths/Cargo.toml new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader new file mode 100644 index 0000000..d808e19 --- /dev/null +++ b/test/command_callback/test_cargo_command_callbacks.vader @@ -0,0 +1,115 @@ +Before: + Save g:ale_rust_cargo_use_check + Save g:ale_rust_cargo_check_all_targets + + unlet! g:ale_rust_cargo_use_check + unlet! g:ale_cargo_check_all_targets + + runtime ale_linters/rust/cargo.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + + let g:suffix = ' --frozen --message-format=json -q' + +After: + Restore + + unlet! g:suffix + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(An empty string should be returned for the cargo executable when there's no Cargo.toml file): + AssertEqual + \ '', + \ ale_linters#rust#cargo#GetCargoExecutable(bufnr('')) + +Execute(The executable should be returned when there is a Cargo.toml file): + call ale#test#SetFilename('cargo_paths/test.rs') + + AssertEqual + \ 'cargo', + \ ale_linters#rust#cargo#GetCargoExecutable(bufnr('')) + +Execute(The VersionCheck function should return the --version command): + AssertEqual + \ 'cargo --version', + \ ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(The default command should be correct): + AssertEqual + \ 'cargo build' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + +Execute(`cargo check` should be used when the version is new enough): + AssertEqual + \ 'cargo check' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.17.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo check' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(`cargo build` should be used when cargo is too old): + AssertEqual + \ 'cargo build' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.16.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo build' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(`cargo build` should be used when g:ale_rust_cargo_use_check is set to 0): + let g:ale_rust_cargo_use_check = 0 + + AssertEqual + \ 'cargo build' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.24.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo build' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(`cargo check --all-targets` should be used when the version is new enough): + AssertEqual + \ 'cargo check --all-targets' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo check --all-targets' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(--all-targets should not be used when g:ale_rust_cargo_check_all_targets is set to 0): + let g:ale_rust_cargo_check_all_targets = 0 + + AssertEqual + \ 'cargo check' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo check' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) From 7086586b1776d2b5f3bf87a7f0c25595a5d7e1b0 Mon Sep 17 00:00:00 2001 From: David Sierra DiazGranados Date: Sun, 5 Nov 2017 13:53:12 -0500 Subject: [PATCH 060/390] Add executable option for phpmd linter (resolves #1076) (#1078) * Add executable option for phpmd linter (resolves #1076) * Add test for phpmd executable option --- ale_linters/php/phpmd.vim | 15 +++++++++++--- doc/ale-php.txt | 8 ++++++++ .../test_phpmd_command_callbacks.vader | 20 +++++++++++++++++++ 3 files changed, 40 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_phpmd_command_callbacks.vader diff --git a/ale_linters/php/phpmd.vim b/ale_linters/php/phpmd.vim index e4192c7..e945075 100644 --- a/ale_linters/php/phpmd.vim +++ b/ale_linters/php/phpmd.vim @@ -1,11 +1,20 @@ -" Author: medains +" Author: medains , David Sierra " Description: phpmd for PHP files +let g:ale_php_phpmd_executable = get(g:, 'ale_php_phpmd_executable', 'phpmd') + " Set to change the ruleset let g:ale_php_phpmd_ruleset = get(g:, 'ale_php_phpmd_ruleset', 'cleancode,codesize,controversial,design,naming,unusedcode') +function! ale_linters#php#phpmd#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'php_phpmd_executable') +endfunction + function! ale_linters#php#phpmd#GetCommand(buffer) abort - return 'phpmd %s text ' + let l:executable = ale_linters#php#phpmd#GetExecutable(a:buffer) + + return ale#Escape(l:executable) + \ . ' %s text ' \ . ale#Var(a:buffer, 'php_phpmd_ruleset') \ . ' --ignore-violations-on-exit %t' endfunction @@ -30,7 +39,7 @@ endfunction call ale#linter#Define('php', { \ 'name': 'phpmd', -\ 'executable': 'phpmd', +\ 'executable_callback': 'ale_linters#php#phpmd#GetExecutable', \ 'command_callback': 'ale_linters#php#phpmd#GetCommand', \ 'callback': 'ale_linters#php#phpmd#Handle', \}) diff --git a/doc/ale-php.txt b/doc/ale-php.txt index f09c95f..455472f 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -121,6 +121,14 @@ g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global* =============================================================================== phpmd *ale-php-phpmd* +g:ale_php_phpmd_executable *g:ale_php_phpmd_executable* + *b:ale_php_phpmd_executable* + Type: |String| + Default: `'phpmd'` + + This variable sets executable used for phpmd. + + g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset* *b:ale_php_phpmd_ruleset* Type: |String| diff --git a/test/command_callback/test_phpmd_command_callbacks.vader b/test/command_callback/test_phpmd_command_callbacks.vader new file mode 100644 index 0000000..928b977 --- /dev/null +++ b/test/command_callback/test_phpmd_command_callbacks.vader @@ -0,0 +1,20 @@ +Before: + Save g:ale_php_phpmd_executable + + unlet! g:ale_php_phpmd_executable + + runtime ale_linters/php/phpmd.vim + +After: + Restore + + call ale#linter#Reset() + +Execute(Custom executables should be used for the executable and command): + let g:ale_php_phpmd_executable = 'phpmd_test' + + AssertEqual 'phpmd_test', ale_linters#php#phpmd#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('phpmd_test') + \ . ' %s text cleancode,codesize,controversial,design,naming,unusedcode --ignore-violations-on-exit %t', + \ ale_linters#php#phpmd#GetCommand(bufnr('')) From 716b22d524b80941eee6538e988a963f923901f3 Mon Sep 17 00:00:00 2001 From: Simon Bugert Date: Sun, 5 Nov 2017 22:24:41 +0100 Subject: [PATCH 061/390] Add shfmt fixer for sh files (#1083) * Add shfmt fixer for sh files * Add tests for shfmt fixer --- README.md | 4 ++-- autoload/ale/fix/registry.vim | 5 +++++ autoload/ale/fixers/shfmt.vim | 17 +++++++++++++++ doc/ale-sh.txt | 11 ++++++++++ doc/ale.txt | 5 +++-- test/fixers/test_shfmt_fixer_callback.vader | 24 +++++++++++++++++++++ 6 files changed, 62 insertions(+), 4 deletions(-) create mode 100644 autoload/ale/fixers/shfmt.vim create mode 100644 test/fixers/test_shfmt_fixer_callback.vader diff --git a/README.md b/README.md index f10aa5d..3ff0597 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,8 @@ formatting. | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | | AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Awk | [gawk](https://www.gnu.org/software/gawk/)| -| Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/) | -| Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/) | +| Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | +| Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | C | [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/), [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html)| | C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangcheck](http://clang.llvm.org/docs/ClangCheck.html) !!, [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) !!, [gcc](https://gcc.gnu.org/), [clang-format](https://clang.llvm.org/docs/ClangFormat.html)| | CUDA | [nvcc](http://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/index.html) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 37bbee9..24166da 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -132,6 +132,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['reason'], \ 'description': 'Fix ReasonML files with refmt.', \ }, +\ 'shfmt': { +\ 'function': 'ale#fixers#shfmt#Fix', +\ 'suggested_filetypes': ['sh'], +\ 'description': 'Fix sh files with shfmt.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/shfmt.vim b/autoload/ale/fixers/shfmt.vim new file mode 100644 index 0000000..882cf3a --- /dev/null +++ b/autoload/ale/fixers/shfmt.vim @@ -0,0 +1,17 @@ +scriptencoding utf-8 +" Author: Simon Bugert +" Description: Fix sh files with shfmt. + +call ale#Set('sh_shfmt_executable', 'shfmt') +call ale#Set('sh_shfmt_options', '') + +function! ale#fixers#shfmt#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'sh_shfmt_executable') + let l:options = ale#Var(a:buffer, 'sh_shfmt_options') + + return { + \ 'command': ale#Escape(l:executable) + \ . (empty(l:options) ? '' : ' ' . l:options) + \} + +endfunction diff --git a/doc/ale-sh.txt b/doc/ale-sh.txt index 6fbc9fe..941dc59 100644 --- a/doc/ale-sh.txt +++ b/doc/ale-sh.txt @@ -57,5 +57,16 @@ g:ale_sh_shellcheck_exclusions *g:ale_sh_shellcheck_exclusions* \ let b:ale_sh_shellcheck_exclusions = 'SC2034,SC2154,SC2164' < +=============================================================================== +shfmt *ale-sh-shfmt* + +g:ale_sh_shfmt_options *g:ale_sh_shfmt_options* + *b:ale_sh_shfmt_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the shfmt fixer. + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index bedf0cf..f00e1ac 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -173,6 +173,7 @@ CONTENTS *ale-contents* sh....................................|ale-sh-options| shell...............................|ale-sh-shell| shellcheck..........................|ale-sh-shellcheck| + shfmt...............................|ale-sh-shfmt| sml...................................|ale-sml-options| smlnj...............................|ale-sml-smlnj| solidity..............................|ale-solidity-options| @@ -256,8 +257,8 @@ Notes: * Ansible: `ansible-lint` * AsciiDoc: `proselint`, `write-good` * Awk: `gawk` -* Bash: `shell` (-n flag), `shellcheck` -* Bourne Shell: `shell` (-n flag), `shellcheck` +* Bash: `shell` (-n flag), `shellcheck`, `shfmt` +* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` * C: `cppcheck`, `cpplint`!!, `gcc`, `clang`, `clangtidy`!!, `clang-format` * C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `cppcheck`, `cpplint`!!, `gcc`, `clang-format` * CUDA: `nvcc`!! diff --git a/test/fixers/test_shfmt_fixer_callback.vader b/test/fixers/test_shfmt_fixer_callback.vader new file mode 100644 index 0000000..dcdf66b --- /dev/null +++ b/test/fixers/test_shfmt_fixer_callback.vader @@ -0,0 +1,24 @@ +Before: + Save g:ale_sh_shfmt_executable + Save g:ale_sh_shfmt_options + + " Use an invalid global executable, so we don't match it. + let g:ale_sh_shfmt_executable = 'xxxinvalid' + let g:ale_sh_shfmt_options = '' + +Execute(The shfmt callback should return the correct default values): + AssertEqual + \ { + \ 'command': ale#Escape('xxxinvalid'), + \ }, + \ ale#fixers#shfmt#Fix(bufnr('')) + +Execute(The shfmt callback should include custom shfmt options): + let g:ale_sh_shfmt_options = '--some-option' + + AssertEqual + \ { + \ 'command': ale#Escape(g:ale_sh_shfmt_executable) + \ . ' --some-option', + \ }, + \ ale#fixers#shfmt#Fix(bufnr('')) From 3c8e6ed51c4dcae759231d3bd8baff18da30e120 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 5 Nov 2017 21:31:41 +0000 Subject: [PATCH 062/390] Modify the shmft tests so they won't mess with your settings --- test/fixers/test_shfmt_fixer_callback.vader | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/test/fixers/test_shfmt_fixer_callback.vader b/test/fixers/test_shfmt_fixer_callback.vader index dcdf66b..5dc6e86 100644 --- a/test/fixers/test_shfmt_fixer_callback.vader +++ b/test/fixers/test_shfmt_fixer_callback.vader @@ -2,23 +2,23 @@ Before: Save g:ale_sh_shfmt_executable Save g:ale_sh_shfmt_options - " Use an invalid global executable, so we don't match it. - let g:ale_sh_shfmt_executable = 'xxxinvalid' - let g:ale_sh_shfmt_options = '' +After: + Restore Execute(The shfmt callback should return the correct default values): AssertEqual \ { - \ 'command': ale#Escape('xxxinvalid'), + \ 'command': ale#Escape('shfmt'), \ }, \ ale#fixers#shfmt#Fix(bufnr('')) -Execute(The shfmt callback should include custom shfmt options): +Execute(The shfmt executable and options should be configurable): + let g:ale_sh_shfmt_executable = 'foobar' let g:ale_sh_shfmt_options = '--some-option' AssertEqual \ { - \ 'command': ale#Escape(g:ale_sh_shfmt_executable) + \ 'command': ale#Escape('foobar') \ . ' --some-option', \ }, \ ale#fixers#shfmt#Fix(bufnr('')) From fa7d041c26aa6616c13a62274a7fc8458f6096dd Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 5 Nov 2017 21:41:53 +0000 Subject: [PATCH 063/390] Fix #1085 - Add a final newline character to tsserver and LSP messages --- autoload/ale/lsp/message.vim | 4 ++-- autoload/ale/lsp/tsserver_message.vim | 2 +- test/lsp/test_lsp_client_messages.vader | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/autoload/ale/lsp/message.vim b/autoload/ale/lsp/message.vim index 7910247..31a9b21 100644 --- a/autoload/ale/lsp/message.vim +++ b/autoload/ale/lsp/message.vim @@ -53,7 +53,7 @@ function! ale#lsp#message#DidOpen(buffer, language_id) abort \ 'uri': ale#path#ToURI(expand('#' . a:buffer . ':p')), \ 'languageId': a:language_id, \ 'version': ale#lsp#message#GetNextVersionID(), - \ 'text': join(l:lines, "\n"), + \ 'text': join(l:lines, "\n") . "\n", \ }, \}] endfunction @@ -67,7 +67,7 @@ function! ale#lsp#message#DidChange(buffer) abort \ 'uri': ale#path#ToURI(expand('#' . a:buffer . ':p')), \ 'version': ale#lsp#message#GetNextVersionID(), \ }, - \ 'contentChanges': [{'text': join(l:lines, "\n")}] + \ 'contentChanges': [{'text': join(l:lines, "\n") . "\n"}] \}] endfunction diff --git a/autoload/ale/lsp/tsserver_message.vim b/autoload/ale/lsp/tsserver_message.vim index ab18d74..e2706ed 100644 --- a/autoload/ale/lsp/tsserver_message.vim +++ b/autoload/ale/lsp/tsserver_message.vim @@ -28,7 +28,7 @@ function! ale#lsp#tsserver_message#Change(buffer) abort \ 'offset': 1, \ 'endLine': 1073741824, \ 'endOffset': 1, - \ 'insertString': join(l:lines, "\n"), + \ 'insertString': join(l:lines, "\n") . "\n", \}] endfunction diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index 7ec905c..a7660ce 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -45,7 +45,7 @@ Execute(ale#lsp#message#DidOpen() should return correct messages): \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), \ 'languageId': 'typescript', \ 'version': 12, - \ 'text': "foo()\nbar()\nbaz()", + \ 'text': "foo()\nbar()\nbaz()\n", \ }, \ } \ ], @@ -63,7 +63,7 @@ Execute(ale#lsp#message#DidChange() should return correct messages): \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), \ 'version': 34, \ }, - \ 'contentChanges': [{'text': "foo()\nbar()\nbaz()"}], + \ 'contentChanges': [{'text': "foo()\nbar()\nbaz()\n"}], \ } \ ], \ ale#lsp#message#DidChange(bufnr('')) @@ -134,7 +134,7 @@ Execute(ale#lsp#tsserver_message#Change() should return correct messages): \ 'offset': 1, \ 'endLine': 1073741824, \ 'endOffset': 1, - \ 'insertString': "foo()\nbar()\nbaz()", + \ 'insertString': "foo()\nbar()\nbaz()\n", \ } \ ], \ ale#lsp#tsserver_message#Change(bufnr('')) From 89832884c96a9124f6e99999247e77dc6d20f09c Mon Sep 17 00:00:00 2001 From: Dusan Orlovic Date: Mon, 6 Nov 2017 14:17:38 +0100 Subject: [PATCH 064/390] Add example for changing highlight color Added example on how to actually change the color. Related to #1077 --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ff0597..b8be475 100644 --- a/README.md +++ b/README.md @@ -392,8 +392,13 @@ let g:ale_set_highlights = 0 ``` You can control all of the highlights ALE uses, say if you are using a different -color scheme which produces ugly highlights. See `:help ale-highlights` for more -information. +color scheme which produces ugly highlights. For example: + +```vim +highlight ALEWarning ctermbg=DarkMagenta +``` + +See `:help ale-highlights` for more information. From 8e71f82f8f4f0336ae74fe0e77398c27ea0c5309 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 6 Nov 2017 22:46:32 +0000 Subject: [PATCH 065/390] #1006 Fix raw message handling for LSP support in NeoVim --- autoload/ale/job.vim | 17 ++++++++--------- test/test_line_join.vader | 24 ++++++------------------ 2 files changed, 14 insertions(+), 27 deletions(-) diff --git a/autoload/ale/job.vim b/autoload/ale/job.vim index 0f6b857..e6a75c8 100644 --- a/autoload/ale/job.vim +++ b/autoload/ale/job.vim @@ -25,6 +25,11 @@ endfunction " Note that jobs and IDs are the same thing on NeoVim. function! ale#job#JoinNeovimOutput(job, last_line, data, mode, callback) abort + if a:mode is# 'raw' + call a:callback(a:job, join(a:data, "\n")) + return '' + endif + let l:lines = a:data[:-2] if len(a:data) > 1 @@ -34,15 +39,9 @@ function! ale#job#JoinNeovimOutput(job, last_line, data, mode, callback) abort let l:new_last_line = a:last_line . a:data[0] endif - if a:mode is# 'raw' - if !empty(l:lines) - call a:callback(a:job, join(l:lines, "\n") . "\n") - endif - else - for l:line in l:lines - call a:callback(a:job, l:line) - endfor - endif + for l:line in l:lines + call a:callback(a:job, l:line) + endfor return l:new_last_line endfunction diff --git a/test/test_line_join.vader b/test/test_line_join.vader index 0426429..c93b192 100644 --- a/test/test_line_join.vader +++ b/test/test_line_join.vader @@ -62,8 +62,8 @@ Execute (ALE should pass on full lines for NeoVim for raw data): Execute (ALE should pass on a single long line): let g:last_line = ale#job#JoinNeovimOutput(1, '', ['x'], 'raw', function('RawCallback')) - AssertEqual '', g:data - AssertEqual 'x', g:last_line + AssertEqual 'x', g:data + AssertEqual '', g:last_line Execute (ALE should handle just a single line of output): let g:last_line = ale#job#JoinNeovimOutput(1, '', ['x', ''], 'raw', function('RawCallback')) @@ -71,20 +71,8 @@ Execute (ALE should handle just a single line of output): AssertEqual "x\n", g:data AssertEqual '', g:last_line -Execute (ALE should join two incomplete pieces of large lines together): - let g:last_line = ale#job#JoinNeovimOutput(1, 'x', ['y'], 'raw', function('RawCallback')) +Execute (ALE should pass on two lines and one incomplete one): + let g:last_line = ale#job#JoinNeovimOutput(1, '', ['y', 'z', 'a'], 'raw', function('RawCallback')) - AssertEqual '', g:data - AssertEqual 'xy', g:last_line - -Execute (ALE join incomplete lines, and set new ones): - let g:last_line = ale#job#JoinNeovimOutput(1, 'x', ['y', 'z', 'a'], 'raw', function('RawCallback')) - - AssertEqual "xy\nz\n", g:data - AssertEqual 'a', g:last_line - -Execute (ALE join incomplete lines, and set new ones, with two elements): - let g:last_line = ale#job#JoinNeovimOutput(1, 'x', ['y', 'z'], 'raw', function('RawCallback')) - - AssertEqual "xy\n", g:data - AssertEqual 'z', g:last_line + AssertEqual "y\nz\na", g:data + AssertEqual '', g:last_line From b5254e97608fb6b64e30b78b3d81171574426dab Mon Sep 17 00:00:00 2001 From: aurieh Date: Mon, 30 Oct 2017 14:39:23 +0200 Subject: [PATCH 066/390] Add dart LSP (resolves #1006) --- ale_linters/dart/language_server.vim | 30 ++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 ale_linters/dart/language_server.vim diff --git a/ale_linters/dart/language_server.vim b/ale_linters/dart/language_server.vim new file mode 100644 index 0000000..15c7701 --- /dev/null +++ b/ale_linters/dart/language_server.vim @@ -0,0 +1,30 @@ +" Author: aurieh +" Description: A language server for dart + +call ale#Set('dart_language_server_executable', 'dart_language_server') + +function! ale_linters#dart#language_server#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'dart_language_server_executable') +endfunction + +function! ale_linters#dart#language_server#GetLanguage(buffer) abort + return 'dart' +endfunction + +function! ale_linters#dart#language_server#GetProjectRoot(buffer) abort + " Note: pub only looks for pubspec.yaml, there's no point in adding + " support for pubspec.yml + let l:pubspec = ale#path#FindNearestFile(a:buffer, 'pubspec.yaml') + + return !empty(l:pubspec) ? fnamemodify(l:pubspec, ':h:h') : '' +endfunction + +call ale#linter#Define('dart', { +\ 'name': 'language_server', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale_linters#dart#language_server#GetExecutable', +\ 'command_callback': 'ale_linters#dart#language_server#GetExecutable', +\ 'language_callback': 'ale_linters#dart#language_server#GetLanguage', +\ 'project_root_callback': 'ale_linters#dart#language_server#GetProjectRoot', +\}) + From 3a57e4d1516c31e305d9f374d2f83a9a541afa52 Mon Sep 17 00:00:00 2001 From: aurieh Date: Mon, 30 Oct 2017 18:46:02 +0200 Subject: [PATCH 067/390] Update doc and README for Dart LSP --- README.md | 2 +- doc/ale.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b8be475..088c08c 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ formatting. | CSS | [csslint](http://csslint.net/), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | | Cython (pyrex filetype) | [cython](http://cython.org/) | | D | [dmd](https://dlang.org/dmd-linux.html) | -| Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !! | +| Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !!, [language_server](https://github.com/natebosch/dart_language_server) | | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | diff --git a/doc/ale.txt b/doc/ale.txt index f00e1ac..67a5a13 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -270,7 +270,7 @@ Notes: * CSS: `csslint`, `stylelint`, `prettier` * Cython (pyrex filetype): `cython` * D: `dmd` -* Dart: `dartanalyzer`!! +* Dart: `dartanalyzer`!!, `language_server` * Dockerfile: `hadolint` * Elixir: `credo`, `dogma`!! * Elm: `elm-format, elm-make` From d97924b6986216aea3eae68a3fdc27b9bde341bb Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 7 Nov 2017 19:47:20 +0000 Subject: [PATCH 068/390] Tell users when a fixer does not exist, and make the no fixers message softer --- autoload/ale/fix.vim | 14 ++++++++++++-- test/test_ale_fix.vader | 24 ++++++++++++++++++++++-- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index a9bb7d4..677fb3d 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -352,11 +352,21 @@ function! ale#fix#Fix(...) abort throw "fixing_flag must be either '' or 'save_file'" endif - let l:callback_list = s:GetCallbacks() + try + let l:callback_list = s:GetCallbacks() + catch /E700/ + let l:function_name = join(split(split(v:exception, ':')[3])) + echom printf( + \ 'There is no fixer named `%s`. Check :ALEFixSuggest', + \ l:function_name, + \) + + return 0 + endtry if empty(l:callback_list) if l:fixing_flag is# '' - echoerr 'No fixers have been defined. Try :ALEFixSuggest' + echom 'No fixers have been defined. Try :ALEFixSuggest' endif return 0 diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index fac9a25..fbf4755 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -71,6 +71,16 @@ Before: \}) endfunction + function GetLastMessage() + redir => l:output + silent mess + redir END + + let l:lines = split(l:output, "\n") + + return empty(l:lines) ? '' : l:lines[-1] + endfunction + After: Restore unlet! g:ale_run_synchronously @@ -88,6 +98,7 @@ After: delfunction RemoveLastLineOneArg delfunction TestCallback delfunction SetUpLinters + delfunction GetLastMessage call ale#test#RestoreDirectory() @@ -104,14 +115,17 @@ After: let g:ale_fix_buffer_data = {} + " Clear the messages between tests. + echomsg '' + Given testft (A file with three lines): a b c Execute(ALEFix should complain when there are no functions to call): - AssertThrows ALEFix - AssertEqual 'Vim(echoerr):No fixers have been defined. Try :ALEFixSuggest', g:vader_exception + ALEFix + AssertEqual 'No fixers have been defined. Try :ALEFixSuggest', GetLastMessage() Execute(ALEFix should apply simple functions): let g:ale_fixers.testft = ['AddCarets'] @@ -450,3 +464,9 @@ Expect(An extra line should be added): b c d + +Execute(ALE should print a message telling you something isn't a valid fixer when you type some nonsense): + let g:ale_fixers.testft = ['CatLine', 'invalidname'] + ALEFix + + AssertEqual 'There is no fixer named `invalidname`. Check :ALEFixSuggest', GetLastMessage() From 1bf894f48c2169e18e5978c9347e40f186e425ab Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 7 Nov 2017 23:20:14 +0000 Subject: [PATCH 069/390] Fix #1086 - Implement command chaining for fixers --- autoload/ale/fix.vim | 57 ++++++++++++++++++++++---- doc/ale.txt | 20 +++++++++ test/test_ale_fix.vader | 89 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 159 insertions(+), 7 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 677fb3d..a57ad19 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -108,17 +108,27 @@ function! s:HandleExit(job_id, exit_code) abort let l:job_info.output = readfile(l:job_info.file_to_read) endif + let l:chain_callback = get(l:job_info, 'chain_with', v:null) + " Use the output of the job for changing the file if it isn't empty, " otherwise skip this job and use the input from before. - let l:input = !empty(l:job_info.output) + " + " We'll use the input from before for chained commands. + let l:input = l:chain_callback is v:null && !empty(l:job_info.output) \ ? l:job_info.output \ : l:job_info.input + let l:next_index = l:chain_callback is v:null + \ ? l:job_info.callback_index + 1 + \ : l:job_info.callback_index + call s:RunFixer({ \ 'buffer': l:buffer, \ 'input': l:input, + \ 'output': l:job_info.output, \ 'callback_list': l:job_info.callback_list, - \ 'callback_index': l:job_info.callback_index + 1, + \ 'callback_index': l:next_index, + \ 'chain_callback': l:chain_callback, \}) endfunction @@ -172,6 +182,26 @@ function! s:RunJob(options) abort let l:input = a:options.input let l:output_stream = a:options.output_stream let l:read_temporary_file = a:options.read_temporary_file + let l:chain_with = a:options.chain_with + + if empty(l:command) + " If there's nothing further to chain the command with, stop here. + if l:chain_with is v:null + return 0 + endif + + " If there's another chained callback to run, then run that. + call s:RunFixer({ + \ 'buffer': l:buffer, + \ 'input': l:input, + \ 'callback_index': a:options.callback_index, + \ 'callback_list': a:options.callback_list, + \ 'chain_callback': l:chain_with, + \ 'output': [], + \}) + + return 1 + endif let [l:temporary_file, l:command] = ale#command#FormatCommand(l:buffer, l:command, 1) call s:CreateTemporaryFileForJob(l:buffer, l:temporary_file, l:input) @@ -186,8 +216,9 @@ function! s:RunJob(options) abort \ 'buffer': l:buffer, \ 'input': l:input, \ 'output': [], - \ 'callback_list': a:options.callback_list, + \ 'chain_with': l:chain_with, \ 'callback_index': a:options.callback_index, + \ 'callback_list': a:options.callback_list, \} if l:read_temporary_file @@ -250,13 +281,24 @@ function! s:RunFixer(options) abort let l:buffer = a:options.buffer let l:input = a:options.input let l:index = a:options.callback_index + let l:chain_callback = get(a:options, 'chain_callback', v:null) while len(a:options.callback_list) > l:index - let l:Function = a:options.callback_list[l:index] + let l:Function = l:chain_callback isnot v:null + \ ? ale#util#GetFunction(l:chain_callback) + \ : a:options.callback_list[l:index] - let l:result = ale#util#FunctionArgCount(l:Function) == 1 - \ ? call(l:Function, [l:buffer]) - \ : call(l:Function, [l:buffer, copy(l:input)]) + if l:chain_callback isnot v:null + " Chained commands accept (buffer, output, [input]) + let l:result = ale#util#FunctionArgCount(l:Function) == 2 + \ ? call(l:Function, [l:buffer, a:options.output]) + \ : call(l:Function, [l:buffer, a:options.output, copy(l:input)]) + else + " Chained commands accept (buffer, [input]) + let l:result = ale#util#FunctionArgCount(l:Function) == 1 + \ ? call(l:Function, [l:buffer]) + \ : call(l:Function, [l:buffer, copy(l:input)]) + endif if type(l:result) == type(0) && l:result == 0 " When `0` is returned, skip this item. @@ -271,6 +313,7 @@ function! s:RunFixer(options) abort \ 'input': l:input, \ 'output_stream': get(l:result, 'output_stream', 'stdout'), \ 'read_temporary_file': get(l:result, 'read_temporary_file', 0), + \ 'chain_with': get(l:result, 'chain_with', v:null), \ 'callback_list': a:options.callback_list, \ 'callback_index': l:index, \}) diff --git a/doc/ale.txt b/doc/ale.txt index 67a5a13..d3efcc1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -443,6 +443,26 @@ are supported for running the commands. for commands which need to modify some file on disk in order to fix files. + `chain_with` An optional key for defining a callback to call next. + + The callback must accept two or three arguments, + `(buffer, output)` or `(buffer, output, input)` . + Functions receiving a variable number of arguments will + only receive the first two values. The `output` argument + will contain the lines of output from the command run. + The `input` argument is the List of lines for the + buffer, after applying any previous fixers. + + The callback must return the same values returned for + any fixer function. This allows fixer functions to be + chained recursively. + + When the command string returned for a fixer is an empty + string, the next command in the chain will still be run. + This allows commands to be skipped, like version checks + that are cached. An empty List will be passed to the + next callback in the chain for the `output`. + *ale-fix-configuration* Synchronous functions and asynchronous jobs will be run in a sequence for diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index fbf4755..ffe3d93 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -62,6 +62,49 @@ Before: return [{'lnum': 1, 'col': 1, 'text': 'xxx'}] endfunction + function! FirstChainCallback(buffer) + return {'command': 'echo echoline', 'chain_with': 'SecondChainCallback'} + endfunction + + function! FirstChainCallbackSkipped(buffer) + return {'command': '', 'chain_with': 'SecondChainCallback'} + endfunction + + function! FirstChainCallbackSecondSkipped(buffer) + return {'command': 'echo skipit', 'chain_with': 'SecondChainCallback'} + endfunction + + function! SecondChainCallback(buffer, output) + let l:previous_line = empty(a:output) + \ ? 'emptydefault' + \ : join(split(a:output[0])) + + if l:previous_line is# 'skipit' + return {'command': '', 'chain_with': 'ThirdChainCallback'} + endif + + return { + \ 'command': 'echo ' . l:previous_line, + \ 'chain_with': 'ThirdChainCallback', + \} + endfunction + + function! ThirdChainCallback(buffer, output, input) + let l:previous_line = empty(a:output) + \ ? 'thirddefault' + \ : join(split(a:output[0])) + + return a:input + [l:previous_line] + endfunction + + function! ChainWhereLastIsSkipped(buffer) + return {'command': 'echo echoline', 'chain_with': 'ChainEndSkipped'} + endfunction + + function! ChainEndSkipped(buffer, output) + return {'command': ''} + endfunction + function! SetUpLinters() call ale#linter#Define('testft', { \ 'name': 'testlinter', @@ -97,6 +140,13 @@ After: delfunction RemoveLastLine delfunction RemoveLastLineOneArg delfunction TestCallback + delfunction FirstChainCallback + delfunction FirstChainCallbackSkipped + delfunction FirstChainCallbackSecondSkipped + delfunction SecondChainCallback + delfunction ThirdChainCallback + delfunction ChainWhereLastIsSkipped + delfunction ChainEndSkipped delfunction SetUpLinters delfunction GetLastMessage @@ -470,3 +520,42 @@ Execute(ALE should print a message telling you something isn't a valid fixer whe ALEFix AssertEqual 'There is no fixer named `invalidname`. Check :ALEFixSuggest', GetLastMessage() + +Execute(Test fixing with chained callbacks): + let g:ale_fixers.testft = ['FirstChainCallback'] + ALEFix + +Expect(The echoed line should be added): + a + b + c + echoline + +Execute(Test fixing with chained callback where the first command is skipped): + let g:ale_fixers.testft = ['FirstChainCallbackSkipped'] + ALEFix + +Expect(The default line should be added): + a + b + c + emptydefault + +Execute(Test fixing with chained callback where the second command is skipped): + let g:ale_fixers.testft = ['FirstChainCallbackSecondSkipped'] + ALEFix + +Expect(The default line should be added): + a + b + c + thirddefault + +Execute(Test fixing with chained callback where the final callback is skipped): + let g:ale_fixers.testft = ['ChainWhereLastIsSkipped'] + ALEFix + +Expect(The lines should be the same): + a + b + c From 248a5eb2f61aafdc7a20d3eea5709476c2a21a5b Mon Sep 17 00:00:00 2001 From: Taylor Blau Date: Tue, 7 Nov 2017 22:11:49 -0800 Subject: [PATCH 070/390] ale_linters: add 'dafny' linter --- README.md | 1 + ale_linters/dafny/dafny.vim | 24 ++++++++++++++++++++++++ doc/ale.txt | 1 + test/handler/test_dafny_handler.vader | 26 ++++++++++++++++++++++++++ 4 files changed, 52 insertions(+) create mode 100644 ale_linters/dafny/dafny.vim create mode 100644 test/handler/test_dafny_handler.vader diff --git a/README.md b/README.md index 088c08c..ca0405f 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ formatting. | CSS | [csslint](http://csslint.net/), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | | Cython (pyrex filetype) | [cython](http://cython.org/) | | D | [dmd](https://dlang.org/dmd-linux.html) | +| Dafny | [dafny](https://rise4fun.com/Dafny) | | Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !!, [language_server](https://github.com/natebosch/dart_language_server) | | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | diff --git a/ale_linters/dafny/dafny.vim b/ale_linters/dafny/dafny.vim new file mode 100644 index 0000000..8f6c62b --- /dev/null +++ b/ale_linters/dafny/dafny.vim @@ -0,0 +1,24 @@ +" Author: Taylor Blau + +function! ale_linters#dafny#dafny#Handle(buffer, lines) abort + let l:pattern = '\v(.*)\((\d+),(\d+)\): (.*): (.*)' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'bufnr': a:buffer, + \ 'col': l:match[3] + 0, + \ 'lnum': l:match[2] + 0, + \ 'text': l:match[5], + \ 'type': l:match[4] =~# '^Error' ? 'E' : 'W' + \ }) + endfor + return l:output +endfunction + +call ale#linter#Define('dafny', { +\ 'name': 'dafny', +\ 'executable': 'dafny', +\ 'command': 'dafny %s /compile:0', +\ 'callback': 'ale_linters#dafny#dafny#Handle', +\ }) diff --git a/doc/ale.txt b/doc/ale.txt index d3efcc1..9ca0c72 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -270,6 +270,7 @@ Notes: * CSS: `csslint`, `stylelint`, `prettier` * Cython (pyrex filetype): `cython` * D: `dmd` +* Dafny: `dafny`!! * Dart: `dartanalyzer`!!, `language_server` * Dockerfile: `hadolint` * Elixir: `credo`, `dogma`!! diff --git a/test/handler/test_dafny_handler.vader b/test/handler/test_dafny_handler.vader new file mode 100644 index 0000000..1de9a77 --- /dev/null +++ b/test/handler/test_dafny_handler.vader @@ -0,0 +1,26 @@ +Execute(The Dafny handler should parse output correctly): + runtime ale_linters/dafny/dafny.vim + AssertEqual + \ [ + \ { + \ 'bufnr': 0, + \ 'col': 45, + \ 'lnum': 123, + \ 'text': 'A precondition for this call might not hold.', + \ 'type': 'E' + \ }, + \ { + \ 'bufnr': 0, + \ 'col': 90, + \ 'lnum': 678, + \ 'text': 'This is the precondition that might not hold.', + \ 'type': 'W' + \ } + \ ], + \ ale_linters#dafny#dafny#Handle(0, [ + \ 'File.dfy(123,45): Error BP5002: A precondition for this call might not hold.', + \ 'File.dfy(678,90): Related location: This is the precondition that might not hold.' + \ ]) + +After: + call ale#linter#Reset() From 105251c1de75d2c6775175eb012bf8eb600e2a44 Mon Sep 17 00:00:00 2001 From: Taylor Blau Date: Tue, 7 Nov 2017 22:18:49 -0800 Subject: [PATCH 071/390] README: denote that 'Dafny' linter checks files --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca0405f..624b5cd 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ formatting. | CSS | [csslint](http://csslint.net/), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | | Cython (pyrex filetype) | [cython](http://cython.org/) | | D | [dmd](https://dlang.org/dmd-linux.html) | -| Dafny | [dafny](https://rise4fun.com/Dafny) | +| Dafny | [dafny](https://rise4fun.com/Dafny) !! | | Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !!, [language_server](https://github.com/natebosch/dart_language_server) | | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | From da8012971a5f0e6af63b94bc2fc2e8307c09e1c2 Mon Sep 17 00:00:00 2001 From: Taylor Blau Date: Wed, 8 Nov 2017 09:28:24 -0800 Subject: [PATCH 072/390] ale_linters/dafny: lint only saved files --- ale_linters/dafny/dafny.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/ale_linters/dafny/dafny.vim b/ale_linters/dafny/dafny.vim index 8f6c62b..8bbf1b1 100644 --- a/ale_linters/dafny/dafny.vim +++ b/ale_linters/dafny/dafny.vim @@ -21,4 +21,5 @@ call ale#linter#Define('dafny', { \ 'executable': 'dafny', \ 'command': 'dafny %s /compile:0', \ 'callback': 'ale_linters#dafny#dafny#Handle', +\ 'lint_file': 1, \ }) From 8a4cf923a8a3017fa683bd27d699d9b14720cd66 Mon Sep 17 00:00:00 2001 From: Auri Date: Wed, 8 Nov 2017 19:58:56 +0200 Subject: [PATCH 073/390] Add PyLS linter (#1097) * Support PyLS (python language server) * Replace pyls#GetProjectRoot and add more config types to ale#python#FindProjectRoot --- README.md | 2 +- ale_linters/python/pyls.vim | 21 +++++++++++++++++++++ autoload/ale/python.vim | 2 ++ doc/ale-python.txt | 9 +++++++++ doc/ale.txt | 3 ++- 5 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 ale_linters/python/pyls.vim diff --git a/README.md b/README.md index 624b5cd..9c5bc5a 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ formatting. | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | -| Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | +| Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | diff --git a/ale_linters/python/pyls.vim b/ale_linters/python/pyls.vim new file mode 100644 index 0000000..1b91c2c --- /dev/null +++ b/ale_linters/python/pyls.vim @@ -0,0 +1,21 @@ +" Author: aurieh +" Description: A language server for Python + +call ale#Set('python_pyls_executable', 'pyls') + +function! ale_linters#python#pyls#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'python_pyls_executable') +endfunction + +function! ale_linters#python#pyls#GetLanguage(buffer) abort + return 'python' +endfunction + +call ale#linter#Define('python', { +\ 'name': 'pyls', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale_linters#python#pyls#GetExecutable', +\ 'command_callback': 'ale_linters#python#pyls#GetExecutable', +\ 'language_callback': 'ale_linters#python#pyls#GetLanguage', +\ 'project_root_callback': 'ale#python#FindProjectRoot', +\}) diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index 2a15f45..90721ef 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -18,6 +18,8 @@ function! ale#python#FindProjectRootIni(buffer) abort \|| filereadable(l:path . '/setup.cfg') \|| filereadable(l:path . '/pytest.ini') \|| filereadable(l:path . '/tox.ini') + \|| filereadable(l:path . '/pycodestyle.cfg') + \|| filereadable(l:path . '/flake8.cfg') return l:path endif endfor diff --git a/doc/ale-python.txt b/doc/ale-python.txt index 755094a..e34b548 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -189,6 +189,15 @@ g:ale_python_pylint_use_global *g:ale_python_pylint_use_global* See |ale-integrations-local-executables| +=============================================================================== +pyls *ale-python-pyls* + +g:ale_python_pyls_executable *g:ale_python_pyls_executable* + *b:ale_python_pyls_executable* + Type: |String| + Default: `pyls` + + See |ale-integrations-local-executables| =============================================================================== yapf *ale-python-yapf* diff --git a/doc/ale.txt b/doc/ale.txt index 9ca0c72..2ee2c2d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -145,6 +145,7 @@ CONTENTS *ale-contents* mypy................................|ale-python-mypy| pycodestyle.........................|ale-python-pycodestyle| pylint..............................|ale-python-pylint| + pyls................................|ale-python-pyls| yapf................................|ale-python-yapf| r.....................................|ale-r-options| lintr...............................|ale-r-lintr| @@ -309,7 +310,7 @@ Notes: * Pod: `proselint`, `write-good` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` -* Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pylint`!!, `yapf` +* Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `refmt` * reStructuredText: `proselint`, `write-good` From 8ef8a35462e9d3fbfe3fdf704e06ab957fb4ed7f Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 9 Nov 2017 10:32:41 +0000 Subject: [PATCH 074/390] Fix #1101 - Ignore no-implicit-dependencies errors until TSLint supports checking via stdin properly --- ale_linters/typescript/tslint.vim | 4 ++++ test/handler/test_tslint_handler.vader | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/ale_linters/typescript/tslint.vim b/ale_linters/typescript/tslint.vim index c3852b8..e366af8 100644 --- a/ale_linters/typescript/tslint.vim +++ b/ale_linters/typescript/tslint.vim @@ -24,6 +24,10 @@ function! ale_linters#typescript#tslint#Handle(buffer, lines) abort let l:output = [] for l:error in ale#util#FuzzyJSONDecode(a:lines, []) + if get(l:error, 'ruleName', '') is# 'no-implicit-dependencies' + continue + endif + call add(l:output, { \ 'filename': ale#path#GetAbsPath(l:dir, l:error.name), \ 'type': (get(l:error, 'ruleSeverity', '') is# 'WARNING' ? 'W' : 'E'), diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index 2ed3357..db6294c 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -252,3 +252,26 @@ Execute(The tslint handler should report errors when the ignore option is on, bu \ 'position': 1 \ } \ }])]) + +Execute(The tslint handler should not report no-implicit-dependencies errors): + call ale#test#SetFilename('app/test.ts') + + AssertEqual + \ [ + \ ], + \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([{ + \ 'endPosition': { + \ 'character': 0, + \ 'line': 1, + \ 'position': 1 + \ }, + \ 'failure': 'this is ignored', + \ 'name': 'test.ts', + \ 'ruleName': 'no-implicit-dependencies', + \ 'ruleSeverity': 'ERROR', + \ 'startPosition': { + \ 'character': 0, + \ 'line': 1, + \ 'position': 1 + \ } + \ }])]) From 732d8e3ed6deb1b16bf47e21ce1a823e5e23228b Mon Sep 17 00:00:00 2001 From: Marcus Zanona Date: Thu, 9 Nov 2017 09:49:44 -0200 Subject: [PATCH 075/390] Add support for linting less files with lessc --- README.md | 1 + ale_linters/less/lessc.vim | 36 ++++++++++++++++++++++++++++++++++++ doc/ale-less.txt | 11 +++++++++++ doc/ale.txt | 2 ++ 4 files changed, 50 insertions(+) create mode 100755 ale_linters/less/lessc.vim diff --git a/README.md b/README.md index 9c5bc5a..7c6488c 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,7 @@ formatting. | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Less | [lessc](https://www.npmjs.com/package/less) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim new file mode 100755 index 0000000..3f6e265 --- /dev/null +++ b/ale_linters/less/lessc.vim @@ -0,0 +1,36 @@ +" Author: zanona , w0rp +" Description: This file adds support for checking Less code with lessc. + +call ale#Set('less_lessc_options', '') + +function! ale_linters#less#lessc#GetCommand(buffer) abort + return 'lessc' + \ . ' --no-color --lint ' + \ . ale#Var(a:buffer, 'less_lessc_options') + \ . ' %t' +endfunction + +function! ale_linters#less#lessc#Handle(buffer, lines) abort + " Matches patterns like the following: + let l:pattern = '^\(\w\+\): \(.\{-}\) in \(.\{-}\) on line \(\d\+\), column \(\d\+\):$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'lnum': l:match[4] + 0, + \ 'col': l:match[5] + 0, + \ 'text': l:match[2], + \ 'type': 'E', + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('less', { +\ 'name': 'lessc', +\ 'executable': 'lessc', +\ 'output_stream': 'stderr', +\ 'command_callback': 'ale_linters#less#lessc#GetCommand', +\ 'callback': 'ale_linters#less#lessc#Handle', +\}) diff --git a/doc/ale-less.txt b/doc/ale-less.txt index a6b5998..cac9c9a 100644 --- a/doc/ale-less.txt +++ b/doc/ale-less.txt @@ -2,6 +2,17 @@ ALE Less Integration *ale-less-options* +=============================================================================== +lessc *ale-less-lessc* + +g:ale_less_lessc_options *g:ale_less_lessc_options* + *b:ale_less_lessc_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to lessc. + + =============================================================================== prettier *ale-less-prettier* diff --git a/doc/ale.txt b/doc/ale.txt index 2ee2c2d..ffe7ac7 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -105,6 +105,7 @@ CONTENTS *ale-contents* latex.................................|ale-latex-options| write-good..........................|ale-latex-write-good| less..................................|ale-less-options| + lessc...............................|ale-less-lessc-options| prettier............................|ale-less-prettier| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| @@ -293,6 +294,7 @@ Notes: * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` +* Less: `lessc` * LLVM: `llc` * Lua: `luacheck` * Mail: `proselint`, `vale` From bcc215c4e022704ffe77fb0cd8832c652e3414b0 Mon Sep 17 00:00:00 2001 From: wuqiong4945 Date: Thu, 9 Nov 2017 21:14:29 +0800 Subject: [PATCH 076/390] add 'output_stream': 'stderr', let golint work --- ale_linters/go/golint.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/ale_linters/go/golint.vim b/ale_linters/go/golint.vim index cc807fe..708cf15 100644 --- a/ale_linters/go/golint.vim +++ b/ale_linters/go/golint.vim @@ -3,6 +3,7 @@ call ale#linter#Define('go', { \ 'name': 'golint', +\ 'output_stream': 'stderr', \ 'executable': 'golint', \ 'command': 'golint %t', \ 'callback': 'ale#handlers#unix#HandleAsWarning', From decf8188bc07a097e855af2b424d68374438c635 Mon Sep 17 00:00:00 2001 From: Marcus Zanona Date: Thu, 9 Nov 2017 13:39:38 -0200 Subject: [PATCH 077/390] Adjust formatting on less#lessc linter --- ale_linters/less/lessc.vim | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index 3f6e265..941607b 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -5,9 +5,9 @@ call ale#Set('less_lessc_options', '') function! ale_linters#less#lessc#GetCommand(buffer) abort return 'lessc' - \ . ' --no-color --lint ' - \ . ale#Var(a:buffer, 'less_lessc_options') - \ . ' %t' + \ . ' --no-color --lint' + \ . ' ' . ale#Var(a:buffer, 'less_lessc_options') + \ . ' %t' endfunction function! ale_linters#less#lessc#Handle(buffer, lines) abort From 7ed82ab712324eb410279b95d852659e97ff9021 Mon Sep 17 00:00:00 2001 From: Marcus Zanona Date: Thu, 9 Nov 2017 13:40:13 -0200 Subject: [PATCH 078/390] Adjust author info on less#lessc linter --- ale_linters/less/lessc.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index 941607b..db871ac 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -1,4 +1,4 @@ -" Author: zanona , w0rp +" Author: zanona " Description: This file adds support for checking Less code with lessc. call ale#Set('less_lessc_options', '') From 4bc31fcd18bda03f0de516be0380d6885cdd3d9b Mon Sep 17 00:00:00 2001 From: Marcus Zanona Date: Thu, 9 Nov 2017 13:45:14 -0200 Subject: [PATCH 079/390] Fix imported files path lookup on less#lessc linter Ale saves a temporary file (%t) which does not share the same path as the original file, breaking import statements with relative URLs. This fix sends content to `lessc` over stdin and adds the current file (%s) as one of the included paths, so statements like `@import '../utils' will correctly resolve based on the current file path. --- ale_linters/less/lessc.vim | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index db871ac..1c5df91 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -4,10 +4,10 @@ call ale#Set('less_lessc_options', '') function! ale_linters#less#lessc#GetCommand(buffer) abort - return 'lessc' - \ . ' --no-color --lint' + return 'cat %t | lessc' + \ . ' --no-color --lint --include-path=' . expand('%:p:h') \ . ' ' . ale#Var(a:buffer, 'less_lessc_options') - \ . ' %t' + \ . ' -' endfunction function! ale_linters#less#lessc#Handle(buffer, lines) abort From 1ad7d5e6ca34c285dc7abbb98222b05a32b4f70d Mon Sep 17 00:00:00 2001 From: Marcus Zanona Date: Thu, 9 Nov 2017 19:52:08 -0200 Subject: [PATCH 080/390] Remove unnecessary cat command from less#lessc --- ale_linters/less/lessc.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index 1c5df91..76b7f13 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -4,7 +4,7 @@ call ale#Set('less_lessc_options', '') function! ale_linters#less#lessc#GetCommand(buffer) abort - return 'cat %t | lessc' + return 'lessc' \ . ' --no-color --lint --include-path=' . expand('%:p:h') \ . ' ' . ale#Var(a:buffer, 'less_lessc_options') \ . ' -' From d425b8a18ab3c8155fdc7376192434f8878e954f Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 9 Nov 2017 23:42:54 +0000 Subject: [PATCH 081/390] Simplfy semver handling and share the semver version cache across everything --- ale_linters/javascript/flow.vim | 13 ++-- ale_linters/python/flake8.vim | 43 ++----------- ale_linters/rust/cargo.vim | 62 ++++-------------- ale_linters/sh/shellcheck.vim | 31 ++------- ale_linters/vim/vint.vim | 20 ++---- autoload/ale/handlers/gcc.vim | 12 ---- autoload/ale/semver.vim | 52 +++++++++++---- .../test_cargo_command_callbacks.vader | 1 + .../test_flake8_command_callback.vader | 11 ++-- test/handler/test_gcc_handler.vader | 11 ---- test/test_flow_command.vader | 1 + test/test_semver_utils.vader | 64 ++++++++++++++----- 12 files changed, 133 insertions(+), 188 deletions(-) diff --git a/ale_linters/javascript/flow.vim b/ale_linters/javascript/flow.vim index 0dd6453..6d51628 100644 --- a/ale_linters/javascript/flow.vim +++ b/ale_linters/javascript/flow.vim @@ -23,18 +23,15 @@ function! ale_linters#javascript#flow#GetCommand(buffer, version_lines) abort return '' endif - let l:use_respect_pragma = 1 + let l:executable = ale_linters#javascript#flow#GetExecutable(a:buffer) + let l:version = ale#semver#GetVersion(l:executable, a:version_lines) " If we can parse the version number, then only use --respect-pragma " if the version is >= 0.36.0, which added the argument. - for l:match in ale#util#GetMatches(a:version_lines, '\v\d+\.\d+\.\d+$') - let l:use_respect_pragma = ale#semver#GreaterOrEqual( - \ ale#semver#Parse(l:match[0]), - \ [0, 36, 0] - \) - endfor + let l:use_respect_pragma = empty(l:version) + \ || ale#semver#GTE(l:version, [0, 36]) - return ale#Escape(ale_linters#javascript#flow#GetExecutable(a:buffer)) + return ale#Escape(l:executable) \ . ' check-contents' \ . (l:use_respect_pragma ? ' --respect-pragma': '') \ . ' --json --from ale %s' diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim index 8aa4c4d..501db0b 100644 --- a/ale_linters/python/flake8.vim +++ b/ale_linters/python/flake8.vim @@ -10,10 +10,6 @@ let g:ale_python_flake8_options = \ get(g:, 'ale_python_flake8_options', s:default_options) let g:ale_python_flake8_use_global = get(g:, 'ale_python_flake8_use_global', 0) -" A map from Python executable paths to semver strings parsed for those -" executables, so we don't have to look up the version number constantly. -let s:version_cache = {} - function! s:UsingModule(buffer) abort return ale#Var(a:buffer, 'python_flake8_options') =~# ' *-m flake8' endfunction @@ -26,62 +22,35 @@ function! ale_linters#python#flake8#GetExecutable(buffer) abort return ale#Var(a:buffer, 'python_flake8_executable') endfunction -function! ale_linters#python#flake8#ClearVersionCache() abort - let s:version_cache = {} -endfunction - function! ale_linters#python#flake8#VersionCheck(buffer) abort let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) " If we have previously stored the version number in a cache, then " don't look it up again. - if has_key(s:version_cache, l:executable) + if ale#semver#HasVersion(l:executable) " Returning an empty string skips this command. return '' endif - let l:executable = ale#Escape(ale_linters#python#flake8#GetExecutable(a:buffer)) + let l:executable = ale#Escape(l:executable) let l:module_string = s:UsingModule(a:buffer) ? ' -m flake8' : '' return l:executable . l:module_string . ' --version' endfunction -" Get the flake8 version from the output, or the cache. -function! s:GetVersion(buffer, version_output) abort - let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) - let l:version = [] - - " Get the version from the cache. - if has_key(s:version_cache, l:executable) - return s:version_cache[l:executable] - endif - - if !empty(a:version_output) - " Parse the version string, and store it in the cache. - let l:version = ale#semver#Parse(a:version_output[0]) - let s:version_cache[l:executable] = l:version - endif - - return l:version -endfunction - -" flake8 versions 3 and up support the --stdin-display-name argument. -function! s:SupportsDisplayName(version) abort - return !empty(a:version) && ale#semver#GreaterOrEqual(a:version, [3, 0, 0]) -endfunction - function! ale_linters#python#flake8#GetCommand(buffer, version_output) abort - let l:version = s:GetVersion(a:buffer, a:version_output) + let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) + let l:version = ale#semver#GetVersion(l:executable, a:version_output) " Only include the --stdin-display-name argument if we can parse the " flake8 version, and it is recent enough to support it. - let l:display_name_args = s:SupportsDisplayName(l:version) + let l:display_name_args = ale#semver#GTE(l:version, [3, 0, 0]) \ ? ' --stdin-display-name %s' \ : '' let l:options = ale#Var(a:buffer, 'python_flake8_options') - return ale#Escape(ale_linters#python#flake8#GetExecutable(a:buffer)) + return ale#Escape(l:executable) \ . (!empty(l:options) ? ' ' . l:options : '') \ . ' --format=default' \ . l:display_name_args . ' -' diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index f41cb4b..ae26fab 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -4,8 +4,6 @@ call ale#Set('rust_cargo_use_check', 1) call ale#Set('rust_cargo_check_all_targets', 1) -let s:version_cache = {} - function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# '' return 'cargo' @@ -17,59 +15,23 @@ function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort endfunction function! ale_linters#rust#cargo#VersionCheck(buffer) abort - if has_key(s:version_cache, 'cargo') - return '' - endif - - return 'cargo --version' -endfunction - -function! s:GetVersion(executable, output) abort - let l:version = get(s:version_cache, a:executable, []) - - for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') - let l:version = ale#semver#Parse(l:match[0]) - let s:version_cache[a:executable] = l:version - endfor - - return l:version -endfunction - -function! s:CanUseCargoCheck(buffer, version) abort - " Allow `cargo check` to be disabled. - if !ale#Var(a:buffer, 'rust_cargo_use_check') - return 0 - endif - - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 17, 0]) -endfunction - -function! s:CanUseAllTargets(buffer, version) abort - if !ale#Var(a:buffer, 'rust_cargo_use_check') - return 0 - endif - - if !ale#Var(a:buffer, 'rust_cargo_check_all_targets') - return 0 - endif - - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 22, 0]) + return !ale#semver#HasVersion('cargo') + \ ? 'cargo --version' + \ : '' endfunction function! ale_linters#rust#cargo#GetCommand(buffer, version_output) abort - let l:version = s:GetVersion('cargo', a:version_output) - let l:command = s:CanUseCargoCheck(a:buffer, l:version) - \ ? 'check' - \ : 'build' - let l:all_targets = s:CanUseAllTargets(a:buffer, l:version) - \ ? ' --all-targets' - \ : '' + let l:version = ale#semver#GetVersion('cargo', a:version_output) + + let l:use_check = ale#Var(a:buffer, 'rust_cargo_use_check') + \ && ale#semver#GTE(l:version, [0, 17, 0]) + let l:use_all_targets = l:use_check + \ && ale#Var(a:buffer, 'rust_cargo_check_all_targets') + \ && ale#semver#GTE(l:version, [0, 22, 0]) return 'cargo ' - \ . l:command - \ . l:all_targets + \ . (l:use_check ? 'check' : 'build') + \ . (l:use_all_targets ? ' --all-targets' : '') \ . ' --frozen --message-format=json -q' endfunction diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 1f6bdf8..e79b3b8 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -15,8 +15,6 @@ let g:ale_sh_shellcheck_executable = let g:ale_sh_shellcheck_options = \ get(g:, 'ale_sh_shellcheck_options', '') -let s:version_cache = {} - function! ale_linters#sh#shellcheck#GetExecutable(buffer) abort return ale#Var(a:buffer, 'sh_shellcheck_executable') endfunction @@ -49,38 +47,19 @@ function! ale_linters#sh#shellcheck#VersionCheck(buffer) abort let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) " Don't check the version again if we've already cached it. - if has_key(s:version_cache, l:executable) - return '' - endif - - return ale#Escape(l:executable) . ' --version' -endfunction - -" Get the shellcheck version from the cache, or parse it and cache it. -function! s:GetVersion(executable, output) abort - let l:version = get(s:version_cache, a:executable, []) - - for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') - let l:version = ale#semver#Parse(l:match[0]) - let s:version_cache[a:executable] = l:version - endfor - - return l:version -endfunction - -function! s:CanUseExternalOption(version) abort - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 4, 0]) + return !ale#semver#HasVersion(l:executable) + \ ? ale#Escape(l:executable) . ' --version' + \ : '' endfunction function! ale_linters#sh#shellcheck#GetCommand(buffer, version_output) abort let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) - let l:version = s:GetVersion(l:executable, a:version_output) + let l:version = ale#semver#GetVersion(l:executable, a:version_output) let l:options = ale#Var(a:buffer, 'sh_shellcheck_options') let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions') let l:dialect = ale_linters#sh#shellcheck#GetDialectArgument(a:buffer) - let l:external_option = s:CanUseExternalOption(l:version) ? ' -x' : '' + let l:external_option = ale#semver#GTE(l:version, [0, 4, 0]) ? ' -x' : '' return ale#path#BufferCdString(a:buffer) \ . ale#Escape(l:executable) diff --git a/ale_linters/vim/vint.vim b/ale_linters/vim/vint.vim index adf2b4a..dfa00dc 100644 --- a/ale_linters/vim/vint.vim +++ b/ale_linters/vim/vint.vim @@ -6,25 +6,19 @@ let g:ale_vim_vint_show_style_issues = \ get(g:, 'ale_vim_vint_show_style_issues', 1) let s:enable_neovim = has('nvim') ? ' --enable-neovim ' : '' let s:format = '-f "{file_path}:{line_number}:{column_number}: {severity}: {description} (see {reference})"' -let s:vint_version = [] function! ale_linters#vim#vint#VersionCommand(buffer) abort - if empty(s:vint_version) - " Check the Vint version if we haven't checked it already. - return 'vint --version' - endif - - return '' + " Check the Vint version if we haven't checked it already. + return !ale#semver#HasVersion('vint') + \ ? 'vint --version' + \ : '' endfunction function! ale_linters#vim#vint#GetCommand(buffer, version_output) abort - if empty(s:vint_version) && !empty(a:version_output) - " Parse the version out of the --version output. - let s:vint_version = ale#semver#Parse(join(a:version_output, "\n")) - endif + let l:version = ale#semver#GetVersion('vint', a:version_output) - let l:can_use_no_color_flag = empty(s:vint_version) - \ || ale#semver#GreaterOrEqual(s:vint_version, [0, 3, 7]) + let l:can_use_no_color_flag = empty(l:version) + \ || ale#semver#GTE(l:version, [0, 3, 7]) let l:warning_flag = ale#Var(a:buffer, 'vim_vint_show_style_issues') ? '-s' : '-w' diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index 256cd01..9ec7b11 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -18,18 +18,6 @@ function! s:RemoveUnicodeQuotes(text) abort return l:text endfunction -function! ale#handlers#gcc#ParseGCCVersion(lines) abort - for l:line in a:lines - let l:match = matchstr(l:line, '\d\.\d\.\d') - - if !empty(l:match) - return ale#semver#Parse(l:match) - endif - endfor - - return [] -endfunction - function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort " Look for lines like the following. " diff --git a/autoload/ale/semver.vim b/autoload/ale/semver.vim index b153dd1..6b0fd34 100644 --- a/autoload/ale/semver.vim +++ b/autoload/ale/semver.vim @@ -1,27 +1,55 @@ -" Given some text, parse a semantic versioning string from the text -" into a triple of integeers [major, minor, patch]. +let s:version_cache = {} + +" Reset the version cache used for parsing the version. +function! ale#semver#ResetVersionCache() abort + let s:version_cache = {} +endfunction + +" Given an executable name and some lines of output, which can be empty, +" parse the version from the lines of output, or return the cached version +" triple [major, minor, patch] " -" If no match can be performed, then an empty List will be returned instead. -function! ale#semver#Parse(text) abort - let l:match = matchlist(a:text, '^ *\(\d\+\)\.\(\d\+\)\.\(\d\+\)') +" If the version cannot be found, an empty List will be returned instead. +function! ale#semver#GetVersion(executable, version_lines) abort + let l:version = get(s:version_cache, a:executable, []) - if empty(l:match) - return [] - endif + for l:line in a:version_lines + let l:match = matchlist(l:line, '\v(\d+)\.(\d+)\.(\d+)') - return [l:match[1] + 0, l:match[2] + 0, l:match[3] + 0] + if !empty(l:match) + let l:version = [l:match[1] + 0, l:match[2] + 0, l:match[3] + 0] + let s:version_cache[a:executable] = l:version + + break + endif + endfor + + return l:version +endfunction + +" Return 1 if the semver version has been cached for a given executable. +function! ale#semver#HasVersion(executable) abort + return has_key(s:version_cache, a:executable) endfunction " Given two triples of integers [major, minor, patch], compare the triples -" and return 1 if the lhs is greater than or equal to the rhs. -function! ale#semver#GreaterOrEqual(lhs, rhs) abort +" and return 1 if the LHS is greater than or equal to the RHS. +" +" Pairs of [major, minor] can also be used for either argument. +" +" 0 will be returned if the LHS is an empty List. +function! ale#semver#GTE(lhs, rhs) abort + if empty(a:lhs) + return 0 + endif + if a:lhs[0] > a:rhs[0] return 1 elseif a:lhs[0] == a:rhs[0] if a:lhs[1] > a:rhs[1] return 1 elseif a:lhs[1] == a:rhs[1] - return a:lhs[2] >= a:rhs[2] + return get(a:lhs, 2) >= get(a:rhs, 2) endif endif diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader index d808e19..1053551 100644 --- a/test/command_callback/test_cargo_command_callbacks.vader +++ b/test/command_callback/test_cargo_command_callbacks.vader @@ -17,6 +17,7 @@ After: call ale#test#RestoreDirectory() call ale#linter#Reset() + call ale#semver#ResetVersionCache() Execute(An empty string should be returned for the cargo executable when there's no Cargo.toml file): AssertEqual diff --git a/test/command_callback/test_flake8_command_callback.vader b/test/command_callback/test_flake8_command_callback.vader index a510f4c..47d5c0f 100644 --- a/test/command_callback/test_flake8_command_callback.vader +++ b/test/command_callback/test_flake8_command_callback.vader @@ -23,7 +23,7 @@ After: call ale#test#RestoreDirectory() call ale#linter#Reset() - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() Execute(The flake8 callbacks should return the correct default values): AssertEqual @@ -35,8 +35,9 @@ Execute(The flake8 callbacks should return the correct default values): AssertEqual \ ale#Escape('flake8') . ' --format=default --stdin-display-name %s -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['3.0.0']) + " Try with older versions. - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() AssertEqual \ ale#Escape('flake8') . ' --format=default -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['2.9.9']) @@ -49,7 +50,9 @@ Execute(The flake8 command callback should let you set options): \ . ' --some-option --format=default' \ . ' --stdin-display-name %s -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['3.0.4']) - call ale_linters#python#flake8#ClearVersionCache() + + call ale#semver#ResetVersionCache() + AssertEqual \ ale#Escape('flake8') \ . ' --some-option --format=default -', @@ -140,7 +143,7 @@ Execute(Using `python -m flake8` should be supported for running flake8): \ ale#Escape('python') . ' -m flake8 --some-option --format=default -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['2.9.9']) - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() " Leading spaces shouldn't matter let g:ale_python_flake8_options = ' -m flake8 --some-option' diff --git a/test/handler/test_gcc_handler.vader b/test/handler/test_gcc_handler.vader index 9324273..79f1789 100644 --- a/test/handler/test_gcc_handler.vader +++ b/test/handler/test_gcc_handler.vader @@ -71,17 +71,6 @@ Execute(GCC errors from included files should be parsed correctly): \ ' ^', \ ]) -Execute(GCC versions should be parsed correctly): - AssertEqual [4, 9, 1], ale#handlers#gcc#ParseGCCVersion([ - \ 'g++ (GCC) 4.9.1 20140922 (Red Hat 4.9.1-10)', - \]) - AssertEqual [4, 8, 4], ale#handlers#gcc#ParseGCCVersion([ - \ 'gcc (Ubuntu 4.8.4-2ubuntu1~14.04.3) 4.8.4', - \ 'Copyright (C) 2013 Free Software Foundation, Inc.', - \ 'This is free software; see the source for copying conditions. There is NO', - \ 'warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.', - \]) - Execute(The GCC handler shouldn't complain about #pragma once for headers): silent file! test.h diff --git a/test/test_flow_command.vader b/test/test_flow_command.vader index 32ceb57..49546e9 100644 --- a/test/test_flow_command.vader +++ b/test/test_flow_command.vader @@ -5,6 +5,7 @@ Before: After: call ale#test#RestoreDirectory() call ale#linter#Reset() + call ale#semver#ResetVersionCache() Execute(flow should return a command to run if a .flowconfig file exists): call ale#test#SetFilename('flow/a/sub/dummy') diff --git a/test/test_semver_utils.vader b/test/test_semver_utils.vader index 9730b74..30e9e81 100644 --- a/test/test_semver_utils.vader +++ b/test/test_semver_utils.vader @@ -1,16 +1,50 @@ -Execute(ParseSemver should return the correct results): - " We should be able to parse the semver string from flake8 - AssertEqual [3, 0, 4], ale#semver#Parse('3.0.4 (mccabe: 0.5.2, pyflakes: 1.2.3, pycodestyle: 2.0.0) CPython 2.7.12 on Linux') +After: + call ale#semver#ResetVersionCache() -Execute(GreaterOrEqual should compare triples correctly): - Assert ale#semver#GreaterOrEqual([3, 0, 4], [3, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 0, 0], [3, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 0, 0], [2, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 1, 0], [3, 1, 0]) - Assert ale#semver#GreaterOrEqual([3, 2, 0], [3, 1, 0]) - Assert ale#semver#GreaterOrEqual([3, 2, 2], [3, 1, 6]) - Assert ale#semver#GreaterOrEqual([3, 2, 5], [3, 2, 5]) - Assert ale#semver#GreaterOrEqual([3, 2, 6], [3, 2, 5]) - Assert !ale#semver#GreaterOrEqual([2, 9, 1], [3, 0, 0]) - Assert !ale#semver#GreaterOrEqual([3, 2, 3], [3, 3, 3]) - Assert !ale#semver#GreaterOrEqual([3, 3, 2], [3, 3, 3]) +Execute(GetVersion should return the version from the lines of output): + " We should be able to parse the semver string from flake8 + AssertEqual [3, 0, 4], ale#semver#GetVersion('dummy', [ + \ '3.0.4 (mccabe: 0.5.2, pyflakes: 1.2.3, pycodestyle: 2.0.0) CPython 2.7.12 on Linux', + \ '1.2.3', + \]) + +Execute(GetVersion should return an empty list when no vesrion can be found): + AssertEqual [], ale#semver#GetVersion('dummy', ['x']) + AssertEqual [], ale#semver#GetVersion('dummy', []) + +Execute(GetVersion should cache the version): + AssertEqual [], ale#semver#GetVersion('dummy', []) + AssertEqual [3, 4, 7], ale#semver#GetVersion('dummy', ['Version 3.4.7']) + AssertEqual [3, 4, 7], ale#semver#GetVersion('dummy', []) + +Execute(HasVersion should return 1 when the version has been cached): + call ale#semver#GetVersion('dummy', []) + AssertEqual 0, ale#semver#HasVersion('dummy') + call ale#semver#GetVersion('dummy', ['3.4.7']) + AssertEqual 1, ale#semver#HasVersion('dummy') + +Execute(GTE should compare triples correctly): + Assert ale#semver#GTE([3, 0, 4], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 0], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 0], [2, 0, 0]) + Assert ale#semver#GTE([3, 1, 0], [3, 1, 0]) + Assert ale#semver#GTE([3, 2, 0], [3, 1, 0]) + Assert ale#semver#GTE([3, 2, 2], [3, 1, 6]) + Assert ale#semver#GTE([3, 2, 5], [3, 2, 5]) + Assert ale#semver#GTE([3, 2, 6], [3, 2, 5]) + Assert !ale#semver#GTE([2, 9, 1], [3, 0, 0]) + Assert !ale#semver#GTE([3, 2, 3], [3, 3, 3]) + Assert !ale#semver#GTE([3, 3, 2], [3, 3, 3]) + +Execute(GTE should compare pairs correctly): + Assert ale#semver#GTE([3, 0], [3, 0, 0]) + Assert ale#semver#GTE([3, 0], [3, 0]) + Assert ale#semver#GTE([3, 1], [3, 0]) + Assert ale#semver#GTE([3, 1], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 1], [3, 0]) + Assert !ale#semver#GTE([3, 0], [3, 0, 1]) + Assert !ale#semver#GTE([3, 0], [3, 1]) + Assert !ale#semver#GTE([2, 9, 11], [3, 0]) + +Execute(GTE should permit the LHS to be an empty List): + Assert !ale#semver#GTE([], [0, 0, 0]) From 27780cbb230fad55fbc07752febe5c21a69a18aa Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Fri, 10 Nov 2017 18:37:23 +0900 Subject: [PATCH 082/390] Added support for linting of proto files (#1098) * Added support for linting of proto files * Added function to get the proper protoc command --- ale_linters/proto/protoc_gen_lint.vim | 19 +++++++++++++++ doc/ale-proto.txt | 24 +++++++++++++++++++ doc/ale.txt | 2 ++ .../test_proto_command_callback.vader | 16 +++++++++++++ 4 files changed, 61 insertions(+) create mode 100644 ale_linters/proto/protoc_gen_lint.vim create mode 100644 doc/ale-proto.txt create mode 100644 test/command_callback/test_proto_command_callback.vader diff --git a/ale_linters/proto/protoc_gen_lint.vim b/ale_linters/proto/protoc_gen_lint.vim new file mode 100644 index 0000000..9d5ceac --- /dev/null +++ b/ale_linters/proto/protoc_gen_lint.vim @@ -0,0 +1,19 @@ +" Author: Jeff Willette +" Description: run the protoc-gen-lint plugin for the protoc binary + +function! ale_linters#proto#protoc_gen_lint#GetCommand(buffer) abort + let l:dirname = expand('#' . a:buffer . ':p:h') + + return 'protoc' + \ . ' -I ' . ale#Escape(l:dirname) + \ . ' --lint_out=. ' . '%s' +endfunction + +call ale#linter#Define('proto', { +\ 'name': 'protoc-gen-lint', +\ 'lint_file': 1, +\ 'output_stream': 'stderr', +\ 'executable': 'protoc', +\ 'command_callback': 'ale_linters#proto#protoc_gen_lint#GetCommand', +\ 'callback': 'ale#handlers#unix#HandleAsError', +\}) diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt new file mode 100644 index 0000000..6a25638 --- /dev/null +++ b/doc/ale-proto.txt @@ -0,0 +1,24 @@ +=============================================================================== +ALE Proto Integration *ale-proto-options* + + +=============================================================================== +Integration Information + +Linting of `.proto` files requires that the `protoc` binary is installed in the +system path and that the `protoc-gen-lint` plugin for the `protoc` binary is also +installed. + +To enable `.proto` file linting, update |g:ale_linters| as appropriate: +> + " Enable linter for .proto files + let g:ale_linters = {'proto': ['protoc-gen-lint']} +< +=============================================================================== +protoc-gen-lint *ale-proto-protoc-gen-lint* + + The linter is a plugin for the `protoc` binary. As long as the binary resides + in the system path, `protoc` will find it. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 2ee2c2d..a0aa9c8 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -134,6 +134,8 @@ CONTENTS *ale-contents* phpstan.............................|ale-php-phpstan| pod...................................|ale-pod-options| write-good..........................|ale-pod-write-good| + proto.................................|ale-proto-options| + protoc-gen-lint.....................|ale-proto-protoc-gen-lint| pug...................................|ale-pug-options| puglint.............................|ale-pug-puglint| puppet................................|ale-puppet-options| diff --git a/test/command_callback/test_proto_command_callback.vader b/test/command_callback/test_proto_command_callback.vader new file mode 100644 index 0000000..2730bb8 --- /dev/null +++ b/test/command_callback/test_proto_command_callback.vader @@ -0,0 +1,16 @@ +Before: + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('test.proto') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The default command should be correct): + + AssertEqual + \ 'protoc' . ' -I ' . ale#Escape(getcwd()) . ' --lint_out=. ' . '%s', + \ ale_linters#proto#protoc_gen_lint#GetCommand(bufnr('')) + From bb271859efa503a4f4546b5df1987dd579d4efb1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 10 Nov 2017 09:43:42 +0000 Subject: [PATCH 083/390] #1098 Add protoc-gen-lint to the list of supported tools --- README.md | 1 + doc/ale.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 9c5bc5a..806ada6 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,7 @@ formatting. | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | diff --git a/doc/ale.txt b/doc/ale.txt index a0aa9c8..76df66d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -310,6 +310,7 @@ Notes: * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint`, `write-good` +* proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` From 1ddc3eec6dff1c35111d47ec6e46cf2f2f699e20 Mon Sep 17 00:00:00 2001 From: Florian Beeres Date: Sat, 11 Nov 2017 13:07:08 +0100 Subject: [PATCH 084/390] Handle flow extra errors (#946) Show more information for Flow errors with :ALEDetail --- ale_linters/javascript/flow.vim | 54 +++++++++- test/handler/test_flow_handler.vader | 156 ++++++++++++++++++++++++++- 2 files changed, 205 insertions(+), 5 deletions(-) mode change 100644 => 100755 ale_linters/javascript/flow.vim diff --git a/ale_linters/javascript/flow.vim b/ale_linters/javascript/flow.vim old mode 100644 new mode 100755 index 6d51628..8dc930c --- a/ale_linters/javascript/flow.vim +++ b/ale_linters/javascript/flow.vim @@ -1,6 +1,9 @@ " Author: Zach Perrault -- @zperrault " Description: FlowType checking for JavaScript files +" Flow extra errors +" Author: Florian Beeres + call ale#Set('javascript_flow_executable', 'flow') call ale#Set('javascript_flow_use_global', 0) @@ -53,6 +56,44 @@ function! s:GetJSONLines(lines) abort return a:lines[l:start_index :] endfunction +function! s:ExtraErrorMsg(current, new) abort + let l:newMsg = '' + + if a:current is# '' + " extra messages appear to already have a : + let l:newMsg = a:new + else + let l:newMsg = a:current . ' ' . a:new + endif + + return l:newMsg +endfunction + + +function! s:GetDetails(error) abort + let l:detail = '' + + for l:extra_error in a:error.extra + + if has_key(l:extra_error, 'message') + for l:extra_message in l:extra_error.message + let l:detail = s:ExtraErrorMsg(l:detail, l:extra_message.descr) + endfor + endif + + if has_key(l:extra_error, 'children') + for l:child in l:extra_error.children + for l:child_message in l:child.message + let l:detail = l:detail . ' ' . l:child_message.descr + endfor + endfor + endif + + endfor + + return l:detail +endfunction + function! ale_linters#javascript#flow#Handle(buffer, lines) abort let l:str = join(s:GetJSONLines(a:lines), '') @@ -91,12 +132,19 @@ function! ale_linters#javascript#flow#Handle(buffer, lines) abort let l:text = l:text . ' See also: ' . l:error.operation.descr endif - call add(l:output, { + let l:errorToAdd = { \ 'lnum': l:line, \ 'col': l:col, \ 'text': l:text, - \ 'type': l:error.level is# 'error' ? 'E' : 'W', - \}) + \ 'type': has_key(l:error, 'level') && l:error.level is# 'error' ? 'E' : 'W', + \} + + if has_key(l:error, 'extra') + let l:errorToAdd.detail = s:GetDetails(l:error) + endif + + call add(l:output, l:errorToAdd) + endfor return l:output diff --git a/test/handler/test_flow_handler.vader b/test/handler/test_flow_handler.vader index 47efc30..3a575a0 100644 --- a/test/handler/test_flow_handler.vader +++ b/test/handler/test_flow_handler.vader @@ -243,7 +243,7 @@ Execute(The flow handler should fetch the correct location for the currently ope \ 'lnum': 6, \ 'col': 3, \ 'type': 'E', - \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`' + \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`', \ } \] @@ -347,7 +347,159 @@ Execute(The flow handler should handle relative paths): \ 'lnum': 6, \ 'col': 3, \ 'type': 'E', - \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`' + \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`', + \ } + \] + + AssertEqual g:expected, g:actual + +Execute(The flow handler should handle extra errors): + silent! noautocmd file /Users/rav/Projects/vim-ale-flow/index.js + + let g:flow_output = { + \ "flowVersion": "0.54.0", + \ "errors": [{ + \ "extra": [{ + \ "message": [{ + \ "context": v:null, + \ "descr": "Property \`setVector\` is incompatible:", + \ "type": "Blame ", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }], + \ "children": [{ + \ "message": [{ + \ "context": "setVector = \{2\}", + \ "descr": "number ", + \ "type": "Blame ", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile ", + \ "start": { + \ "line": 90, + \ "column": 30, + \ "offset": 2296 + \ }, + \ "end": { + \ "line": 90, + \ "column": 30, + \ "offset": 2297 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 90, + \ "endline": 90, + \ "start": 30, + \ "end": 30 + \ }, { + \ "context": v:null, + \ "descr": "This type is incompatible with ", + \ "type": "Comment ", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }, { + \ "context": "setVector: VectorType => void,", + \ "descr": "function type ", + \ "type": "Blame ", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile", + \ "start": { + \ "line": 9, + \ "column": 14, + \ "offset": 252 + \ }, + \ "end": { + \ "line": 9, + \ "column": 31, + \ "offset": 270 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 9, + \ "endline": 9, + \ "start": 14, + \ "end": 31 + \ }] + \ }] + \ }], + \ "kind": "infer", + \ "level": "error", + \ "suppressions": [], + \ "message": [{ + \ "context": " < New ", + \ "descr": "props of React element `New`", + \ "type": "Blame", + \ "loc": { + \ "source": "vim-ale-flow/foo.js", + \ "type": "SourceFile", + \ "start": { + \ "line": 89, + \ "column": 17, + \ "offset": 2262 + \ }, + \ "end": { + \ "line": 94, + \ "column": 18, + \ "offset": 2488 + \ } + \ }, + \ "path": "", + \ "line": 89, + \ "endline": 94, + \ "start": 17, + \ "end": 18 + \ }, { + \ "context": v:null, + \ "descr": "This type is incompatible with", + \ "type": "Comment", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }, { + \ "context": "class New extends React.Component < NewProps,NewState > {", + \ "descr": "object type", + \ "type": "Blame", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile", + \ "start": { + \ "line": 20, + \ "column": 35, + \ "offset": 489 + \ }, + \ "end": { + \ "line": 20, + \ "column": 42, + \ "offset": 497 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 20, + \ "endline": 20, + \ "start": 35, + \ "end": 42 + \ }] + \ }], + \ "passed": v:false + \} + + let g:actual = ale_linters#javascript#flow#Handle(bufnr(''), [json_encode(g:flow_output)]) + let g:expected = [ + \ { + \ 'lnum': 20, + \ 'col': 35, + \ 'type': 'E', + \ 'text': 'props of React element `New`: This type is incompatible with object type', + \ 'detail': 'Property `setVector` is incompatible: number This type is incompatible with function type ', \ } \] From 6c014a25e86c864c893c59ee3f30ce80cfd5fbb6 Mon Sep 17 00:00:00 2001 From: jnduli Date: Sat, 11 Nov 2017 15:10:17 +0300 Subject: [PATCH 085/390] Add rstcheck linter to check for errors in restructured text (#1090) --- README.md | 2 +- ale_linters/rst/rstcheck.vim | 37 +++++++++++++++++++ doc/ale.txt | 2 +- test/handler/test_rstcheck_lint_handler.vader | 33 +++++++++++++++++ 4 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 ale_linters/rst/rstcheck.vim create mode 100644 test/handler/test_rstcheck_lint_handler.vader diff --git a/README.md b/README.md index 806ada6..7cfbf62 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ formatting. | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | | Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | diff --git a/ale_linters/rst/rstcheck.vim b/ale_linters/rst/rstcheck.vim new file mode 100644 index 0000000..b660627 --- /dev/null +++ b/ale_linters/rst/rstcheck.vim @@ -0,0 +1,37 @@ +" Author: John Nduli https://github.com/jnduli +" Description: Rstcheck for reStructuredText files +" + +function! ale_linters#rst#rstcheck#Handle(buffer, lines) abort + " matches: 'bad_rst.rst:1: (SEVERE/4) Title overline & underline + " mismatch.' + let l:pattern = '\v^(.+):(\d*): \(([a-zA-Z]*)/\d*\) (.+)$' + let l:dir = expand('#' . a:buffer . ':p:h') + let l:output = [] + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), + \ 'lnum': l:match[2] + 0, + \ 'col': 0, + \ 'type': l:match[3] is# 'SEVERE' ? 'E' : 'W', + \ 'text': l:match[4], + \}) + endfor + + return l:output +endfunction + +function! ale_linters#rst#rstcheck#GetCommand(buffer) abort + return ale#path#BufferCdString(a:buffer) + \ . 'rstcheck' + \ . ' %t' +endfunction + + +call ale#linter#Define('rst', { +\ 'name': 'rstcheck', +\ 'executable': 'rstcheck', +\ 'command_callback': 'ale_linters#rst#rstcheck#GetCommand', +\ 'callback': 'ale_linters#rst#rstcheck#Handle', +\ 'output_stream': 'both', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index 76df66d..83646c5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -316,7 +316,7 @@ Notes: * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `refmt` -* reStructuredText: `proselint`, `write-good` +* reStructuredText: `proselint`, `rstcheck`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` diff --git a/test/handler/test_rstcheck_lint_handler.vader b/test/handler/test_rstcheck_lint_handler.vader new file mode 100644 index 0000000..64cb587 --- /dev/null +++ b/test/handler/test_rstcheck_lint_handler.vader @@ -0,0 +1,33 @@ +Before: + runtime ale_linters/rstcheck/rstcheck.vim + +Execute(Warning and error messages should be handled correctly): + AssertEqual + \ [ + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_python.rst'), + \ 'lnum': 7, + \ 'col': 0, + \ 'type': 'W', + \ 'text': '(python) unexpected EOF while parsing', + \ }, + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_cpp.rst'), + \ 'lnum': 9, + \ 'col': 0, + \ 'type': 'W', + \ 'text': '(cpp) error: ''x'' was not declared in this scope', + \ }, + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_rst.rst'), + \ 'lnum': 1, + \ 'col': 0, + \ 'type': 'E', + \ 'text': 'Title overline & underline mismatch.', + \ }, + \ ], + \ ale_linters#rst#rstcheck#Handle(1, [ + \ 'bad_python.rst:7: (ERROR/3) (python) unexpected EOF while parsing', + \ 'bad_cpp.rst:9: (ERROR/3) (cpp) error: ''x'' was not declared in this scope', + \ 'bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.', + \]) From 8c1d6eda81d408de767916c00d20139ddf6fc9c6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 13:44:05 +0000 Subject: [PATCH 086/390] #1095 Apply all patterns for g:ale_pattern_options, instead of just the first match --- autoload/ale/pattern_options.vim | 40 +++++++++++------- autoload/ale/toggle.vim | 5 +-- doc/ale.txt | 14 ++++--- test/test_autocmd_commands.vader | 25 ++++++++---- test/test_pattern_options.vader | 70 ++++++++++++++++++++++++++------ 5 files changed, 111 insertions(+), 43 deletions(-) diff --git a/autoload/ale/pattern_options.vim b/autoload/ale/pattern_options.vim index a603c98..a55a27f 100644 --- a/autoload/ale/pattern_options.vim +++ b/autoload/ale/pattern_options.vim @@ -1,22 +1,34 @@ " Author: w0rp " Description: Set options in files based on regex patterns. -function! ale#pattern_options#SetOptions() abort - let l:filename = expand('%:p') " no-custom-checks - let l:options = {} +function! s:CmpPatterns(left_item, right_item) abort + if a:left_item[0] < a:right_item[0] + return -1 + endif - for l:pattern in keys(g:ale_pattern_options) + if a:left_item[0] > a:right_item[0] + return 1 + endif + + return 0 +endfunction + +function! ale#pattern_options#SetOptions(buffer) abort + if !g:ale_pattern_options_enabled || empty(g:ale_pattern_options) + return + endif + + let l:filename = expand('#' . a:buffer . ':p') + + " The patterns are sorted, so they are applied consistently. + for [l:pattern, l:options] in sort( + \ items(g:ale_pattern_options), + \ function('s:CmpPatterns') + \) if match(l:filename, l:pattern) >= 0 - let l:options = g:ale_pattern_options[l:pattern] - break - endif - endfor - - for l:key in keys(l:options) - if l:key[:0] is# '&' - call setbufvar(bufnr(''), l:key, l:options[l:key]) - else - let b:[l:key] = l:options[l:key] + for [l:key, l:value] in items(l:options) + call setbufvar(a:buffer, l:key, l:value) + endfor endif endfor endfunction diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index 6809edd..aa6d113 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -4,9 +4,7 @@ function! ale#toggle#InitAuGroups() abort augroup ALEPatternOptionsGroup autocmd! - if g:ale_enabled && g:ale_pattern_options_enabled - autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions() - endif + autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions(str2nr(expand(''))) augroup END augroup ALERunOnTextChangedGroup @@ -71,7 +69,6 @@ function! ale#toggle#InitAuGroups() abort augroup END if !g:ale_enabled - augroup! ALEPatternOptionsGroup augroup! ALERunOnTextChangedGroup augroup! ALERunOnEnterGroup augroup! ALERunOnInsertLeave diff --git a/doc/ale.txt b/doc/ale.txt index 83646c5..4ad8891 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1007,11 +1007,14 @@ g:ale_pattern_options *g:ale_pattern_options* only `eslint` for checking those files by setting `b:ale_linters`. Filenames are matched with |match()|, and patterns depend on the |magic| - setting, unless prefixed with the special escape sequences like `'\v'`, etc. - - The patterns can match any part of a filename. The absolute path of the + setting, unless prefixed with the special escape sequences like `'\v'`, + etc.The patterns can match any part of a filename. The absolute path of the filename will be used for matching, taken from `expand('%:p')`. + The options for every match for the filename will be applied, with the + pattern keys sorted in alphabetical order. Options for `'zebra'` will + override the options for `'alpha'` for a filename `alpha-zebra`. + g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* @@ -1019,8 +1022,9 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* Default: `!empty(g:ale_pattern_options)` This option can be used for turning the behaviour of setting - |g:ale_pattern_options| on or off. By default, setting a single key - for |g:ale_pattern_options| will turn this option on. + |g:ale_pattern_options| on or off. By default, setting a single key for + |g:ale_pattern_options| will turn this option on, as long as the setting is + configured before ALE is loaded. g:ale_set_balloons *g:ale_set_balloons* diff --git a/test/test_autocmd_commands.vader b/test/test_autocmd_commands.vader index 88504a9..e7e9e86 100644 --- a/test/test_autocmd_commands.vader +++ b/test/test_autocmd_commands.vader @@ -108,17 +108,28 @@ Execute (g:ale_lint_on_insert_leave = 0 should bind no events): AssertEqual [], CheckAutocmd('ALERunOnInsertLeave') -Execute (g:ale_pattern_options_enabled = 0 should bind no events): - let g:ale_pattern_options_enabled = 0 - - AssertEqual [], CheckAutocmd('ALEPatternOptionsGroup') - Execute (g:ale_pattern_options_enabled = 1 should bind BufReadPost and BufEnter): let g:ale_pattern_options_enabled = 1 AssertEqual [ - \ 'BufEnter * call ale#pattern_options#SetOptions()', - \ 'BufReadPost * call ale#pattern_options#SetOptions()', + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \], CheckAutocmd('ALEPatternOptionsGroup') + +Execute (g:ale_pattern_options_enabled = 0 should still bind events): + let g:ale_pattern_options_enabled = 0 + + AssertEqual [ + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \], CheckAutocmd('ALEPatternOptionsGroup') + +Execute (g:ale_enabled = 0 should still bind pattern events): + let g:ale_enabled = 0 + + AssertEqual [ + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', \], CheckAutocmd('ALEPatternOptionsGroup') Execute (g:ale_lint_on_enter = 0 should bind only the BufEnter event): diff --git a/test/test_pattern_options.vader b/test/test_pattern_options.vader index 164e5aa..0ad4415 100644 --- a/test/test_pattern_options.vader +++ b/test/test_pattern_options.vader @@ -3,30 +3,74 @@ Before: Save g:ale_pattern_options_enabled Save &filetype + let g:ale_pattern_options_enabled = 1 + let g:ale_pattern_options = {} + + let b:ale_enabled = 0 + let b:some_option = 0 + + call ale#test#SetDirectory('/testplugin/test') + After: Restore unlet! b:ale_enabled unlet! b:some_option + call ale#test#RestoreDirectory() + +Execute(The pattern options function should work when there are no patterns): + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + Execute(Buffer variables should be set when filename patterns match): - let g:ale_pattern_options = {'baz.*\.js': { - \ 'ale_enabled': 1, - \ 'some_option': 347, - \ '&filetype': 'pattern_option_set_filetype', - \}} + let g:ale_pattern_options = { + \ 'baz.*\.js': { + \ 'ale_enabled': 1, + \ 'some_option': 347, + \ '&filetype': 'pattern_option_set_filetype', + \ }, + \} - silent! file foobar.js + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) - call ale#pattern_options#SetOptions() + AssertEqual 0, b:ale_enabled + AssertEqual 0, b:some_option - Assert !exists('b:ale_enabled') - Assert !exists('b:some_option') - - silent! file bazboz.js - - call ale#pattern_options#SetOptions() + call ale#test#SetFilename('bazboz.js') + call ale#pattern_options#SetOptions(bufnr('')) AssertEqual 1, b:ale_enabled AssertEqual 347, b:some_option AssertEqual 'pattern_option_set_filetype', &filetype + +Execute(Multiple pattern matches should be applied): + let g:ale_pattern_options = { + \ 'foo': { + \ 'some_option': 666, + \ }, + \ 'bar': { + \ 'ale_enabled': 1, + \ 'some_option': 123, + \ }, + \ 'notmatched': { + \ 'some_option': 489, + \ 'ale_enabled': 0, + \ }, + \} + + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 1, b:ale_enabled + AssertEqual 666, b:some_option + +Execute(Patterns should not be applied when the setting is disabled): + let g:ale_pattern_options_enabled = 0 + let g:ale_pattern_options = {'foo': {'some_option': 666}} + + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 0, b:some_option From bac02c9d81356f1cc1f38b598c30c9b46fe21b7b Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 14:26:54 +0000 Subject: [PATCH 087/390] #1095 Cache the sorting of patterns for g:ale_pattern_options --- autoload/ale/pattern_options.vim | 20 +++++++++++++++----- test/test_pattern_options.vader | 16 ++++++++++++++++ 2 files changed, 31 insertions(+), 5 deletions(-) diff --git a/autoload/ale/pattern_options.vim b/autoload/ale/pattern_options.vim index a55a27f..e58b8cf 100644 --- a/autoload/ale/pattern_options.vim +++ b/autoload/ale/pattern_options.vim @@ -1,6 +1,10 @@ " Author: w0rp " Description: Set options in files based on regex patterns. +" These variables are used to cache the sorting of patterns below. +let s:last_pattern_options = {} +let s:sorted_items = [] + function! s:CmpPatterns(left_item, right_item) abort if a:left_item[0] < a:right_item[0] return -1 @@ -18,13 +22,19 @@ function! ale#pattern_options#SetOptions(buffer) abort return endif + " The items will only be sorted whenever the patterns change. + if g:ale_pattern_options != s:last_pattern_options + let s:last_pattern_options = deepcopy(g:ale_pattern_options) + " The patterns are sorted, so they are applied consistently. + let s:sorted_items = sort( + \ items(g:ale_pattern_options), + \ function('s:CmpPatterns') + \) + endif + let l:filename = expand('#' . a:buffer . ':p') - " The patterns are sorted, so they are applied consistently. - for [l:pattern, l:options] in sort( - \ items(g:ale_pattern_options), - \ function('s:CmpPatterns') - \) + for [l:pattern, l:options] in s:sorted_items if match(l:filename, l:pattern) >= 0 for [l:key, l:value] in items(l:options) call setbufvar(a:buffer, l:key, l:value) diff --git a/test/test_pattern_options.vader b/test/test_pattern_options.vader index 0ad4415..0e26eaa 100644 --- a/test/test_pattern_options.vader +++ b/test/test_pattern_options.vader @@ -74,3 +74,19 @@ Execute(Patterns should not be applied when the setting is disabled): call ale#pattern_options#SetOptions(bufnr('')) AssertEqual 0, b:some_option + +" This test is important for making sure we update the sorted items. +Execute(Patterns should be applied after the Dictionary changes): + call ale#test#SetFilename('foobar.js') + + let g:ale_pattern_options = {} + + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 0, b:some_option + + let g:ale_pattern_options['foo'] = {'some_option': 666} + + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 666, b:some_option From 9e7c493e7e6a5b7d22502aebda399e93d40a7974 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 14:27:53 +0000 Subject: [PATCH 088/390] Fix a typo --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 4ad8891..54f1b22 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -882,7 +882,7 @@ g:ale_linter_aliases *g:ale_linter_aliases* `let g:ale_linter_aliases = {'html': ['html', 'javascript', 'css']}` Note that `html` itself was included as an alias. That is because aliases - will override the original linters for the aliased filetepe. + will override the original linters for the aliased filetype. Linter aliases can be configured in each buffer with buffer-local variables. ALE will first look for aliases for filetypes in the `b:ale_linter_aliases` From f8fec369e5daa1be9c3b8e580655920422542f75 Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sat, 11 Nov 2017 19:27:41 +0100 Subject: [PATCH 089/390] Add ocaml-language-server for OCaml and ReasonML --- README.md | 4 ++-- ale_linters/ocaml/ols.vim | 14 ++++++++++++++ ale_linters/reason/ols.vim | 14 ++++++++++++++ autoload/ale/handlers/ols.vim | 25 +++++++++++++++++++++++++ doc/ale-ocaml.txt | 22 ++++++++++++++++++++++ doc/ale-reasonml.txt | 23 +++++++++++++++++++++++ doc/ale.txt | 6 ++++-- 7 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 ale_linters/ocaml/ols.vim create mode 100644 ale_linters/reason/ols.vim create mode 100644 autoload/ale/handlers/ols.vim diff --git a/README.md b/README.md index 7cfbf62..2a74d85 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ formatting. | nroff | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Objective-C | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) | -| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions | +| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | @@ -129,7 +129,7 @@ formatting. | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | -| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | +| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | diff --git a/ale_linters/ocaml/ols.vim b/ale_linters/ocaml/ols.vim new file mode 100644 index 0000000..c0255a6 --- /dev/null +++ b/ale_linters/ocaml/ols.vim @@ -0,0 +1,14 @@ +" Author: Michael Jungo +" Description: A language server for OCaml + +call ale#Set('ocaml_ols_executable', 'ocaml-language-server') +call ale#Set('ocaml_ols_use_global', 0) + +call ale#linter#Define('ocaml', { +\ 'name': 'ols', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale#handlers#ols#GetExecutable', +\ 'command_callback': 'ale#handlers#ols#GetCommand', +\ 'language_callback': 'ale#handlers#ols#GetLanguage', +\ 'project_root_callback': 'ale#handlers#ols#GetProjectRoot', +\}) diff --git a/ale_linters/reason/ols.vim b/ale_linters/reason/ols.vim new file mode 100644 index 0000000..b2cd5f7 --- /dev/null +++ b/ale_linters/reason/ols.vim @@ -0,0 +1,14 @@ +" Author: Michael Jungo +" Description: A language server for Reason + +call ale#Set('reason_ols_executable', 'ocaml-language-server') +call ale#Set('reason_ols_use_global', 0) + +call ale#linter#Define('reason', { +\ 'name': 'ols', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale#handlers#ols#GetExecutable', +\ 'command_callback': 'ale#handlers#ols#GetCommand', +\ 'language_callback': 'ale#handlers#ols#GetLanguage', +\ 'project_root_callback': 'ale#handlers#ols#GetProjectRoot', +\}) diff --git a/autoload/ale/handlers/ols.vim b/autoload/ale/handlers/ols.vim new file mode 100644 index 0000000..1dda7f9 --- /dev/null +++ b/autoload/ale/handlers/ols.vim @@ -0,0 +1,25 @@ +" Author: Michael Jungo +" Description: Handlers for the OCaml language server + +function! ale#handlers#ols#GetExecutable(buffer) abort + let l:ols_setting = ale#handlers#ols#GetLanguage(a:buffer) . '_ols' + return ale#node#FindExecutable(a:buffer, l:ols_setting, [ + \ 'node_modules/.bin/ocaml-language-server', + \]) +endfunction + +function! ale#handlers#ols#GetCommand(buffer) abort + let l:executable = ale#handlers#ols#GetExecutable(a:buffer) + + return ale#node#Executable(a:buffer, l:executable) . ' --stdio' +endfunction + +function! ale#handlers#ols#GetLanguage(buffer) abort + return getbufvar(a:buffer, '&filetype') +endfunction + +function! ale#handlers#ols#GetProjectRoot(buffer) abort + let l:merlin_file = ale#path#FindNearestFile(a:buffer, '.merlin') + + return !empty(l:merlin_file) ? fnamemodify(l:merlin_file, ':h') : '' +endfunction diff --git a/doc/ale-ocaml.txt b/doc/ale-ocaml.txt index 093d911..cfa365a 100644 --- a/doc/ale-ocaml.txt +++ b/doc/ale-ocaml.txt @@ -10,6 +10,28 @@ merlin *ale-ocaml-merlin* detailed instructions (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). +=============================================================================== +ols *ale-ocaml-ols* + + The `ocaml-language-server` is the engine that powers OCaml and ReasonML + editor support using the Language Server Protocol. See the installation + instructions: + https://github.com/freebroccolo/ocaml-language-server#installation + +g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable* + *b:ale_ocaml_ols_executable* + Type: |String| + Default: `'ocaml-language-server'` + + This variable can be set to change the executable path for `ols`. + +g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global* + *b:ale_ocaml_ols_use_global* + Type: |String| + Default: `0` + + This variable can be set to `1` to always use the globally installed + executable. See also |ale-integrations-local-executables|. =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-reasonml.txt b/doc/ale-reasonml.txt index d533d85..36ddd75 100644 --- a/doc/ale-reasonml.txt +++ b/doc/ale-reasonml.txt @@ -10,6 +10,29 @@ merlin *ale-reasonml-merlin* detailed instructions (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). +=============================================================================== +ols *ale-reasonml-ols* + + The `ocaml-language-server` is the engine that powers OCaml and ReasonML + editor support using the Language Server Protocol. See the installation + instructions: + https://github.com/freebroccolo/ocaml-language-server#installation + +g:ale_reason_ols_executable *g:ale_reason_ols_executable* + *b:ale_reason_ols_executable* + Type: |String| + Default: `'ocaml-language-server'` + + This variable can be set to change the executable path for `ols`. + +g:ale_reason_ols_use_global *g:ale_reason_ols_use_global* + *b:ale_reason_ols_use_global* + Type: |String| + Default: `0` + + This variable can be set to `1` to always use the globally installed + executable. See also |ale-integrations-local-executables|. + =============================================================================== refmt *ale-reasonml-refmt* diff --git a/doc/ale.txt b/doc/ale.txt index 54f1b22..ae6b7ab 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -120,6 +120,7 @@ CONTENTS *ale-contents* clang...............................|ale-objcpp-clang| ocaml.................................|ale-ocaml-options| merlin..............................|ale-ocaml-merlin| + ols.................................|ale-ocaml-ols| perl..................................|ale-perl-options| perl................................|ale-perl-perl| perlcritic..........................|ale-perl-perlcritic| @@ -153,6 +154,7 @@ CONTENTS *ale-contents* lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| + ols.................................|ale-reasonml-ols| refmt...............................|ale-reasonml-refmt| restructuredtext......................|ale-restructuredtext-options| write-good..........................|ale-restructuredtext-write-good| @@ -306,7 +308,7 @@ Notes: * nroff: `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` -* OCaml: `merlin` (see |ale-ocaml-merlin|) +* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint`, `write-good` @@ -315,7 +317,7 @@ Notes: * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` -* ReasonML: `merlin`, `refmt` +* ReasonML: `merlin`, `ols`, `refmt` * reStructuredText: `proselint`, `rstcheck`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` From fb00acf73441bffa9014f5a64a3f054069683052 Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sat, 11 Nov 2017 19:28:24 +0100 Subject: [PATCH 090/390] Remove id from LSP notifications --- autoload/ale/lsp.vim | 3 +-- test/lsp/test_lsp_connections.vader | 28 ++++++++++++++-------------- 2 files changed, 15 insertions(+), 16 deletions(-) diff --git a/autoload/ale/lsp.vim b/autoload/ale/lsp.vim index b6c890c..126d6c1 100644 --- a/autoload/ale/lsp.vim +++ b/autoload/ale/lsp.vim @@ -83,9 +83,8 @@ function! ale#lsp#CreateMessageData(message) abort let l:is_notification = a:message[0] let l:obj = { - \ 'id': v:null, - \ 'jsonrpc': '2.0', \ 'method': a:message[1], + \ 'jsonrpc': '2.0', \} if !l:is_notification diff --git a/test/lsp/test_lsp_connections.vader b/test/lsp/test_lsp_connections.vader index 5549b1f..8651d80 100644 --- a/test/lsp/test_lsp_connections.vader +++ b/test/lsp/test_lsp_connections.vader @@ -26,7 +26,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 1, \ "Content-Length: 79\r\n\r\n" - \ . '{"id": 1, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}', + \ . '{"method": "someMethod", "jsonrpc": "2.0", "id": 1, "params": {"foo": "barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) " Check again to ensure that we use the next ID. @@ -34,7 +34,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 2, \ "Content-Length: 79\r\n\r\n" - \ . '{"id": 2, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}', + \ . '{"method": "someMethod", "jsonrpc": "2.0", "id": 2, "params": {"foo": "barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) else @@ -42,14 +42,14 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 1, \ "Content-Length: 71\r\n\r\n" - \ . '{"id":1,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}', + \ . '{"method":"someMethod","jsonrpc":"2.0","id":1,"params":{"foo":"barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) AssertEqual \ [ \ 2, \ "Content-Length: 71\r\n\r\n" - \ . '{"id":2,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}', + \ . '{"method":"someMethod","jsonrpc":"2.0","id":2,"params":{"foo":"barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) endif @@ -60,7 +60,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params): \ [ \ 1, \ "Content-Length: 56\r\n\r\n" - \ . '{"id": 1, "jsonrpc": "2.0", "method": "someOtherMethod"}', + \ . '{"method": "someOtherMethod", "jsonrpc": "2.0", "id": 1}', \ ], \ ale#lsp#CreateMessageData([0, 'someOtherMethod']) else @@ -68,7 +68,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params): \ [ \ 1, \ "Content-Length: 51\r\n\r\n" - \ . '{"id":1,"jsonrpc":"2.0","method":"someOtherMethod"}', + \ . '{"method":"someOtherMethod","jsonrpc":"2.0","id":1}', \ ], \ ale#lsp#CreateMessageData([0, 'someOtherMethod']) endif @@ -78,30 +78,30 @@ Execute(ale#lsp#CreateMessageData() should create notifications): AssertEqual \ [ \ 0, - \ "Content-Length: 60\r\n\r\n" - \ . '{"id": null, "jsonrpc": "2.0", "method": "someNotification"}', + \ "Content-Length: 48\r\n\r\n" + \ . '{"method": "someNotification", "jsonrpc": "2.0"}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification']) AssertEqual \ [ \ 0, - \ "Content-Length: 86\r\n\r\n" - \ . '{"id": null, "jsonrpc": "2.0", "method": "someNotification", "params": {"foo": "bar"}}', + \ "Content-Length: 74\r\n\r\n" + \ . '{"method": "someNotification", "jsonrpc": "2.0", "params": {"foo": "bar"}}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}]) else AssertEqual \ [ \ 0, - \ "Content-Length: 55\r\n\r\n" - \ . '{"id":null,"jsonrpc":"2.0","method":"someNotification"}', + \ "Content-Length: 45\r\n\r\n" + \ . '{"method":"someNotification","jsonrpc":"2.0"}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification']) AssertEqual \ [ \ 0, - \ "Content-Length: 78\r\n\r\n" - \ . '{"id":null,"jsonrpc":"2.0","method":"someNotification","params":{"foo":"bar"}}', + \ "Content-Length: 68\r\n\r\n" + \ . '{"method":"someNotification","jsonrpc":"2.0","params":{"foo":"bar"}}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}]) endif From 4d44996af618bf3907370e45a1e875e3802398d0 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 15:15:19 -0500 Subject: [PATCH 091/390] perlcritic: all issues are warnings Perlcritic is a style checker, not a syntax validator. This change was originally proposed by @RsrchBoy in https://github.com/w0rp/ale/pull/784. --- ale_linters/perl/perlcritic.vim | 1 + test/handler/test_perlcritic_handler.vader | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 test/handler/test_perlcritic_handler.vader diff --git a/ale_linters/perl/perlcritic.vim b/ale_linters/perl/perlcritic.vim index df2f8b2..24f7eb8 100644 --- a/ale_linters/perl/perlcritic.vim +++ b/ale_linters/perl/perlcritic.vim @@ -61,6 +61,7 @@ function! ale_linters#perl#perlcritic#Handle(buffer, lines) abort \ 'lnum': l:match[1], \ 'col': l:match[2], \ 'text': l:match[3], + \ 'type': 'W' \}) endfor diff --git a/test/handler/test_perlcritic_handler.vader b/test/handler/test_perlcritic_handler.vader new file mode 100644 index 0000000..f00b07d --- /dev/null +++ b/test/handler/test_perlcritic_handler.vader @@ -0,0 +1,20 @@ +Before: + runtime ale_linters/perl/perlcritic.vim + +After: + call ale#linter#Reset() + +Execute(The Perl::Critic handler should create all issues as warnings): + AssertEqual + \ [ + \ { + \ 'lnum': '21', + \ 'col': '17', + \ 'text': 'Regular expression without "/m" flag', + \ 'type': 'W', + \ } + \ ], + \ ale_linters#perl#perlcritic#Handle(99, [ + \ '21:17 Regular expression without "/m" flag' + \ ]) + From f6ac8a9eb9f2960747a2685be5e7d5ec4650b2d2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 23:04:08 +0000 Subject: [PATCH 092/390] #1108 Support selecting fixers with Lists --- autoload/ale/fix.vim | 27 +++++++++++++++++---------- doc/ale.txt | 19 +++++++++++++++++-- test/test_ale_fix.vader | 9 +++++++++ 3 files changed, 43 insertions(+), 12 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index a57ad19..5a42b74 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -332,18 +332,25 @@ function! s:RunFixer(options) abort endfunction function! s:GetCallbacks() abort - let l:fixers = ale#Var(bufnr(''), 'fixers') - let l:callback_list = [] + if type(get(b:, 'ale_fixers')) is type([]) + " Lists can be used for buffer-local variables only + let l:callback_list = b:ale_fixers + else + " buffer and global options can use dictionaries mapping filetypes to + " callbacks to run. + let l:fixers = ale#Var(bufnr(''), 'fixers') + let l:callback_list = [] - for l:sub_type in split(&filetype, '\.') - let l:sub_type_callacks = get(l:fixers, l:sub_type, []) + for l:sub_type in split(&filetype, '\.') + let l:sub_type_callacks = get(l:fixers, l:sub_type, []) - if type(l:sub_type_callacks) == type('') - call add(l:callback_list, l:sub_type_callacks) - else - call extend(l:callback_list, l:sub_type_callacks) - endif - endfor + if type(l:sub_type_callacks) == type('') + call add(l:callback_list, l:sub_type_callacks) + else + call extend(l:callback_list, l:sub_type_callacks) + endif + endfor + endif if empty(l:callback_list) return [] diff --git a/doc/ale.txt b/doc/ale.txt index ae6b7ab..cd6c336 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -490,6 +490,18 @@ upon some lines immediately, then run `eslint` from the ALE registry, and then call a lambda function which will remove every single line comment from the file. +For buffer-local settings, such as in |g:ale_pattern_options| or in ftplugin +files, a |List| may be used for configuring the fixers instead. +> + " Same as the above, only a List can be used instead of a Dictionary. + let b:ale_fixers = [ + \ 'DoSomething', + \ 'eslint', + \ {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')}, + \] + + ALEFix +< For convenience, a plug mapping is defined for |ALEFix|, so you can set up a keybind easily for fixing files. > @@ -694,6 +706,8 @@ g:ale_fixers *g:ale_fixers* See |ale-fix| for more information. This variable can be overridden with variables in each buffer. + `b:ale_fixers` can be set to a |List| of callbacks instead, which can be + more convenient. g:ale_fix_on_save *g:ale_fix_on_save* @@ -999,14 +1013,15 @@ g:ale_pattern_options *g:ale_pattern_options* buffer variables. This option can be set to automatically configure different settings for different files. For example: > + " Use just ESLint for linting and fixing files which end in '.foo.js' let g:ale_pattern_options = { \ '\.foo\.js$': { \ 'ale_linters': {'javascript': ['eslint']}, + \ 'ale_fixers: ['eslint'], \ }, \} < - The above example will match any filename ending in `.foo.js`, and use - only `eslint` for checking those files by setting `b:ale_linters`. + See |b:ale_linters| and |b:ale_fixers| for information for those options. Filenames are matched with |match()|, and patterns depend on the |magic| setting, unless prefixed with the special escape sequences like `'\v'`, diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index ffe3d93..ac6427a 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -330,6 +330,15 @@ Expect(There should be only two lines): a b +Execute(ALEFix should allow Lists to be used for buffer-local fixer settings): + let g:ale_fixers.testft = ['AddCarets', 'AddDollars'] + let b:ale_fixers = ['RemoveLastLine'] + ALEFix + +Expect(There should be only two lines): + a + b + Given testft (A file with three lines): a b From ae08f80eade5c28efa54d8366368f2addaec6f35 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 23:55:04 +0000 Subject: [PATCH 093/390] #1108 Support using Lists and 'all' for b:ale_linters --- autoload/ale/linter.vim | 18 +++++++++++++----- doc/ale.txt | 16 +++++++++++++++- test/test_linter_retrieval.vader | 24 ++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 6 deletions(-) diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index 269b092..00ab916 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -289,11 +289,19 @@ function! ale#linter#ResolveFiletype(original_filetype) abort endfunction function! s:GetLinterNames(original_filetype) abort - for l:dict in [ - \ get(b:, 'ale_linters', {}), - \ g:ale_linters, - \ s:default_ale_linters, - \] + let l:buffer_ale_linters = get(b:, 'ale_linters', {}) + + " b:ale_linters can be set to 'all' + if l:buffer_ale_linters is# 'all' + return 'all' + endif + + " b:ale_linters can be set to a List. + if type(l:buffer_ale_linters) is type([]) + return l:buffer_ale_linters + endif + + for l:dict in [l:buffer_ale_linters, g:ale_linters, s:default_ale_linters] if has_key(l:dict, a:original_filetype) return l:dict[a:original_filetype] endif diff --git a/doc/ale.txt b/doc/ale.txt index cd6c336..488c222 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -944,6 +944,20 @@ g:ale_linters *g:ale_linters* will first look for linters for filetypes in the `b:ale_linters` variable, then `g:ale_linters`, and then a default Dictionary. + `b:ale_linters` can be set to a List, or the string `'all'`. When linters + for two different filetypes share the same name, the first linter loaded + will be used. Any ambiguity can be resolved by using a Dictionary specifying + which linter to run for which filetype instead. > + + " Use ESLint for the buffer if the filetype includes 'javascript'. + let b:ale_linters = {'javascript': ['eslint'], 'html': ['tidy']} + " Use a List for the same setting. This will work in most cases. + let b:ale_linters = ['eslint', 'tidy'] + " Disable all linters for the buffer. + let b:ale_linters = [] + " Explicitly enable all available linters for the filetype. + let b:ale_linters = 'all' +< g:ale_max_buffer_history_size *g:ale_max_buffer_history_size* @@ -1016,7 +1030,7 @@ g:ale_pattern_options *g:ale_pattern_options* " Use just ESLint for linting and fixing files which end in '.foo.js' let g:ale_pattern_options = { \ '\.foo\.js$': { - \ 'ale_linters': {'javascript': ['eslint']}, + \ 'ale_linters': ['eslint'], \ 'ale_fixers: ['eslint'], \ }, \} diff --git a/test/test_linter_retrieval.vader b/test/test_linter_retrieval.vader index 1a1e258..265738f 100644 --- a/test/test_linter_retrieval.vader +++ b/test/test_linter_retrieval.vader @@ -42,6 +42,30 @@ Execute (You should be able to select linters with a buffer option): AssertEqual [g:testlinter1], ale#linter#Get('testft') +Execute (b:ale_linters should work when set to a List): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1', 'testlinter2']} + let b:ale_linters = ['testlinter1'] + + AssertEqual [g:testlinter1], ale#linter#Get('testft') + +Execute (b:ale_linters should disable all linters when set to an empty List): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1', 'testlinter2']} + let b:ale_linters = [] + + AssertEqual [], ale#linter#Get('testft') + +Execute (b:ale_linters should enable all available linters when set to 'all'): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1']} + let b:ale_linters = 'all' + + AssertEqual [g:testlinter1, g:testlinter2], ale#linter#Get('testft') + Execute (Buffer settings shouldn't completely replace global settings): call ale#linter#Define('testft', g:testlinter1) call ale#linter#Define('testft', g:testlinter2) From 27e2f53ac9892e8285d629228d5c25bdcdf84803 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 00:11:50 +0000 Subject: [PATCH 094/390] #1108 Support setting b:ale_linter_aliases to a List --- autoload/ale/linter.vim | 9 ++++++++- doc/ale.txt | 6 ++++++ test/test_linter_retrieval.vader | 15 +++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index 00ab916..c6667d9 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -261,12 +261,19 @@ function! ale#linter#GetAll(filetypes) abort endfunction function! s:GetAliasedFiletype(original_filetype) abort + let l:buffer_aliases = get(b:, 'ale_linter_aliases', {}) + + " b:ale_linter_aliases can be set to a List. + if type(l:buffer_aliases) is type([]) + return l:buffer_aliases + endif + " Check for aliased filetypes first in a buffer variable, " then the global variable, " then in the default mapping, " otherwise use the original filetype. for l:dict in [ - \ get(b:, 'ale_linter_aliases', {}), + \ l:buffer_aliases, \ g:ale_linter_aliases, \ s:default_ale_linter_aliases, \] diff --git a/doc/ale.txt b/doc/ale.txt index 488c222..ae69269 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -904,6 +904,12 @@ g:ale_linter_aliases *g:ale_linter_aliases* ALE will first look for aliases for filetypes in the `b:ale_linter_aliases` variable, then `g:ale_linter_aliases`, and then a default Dictionary. + `b:ale_linter_aliases` can be set to a |List|, to tell ALE to load the + linters for specific filetypes for a given buffer. > + + let b:ale_linter_aliases = ['html', 'javascript', 'css'] +< + No linters will be loaded when the buffer's filetype is empty. g:ale_linters *g:ale_linters* *b:ale_linters* diff --git a/test/test_linter_retrieval.vader b/test/test_linter_retrieval.vader index 265738f..5d5b582 100644 --- a/test/test_linter_retrieval.vader +++ b/test/test_linter_retrieval.vader @@ -126,6 +126,21 @@ Execute (The local alias option shouldn't completely replace the global one): " global Dictionary. let b:ale_linter_aliases = {'testft3': ['testft1']} +Execute (Lists should be accepted for local aliases): + call ale#linter#Define('testft1', g:testlinter1) + call ale#linter#Define('testft2', g:testlinter2) + let g:ale_linter_aliases = {'testft1': ['testft1', 'testft2']} + " We should load the testft2 linters for this buffer, with no duplicates. + let b:ale_linter_aliases = ['testft2'] + + AssertEqual [g:testlinter2], ale#linter#Get('anything.else') + +Execute (Buffer-local overrides for aliases should be used): + call ale#linter#Define('testft1', g:testlinter1) + call ale#linter#Define('testft2', g:testlinter2) + let g:ale_linter_aliases = {'testft1': ['testft2']} + let b:ale_linter_aliases = {'testft1': ['testft1', 'testft2']} + AssertEqual [g:testlinter1, g:testlinter2], ale#linter#Get('testft1') Execute (Linters should be loaded from disk appropriately): From cb3a25f276f853ea44140063a1f7246c37fa1252 Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sun, 12 Nov 2017 02:06:28 +0100 Subject: [PATCH 095/390] Add tests for ocaml-language-server callbacks --- test/command_callback/ols_paths/.merlin | 0 .../node_modules/.bin/ocaml-language-server | 0 .../test_ocaml_ols_callbacks.vader | 54 +++++++++++++++++++ .../test_reason_ols_callbacks.vader | 54 +++++++++++++++++++ 4 files changed, 108 insertions(+) create mode 100644 test/command_callback/ols_paths/.merlin create mode 100644 test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server create mode 100644 test/command_callback/test_ocaml_ols_callbacks.vader create mode 100644 test/command_callback/test_reason_ols_callbacks.vader diff --git a/test/command_callback/ols_paths/.merlin b/test/command_callback/ols_paths/.merlin new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server b/test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_ocaml_ols_callbacks.vader b/test/command_callback/test_ocaml_ols_callbacks.vader new file mode 100644 index 0000000..2c44dbc --- /dev/null +++ b/test/command_callback/test_ocaml_ols_callbacks.vader @@ -0,0 +1,54 @@ +Before: + Save &filetype + Save g:ale_ocaml_ols_executable + Save g:ale_ocaml_ols_use_global + + let &filetype = 'ocaml' + unlet! g:ale_ocaml_ols_executable + unlet! g:ale_ocaml_ols_use_global + + runtime ale_linters/ocaml/ols.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The language string should be correct): + AssertEqual 'ocaml', ale#handlers#ols#GetLanguage(bufnr('')) + +Execute(The default executable should be correct): + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('ocaml-language-server') . ' --stdio', + \ ale#handlers#ols#GetCommand(bufnr('')) + +Execute(The project root should be detected correctly): + AssertEqual '', ale#handlers#ols#GetProjectRoot(bufnr('')) + + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#handlers#ols#GetProjectRoot(bufnr('')) + +Execute(The local executable should be used when available): + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The gloabl executable should always be used when use_global is set): + let g:ale_ocaml_ols_use_global = 1 + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The executable should be configurable): + let g:ale_ocaml_ols_executable = 'foobar' + + AssertEqual 'foobar', ale#handlers#ols#GetExecutable(bufnr('')) diff --git a/test/command_callback/test_reason_ols_callbacks.vader b/test/command_callback/test_reason_ols_callbacks.vader new file mode 100644 index 0000000..ffe403f --- /dev/null +++ b/test/command_callback/test_reason_ols_callbacks.vader @@ -0,0 +1,54 @@ +Before: + Save &filetype + Save g:ale_reason_ols_executable + Save g:ale_reason_ols_use_global + + let &filetype = 'reason' + unlet! g:ale_reason_ols_executable + unlet! g:ale_reason_ols_use_global + + runtime ale_linters/reason/ols.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The language string should be correct): + AssertEqual 'reason', ale#handlers#ols#GetLanguage(bufnr('')) + +Execute(The default executable should be correct): + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('ocaml-language-server') . ' --stdio', + \ ale#handlers#ols#GetCommand(bufnr('')) + +Execute(The project root should be detected correctly): + AssertEqual '', ale#handlers#ols#GetProjectRoot(bufnr('')) + + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#handlers#ols#GetProjectRoot(bufnr('')) + +Execute(The local executable should be used when available): + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The gloabl executable should always be used when use_global is set): + let g:ale_reason_ols_use_global = 1 + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The executable should be configurable): + let g:ale_reason_ols_executable = 'foobar' + + AssertEqual 'foobar', ale#handlers#ols#GetExecutable(bufnr('')) From 911b6d8f71213d065bd14548a16ba9140f1790ee Mon Sep 17 00:00:00 2001 From: wuqiong4945 Date: Thu, 9 Nov 2017 21:14:29 +0800 Subject: [PATCH 096/390] add 'output_stream': 'stderr', let golint work --- ale_linters/go/golint.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/ale_linters/go/golint.vim b/ale_linters/go/golint.vim index cc807fe..708cf15 100644 --- a/ale_linters/go/golint.vim +++ b/ale_linters/go/golint.vim @@ -3,6 +3,7 @@ call ale#linter#Define('go', { \ 'name': 'golint', +\ 'output_stream': 'stderr', \ 'executable': 'golint', \ 'command': 'golint %t', \ 'callback': 'ale#handlers#unix#HandleAsWarning', From a8c5e0f4dce14b9dad8e4a238ebc93d8aa6ed28e Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 9 Nov 2017 23:42:54 +0000 Subject: [PATCH 097/390] Simplfy semver handling and share the semver version cache across everything --- ale_linters/javascript/flow.vim | 13 ++-- ale_linters/python/flake8.vim | 43 ++----------- ale_linters/rust/cargo.vim | 62 ++++-------------- ale_linters/sh/shellcheck.vim | 31 ++------- ale_linters/vim/vint.vim | 20 ++---- autoload/ale/handlers/gcc.vim | 12 ---- autoload/ale/semver.vim | 52 +++++++++++---- .../test_cargo_command_callbacks.vader | 1 + .../test_flake8_command_callback.vader | 11 ++-- test/handler/test_gcc_handler.vader | 11 ---- test/test_flow_command.vader | 1 + test/test_semver_utils.vader | 64 ++++++++++++++----- 12 files changed, 133 insertions(+), 188 deletions(-) diff --git a/ale_linters/javascript/flow.vim b/ale_linters/javascript/flow.vim index 0dd6453..6d51628 100644 --- a/ale_linters/javascript/flow.vim +++ b/ale_linters/javascript/flow.vim @@ -23,18 +23,15 @@ function! ale_linters#javascript#flow#GetCommand(buffer, version_lines) abort return '' endif - let l:use_respect_pragma = 1 + let l:executable = ale_linters#javascript#flow#GetExecutable(a:buffer) + let l:version = ale#semver#GetVersion(l:executable, a:version_lines) " If we can parse the version number, then only use --respect-pragma " if the version is >= 0.36.0, which added the argument. - for l:match in ale#util#GetMatches(a:version_lines, '\v\d+\.\d+\.\d+$') - let l:use_respect_pragma = ale#semver#GreaterOrEqual( - \ ale#semver#Parse(l:match[0]), - \ [0, 36, 0] - \) - endfor + let l:use_respect_pragma = empty(l:version) + \ || ale#semver#GTE(l:version, [0, 36]) - return ale#Escape(ale_linters#javascript#flow#GetExecutable(a:buffer)) + return ale#Escape(l:executable) \ . ' check-contents' \ . (l:use_respect_pragma ? ' --respect-pragma': '') \ . ' --json --from ale %s' diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim index 8aa4c4d..501db0b 100644 --- a/ale_linters/python/flake8.vim +++ b/ale_linters/python/flake8.vim @@ -10,10 +10,6 @@ let g:ale_python_flake8_options = \ get(g:, 'ale_python_flake8_options', s:default_options) let g:ale_python_flake8_use_global = get(g:, 'ale_python_flake8_use_global', 0) -" A map from Python executable paths to semver strings parsed for those -" executables, so we don't have to look up the version number constantly. -let s:version_cache = {} - function! s:UsingModule(buffer) abort return ale#Var(a:buffer, 'python_flake8_options') =~# ' *-m flake8' endfunction @@ -26,62 +22,35 @@ function! ale_linters#python#flake8#GetExecutable(buffer) abort return ale#Var(a:buffer, 'python_flake8_executable') endfunction -function! ale_linters#python#flake8#ClearVersionCache() abort - let s:version_cache = {} -endfunction - function! ale_linters#python#flake8#VersionCheck(buffer) abort let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) " If we have previously stored the version number in a cache, then " don't look it up again. - if has_key(s:version_cache, l:executable) + if ale#semver#HasVersion(l:executable) " Returning an empty string skips this command. return '' endif - let l:executable = ale#Escape(ale_linters#python#flake8#GetExecutable(a:buffer)) + let l:executable = ale#Escape(l:executable) let l:module_string = s:UsingModule(a:buffer) ? ' -m flake8' : '' return l:executable . l:module_string . ' --version' endfunction -" Get the flake8 version from the output, or the cache. -function! s:GetVersion(buffer, version_output) abort - let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) - let l:version = [] - - " Get the version from the cache. - if has_key(s:version_cache, l:executable) - return s:version_cache[l:executable] - endif - - if !empty(a:version_output) - " Parse the version string, and store it in the cache. - let l:version = ale#semver#Parse(a:version_output[0]) - let s:version_cache[l:executable] = l:version - endif - - return l:version -endfunction - -" flake8 versions 3 and up support the --stdin-display-name argument. -function! s:SupportsDisplayName(version) abort - return !empty(a:version) && ale#semver#GreaterOrEqual(a:version, [3, 0, 0]) -endfunction - function! ale_linters#python#flake8#GetCommand(buffer, version_output) abort - let l:version = s:GetVersion(a:buffer, a:version_output) + let l:executable = ale_linters#python#flake8#GetExecutable(a:buffer) + let l:version = ale#semver#GetVersion(l:executable, a:version_output) " Only include the --stdin-display-name argument if we can parse the " flake8 version, and it is recent enough to support it. - let l:display_name_args = s:SupportsDisplayName(l:version) + let l:display_name_args = ale#semver#GTE(l:version, [3, 0, 0]) \ ? ' --stdin-display-name %s' \ : '' let l:options = ale#Var(a:buffer, 'python_flake8_options') - return ale#Escape(ale_linters#python#flake8#GetExecutable(a:buffer)) + return ale#Escape(l:executable) \ . (!empty(l:options) ? ' ' . l:options : '') \ . ' --format=default' \ . l:display_name_args . ' -' diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index f41cb4b..ae26fab 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -4,8 +4,6 @@ call ale#Set('rust_cargo_use_check', 1) call ale#Set('rust_cargo_check_all_targets', 1) -let s:version_cache = {} - function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# '' return 'cargo' @@ -17,59 +15,23 @@ function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort endfunction function! ale_linters#rust#cargo#VersionCheck(buffer) abort - if has_key(s:version_cache, 'cargo') - return '' - endif - - return 'cargo --version' -endfunction - -function! s:GetVersion(executable, output) abort - let l:version = get(s:version_cache, a:executable, []) - - for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') - let l:version = ale#semver#Parse(l:match[0]) - let s:version_cache[a:executable] = l:version - endfor - - return l:version -endfunction - -function! s:CanUseCargoCheck(buffer, version) abort - " Allow `cargo check` to be disabled. - if !ale#Var(a:buffer, 'rust_cargo_use_check') - return 0 - endif - - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 17, 0]) -endfunction - -function! s:CanUseAllTargets(buffer, version) abort - if !ale#Var(a:buffer, 'rust_cargo_use_check') - return 0 - endif - - if !ale#Var(a:buffer, 'rust_cargo_check_all_targets') - return 0 - endif - - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 22, 0]) + return !ale#semver#HasVersion('cargo') + \ ? 'cargo --version' + \ : '' endfunction function! ale_linters#rust#cargo#GetCommand(buffer, version_output) abort - let l:version = s:GetVersion('cargo', a:version_output) - let l:command = s:CanUseCargoCheck(a:buffer, l:version) - \ ? 'check' - \ : 'build' - let l:all_targets = s:CanUseAllTargets(a:buffer, l:version) - \ ? ' --all-targets' - \ : '' + let l:version = ale#semver#GetVersion('cargo', a:version_output) + + let l:use_check = ale#Var(a:buffer, 'rust_cargo_use_check') + \ && ale#semver#GTE(l:version, [0, 17, 0]) + let l:use_all_targets = l:use_check + \ && ale#Var(a:buffer, 'rust_cargo_check_all_targets') + \ && ale#semver#GTE(l:version, [0, 22, 0]) return 'cargo ' - \ . l:command - \ . l:all_targets + \ . (l:use_check ? 'check' : 'build') + \ . (l:use_all_targets ? ' --all-targets' : '') \ . ' --frozen --message-format=json -q' endfunction diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 1f6bdf8..e79b3b8 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -15,8 +15,6 @@ let g:ale_sh_shellcheck_executable = let g:ale_sh_shellcheck_options = \ get(g:, 'ale_sh_shellcheck_options', '') -let s:version_cache = {} - function! ale_linters#sh#shellcheck#GetExecutable(buffer) abort return ale#Var(a:buffer, 'sh_shellcheck_executable') endfunction @@ -49,38 +47,19 @@ function! ale_linters#sh#shellcheck#VersionCheck(buffer) abort let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) " Don't check the version again if we've already cached it. - if has_key(s:version_cache, l:executable) - return '' - endif - - return ale#Escape(l:executable) . ' --version' -endfunction - -" Get the shellcheck version from the cache, or parse it and cache it. -function! s:GetVersion(executable, output) abort - let l:version = get(s:version_cache, a:executable, []) - - for l:match in ale#util#GetMatches(a:output, '\v\d+\.\d+\.\d+') - let l:version = ale#semver#Parse(l:match[0]) - let s:version_cache[a:executable] = l:version - endfor - - return l:version -endfunction - -function! s:CanUseExternalOption(version) abort - return !empty(a:version) - \ && ale#semver#GreaterOrEqual(a:version, [0, 4, 0]) + return !ale#semver#HasVersion(l:executable) + \ ? ale#Escape(l:executable) . ' --version' + \ : '' endfunction function! ale_linters#sh#shellcheck#GetCommand(buffer, version_output) abort let l:executable = ale_linters#sh#shellcheck#GetExecutable(a:buffer) - let l:version = s:GetVersion(l:executable, a:version_output) + let l:version = ale#semver#GetVersion(l:executable, a:version_output) let l:options = ale#Var(a:buffer, 'sh_shellcheck_options') let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions') let l:dialect = ale_linters#sh#shellcheck#GetDialectArgument(a:buffer) - let l:external_option = s:CanUseExternalOption(l:version) ? ' -x' : '' + let l:external_option = ale#semver#GTE(l:version, [0, 4, 0]) ? ' -x' : '' return ale#path#BufferCdString(a:buffer) \ . ale#Escape(l:executable) diff --git a/ale_linters/vim/vint.vim b/ale_linters/vim/vint.vim index adf2b4a..dfa00dc 100644 --- a/ale_linters/vim/vint.vim +++ b/ale_linters/vim/vint.vim @@ -6,25 +6,19 @@ let g:ale_vim_vint_show_style_issues = \ get(g:, 'ale_vim_vint_show_style_issues', 1) let s:enable_neovim = has('nvim') ? ' --enable-neovim ' : '' let s:format = '-f "{file_path}:{line_number}:{column_number}: {severity}: {description} (see {reference})"' -let s:vint_version = [] function! ale_linters#vim#vint#VersionCommand(buffer) abort - if empty(s:vint_version) - " Check the Vint version if we haven't checked it already. - return 'vint --version' - endif - - return '' + " Check the Vint version if we haven't checked it already. + return !ale#semver#HasVersion('vint') + \ ? 'vint --version' + \ : '' endfunction function! ale_linters#vim#vint#GetCommand(buffer, version_output) abort - if empty(s:vint_version) && !empty(a:version_output) - " Parse the version out of the --version output. - let s:vint_version = ale#semver#Parse(join(a:version_output, "\n")) - endif + let l:version = ale#semver#GetVersion('vint', a:version_output) - let l:can_use_no_color_flag = empty(s:vint_version) - \ || ale#semver#GreaterOrEqual(s:vint_version, [0, 3, 7]) + let l:can_use_no_color_flag = empty(l:version) + \ || ale#semver#GTE(l:version, [0, 3, 7]) let l:warning_flag = ale#Var(a:buffer, 'vim_vint_show_style_issues') ? '-s' : '-w' diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index 256cd01..9ec7b11 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -18,18 +18,6 @@ function! s:RemoveUnicodeQuotes(text) abort return l:text endfunction -function! ale#handlers#gcc#ParseGCCVersion(lines) abort - for l:line in a:lines - let l:match = matchstr(l:line, '\d\.\d\.\d') - - if !empty(l:match) - return ale#semver#Parse(l:match) - endif - endfor - - return [] -endfunction - function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort " Look for lines like the following. " diff --git a/autoload/ale/semver.vim b/autoload/ale/semver.vim index b153dd1..6b0fd34 100644 --- a/autoload/ale/semver.vim +++ b/autoload/ale/semver.vim @@ -1,27 +1,55 @@ -" Given some text, parse a semantic versioning string from the text -" into a triple of integeers [major, minor, patch]. +let s:version_cache = {} + +" Reset the version cache used for parsing the version. +function! ale#semver#ResetVersionCache() abort + let s:version_cache = {} +endfunction + +" Given an executable name and some lines of output, which can be empty, +" parse the version from the lines of output, or return the cached version +" triple [major, minor, patch] " -" If no match can be performed, then an empty List will be returned instead. -function! ale#semver#Parse(text) abort - let l:match = matchlist(a:text, '^ *\(\d\+\)\.\(\d\+\)\.\(\d\+\)') +" If the version cannot be found, an empty List will be returned instead. +function! ale#semver#GetVersion(executable, version_lines) abort + let l:version = get(s:version_cache, a:executable, []) - if empty(l:match) - return [] - endif + for l:line in a:version_lines + let l:match = matchlist(l:line, '\v(\d+)\.(\d+)\.(\d+)') - return [l:match[1] + 0, l:match[2] + 0, l:match[3] + 0] + if !empty(l:match) + let l:version = [l:match[1] + 0, l:match[2] + 0, l:match[3] + 0] + let s:version_cache[a:executable] = l:version + + break + endif + endfor + + return l:version +endfunction + +" Return 1 if the semver version has been cached for a given executable. +function! ale#semver#HasVersion(executable) abort + return has_key(s:version_cache, a:executable) endfunction " Given two triples of integers [major, minor, patch], compare the triples -" and return 1 if the lhs is greater than or equal to the rhs. -function! ale#semver#GreaterOrEqual(lhs, rhs) abort +" and return 1 if the LHS is greater than or equal to the RHS. +" +" Pairs of [major, minor] can also be used for either argument. +" +" 0 will be returned if the LHS is an empty List. +function! ale#semver#GTE(lhs, rhs) abort + if empty(a:lhs) + return 0 + endif + if a:lhs[0] > a:rhs[0] return 1 elseif a:lhs[0] == a:rhs[0] if a:lhs[1] > a:rhs[1] return 1 elseif a:lhs[1] == a:rhs[1] - return a:lhs[2] >= a:rhs[2] + return get(a:lhs, 2) >= get(a:rhs, 2) endif endif diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader index d808e19..1053551 100644 --- a/test/command_callback/test_cargo_command_callbacks.vader +++ b/test/command_callback/test_cargo_command_callbacks.vader @@ -17,6 +17,7 @@ After: call ale#test#RestoreDirectory() call ale#linter#Reset() + call ale#semver#ResetVersionCache() Execute(An empty string should be returned for the cargo executable when there's no Cargo.toml file): AssertEqual diff --git a/test/command_callback/test_flake8_command_callback.vader b/test/command_callback/test_flake8_command_callback.vader index a510f4c..47d5c0f 100644 --- a/test/command_callback/test_flake8_command_callback.vader +++ b/test/command_callback/test_flake8_command_callback.vader @@ -23,7 +23,7 @@ After: call ale#test#RestoreDirectory() call ale#linter#Reset() - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() Execute(The flake8 callbacks should return the correct default values): AssertEqual @@ -35,8 +35,9 @@ Execute(The flake8 callbacks should return the correct default values): AssertEqual \ ale#Escape('flake8') . ' --format=default --stdin-display-name %s -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['3.0.0']) + " Try with older versions. - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() AssertEqual \ ale#Escape('flake8') . ' --format=default -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['2.9.9']) @@ -49,7 +50,9 @@ Execute(The flake8 command callback should let you set options): \ . ' --some-option --format=default' \ . ' --stdin-display-name %s -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['3.0.4']) - call ale_linters#python#flake8#ClearVersionCache() + + call ale#semver#ResetVersionCache() + AssertEqual \ ale#Escape('flake8') \ . ' --some-option --format=default -', @@ -140,7 +143,7 @@ Execute(Using `python -m flake8` should be supported for running flake8): \ ale#Escape('python') . ' -m flake8 --some-option --format=default -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['2.9.9']) - call ale_linters#python#flake8#ClearVersionCache() + call ale#semver#ResetVersionCache() " Leading spaces shouldn't matter let g:ale_python_flake8_options = ' -m flake8 --some-option' diff --git a/test/handler/test_gcc_handler.vader b/test/handler/test_gcc_handler.vader index 9324273..79f1789 100644 --- a/test/handler/test_gcc_handler.vader +++ b/test/handler/test_gcc_handler.vader @@ -71,17 +71,6 @@ Execute(GCC errors from included files should be parsed correctly): \ ' ^', \ ]) -Execute(GCC versions should be parsed correctly): - AssertEqual [4, 9, 1], ale#handlers#gcc#ParseGCCVersion([ - \ 'g++ (GCC) 4.9.1 20140922 (Red Hat 4.9.1-10)', - \]) - AssertEqual [4, 8, 4], ale#handlers#gcc#ParseGCCVersion([ - \ 'gcc (Ubuntu 4.8.4-2ubuntu1~14.04.3) 4.8.4', - \ 'Copyright (C) 2013 Free Software Foundation, Inc.', - \ 'This is free software; see the source for copying conditions. There is NO', - \ 'warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.', - \]) - Execute(The GCC handler shouldn't complain about #pragma once for headers): silent file! test.h diff --git a/test/test_flow_command.vader b/test/test_flow_command.vader index 32ceb57..49546e9 100644 --- a/test/test_flow_command.vader +++ b/test/test_flow_command.vader @@ -5,6 +5,7 @@ Before: After: call ale#test#RestoreDirectory() call ale#linter#Reset() + call ale#semver#ResetVersionCache() Execute(flow should return a command to run if a .flowconfig file exists): call ale#test#SetFilename('flow/a/sub/dummy') diff --git a/test/test_semver_utils.vader b/test/test_semver_utils.vader index 9730b74..30e9e81 100644 --- a/test/test_semver_utils.vader +++ b/test/test_semver_utils.vader @@ -1,16 +1,50 @@ -Execute(ParseSemver should return the correct results): - " We should be able to parse the semver string from flake8 - AssertEqual [3, 0, 4], ale#semver#Parse('3.0.4 (mccabe: 0.5.2, pyflakes: 1.2.3, pycodestyle: 2.0.0) CPython 2.7.12 on Linux') +After: + call ale#semver#ResetVersionCache() -Execute(GreaterOrEqual should compare triples correctly): - Assert ale#semver#GreaterOrEqual([3, 0, 4], [3, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 0, 0], [3, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 0, 0], [2, 0, 0]) - Assert ale#semver#GreaterOrEqual([3, 1, 0], [3, 1, 0]) - Assert ale#semver#GreaterOrEqual([3, 2, 0], [3, 1, 0]) - Assert ale#semver#GreaterOrEqual([3, 2, 2], [3, 1, 6]) - Assert ale#semver#GreaterOrEqual([3, 2, 5], [3, 2, 5]) - Assert ale#semver#GreaterOrEqual([3, 2, 6], [3, 2, 5]) - Assert !ale#semver#GreaterOrEqual([2, 9, 1], [3, 0, 0]) - Assert !ale#semver#GreaterOrEqual([3, 2, 3], [3, 3, 3]) - Assert !ale#semver#GreaterOrEqual([3, 3, 2], [3, 3, 3]) +Execute(GetVersion should return the version from the lines of output): + " We should be able to parse the semver string from flake8 + AssertEqual [3, 0, 4], ale#semver#GetVersion('dummy', [ + \ '3.0.4 (mccabe: 0.5.2, pyflakes: 1.2.3, pycodestyle: 2.0.0) CPython 2.7.12 on Linux', + \ '1.2.3', + \]) + +Execute(GetVersion should return an empty list when no vesrion can be found): + AssertEqual [], ale#semver#GetVersion('dummy', ['x']) + AssertEqual [], ale#semver#GetVersion('dummy', []) + +Execute(GetVersion should cache the version): + AssertEqual [], ale#semver#GetVersion('dummy', []) + AssertEqual [3, 4, 7], ale#semver#GetVersion('dummy', ['Version 3.4.7']) + AssertEqual [3, 4, 7], ale#semver#GetVersion('dummy', []) + +Execute(HasVersion should return 1 when the version has been cached): + call ale#semver#GetVersion('dummy', []) + AssertEqual 0, ale#semver#HasVersion('dummy') + call ale#semver#GetVersion('dummy', ['3.4.7']) + AssertEqual 1, ale#semver#HasVersion('dummy') + +Execute(GTE should compare triples correctly): + Assert ale#semver#GTE([3, 0, 4], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 0], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 0], [2, 0, 0]) + Assert ale#semver#GTE([3, 1, 0], [3, 1, 0]) + Assert ale#semver#GTE([3, 2, 0], [3, 1, 0]) + Assert ale#semver#GTE([3, 2, 2], [3, 1, 6]) + Assert ale#semver#GTE([3, 2, 5], [3, 2, 5]) + Assert ale#semver#GTE([3, 2, 6], [3, 2, 5]) + Assert !ale#semver#GTE([2, 9, 1], [3, 0, 0]) + Assert !ale#semver#GTE([3, 2, 3], [3, 3, 3]) + Assert !ale#semver#GTE([3, 3, 2], [3, 3, 3]) + +Execute(GTE should compare pairs correctly): + Assert ale#semver#GTE([3, 0], [3, 0, 0]) + Assert ale#semver#GTE([3, 0], [3, 0]) + Assert ale#semver#GTE([3, 1], [3, 0]) + Assert ale#semver#GTE([3, 1], [3, 0, 0]) + Assert ale#semver#GTE([3, 0, 1], [3, 0]) + Assert !ale#semver#GTE([3, 0], [3, 0, 1]) + Assert !ale#semver#GTE([3, 0], [3, 1]) + Assert !ale#semver#GTE([2, 9, 11], [3, 0]) + +Execute(GTE should permit the LHS to be an empty List): + Assert !ale#semver#GTE([], [0, 0, 0]) From 8bc44ed585db4c704f4c93feab6477f32d8aebe6 Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Fri, 10 Nov 2017 18:37:23 +0900 Subject: [PATCH 098/390] Added support for linting of proto files (#1098) * Added support for linting of proto files * Added function to get the proper protoc command --- ale_linters/proto/protoc_gen_lint.vim | 19 +++++++++++++++ doc/ale-proto.txt | 24 +++++++++++++++++++ doc/ale.txt | 2 ++ .../test_proto_command_callback.vader | 16 +++++++++++++ 4 files changed, 61 insertions(+) create mode 100644 ale_linters/proto/protoc_gen_lint.vim create mode 100644 doc/ale-proto.txt create mode 100644 test/command_callback/test_proto_command_callback.vader diff --git a/ale_linters/proto/protoc_gen_lint.vim b/ale_linters/proto/protoc_gen_lint.vim new file mode 100644 index 0000000..9d5ceac --- /dev/null +++ b/ale_linters/proto/protoc_gen_lint.vim @@ -0,0 +1,19 @@ +" Author: Jeff Willette +" Description: run the protoc-gen-lint plugin for the protoc binary + +function! ale_linters#proto#protoc_gen_lint#GetCommand(buffer) abort + let l:dirname = expand('#' . a:buffer . ':p:h') + + return 'protoc' + \ . ' -I ' . ale#Escape(l:dirname) + \ . ' --lint_out=. ' . '%s' +endfunction + +call ale#linter#Define('proto', { +\ 'name': 'protoc-gen-lint', +\ 'lint_file': 1, +\ 'output_stream': 'stderr', +\ 'executable': 'protoc', +\ 'command_callback': 'ale_linters#proto#protoc_gen_lint#GetCommand', +\ 'callback': 'ale#handlers#unix#HandleAsError', +\}) diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt new file mode 100644 index 0000000..6a25638 --- /dev/null +++ b/doc/ale-proto.txt @@ -0,0 +1,24 @@ +=============================================================================== +ALE Proto Integration *ale-proto-options* + + +=============================================================================== +Integration Information + +Linting of `.proto` files requires that the `protoc` binary is installed in the +system path and that the `protoc-gen-lint` plugin for the `protoc` binary is also +installed. + +To enable `.proto` file linting, update |g:ale_linters| as appropriate: +> + " Enable linter for .proto files + let g:ale_linters = {'proto': ['protoc-gen-lint']} +< +=============================================================================== +protoc-gen-lint *ale-proto-protoc-gen-lint* + + The linter is a plugin for the `protoc` binary. As long as the binary resides + in the system path, `protoc` will find it. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index ffe7ac7..9401662 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -135,6 +135,8 @@ CONTENTS *ale-contents* phpstan.............................|ale-php-phpstan| pod...................................|ale-pod-options| write-good..........................|ale-pod-write-good| + proto.................................|ale-proto-options| + protoc-gen-lint.....................|ale-proto-protoc-gen-lint| pug...................................|ale-pug-options| puglint.............................|ale-pug-puglint| puppet................................|ale-puppet-options| diff --git a/test/command_callback/test_proto_command_callback.vader b/test/command_callback/test_proto_command_callback.vader new file mode 100644 index 0000000..2730bb8 --- /dev/null +++ b/test/command_callback/test_proto_command_callback.vader @@ -0,0 +1,16 @@ +Before: + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('test.proto') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The default command should be correct): + + AssertEqual + \ 'protoc' . ' -I ' . ale#Escape(getcwd()) . ' --lint_out=. ' . '%s', + \ ale_linters#proto#protoc_gen_lint#GetCommand(bufnr('')) + From 4952e2f143d87270292a56fb305fcba633d3d561 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 10 Nov 2017 09:43:42 +0000 Subject: [PATCH 099/390] #1098 Add protoc-gen-lint to the list of supported tools --- README.md | 1 + doc/ale.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 7c6488c..8decebf 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,7 @@ formatting. | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | diff --git a/doc/ale.txt b/doc/ale.txt index 9401662..5533277 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -312,6 +312,7 @@ Notes: * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint`, `write-good` +* proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` From 52b60249979ead96df696e82d9ed5ec57db04f0e Mon Sep 17 00:00:00 2001 From: Florian Beeres Date: Sat, 11 Nov 2017 13:07:08 +0100 Subject: [PATCH 100/390] Handle flow extra errors (#946) Show more information for Flow errors with :ALEDetail --- ale_linters/javascript/flow.vim | 54 +++++++++- test/handler/test_flow_handler.vader | 156 ++++++++++++++++++++++++++- 2 files changed, 205 insertions(+), 5 deletions(-) mode change 100644 => 100755 ale_linters/javascript/flow.vim diff --git a/ale_linters/javascript/flow.vim b/ale_linters/javascript/flow.vim old mode 100644 new mode 100755 index 6d51628..8dc930c --- a/ale_linters/javascript/flow.vim +++ b/ale_linters/javascript/flow.vim @@ -1,6 +1,9 @@ " Author: Zach Perrault -- @zperrault " Description: FlowType checking for JavaScript files +" Flow extra errors +" Author: Florian Beeres + call ale#Set('javascript_flow_executable', 'flow') call ale#Set('javascript_flow_use_global', 0) @@ -53,6 +56,44 @@ function! s:GetJSONLines(lines) abort return a:lines[l:start_index :] endfunction +function! s:ExtraErrorMsg(current, new) abort + let l:newMsg = '' + + if a:current is# '' + " extra messages appear to already have a : + let l:newMsg = a:new + else + let l:newMsg = a:current . ' ' . a:new + endif + + return l:newMsg +endfunction + + +function! s:GetDetails(error) abort + let l:detail = '' + + for l:extra_error in a:error.extra + + if has_key(l:extra_error, 'message') + for l:extra_message in l:extra_error.message + let l:detail = s:ExtraErrorMsg(l:detail, l:extra_message.descr) + endfor + endif + + if has_key(l:extra_error, 'children') + for l:child in l:extra_error.children + for l:child_message in l:child.message + let l:detail = l:detail . ' ' . l:child_message.descr + endfor + endfor + endif + + endfor + + return l:detail +endfunction + function! ale_linters#javascript#flow#Handle(buffer, lines) abort let l:str = join(s:GetJSONLines(a:lines), '') @@ -91,12 +132,19 @@ function! ale_linters#javascript#flow#Handle(buffer, lines) abort let l:text = l:text . ' See also: ' . l:error.operation.descr endif - call add(l:output, { + let l:errorToAdd = { \ 'lnum': l:line, \ 'col': l:col, \ 'text': l:text, - \ 'type': l:error.level is# 'error' ? 'E' : 'W', - \}) + \ 'type': has_key(l:error, 'level') && l:error.level is# 'error' ? 'E' : 'W', + \} + + if has_key(l:error, 'extra') + let l:errorToAdd.detail = s:GetDetails(l:error) + endif + + call add(l:output, l:errorToAdd) + endfor return l:output diff --git a/test/handler/test_flow_handler.vader b/test/handler/test_flow_handler.vader index 47efc30..3a575a0 100644 --- a/test/handler/test_flow_handler.vader +++ b/test/handler/test_flow_handler.vader @@ -243,7 +243,7 @@ Execute(The flow handler should fetch the correct location for the currently ope \ 'lnum': 6, \ 'col': 3, \ 'type': 'E', - \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`' + \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`', \ } \] @@ -347,7 +347,159 @@ Execute(The flow handler should handle relative paths): \ 'lnum': 6, \ 'col': 3, \ 'type': 'E', - \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`' + \ 'text': 'property `bar`: Property not found in props of React element `Foo` See also: React element `Foo`', + \ } + \] + + AssertEqual g:expected, g:actual + +Execute(The flow handler should handle extra errors): + silent! noautocmd file /Users/rav/Projects/vim-ale-flow/index.js + + let g:flow_output = { + \ "flowVersion": "0.54.0", + \ "errors": [{ + \ "extra": [{ + \ "message": [{ + \ "context": v:null, + \ "descr": "Property \`setVector\` is incompatible:", + \ "type": "Blame ", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }], + \ "children": [{ + \ "message": [{ + \ "context": "setVector = \{2\}", + \ "descr": "number ", + \ "type": "Blame ", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile ", + \ "start": { + \ "line": 90, + \ "column": 30, + \ "offset": 2296 + \ }, + \ "end": { + \ "line": 90, + \ "column": 30, + \ "offset": 2297 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 90, + \ "endline": 90, + \ "start": 30, + \ "end": 30 + \ }, { + \ "context": v:null, + \ "descr": "This type is incompatible with ", + \ "type": "Comment ", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }, { + \ "context": "setVector: VectorType => void,", + \ "descr": "function type ", + \ "type": "Blame ", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile", + \ "start": { + \ "line": 9, + \ "column": 14, + \ "offset": 252 + \ }, + \ "end": { + \ "line": 9, + \ "column": 31, + \ "offset": 270 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 9, + \ "endline": 9, + \ "start": 14, + \ "end": 31 + \ }] + \ }] + \ }], + \ "kind": "infer", + \ "level": "error", + \ "suppressions": [], + \ "message": [{ + \ "context": " < New ", + \ "descr": "props of React element `New`", + \ "type": "Blame", + \ "loc": { + \ "source": "vim-ale-flow/foo.js", + \ "type": "SourceFile", + \ "start": { + \ "line": 89, + \ "column": 17, + \ "offset": 2262 + \ }, + \ "end": { + \ "line": 94, + \ "column": 18, + \ "offset": 2488 + \ } + \ }, + \ "path": "", + \ "line": 89, + \ "endline": 94, + \ "start": 17, + \ "end": 18 + \ }, { + \ "context": v:null, + \ "descr": "This type is incompatible with", + \ "type": "Comment", + \ "path": "", + \ "line": 0, + \ "endline": 0, + \ "start": 1, + \ "end": 0 + \ }, { + \ "context": "class New extends React.Component < NewProps,NewState > {", + \ "descr": "object type", + \ "type": "Blame", + \ "loc": { + \ "source": expand('%:p'), + \ "type": "SourceFile", + \ "start": { + \ "line": 20, + \ "column": 35, + \ "offset": 489 + \ }, + \ "end": { + \ "line": 20, + \ "column": 42, + \ "offset": 497 + \ } + \ }, + \ "path": expand('%:p'), + \ "line": 20, + \ "endline": 20, + \ "start": 35, + \ "end": 42 + \ }] + \ }], + \ "passed": v:false + \} + + let g:actual = ale_linters#javascript#flow#Handle(bufnr(''), [json_encode(g:flow_output)]) + let g:expected = [ + \ { + \ 'lnum': 20, + \ 'col': 35, + \ 'type': 'E', + \ 'text': 'props of React element `New`: This type is incompatible with object type', + \ 'detail': 'Property `setVector` is incompatible: number This type is incompatible with function type ', \ } \] From 6c60ca24c13872c8e2e1e56154eac56e8555452c Mon Sep 17 00:00:00 2001 From: jnduli Date: Sat, 11 Nov 2017 15:10:17 +0300 Subject: [PATCH 101/390] Add rstcheck linter to check for errors in restructured text (#1090) --- README.md | 2 +- ale_linters/rst/rstcheck.vim | 37 +++++++++++++++++++ doc/ale.txt | 2 +- test/handler/test_rstcheck_lint_handler.vader | 33 +++++++++++++++++ 4 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 ale_linters/rst/rstcheck.vim create mode 100644 test/handler/test_rstcheck_lint_handler.vader diff --git a/README.md b/README.md index 8decebf..285efaa 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ formatting. | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | | Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | diff --git a/ale_linters/rst/rstcheck.vim b/ale_linters/rst/rstcheck.vim new file mode 100644 index 0000000..b660627 --- /dev/null +++ b/ale_linters/rst/rstcheck.vim @@ -0,0 +1,37 @@ +" Author: John Nduli https://github.com/jnduli +" Description: Rstcheck for reStructuredText files +" + +function! ale_linters#rst#rstcheck#Handle(buffer, lines) abort + " matches: 'bad_rst.rst:1: (SEVERE/4) Title overline & underline + " mismatch.' + let l:pattern = '\v^(.+):(\d*): \(([a-zA-Z]*)/\d*\) (.+)$' + let l:dir = expand('#' . a:buffer . ':p:h') + let l:output = [] + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), + \ 'lnum': l:match[2] + 0, + \ 'col': 0, + \ 'type': l:match[3] is# 'SEVERE' ? 'E' : 'W', + \ 'text': l:match[4], + \}) + endfor + + return l:output +endfunction + +function! ale_linters#rst#rstcheck#GetCommand(buffer) abort + return ale#path#BufferCdString(a:buffer) + \ . 'rstcheck' + \ . ' %t' +endfunction + + +call ale#linter#Define('rst', { +\ 'name': 'rstcheck', +\ 'executable': 'rstcheck', +\ 'command_callback': 'ale_linters#rst#rstcheck#GetCommand', +\ 'callback': 'ale_linters#rst#rstcheck#Handle', +\ 'output_stream': 'both', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index 5533277..a684d70 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -318,7 +318,7 @@ Notes: * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `refmt` -* reStructuredText: `proselint`, `write-good` +* reStructuredText: `proselint`, `rstcheck`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` diff --git a/test/handler/test_rstcheck_lint_handler.vader b/test/handler/test_rstcheck_lint_handler.vader new file mode 100644 index 0000000..64cb587 --- /dev/null +++ b/test/handler/test_rstcheck_lint_handler.vader @@ -0,0 +1,33 @@ +Before: + runtime ale_linters/rstcheck/rstcheck.vim + +Execute(Warning and error messages should be handled correctly): + AssertEqual + \ [ + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_python.rst'), + \ 'lnum': 7, + \ 'col': 0, + \ 'type': 'W', + \ 'text': '(python) unexpected EOF while parsing', + \ }, + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_cpp.rst'), + \ 'lnum': 9, + \ 'col': 0, + \ 'type': 'W', + \ 'text': '(cpp) error: ''x'' was not declared in this scope', + \ }, + \ { + \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_rst.rst'), + \ 'lnum': 1, + \ 'col': 0, + \ 'type': 'E', + \ 'text': 'Title overline & underline mismatch.', + \ }, + \ ], + \ ale_linters#rst#rstcheck#Handle(1, [ + \ 'bad_python.rst:7: (ERROR/3) (python) unexpected EOF while parsing', + \ 'bad_cpp.rst:9: (ERROR/3) (cpp) error: ''x'' was not declared in this scope', + \ 'bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.', + \]) From 8cd1ccff844bb8a23a616c09cf55a9f40018e41f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 13:44:05 +0000 Subject: [PATCH 102/390] #1095 Apply all patterns for g:ale_pattern_options, instead of just the first match --- autoload/ale/pattern_options.vim | 40 +++++++++++------- autoload/ale/toggle.vim | 5 +-- doc/ale.txt | 14 ++++--- test/test_autocmd_commands.vader | 25 ++++++++---- test/test_pattern_options.vader | 70 ++++++++++++++++++++++++++------ 5 files changed, 111 insertions(+), 43 deletions(-) diff --git a/autoload/ale/pattern_options.vim b/autoload/ale/pattern_options.vim index a603c98..a55a27f 100644 --- a/autoload/ale/pattern_options.vim +++ b/autoload/ale/pattern_options.vim @@ -1,22 +1,34 @@ " Author: w0rp " Description: Set options in files based on regex patterns. -function! ale#pattern_options#SetOptions() abort - let l:filename = expand('%:p') " no-custom-checks - let l:options = {} +function! s:CmpPatterns(left_item, right_item) abort + if a:left_item[0] < a:right_item[0] + return -1 + endif - for l:pattern in keys(g:ale_pattern_options) + if a:left_item[0] > a:right_item[0] + return 1 + endif + + return 0 +endfunction + +function! ale#pattern_options#SetOptions(buffer) abort + if !g:ale_pattern_options_enabled || empty(g:ale_pattern_options) + return + endif + + let l:filename = expand('#' . a:buffer . ':p') + + " The patterns are sorted, so they are applied consistently. + for [l:pattern, l:options] in sort( + \ items(g:ale_pattern_options), + \ function('s:CmpPatterns') + \) if match(l:filename, l:pattern) >= 0 - let l:options = g:ale_pattern_options[l:pattern] - break - endif - endfor - - for l:key in keys(l:options) - if l:key[:0] is# '&' - call setbufvar(bufnr(''), l:key, l:options[l:key]) - else - let b:[l:key] = l:options[l:key] + for [l:key, l:value] in items(l:options) + call setbufvar(a:buffer, l:key, l:value) + endfor endif endfor endfunction diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index 6809edd..aa6d113 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -4,9 +4,7 @@ function! ale#toggle#InitAuGroups() abort augroup ALEPatternOptionsGroup autocmd! - if g:ale_enabled && g:ale_pattern_options_enabled - autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions() - endif + autocmd BufEnter,BufRead * call ale#pattern_options#SetOptions(str2nr(expand(''))) augroup END augroup ALERunOnTextChangedGroup @@ -71,7 +69,6 @@ function! ale#toggle#InitAuGroups() abort augroup END if !g:ale_enabled - augroup! ALEPatternOptionsGroup augroup! ALERunOnTextChangedGroup augroup! ALERunOnEnterGroup augroup! ALERunOnInsertLeave diff --git a/doc/ale.txt b/doc/ale.txt index a684d70..6d2e2c6 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1009,11 +1009,14 @@ g:ale_pattern_options *g:ale_pattern_options* only `eslint` for checking those files by setting `b:ale_linters`. Filenames are matched with |match()|, and patterns depend on the |magic| - setting, unless prefixed with the special escape sequences like `'\v'`, etc. - - The patterns can match any part of a filename. The absolute path of the + setting, unless prefixed with the special escape sequences like `'\v'`, + etc.The patterns can match any part of a filename. The absolute path of the filename will be used for matching, taken from `expand('%:p')`. + The options for every match for the filename will be applied, with the + pattern keys sorted in alphabetical order. Options for `'zebra'` will + override the options for `'alpha'` for a filename `alpha-zebra`. + g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* @@ -1021,8 +1024,9 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* Default: `!empty(g:ale_pattern_options)` This option can be used for turning the behaviour of setting - |g:ale_pattern_options| on or off. By default, setting a single key - for |g:ale_pattern_options| will turn this option on. + |g:ale_pattern_options| on or off. By default, setting a single key for + |g:ale_pattern_options| will turn this option on, as long as the setting is + configured before ALE is loaded. g:ale_set_balloons *g:ale_set_balloons* diff --git a/test/test_autocmd_commands.vader b/test/test_autocmd_commands.vader index 88504a9..e7e9e86 100644 --- a/test/test_autocmd_commands.vader +++ b/test/test_autocmd_commands.vader @@ -108,17 +108,28 @@ Execute (g:ale_lint_on_insert_leave = 0 should bind no events): AssertEqual [], CheckAutocmd('ALERunOnInsertLeave') -Execute (g:ale_pattern_options_enabled = 0 should bind no events): - let g:ale_pattern_options_enabled = 0 - - AssertEqual [], CheckAutocmd('ALEPatternOptionsGroup') - Execute (g:ale_pattern_options_enabled = 1 should bind BufReadPost and BufEnter): let g:ale_pattern_options_enabled = 1 AssertEqual [ - \ 'BufEnter * call ale#pattern_options#SetOptions()', - \ 'BufReadPost * call ale#pattern_options#SetOptions()', + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \], CheckAutocmd('ALEPatternOptionsGroup') + +Execute (g:ale_pattern_options_enabled = 0 should still bind events): + let g:ale_pattern_options_enabled = 0 + + AssertEqual [ + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \], CheckAutocmd('ALEPatternOptionsGroup') + +Execute (g:ale_enabled = 0 should still bind pattern events): + let g:ale_enabled = 0 + + AssertEqual [ + \ 'BufEnter * call ale#pattern_options#SetOptions(str2nr(expand('''')))', + \ 'BufReadPost * call ale#pattern_options#SetOptions(str2nr(expand('''')))', \], CheckAutocmd('ALEPatternOptionsGroup') Execute (g:ale_lint_on_enter = 0 should bind only the BufEnter event): diff --git a/test/test_pattern_options.vader b/test/test_pattern_options.vader index 164e5aa..0ad4415 100644 --- a/test/test_pattern_options.vader +++ b/test/test_pattern_options.vader @@ -3,30 +3,74 @@ Before: Save g:ale_pattern_options_enabled Save &filetype + let g:ale_pattern_options_enabled = 1 + let g:ale_pattern_options = {} + + let b:ale_enabled = 0 + let b:some_option = 0 + + call ale#test#SetDirectory('/testplugin/test') + After: Restore unlet! b:ale_enabled unlet! b:some_option + call ale#test#RestoreDirectory() + +Execute(The pattern options function should work when there are no patterns): + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + Execute(Buffer variables should be set when filename patterns match): - let g:ale_pattern_options = {'baz.*\.js': { - \ 'ale_enabled': 1, - \ 'some_option': 347, - \ '&filetype': 'pattern_option_set_filetype', - \}} + let g:ale_pattern_options = { + \ 'baz.*\.js': { + \ 'ale_enabled': 1, + \ 'some_option': 347, + \ '&filetype': 'pattern_option_set_filetype', + \ }, + \} - silent! file foobar.js + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) - call ale#pattern_options#SetOptions() + AssertEqual 0, b:ale_enabled + AssertEqual 0, b:some_option - Assert !exists('b:ale_enabled') - Assert !exists('b:some_option') - - silent! file bazboz.js - - call ale#pattern_options#SetOptions() + call ale#test#SetFilename('bazboz.js') + call ale#pattern_options#SetOptions(bufnr('')) AssertEqual 1, b:ale_enabled AssertEqual 347, b:some_option AssertEqual 'pattern_option_set_filetype', &filetype + +Execute(Multiple pattern matches should be applied): + let g:ale_pattern_options = { + \ 'foo': { + \ 'some_option': 666, + \ }, + \ 'bar': { + \ 'ale_enabled': 1, + \ 'some_option': 123, + \ }, + \ 'notmatched': { + \ 'some_option': 489, + \ 'ale_enabled': 0, + \ }, + \} + + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 1, b:ale_enabled + AssertEqual 666, b:some_option + +Execute(Patterns should not be applied when the setting is disabled): + let g:ale_pattern_options_enabled = 0 + let g:ale_pattern_options = {'foo': {'some_option': 666}} + + call ale#test#SetFilename('foobar.js') + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 0, b:some_option From 555743a2baf7ca9cb00ccef91979c2e422cac49f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 14:26:54 +0000 Subject: [PATCH 103/390] #1095 Cache the sorting of patterns for g:ale_pattern_options --- autoload/ale/pattern_options.vim | 20 +++++++++++++++----- test/test_pattern_options.vader | 16 ++++++++++++++++ 2 files changed, 31 insertions(+), 5 deletions(-) diff --git a/autoload/ale/pattern_options.vim b/autoload/ale/pattern_options.vim index a55a27f..e58b8cf 100644 --- a/autoload/ale/pattern_options.vim +++ b/autoload/ale/pattern_options.vim @@ -1,6 +1,10 @@ " Author: w0rp " Description: Set options in files based on regex patterns. +" These variables are used to cache the sorting of patterns below. +let s:last_pattern_options = {} +let s:sorted_items = [] + function! s:CmpPatterns(left_item, right_item) abort if a:left_item[0] < a:right_item[0] return -1 @@ -18,13 +22,19 @@ function! ale#pattern_options#SetOptions(buffer) abort return endif + " The items will only be sorted whenever the patterns change. + if g:ale_pattern_options != s:last_pattern_options + let s:last_pattern_options = deepcopy(g:ale_pattern_options) + " The patterns are sorted, so they are applied consistently. + let s:sorted_items = sort( + \ items(g:ale_pattern_options), + \ function('s:CmpPatterns') + \) + endif + let l:filename = expand('#' . a:buffer . ':p') - " The patterns are sorted, so they are applied consistently. - for [l:pattern, l:options] in sort( - \ items(g:ale_pattern_options), - \ function('s:CmpPatterns') - \) + for [l:pattern, l:options] in s:sorted_items if match(l:filename, l:pattern) >= 0 for [l:key, l:value] in items(l:options) call setbufvar(a:buffer, l:key, l:value) diff --git a/test/test_pattern_options.vader b/test/test_pattern_options.vader index 0ad4415..0e26eaa 100644 --- a/test/test_pattern_options.vader +++ b/test/test_pattern_options.vader @@ -74,3 +74,19 @@ Execute(Patterns should not be applied when the setting is disabled): call ale#pattern_options#SetOptions(bufnr('')) AssertEqual 0, b:some_option + +" This test is important for making sure we update the sorted items. +Execute(Patterns should be applied after the Dictionary changes): + call ale#test#SetFilename('foobar.js') + + let g:ale_pattern_options = {} + + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 0, b:some_option + + let g:ale_pattern_options['foo'] = {'some_option': 666} + + call ale#pattern_options#SetOptions(bufnr('')) + + AssertEqual 666, b:some_option From 8e0d1f57c6f568a6845aa11a57add84a8f771b68 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 14:27:53 +0000 Subject: [PATCH 104/390] Fix a typo --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 6d2e2c6..c78ba3b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -884,7 +884,7 @@ g:ale_linter_aliases *g:ale_linter_aliases* `let g:ale_linter_aliases = {'html': ['html', 'javascript', 'css']}` Note that `html` itself was included as an alias. That is because aliases - will override the original linters for the aliased filetepe. + will override the original linters for the aliased filetype. Linter aliases can be configured in each buffer with buffer-local variables. ALE will first look for aliases for filetypes in the `b:ale_linter_aliases` From 39107a48b99607fdebd1708cfaf0f115768c4899 Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sat, 11 Nov 2017 19:27:41 +0100 Subject: [PATCH 105/390] Add ocaml-language-server for OCaml and ReasonML --- README.md | 4 ++-- ale_linters/ocaml/ols.vim | 14 ++++++++++++++ ale_linters/reason/ols.vim | 14 ++++++++++++++ autoload/ale/handlers/ols.vim | 25 +++++++++++++++++++++++++ doc/ale-ocaml.txt | 22 ++++++++++++++++++++++ doc/ale-reasonml.txt | 23 +++++++++++++++++++++++ doc/ale.txt | 6 ++++-- 7 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 ale_linters/ocaml/ols.vim create mode 100644 ale_linters/reason/ols.vim create mode 100644 autoload/ale/handlers/ols.vim diff --git a/README.md b/README.md index 285efaa..24f3deb 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ formatting. | nroff | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Objective-C | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) | -| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions | +| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | @@ -130,7 +130,7 @@ formatting. | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | -| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) | +| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | diff --git a/ale_linters/ocaml/ols.vim b/ale_linters/ocaml/ols.vim new file mode 100644 index 0000000..c0255a6 --- /dev/null +++ b/ale_linters/ocaml/ols.vim @@ -0,0 +1,14 @@ +" Author: Michael Jungo +" Description: A language server for OCaml + +call ale#Set('ocaml_ols_executable', 'ocaml-language-server') +call ale#Set('ocaml_ols_use_global', 0) + +call ale#linter#Define('ocaml', { +\ 'name': 'ols', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale#handlers#ols#GetExecutable', +\ 'command_callback': 'ale#handlers#ols#GetCommand', +\ 'language_callback': 'ale#handlers#ols#GetLanguage', +\ 'project_root_callback': 'ale#handlers#ols#GetProjectRoot', +\}) diff --git a/ale_linters/reason/ols.vim b/ale_linters/reason/ols.vim new file mode 100644 index 0000000..b2cd5f7 --- /dev/null +++ b/ale_linters/reason/ols.vim @@ -0,0 +1,14 @@ +" Author: Michael Jungo +" Description: A language server for Reason + +call ale#Set('reason_ols_executable', 'ocaml-language-server') +call ale#Set('reason_ols_use_global', 0) + +call ale#linter#Define('reason', { +\ 'name': 'ols', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale#handlers#ols#GetExecutable', +\ 'command_callback': 'ale#handlers#ols#GetCommand', +\ 'language_callback': 'ale#handlers#ols#GetLanguage', +\ 'project_root_callback': 'ale#handlers#ols#GetProjectRoot', +\}) diff --git a/autoload/ale/handlers/ols.vim b/autoload/ale/handlers/ols.vim new file mode 100644 index 0000000..1dda7f9 --- /dev/null +++ b/autoload/ale/handlers/ols.vim @@ -0,0 +1,25 @@ +" Author: Michael Jungo +" Description: Handlers for the OCaml language server + +function! ale#handlers#ols#GetExecutable(buffer) abort + let l:ols_setting = ale#handlers#ols#GetLanguage(a:buffer) . '_ols' + return ale#node#FindExecutable(a:buffer, l:ols_setting, [ + \ 'node_modules/.bin/ocaml-language-server', + \]) +endfunction + +function! ale#handlers#ols#GetCommand(buffer) abort + let l:executable = ale#handlers#ols#GetExecutable(a:buffer) + + return ale#node#Executable(a:buffer, l:executable) . ' --stdio' +endfunction + +function! ale#handlers#ols#GetLanguage(buffer) abort + return getbufvar(a:buffer, '&filetype') +endfunction + +function! ale#handlers#ols#GetProjectRoot(buffer) abort + let l:merlin_file = ale#path#FindNearestFile(a:buffer, '.merlin') + + return !empty(l:merlin_file) ? fnamemodify(l:merlin_file, ':h') : '' +endfunction diff --git a/doc/ale-ocaml.txt b/doc/ale-ocaml.txt index 093d911..cfa365a 100644 --- a/doc/ale-ocaml.txt +++ b/doc/ale-ocaml.txt @@ -10,6 +10,28 @@ merlin *ale-ocaml-merlin* detailed instructions (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). +=============================================================================== +ols *ale-ocaml-ols* + + The `ocaml-language-server` is the engine that powers OCaml and ReasonML + editor support using the Language Server Protocol. See the installation + instructions: + https://github.com/freebroccolo/ocaml-language-server#installation + +g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable* + *b:ale_ocaml_ols_executable* + Type: |String| + Default: `'ocaml-language-server'` + + This variable can be set to change the executable path for `ols`. + +g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global* + *b:ale_ocaml_ols_use_global* + Type: |String| + Default: `0` + + This variable can be set to `1` to always use the globally installed + executable. See also |ale-integrations-local-executables|. =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-reasonml.txt b/doc/ale-reasonml.txt index d533d85..36ddd75 100644 --- a/doc/ale-reasonml.txt +++ b/doc/ale-reasonml.txt @@ -10,6 +10,29 @@ merlin *ale-reasonml-merlin* detailed instructions (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). +=============================================================================== +ols *ale-reasonml-ols* + + The `ocaml-language-server` is the engine that powers OCaml and ReasonML + editor support using the Language Server Protocol. See the installation + instructions: + https://github.com/freebroccolo/ocaml-language-server#installation + +g:ale_reason_ols_executable *g:ale_reason_ols_executable* + *b:ale_reason_ols_executable* + Type: |String| + Default: `'ocaml-language-server'` + + This variable can be set to change the executable path for `ols`. + +g:ale_reason_ols_use_global *g:ale_reason_ols_use_global* + *b:ale_reason_ols_use_global* + Type: |String| + Default: `0` + + This variable can be set to `1` to always use the globally installed + executable. See also |ale-integrations-local-executables|. + =============================================================================== refmt *ale-reasonml-refmt* diff --git a/doc/ale.txt b/doc/ale.txt index c78ba3b..83a724f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -121,6 +121,7 @@ CONTENTS *ale-contents* clang...............................|ale-objcpp-clang| ocaml.................................|ale-ocaml-options| merlin..............................|ale-ocaml-merlin| + ols.................................|ale-ocaml-ols| perl..................................|ale-perl-options| perl................................|ale-perl-perl| perlcritic..........................|ale-perl-perlcritic| @@ -154,6 +155,7 @@ CONTENTS *ale-contents* lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| + ols.................................|ale-reasonml-ols| refmt...............................|ale-reasonml-refmt| restructuredtext......................|ale-restructuredtext-options| write-good..........................|ale-restructuredtext-write-good| @@ -308,7 +310,7 @@ Notes: * nroff: `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` -* OCaml: `merlin` (see |ale-ocaml-merlin|) +* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * Pod: `proselint`, `write-good` @@ -317,7 +319,7 @@ Notes: * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` -* ReasonML: `merlin`, `refmt` +* ReasonML: `merlin`, `ols`, `refmt` * reStructuredText: `proselint`, `rstcheck`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` From 5df6ce6bb82e6a042eff644d77c71537e375114a Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sat, 11 Nov 2017 19:28:24 +0100 Subject: [PATCH 106/390] Remove id from LSP notifications --- autoload/ale/lsp.vim | 3 +-- test/lsp/test_lsp_connections.vader | 28 ++++++++++++++-------------- 2 files changed, 15 insertions(+), 16 deletions(-) diff --git a/autoload/ale/lsp.vim b/autoload/ale/lsp.vim index b6c890c..126d6c1 100644 --- a/autoload/ale/lsp.vim +++ b/autoload/ale/lsp.vim @@ -83,9 +83,8 @@ function! ale#lsp#CreateMessageData(message) abort let l:is_notification = a:message[0] let l:obj = { - \ 'id': v:null, - \ 'jsonrpc': '2.0', \ 'method': a:message[1], + \ 'jsonrpc': '2.0', \} if !l:is_notification diff --git a/test/lsp/test_lsp_connections.vader b/test/lsp/test_lsp_connections.vader index 5549b1f..8651d80 100644 --- a/test/lsp/test_lsp_connections.vader +++ b/test/lsp/test_lsp_connections.vader @@ -26,7 +26,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 1, \ "Content-Length: 79\r\n\r\n" - \ . '{"id": 1, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}', + \ . '{"method": "someMethod", "jsonrpc": "2.0", "id": 1, "params": {"foo": "barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) " Check again to ensure that we use the next ID. @@ -34,7 +34,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 2, \ "Content-Length: 79\r\n\r\n" - \ . '{"id": 2, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}', + \ . '{"method": "someMethod", "jsonrpc": "2.0", "id": 2, "params": {"foo": "barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) else @@ -42,14 +42,14 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message): \ [ \ 1, \ "Content-Length: 71\r\n\r\n" - \ . '{"id":1,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}', + \ . '{"method":"someMethod","jsonrpc":"2.0","id":1,"params":{"foo":"barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) AssertEqual \ [ \ 2, \ "Content-Length: 71\r\n\r\n" - \ . '{"id":2,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}', + \ . '{"method":"someMethod","jsonrpc":"2.0","id":2,"params":{"foo":"barÜ"}}', \ ], \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}]) endif @@ -60,7 +60,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params): \ [ \ 1, \ "Content-Length: 56\r\n\r\n" - \ . '{"id": 1, "jsonrpc": "2.0", "method": "someOtherMethod"}', + \ . '{"method": "someOtherMethod", "jsonrpc": "2.0", "id": 1}', \ ], \ ale#lsp#CreateMessageData([0, 'someOtherMethod']) else @@ -68,7 +68,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params): \ [ \ 1, \ "Content-Length: 51\r\n\r\n" - \ . '{"id":1,"jsonrpc":"2.0","method":"someOtherMethod"}', + \ . '{"method":"someOtherMethod","jsonrpc":"2.0","id":1}', \ ], \ ale#lsp#CreateMessageData([0, 'someOtherMethod']) endif @@ -78,30 +78,30 @@ Execute(ale#lsp#CreateMessageData() should create notifications): AssertEqual \ [ \ 0, - \ "Content-Length: 60\r\n\r\n" - \ . '{"id": null, "jsonrpc": "2.0", "method": "someNotification"}', + \ "Content-Length: 48\r\n\r\n" + \ . '{"method": "someNotification", "jsonrpc": "2.0"}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification']) AssertEqual \ [ \ 0, - \ "Content-Length: 86\r\n\r\n" - \ . '{"id": null, "jsonrpc": "2.0", "method": "someNotification", "params": {"foo": "bar"}}', + \ "Content-Length: 74\r\n\r\n" + \ . '{"method": "someNotification", "jsonrpc": "2.0", "params": {"foo": "bar"}}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}]) else AssertEqual \ [ \ 0, - \ "Content-Length: 55\r\n\r\n" - \ . '{"id":null,"jsonrpc":"2.0","method":"someNotification"}', + \ "Content-Length: 45\r\n\r\n" + \ . '{"method":"someNotification","jsonrpc":"2.0"}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification']) AssertEqual \ [ \ 0, - \ "Content-Length: 78\r\n\r\n" - \ . '{"id":null,"jsonrpc":"2.0","method":"someNotification","params":{"foo":"bar"}}', + \ "Content-Length: 68\r\n\r\n" + \ . '{"method":"someNotification","jsonrpc":"2.0","params":{"foo":"bar"}}', \ ], \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}]) endif From 365d023d0e5094b474b91d2ad72244ec5a13a08c Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 15:15:19 -0500 Subject: [PATCH 107/390] perlcritic: all issues are warnings Perlcritic is a style checker, not a syntax validator. This change was originally proposed by @RsrchBoy in https://github.com/w0rp/ale/pull/784. --- ale_linters/perl/perlcritic.vim | 1 + test/handler/test_perlcritic_handler.vader | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 test/handler/test_perlcritic_handler.vader diff --git a/ale_linters/perl/perlcritic.vim b/ale_linters/perl/perlcritic.vim index df2f8b2..24f7eb8 100644 --- a/ale_linters/perl/perlcritic.vim +++ b/ale_linters/perl/perlcritic.vim @@ -61,6 +61,7 @@ function! ale_linters#perl#perlcritic#Handle(buffer, lines) abort \ 'lnum': l:match[1], \ 'col': l:match[2], \ 'text': l:match[3], + \ 'type': 'W' \}) endfor diff --git a/test/handler/test_perlcritic_handler.vader b/test/handler/test_perlcritic_handler.vader new file mode 100644 index 0000000..f00b07d --- /dev/null +++ b/test/handler/test_perlcritic_handler.vader @@ -0,0 +1,20 @@ +Before: + runtime ale_linters/perl/perlcritic.vim + +After: + call ale#linter#Reset() + +Execute(The Perl::Critic handler should create all issues as warnings): + AssertEqual + \ [ + \ { + \ 'lnum': '21', + \ 'col': '17', + \ 'text': 'Regular expression without "/m" flag', + \ 'type': 'W', + \ } + \ ], + \ ale_linters#perl#perlcritic#Handle(99, [ + \ '21:17 Regular expression without "/m" flag' + \ ]) + From 099df0af522fddda09b50fd9ffe1f66cab310607 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 23:04:08 +0000 Subject: [PATCH 108/390] #1108 Support selecting fixers with Lists --- autoload/ale/fix.vim | 27 +++++++++++++++++---------- doc/ale.txt | 19 +++++++++++++++++-- test/test_ale_fix.vader | 9 +++++++++ 3 files changed, 43 insertions(+), 12 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index a57ad19..5a42b74 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -332,18 +332,25 @@ function! s:RunFixer(options) abort endfunction function! s:GetCallbacks() abort - let l:fixers = ale#Var(bufnr(''), 'fixers') - let l:callback_list = [] + if type(get(b:, 'ale_fixers')) is type([]) + " Lists can be used for buffer-local variables only + let l:callback_list = b:ale_fixers + else + " buffer and global options can use dictionaries mapping filetypes to + " callbacks to run. + let l:fixers = ale#Var(bufnr(''), 'fixers') + let l:callback_list = [] - for l:sub_type in split(&filetype, '\.') - let l:sub_type_callacks = get(l:fixers, l:sub_type, []) + for l:sub_type in split(&filetype, '\.') + let l:sub_type_callacks = get(l:fixers, l:sub_type, []) - if type(l:sub_type_callacks) == type('') - call add(l:callback_list, l:sub_type_callacks) - else - call extend(l:callback_list, l:sub_type_callacks) - endif - endfor + if type(l:sub_type_callacks) == type('') + call add(l:callback_list, l:sub_type_callacks) + else + call extend(l:callback_list, l:sub_type_callacks) + endif + endfor + endif if empty(l:callback_list) return [] diff --git a/doc/ale.txt b/doc/ale.txt index 83a724f..b070414 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -492,6 +492,18 @@ upon some lines immediately, then run `eslint` from the ALE registry, and then call a lambda function which will remove every single line comment from the file. +For buffer-local settings, such as in |g:ale_pattern_options| or in ftplugin +files, a |List| may be used for configuring the fixers instead. +> + " Same as the above, only a List can be used instead of a Dictionary. + let b:ale_fixers = [ + \ 'DoSomething', + \ 'eslint', + \ {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')}, + \] + + ALEFix +< For convenience, a plug mapping is defined for |ALEFix|, so you can set up a keybind easily for fixing files. > @@ -696,6 +708,8 @@ g:ale_fixers *g:ale_fixers* See |ale-fix| for more information. This variable can be overridden with variables in each buffer. + `b:ale_fixers` can be set to a |List| of callbacks instead, which can be + more convenient. g:ale_fix_on_save *g:ale_fix_on_save* @@ -1001,14 +1015,15 @@ g:ale_pattern_options *g:ale_pattern_options* buffer variables. This option can be set to automatically configure different settings for different files. For example: > + " Use just ESLint for linting and fixing files which end in '.foo.js' let g:ale_pattern_options = { \ '\.foo\.js$': { \ 'ale_linters': {'javascript': ['eslint']}, + \ 'ale_fixers: ['eslint'], \ }, \} < - The above example will match any filename ending in `.foo.js`, and use - only `eslint` for checking those files by setting `b:ale_linters`. + See |b:ale_linters| and |b:ale_fixers| for information for those options. Filenames are matched with |match()|, and patterns depend on the |magic| setting, unless prefixed with the special escape sequences like `'\v'`, diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index ffe3d93..ac6427a 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -330,6 +330,15 @@ Expect(There should be only two lines): a b +Execute(ALEFix should allow Lists to be used for buffer-local fixer settings): + let g:ale_fixers.testft = ['AddCarets', 'AddDollars'] + let b:ale_fixers = ['RemoveLastLine'] + ALEFix + +Expect(There should be only two lines): + a + b + Given testft (A file with three lines): a b From b98387d0fa9452a70f383ac19deb4d109ddf38ec Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 11 Nov 2017 23:55:04 +0000 Subject: [PATCH 109/390] #1108 Support using Lists and 'all' for b:ale_linters --- autoload/ale/linter.vim | 18 +++++++++++++----- doc/ale.txt | 16 +++++++++++++++- test/test_linter_retrieval.vader | 24 ++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 6 deletions(-) diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index 269b092..00ab916 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -289,11 +289,19 @@ function! ale#linter#ResolveFiletype(original_filetype) abort endfunction function! s:GetLinterNames(original_filetype) abort - for l:dict in [ - \ get(b:, 'ale_linters', {}), - \ g:ale_linters, - \ s:default_ale_linters, - \] + let l:buffer_ale_linters = get(b:, 'ale_linters', {}) + + " b:ale_linters can be set to 'all' + if l:buffer_ale_linters is# 'all' + return 'all' + endif + + " b:ale_linters can be set to a List. + if type(l:buffer_ale_linters) is type([]) + return l:buffer_ale_linters + endif + + for l:dict in [l:buffer_ale_linters, g:ale_linters, s:default_ale_linters] if has_key(l:dict, a:original_filetype) return l:dict[a:original_filetype] endif diff --git a/doc/ale.txt b/doc/ale.txt index b070414..6d6a449 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -946,6 +946,20 @@ g:ale_linters *g:ale_linters* will first look for linters for filetypes in the `b:ale_linters` variable, then `g:ale_linters`, and then a default Dictionary. + `b:ale_linters` can be set to a List, or the string `'all'`. When linters + for two different filetypes share the same name, the first linter loaded + will be used. Any ambiguity can be resolved by using a Dictionary specifying + which linter to run for which filetype instead. > + + " Use ESLint for the buffer if the filetype includes 'javascript'. + let b:ale_linters = {'javascript': ['eslint'], 'html': ['tidy']} + " Use a List for the same setting. This will work in most cases. + let b:ale_linters = ['eslint', 'tidy'] + " Disable all linters for the buffer. + let b:ale_linters = [] + " Explicitly enable all available linters for the filetype. + let b:ale_linters = 'all' +< g:ale_max_buffer_history_size *g:ale_max_buffer_history_size* @@ -1018,7 +1032,7 @@ g:ale_pattern_options *g:ale_pattern_options* " Use just ESLint for linting and fixing files which end in '.foo.js' let g:ale_pattern_options = { \ '\.foo\.js$': { - \ 'ale_linters': {'javascript': ['eslint']}, + \ 'ale_linters': ['eslint'], \ 'ale_fixers: ['eslint'], \ }, \} diff --git a/test/test_linter_retrieval.vader b/test/test_linter_retrieval.vader index 1a1e258..265738f 100644 --- a/test/test_linter_retrieval.vader +++ b/test/test_linter_retrieval.vader @@ -42,6 +42,30 @@ Execute (You should be able to select linters with a buffer option): AssertEqual [g:testlinter1], ale#linter#Get('testft') +Execute (b:ale_linters should work when set to a List): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1', 'testlinter2']} + let b:ale_linters = ['testlinter1'] + + AssertEqual [g:testlinter1], ale#linter#Get('testft') + +Execute (b:ale_linters should disable all linters when set to an empty List): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1', 'testlinter2']} + let b:ale_linters = [] + + AssertEqual [], ale#linter#Get('testft') + +Execute (b:ale_linters should enable all available linters when set to 'all'): + call ale#linter#Define('testft', g:testlinter1) + call ale#linter#Define('testft', g:testlinter2) + let g:ale_linters = {'testft': ['testlinter1']} + let b:ale_linters = 'all' + + AssertEqual [g:testlinter1, g:testlinter2], ale#linter#Get('testft') + Execute (Buffer settings shouldn't completely replace global settings): call ale#linter#Define('testft', g:testlinter1) call ale#linter#Define('testft', g:testlinter2) From d20e3bc71cd835f6708e78c5efea2f6d826d7e4d Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 00:11:50 +0000 Subject: [PATCH 110/390] #1108 Support setting b:ale_linter_aliases to a List --- autoload/ale/linter.vim | 9 ++++++++- doc/ale.txt | 6 ++++++ test/test_linter_retrieval.vader | 15 +++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index 00ab916..c6667d9 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -261,12 +261,19 @@ function! ale#linter#GetAll(filetypes) abort endfunction function! s:GetAliasedFiletype(original_filetype) abort + let l:buffer_aliases = get(b:, 'ale_linter_aliases', {}) + + " b:ale_linter_aliases can be set to a List. + if type(l:buffer_aliases) is type([]) + return l:buffer_aliases + endif + " Check for aliased filetypes first in a buffer variable, " then the global variable, " then in the default mapping, " otherwise use the original filetype. for l:dict in [ - \ get(b:, 'ale_linter_aliases', {}), + \ l:buffer_aliases, \ g:ale_linter_aliases, \ s:default_ale_linter_aliases, \] diff --git a/doc/ale.txt b/doc/ale.txt index 6d6a449..41e9661 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -906,6 +906,12 @@ g:ale_linter_aliases *g:ale_linter_aliases* ALE will first look for aliases for filetypes in the `b:ale_linter_aliases` variable, then `g:ale_linter_aliases`, and then a default Dictionary. + `b:ale_linter_aliases` can be set to a |List|, to tell ALE to load the + linters for specific filetypes for a given buffer. > + + let b:ale_linter_aliases = ['html', 'javascript', 'css'] +< + No linters will be loaded when the buffer's filetype is empty. g:ale_linters *g:ale_linters* *b:ale_linters* diff --git a/test/test_linter_retrieval.vader b/test/test_linter_retrieval.vader index 265738f..5d5b582 100644 --- a/test/test_linter_retrieval.vader +++ b/test/test_linter_retrieval.vader @@ -126,6 +126,21 @@ Execute (The local alias option shouldn't completely replace the global one): " global Dictionary. let b:ale_linter_aliases = {'testft3': ['testft1']} +Execute (Lists should be accepted for local aliases): + call ale#linter#Define('testft1', g:testlinter1) + call ale#linter#Define('testft2', g:testlinter2) + let g:ale_linter_aliases = {'testft1': ['testft1', 'testft2']} + " We should load the testft2 linters for this buffer, with no duplicates. + let b:ale_linter_aliases = ['testft2'] + + AssertEqual [g:testlinter2], ale#linter#Get('anything.else') + +Execute (Buffer-local overrides for aliases should be used): + call ale#linter#Define('testft1', g:testlinter1) + call ale#linter#Define('testft2', g:testlinter2) + let g:ale_linter_aliases = {'testft1': ['testft2']} + let b:ale_linter_aliases = {'testft1': ['testft1', 'testft2']} + AssertEqual [g:testlinter1, g:testlinter2], ale#linter#Get('testft1') Execute (Linters should be loaded from disk appropriately): From 3aff1df9615ccc95bb91910f82d43947dd835f28 Mon Sep 17 00:00:00 2001 From: Michael Jungo Date: Sun, 12 Nov 2017 02:06:28 +0100 Subject: [PATCH 111/390] Add tests for ocaml-language-server callbacks --- test/command_callback/ols_paths/.merlin | 0 .../node_modules/.bin/ocaml-language-server | 0 .../test_ocaml_ols_callbacks.vader | 54 +++++++++++++++++++ .../test_reason_ols_callbacks.vader | 54 +++++++++++++++++++ 4 files changed, 108 insertions(+) create mode 100644 test/command_callback/ols_paths/.merlin create mode 100644 test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server create mode 100644 test/command_callback/test_ocaml_ols_callbacks.vader create mode 100644 test/command_callback/test_reason_ols_callbacks.vader diff --git a/test/command_callback/ols_paths/.merlin b/test/command_callback/ols_paths/.merlin new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server b/test/command_callback/ols_paths/node_modules/.bin/ocaml-language-server new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_ocaml_ols_callbacks.vader b/test/command_callback/test_ocaml_ols_callbacks.vader new file mode 100644 index 0000000..2c44dbc --- /dev/null +++ b/test/command_callback/test_ocaml_ols_callbacks.vader @@ -0,0 +1,54 @@ +Before: + Save &filetype + Save g:ale_ocaml_ols_executable + Save g:ale_ocaml_ols_use_global + + let &filetype = 'ocaml' + unlet! g:ale_ocaml_ols_executable + unlet! g:ale_ocaml_ols_use_global + + runtime ale_linters/ocaml/ols.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The language string should be correct): + AssertEqual 'ocaml', ale#handlers#ols#GetLanguage(bufnr('')) + +Execute(The default executable should be correct): + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('ocaml-language-server') . ' --stdio', + \ ale#handlers#ols#GetCommand(bufnr('')) + +Execute(The project root should be detected correctly): + AssertEqual '', ale#handlers#ols#GetProjectRoot(bufnr('')) + + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#handlers#ols#GetProjectRoot(bufnr('')) + +Execute(The local executable should be used when available): + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The gloabl executable should always be used when use_global is set): + let g:ale_ocaml_ols_use_global = 1 + call ale#test#SetFilename('ols_paths/file.ml') + + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The executable should be configurable): + let g:ale_ocaml_ols_executable = 'foobar' + + AssertEqual 'foobar', ale#handlers#ols#GetExecutable(bufnr('')) diff --git a/test/command_callback/test_reason_ols_callbacks.vader b/test/command_callback/test_reason_ols_callbacks.vader new file mode 100644 index 0000000..ffe403f --- /dev/null +++ b/test/command_callback/test_reason_ols_callbacks.vader @@ -0,0 +1,54 @@ +Before: + Save &filetype + Save g:ale_reason_ols_executable + Save g:ale_reason_ols_use_global + + let &filetype = 'reason' + unlet! g:ale_reason_ols_executable + unlet! g:ale_reason_ols_use_global + + runtime ale_linters/reason/ols.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The language string should be correct): + AssertEqual 'reason', ale#handlers#ols#GetLanguage(bufnr('')) + +Execute(The default executable should be correct): + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('ocaml-language-server') . ' --stdio', + \ ale#handlers#ols#GetCommand(bufnr('')) + +Execute(The project root should be detected correctly): + AssertEqual '', ale#handlers#ols#GetProjectRoot(bufnr('')) + + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#handlers#ols#GetProjectRoot(bufnr('')) + +Execute(The local executable should be used when available): + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual + \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The gloabl executable should always be used when use_global is set): + let g:ale_reason_ols_use_global = 1 + call ale#test#SetFilename('ols_paths/file.re') + + AssertEqual 'ocaml-language-server', ale#handlers#ols#GetExecutable(bufnr('')) + +Execute(The executable should be configurable): + let g:ale_reason_ols_executable = 'foobar' + + AssertEqual 'foobar', ale#handlers#ols#GetExecutable(bufnr('')) From cd5da50531d55c003de495d8b151c60c5dbf26eb Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 11:25:24 +0000 Subject: [PATCH 112/390] Add tests for the command and executable callbacks, and make them use local node_modulse esxecutables like other linters --- ale_linters/less/lessc.vim | 25 ++++-- doc/ale-less.txt | 18 +++- doc/ale.txt | 2 +- .../lessc_paths/node_modules/.bin/lessc | 0 .../test_lessc_command_callback.vader | 82 +++++++++++++++++++ 5 files changed, 119 insertions(+), 8 deletions(-) create mode 100755 test/command_callback/lessc_paths/node_modules/.bin/lessc create mode 100644 test/command_callback/test_lessc_command_callback.vader diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index 76b7f13..8b7985a 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -1,12 +1,25 @@ -" Author: zanona +" Author: zanona , w0rp " Description: This file adds support for checking Less code with lessc. +call ale#Set('less_lessc_executable', 'lessc') call ale#Set('less_lessc_options', '') +call ale#Set('less_lessc_use_global', 0) + +function! ale_linters#less#lessc#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'less_lessc', [ + \ 'node_modules/.bin/lessc', + \]) +endfunction function! ale_linters#less#lessc#GetCommand(buffer) abort - return 'lessc' - \ . ' --no-color --lint --include-path=' . expand('%:p:h') - \ . ' ' . ale#Var(a:buffer, 'less_lessc_options') + let l:executable = ale_linters#less#lessc#GetExecutable(a:buffer) + let l:dir = expand('#' . a:buffer . ':p:h') + let l:options = ale#Var(a:buffer, 'less_lessc_options') + + return ale#Escape(l:executable) + \ . ' --no-color --lint' + \ . ' --include-path=' . ale#Escape(l:dir) + \ . (!empty(l:options) ? ' ' . l:options : '') \ . ' -' endfunction @@ -29,8 +42,8 @@ endfunction call ale#linter#Define('less', { \ 'name': 'lessc', -\ 'executable': 'lessc', -\ 'output_stream': 'stderr', +\ 'executable_callback': 'ale_linters#less#lessc#GetExecutable', \ 'command_callback': 'ale_linters#less#lessc#GetCommand', \ 'callback': 'ale_linters#less#lessc#Handle', +\ 'output_stream': 'stderr', \}) diff --git a/doc/ale-less.txt b/doc/ale-less.txt index cac9c9a..a372afe 100644 --- a/doc/ale-less.txt +++ b/doc/ale-less.txt @@ -5,6 +5,14 @@ ALE Less Integration *ale-less-options* =============================================================================== lessc *ale-less-lessc* +g:ale_less_lessc_executable *g:ale_less_lessc_executable* + *b:ale_less_lessc_executable* + Type: |String| + Default: `'lessc'` + + See |ale-integrations-local-executables| + + g:ale_less_lessc_options *g:ale_less_lessc_options* *b:ale_less_lessc_options* Type: |String| @@ -13,6 +21,14 @@ g:ale_less_lessc_options *g:ale_less_lessc_options* This variable can be set to pass additional options to lessc. +g:ale_less_lessc_use_global *g:ale_less_lessc_use_global* + *b:ale_less_lessc_use_global* + Type: |String| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== prettier *ale-less-prettier* @@ -20,4 +36,4 @@ See |ale-javascript-prettier| for information about the available options. =============================================================================== - + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 41e9661..ff38cbb 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -105,7 +105,7 @@ CONTENTS *ale-contents* latex.................................|ale-latex-options| write-good..........................|ale-latex-write-good| less..................................|ale-less-options| - lessc...............................|ale-less-lessc-options| + lessc...............................|ale-less-lessc| prettier............................|ale-less-prettier| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| diff --git a/test/command_callback/lessc_paths/node_modules/.bin/lessc b/test/command_callback/lessc_paths/node_modules/.bin/lessc new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/test_lessc_command_callback.vader b/test/command_callback/test_lessc_command_callback.vader new file mode 100644 index 0000000..785c38c --- /dev/null +++ b/test/command_callback/test_lessc_command_callback.vader @@ -0,0 +1,82 @@ +Before: + Save g:ale_less_lessc_executable + Save g:ale_less_lessc_use_global + Save g:ale_less_lessc_options + + unlet! b:executable + + unlet! g:ale_less_lessc_executable + unlet! g:ale_less_lessc_use_global + unlet! g:ale_less_lessc_options + + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('testfile.less') + + runtime ale_linters/less/lessc.vim + +After: + Restore + + unlet! b:executable + unlet! b:ale_less_lessc_executable + unlet! b:ale_less_lessc_use_global + unlet! b:ale_less_lessc_options + + call ale#test#SetFilename('test.txt') + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(node_modules directories should be discovered): + call ale#test#SetFilename('lessc_paths/nested/testfile.less') + + let b:executable = ale#path#Winify( + \ g:dir + \ . '/lessc_paths/node_modules/.bin/lessc' + \) + + AssertEqual + \ b:executable, + \ ale_linters#less#lessc#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape(b:executable) + \ . ' --no-color --lint' + \ . ' --include-path=' + \ . ale#Escape(ale#path#Winify(g:dir . '/lessc_paths/nested')) + \ . ' -', + \ ale_linters#less#lessc#GetCommand(bufnr('')) + +Execute(The global override should work): + let b:ale_less_lessc_executable = 'foobar' + let b:ale_less_lessc_use_global = 1 + + call ale#test#SetFilename('lessc_paths/nested/testfile.less') + + AssertEqual + \ 'foobar', + \ ale_linters#less#lessc#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('foobar') + \ . ' --no-color --lint' + \ . ' --include-path=' + \ . ale#Escape(ale#path#Winify(g:dir . '/lessc_paths/nested')) + \ . ' -', + \ ale_linters#less#lessc#GetCommand(bufnr('')) + +Execute(Extra options should be configurable): + let b:ale_less_lessc_options = '--whatever' + + AssertEqual + \ 'lessc', + \ ale_linters#less#lessc#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('lessc') + \ . ' --no-color --lint' + \ . ' --include-path=' + \ . ale#Escape(ale#path#Winify(g:dir)) + \ . ' --whatever' + \ . ' -', + \ ale_linters#less#lessc#GetCommand(bufnr('')) From 7edcb2210b2b60d5eaf81381e5d9443369576c28 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 11:35:01 +0000 Subject: [PATCH 113/390] Show problems from other files for lessc --- ale_linters/less/lessc.vim | 11 ++++- test/handler/test_lessc_handler.vader | 69 +++++++++++++++++++++++++++ 2 files changed, 78 insertions(+), 2 deletions(-) create mode 100644 test/handler/test_lessc_handler.vader diff --git a/ale_linters/less/lessc.vim b/ale_linters/less/lessc.vim index 8b7985a..108679d 100755 --- a/ale_linters/less/lessc.vim +++ b/ale_linters/less/lessc.vim @@ -24,17 +24,24 @@ function! ale_linters#less#lessc#GetCommand(buffer) abort endfunction function! ale_linters#less#lessc#Handle(buffer, lines) abort + let l:dir = expand('#' . a:buffer . ':p:h') " Matches patterns like the following: let l:pattern = '^\(\w\+\): \(.\{-}\) in \(.\{-}\) on line \(\d\+\), column \(\d\+\):$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - call add(l:output, { + let l:item = { \ 'lnum': l:match[4] + 0, \ 'col': l:match[5] + 0, \ 'text': l:match[2], \ 'type': 'E', - \}) + \} + + if l:match[3] isnot# '-' + let l:item.filename = ale#path#GetAbsPath(l:dir, l:match[3]) + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_lessc_handler.vader b/test/handler/test_lessc_handler.vader new file mode 100644 index 0000000..530c582 --- /dev/null +++ b/test/handler/test_lessc_handler.vader @@ -0,0 +1,69 @@ +Before: + call ale#test#SetDirectory('/testplugin/test/handler') + call ale#test#SetFilename('testfile.less') + + runtime ale_linters/less/lessc.vim + +After: + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The lessc handler should handle errors for the current file correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Unrecognised input. Possibly missing something', + \ }, + \ ], + \ ale_linters#less#lessc#Handle(bufnr(''), [ + \ 'ParseError: Unrecognised input. Possibly missing something in - on line 2, column 1:', + \ '1 vwewww', + \ '2 ', + \]) + +Execute(The lessc handler should handle errors for other files in the same directory correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Unrecognised input. Possibly missing something', + \ 'filename': ale#path#Winify(g:dir . '/imported.less') + \ }, + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Unrecognised input. Possibly missing something', + \ 'filename': ale#path#Winify(g:dir . '/imported.less') + \ }, + \ ], + \ ale_linters#less#lessc#Handle(bufnr(''), [ + \ 'ParseError: Unrecognised input. Possibly missing something in imported.less on line 2, column 1:', + \ '1 vwewww', + \ '2 ', + \ 'ParseError: Unrecognised input. Possibly missing something in ./imported.less on line 2, column 1:', + \ '1 vwewww', + \ '2 ', + \]) + +Execute(The lessc handler should handle errors for files in directories above correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Unrecognised input. Possibly missing something', + \ 'filename': ale#path#Winify(g:dir . '/../imported2.less') + \ }, + \ ], + \ ale_linters#less#lessc#Handle(bufnr(''), [ + \ 'ParseError: Unrecognised input. Possibly missing something in ../imported2.less on line 2, column 1:', + \ '1 vwewww', + \ '2 ', + \]) From 3c34848e0296ca51b35fe15152c11ff7f32a3a72 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 12:09:19 +0000 Subject: [PATCH 114/390] Fix #510 Support checking LESS files with stylelint --- README.md | 2 +- ale_linters/less/stylelint.vim | 27 +++++++++ doc/ale-less.txt | 27 +++++++++ doc/ale.txt | 3 +- .../node_modules/.bin/stylelint | 0 ...test_less_stylelint_command_callback.vader | 60 +++++++++++++++++++ 6 files changed, 117 insertions(+), 2 deletions(-) create mode 100644 ale_linters/less/stylelint.vim create mode 100755 test/command_callback/stylelint_paths/node_modules/.bin/stylelint create mode 100644 test/command_callback/test_less_stylelint_command_callback.vader diff --git a/README.md b/README.md index 24f3deb..e6f7934 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ formatting. | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | -| Less | [lessc](https://www.npmjs.com/package/less) | +| Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | diff --git a/ale_linters/less/stylelint.vim b/ale_linters/less/stylelint.vim new file mode 100644 index 0000000..690c8c9 --- /dev/null +++ b/ale_linters/less/stylelint.vim @@ -0,0 +1,27 @@ +" Author: diartyz , w0rp + +call ale#Set('less_stylelint_executable', 'stylelint') +call ale#Set('less_stylelint_options', '') +call ale#Set('less_stylelint_use_global', 0) + +function! ale_linters#less#stylelint#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'less_stylelint', [ + \ 'node_modules/.bin/stylelint', + \]) +endfunction + +function! ale_linters#less#stylelint#GetCommand(buffer) abort + let l:executable = ale_linters#less#stylelint#GetExecutable(a:buffer) + let l:options = ale#Var(a:buffer, 'less_stylelint_options') + + return ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' --stdin-filename %s' +endfunction + +call ale#linter#Define('less', { +\ 'name': 'stylelint', +\ 'executable_callback': 'ale_linters#less#stylelint#GetExecutable', +\ 'command_callback': 'ale_linters#less#stylelint#GetCommand', +\ 'callback': 'ale#handlers#css#HandleStyleLintFormat', +\}) diff --git a/doc/ale-less.txt b/doc/ale-less.txt index a372afe..05f56e2 100644 --- a/doc/ale-less.txt +++ b/doc/ale-less.txt @@ -35,5 +35,32 @@ prettier *ale-less-prettier* See |ale-javascript-prettier| for information about the available options. +=============================================================================== +stylelint *ale-less-stylelint* + +g:ale_less_stylelint_executable *g:ale_less_stylelint_executable* + *b:ale_less_stylelint_executable* + Type: |String| + Default: `'stylelint'` + + See |ale-integrations-local-executables| + + +g:ale_less_stylelint_options *g:ale_less_stylelint_options* + *b:ale_less_stylelint_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to stylelint. + + +g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global* + *b:ale_less_stylelint_use_global* + Type: |String| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index ff38cbb..c83e39d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -107,6 +107,7 @@ CONTENTS *ale-contents* less..................................|ale-less-options| lessc...............................|ale-less-lessc| prettier............................|ale-less-prettier| + stylelint...........................|ale-less-stylelint| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| lua...................................|ale-lua-options| @@ -298,7 +299,7 @@ Notes: * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` -* Less: `lessc` +* Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` * Lua: `luacheck` * Mail: `proselint`, `vale` diff --git a/test/command_callback/stylelint_paths/node_modules/.bin/stylelint b/test/command_callback/stylelint_paths/node_modules/.bin/stylelint new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/test_less_stylelint_command_callback.vader b/test/command_callback/test_less_stylelint_command_callback.vader new file mode 100644 index 0000000..d5aa3b9 --- /dev/null +++ b/test/command_callback/test_less_stylelint_command_callback.vader @@ -0,0 +1,60 @@ +Before: + Save g:ale_less_stylelint_executable + Save g:ale_less_stylelint_use_global + Save g:ale_less_stylelint_options + + unlet! b:executable + + unlet! g:ale_less_stylelint_executable + unlet! g:ale_less_stylelint_use_global + unlet! g:ale_less_stylelint_options + + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('testfile.less') + + runtime ale_linters/less/stylelint.vim + +After: + Restore + + unlet! b:executable + unlet! b:ale_less_stylelint_executable + unlet! b:ale_less_stylelint_use_global + unlet! b:ale_less_stylelint_options + + call ale#test#SetFilename('test.txt') + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(node_modules directories should be discovered): + call ale#test#SetFilename('stylelint_paths/nested/testfile.less') + + let b:executable = ale#path#Winify( + \ g:dir + \ . '/stylelint_paths/node_modules/.bin/stylelint' + \) + + AssertEqual b:executable, ale_linters#less#stylelint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape(b:executable) . ' --stdin-filename %s', + \ ale_linters#less#stylelint#GetCommand(bufnr('')) + +Execute(The global override should work): + let b:ale_less_stylelint_executable = 'foobar' + let b:ale_less_stylelint_use_global = 1 + + call ale#test#SetFilename('stylelint_paths/nested/testfile.less') + + AssertEqual 'foobar', ale_linters#less#stylelint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('foobar') . ' --stdin-filename %s', + \ ale_linters#less#stylelint#GetCommand(bufnr('')) + +Execute(Extra options should be configurable): + let b:ale_less_stylelint_options = '--whatever' + + AssertEqual 'stylelint', ale_linters#less#stylelint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('stylelint') . ' --whatever --stdin-filename %s', + \ ale_linters#less#stylelint#GetCommand(bufnr('')) From e7b9befaa618dd5834ffa04315964d9bb2d49502 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 12:11:15 +0000 Subject: [PATCH 115/390] Sort some linter entries alphabetically --- README.md | 8 ++++---- doc/ale.txt | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e6f7934..4f26896 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ formatting. | CMake | [cmakelint](https://github.com/richq/cmake-lint) | | CoffeeScript | [coffee](http://coffeescript.org/), [coffeelint](https://www.npmjs.com/package/coffeelint) | | Crystal | [crystal](https://crystal-lang.org/) !! | -| CSS | [csslint](http://csslint.net/), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | +| CSS | [csslint](http://csslint.net/), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | Cython (pyrex filetype) | [cython](http://cython.org/) | | D | [dmd](https://dlang.org/dmd-linux.html) | | Dafny | [dafny](https://rise4fun.com/Dafny) !! | @@ -105,7 +105,7 @@ formatting. | HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | -| JavaScript | [eslint](http://eslint.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [flow](https://flowtype.org/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) +| JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | @@ -136,7 +136,7 @@ formatting. | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | | Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | | SASS | [sass-lint](https://www.npmjs.com/package/sass-lint), [stylelint](https://github.com/stylelint/stylelint) | -| SCSS | [sass-lint](https://www.npmjs.com/package/sass-lint), [scss-lint](https://github.com/brigade/scss-lint), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://github.com/prettier/prettier) | +| SCSS | [prettier](https://github.com/prettier/prettier), [sass-lint](https://www.npmjs.com/package/sass-lint), [scss-lint](https://github.com/brigade/scss-lint), [stylelint](https://github.com/stylelint/stylelint) | | Scala | [scalac](http://scala-lang.org), [scalastyle](http://www.scalastyle.org) | | Slim | [slim-lint](https://github.com/sds/slim-lint) | | SML | [smlnj](http://www.smlnj.org/) | @@ -149,7 +149,7 @@ formatting. | Texinfo | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Thrift | [thrift](http://thrift.apache.org/) | -| TypeScript | [eslint](http://eslint.org/), [tslint](https://github.com/palantir/tslint), tsserver, typecheck, [prettier](https://github.com/prettier/prettier) | +| TypeScript | [eslint](http://eslint.org/), [prettier](https://github.com/prettier/prettier), [tslint](https://github.com/palantir/tslint), tsserver, typecheck | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | | Vim | [vint](https://github.com/Kuniwak/vint) | | Vim help^ | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | diff --git a/doc/ale.txt b/doc/ale.txt index c83e39d..2b60543 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -274,7 +274,7 @@ Notes: * CMake: `cmakelint` * CoffeeScript: `coffee`, `coffeelint` * Crystal: `crystal`!! -* CSS: `csslint`, `stylelint`, `prettier` +* CSS: `csslint`, `prettier`, `stylelint` * Cython (pyrex filetype): `cython` * D: `dmd` * Dafny: `dafny`!! @@ -295,7 +295,7 @@ Notes: * HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` -* JavaScript: `eslint`, `jscs`, `jshint`, `flow`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` +* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` @@ -326,7 +326,7 @@ Notes: * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` * SASS: `sass-lint`, `stylelint` -* SCSS: `sass-lint`, `scss-lint`, `stylelint`, `prettier` +* SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint` * Scala: `scalac`, `scalastyle` * Slim: `slim-lint` * SML: `smlnj` @@ -339,7 +339,7 @@ Notes: * Texinfo: `proselint`, `write-good` * Text^: `proselint`, `vale`, `write-good` * Thrift: `thrift` -* TypeScript: `eslint`, `tslint`, `tsserver`, `typecheck`, `prettier` +* TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck` * Verilog: `iverilog`, `verilator` * Vim: `vint` * Vim help^: `proselint`, `write-good` From 7d056b0839a6d716533bce73cd72555aec6f5837 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 23:01:11 +0000 Subject: [PATCH 116/390] Update the documentation for the echo message format, so it makes more sense --- doc/ale.txt | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index 2b60543..f384b1e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -635,33 +635,37 @@ g:ale_echo_delay *g:ale_echo_delay* g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* Type: |String| - Default: `Error` + Default: `'Error'` - The string used for error severity in the echoed message. - Note |g:ale_echo_cursor| should be set to 1 - Note |g:ale_echo_msg_format| should contain the `%severity%` handler + The string used for `%severity%` for errors. See |g:ale_echo_msg_format| g:ale_echo_msg_format *g:ale_echo_msg_format* Type: |String| - Default: `%s` + Default: `'%s'` - This variable defines the format of the echoed message. The `%s` is the - error message itself, and it can contain the following handlers: - - `%linter%` for linter's name - - `%severity%` for the type of severity - Note |g:ale_echo_cursor| should be setted to 1 + This variable defines a message format for echoed messages. The following + sequences of characters will be replaced. + + `%s` - will be replaced with the text for the problem + `%linter%` - will be replaced with the name of the linter + `%severity%` - will be replaced withe severity of the problem + + The strings for `%severity%` can be configured with the following options. + + |g:ale_echo_msg_error_str| - Defaults to `'Error'` + |g:ale_echo_msg_warning_str| - Defaults to `'Warning'` + + |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed. g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Type: |String| - Default: `Warning` + Default: `'Warning'` - The string used for warning severity in the echoed message. - Note |g:ale_echo_cursor| should be set to 1 - Note |g:ale_echo_msg_format| should contain the `%severity%` handler + The string used for `%severity%` for warnings. See |g:ale_echo_msg_format| g:ale_emit_conflict_warnings *g:ale_emit_conflict_warnings* From 70623ca8a7ffadac0d282b4737dbb7322659c592 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 12 Nov 2017 23:19:26 +0000 Subject: [PATCH 117/390] Add support for showing Info severities in echoed messages --- autoload/ale/cursor.vim | 12 ++++++--- doc/ale.txt | 8 ++++++ plugin/ale.vim | 1 + test/test_cursor_warnings.vader | 46 ++++++++++++++++++++++++++++++++- 4 files changed, 62 insertions(+), 5 deletions(-) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 6238b4a..c7c74c9 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -7,12 +7,16 @@ let s:last_pos = [0, 0, 0] " Return a formatted message according to g:ale_echo_msg_format variable function! s:GetMessage(linter, type, text) abort let l:msg = g:ale_echo_msg_format - let l:type = a:type is# 'E' - \ ? g:ale_echo_msg_error_str - \ : g:ale_echo_msg_warning_str + let l:severity = g:ale_echo_msg_warning_str + + if a:type is# 'E' + let l:severity = g:ale_echo_msg_error_str + elseif a:type is# 'I' + let l:severity = g:ale_echo_msg_info_str + endif " Replace handlers if they exist - for [l:k, l:v] in items({'linter': a:linter, 'severity': l:type}) + for [l:k, l:v] in items({'linter': a:linter, 'severity': l:severity}) let l:msg = substitute(l:msg, '\V%' . l:k . '%', l:v, '') endfor diff --git a/doc/ale.txt b/doc/ale.txt index f384b1e..5638a2c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -660,6 +660,14 @@ g:ale_echo_msg_format *g:ale_echo_msg_format* |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed. +g:ale_echo_msg_info_str *g:ale_echo_msg_info_str* + + Type: |String| + Default: `'Info'` + + The string used for `%severity%` for info. See |g:ale_echo_msg_format| + + g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Type: |String| diff --git a/plugin/ale.vim b/plugin/ale.vim index 0b5ac78..c67e1de 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -155,6 +155,7 @@ let g:ale_echo_msg_format = get(g:, 'ale_echo_msg_format', '%s') " Strings used for severity in the echoed message let g:ale_echo_msg_error_str = get(g:, 'ale_echo_msg_error_str', 'Error') +let g:ale_echo_msg_info_str = get(g:, 'ale_echo_msg_info_str', 'Info') let g:ale_echo_msg_warning_str = get(g:, 'ale_echo_msg_warning_str', 'Warning') " This flag can be set to 0 to disable echoing when the cursor moves. diff --git a/test/test_cursor_warnings.vader b/test/test_cursor_warnings.vader index 586cc13..20ccb15 100644 --- a/test/test_cursor_warnings.vader +++ b/test/test_cursor_warnings.vader @@ -1,4 +1,6 @@ Before: + Save g:ale_echo_msg_format + let g:ale_buffer_info = { \ bufnr('%'): { \ 'loclist': [ @@ -14,6 +16,16 @@ Before: \ 'detail': "Every statement should end with a semicolon\nsecond line" \ }, \ { + \ 'lnum': 1, + \ 'col': 14, + \ 'bufnr': bufnr('%'), + \ 'vcol': 0, + \ 'linter_name': 'eslint', + \ 'nr': -1, + \ 'type': 'I', + \ 'text': 'Some information', + \ }, + \ { \ 'lnum': 2, \ 'col': 10, \ 'bufnr': bufnr('%'), @@ -63,6 +75,8 @@ Before: endfunction After: + Restore + call cursor(1, 1) let g:ale_set_loclist = 1 @@ -81,7 +95,7 @@ After: echomsg '' Given javascript(A Javscript file with warnings/errors): - var x = 3 + var x = 3 + 12345678 var x = 5*2 + parseInt("10"); // comment @@ -141,3 +155,33 @@ Execute(ALEDetail should not capitlise cursor messages): call ale#cursor#EchoCursorWarning() AssertEqual 'lowercase error', GetLastMessage() + +Execute(The linter name should be formatted into the message correctly): + let g:ale_echo_msg_format = '%linter%: %s' + + call cursor(2, 9) + call ale#cursor#EchoCursorWarning() + + AssertEqual + \ 'eslint: Infix operators must be spaced. (space-infix-ops)', + \ GetLastMessage() + +Execute(The severity should be formatted into the message correctly): + let g:ale_echo_msg_format = '%severity%: %s' + + call cursor(2, 9) + call ale#cursor#EchoCursorWarning() + + AssertEqual + \ 'Warning: Infix operators must be spaced. (space-infix-ops)', + \ GetLastMessage() + + call cursor(1, 10) + call ale#cursor#EchoCursorWarning() + + AssertEqual 'Error: Missing semicolon. (semi)', GetLastMessage() + + call cursor(1, 14) + call ale#cursor#EchoCursorWarning() + + AssertEqual 'Info: Some information', GetLastMessage() From 584e0bc7f25563bf4ab3ae738b78d9d13a898f94 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 00:47:34 +0000 Subject: [PATCH 118/390] #852 Support formatting echo messages with error codes. No linters set the `code` key yet --- autoload/ale/cursor.vim | 23 ++++++++++------ doc/ale.txt | 15 +++++++--- plugin/ale.vim | 6 ++-- test/test_ale_info.vader | 2 +- test/test_cursor_warnings.vader | 49 +++++++++++++++++++++++---------- 5 files changed, 63 insertions(+), 32 deletions(-) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index c7c74c9..7b84862 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -5,22 +5,27 @@ let s:cursor_timer = -1 let s:last_pos = [0, 0, 0] " Return a formatted message according to g:ale_echo_msg_format variable -function! s:GetMessage(linter, type, text) abort +function! s:GetMessage(item) abort let l:msg = g:ale_echo_msg_format let l:severity = g:ale_echo_msg_warning_str + let l:code = get(a:item, 'code', '') + let l:code_repl = !empty(l:code) ? '\=submatch(1) . l:code . submatch(2)' : '' - if a:type is# 'E' + if a:item.type is# 'E' let l:severity = g:ale_echo_msg_error_str - elseif a:type is# 'I' + elseif a:item.type is# 'I' let l:severity = g:ale_echo_msg_info_str endif - " Replace handlers if they exist - for [l:k, l:v] in items({'linter': a:linter, 'severity': l:severity}) - let l:msg = substitute(l:msg, '\V%' . l:k . '%', l:v, '') - endfor + " Replace special markers with certain information. + " \=l:variable is used to avoid escaping issues. + let l:msg = substitute(l:msg, '\V%severity%', '\=l:severity', 'g') + let l:msg = substitute(l:msg, '\V%linter%', '\=a:item.linter_name', 'g') + let l:msg = substitute(l:msg, '\v\%([^\%]*)code([^\%]*)\%', l:code_repl, 'g') + " Replace %s with the text. + let l:msg = substitute(l:msg, '\V%s', '\=a:item.text', 'g') - return printf(l:msg, a:text) + return l:msg endfunction function! s:EchoWithShortMess(setting, message) abort @@ -91,7 +96,7 @@ function! s:EchoImpl() abort let [l:info, l:loc] = s:FindItemAtCursor() if !empty(l:loc) - let l:msg = s:GetMessage(l:loc.linter_name, l:loc.type, l:loc.text) + let l:msg = s:GetMessage(l:loc) call ale#cursor#TruncatedEcho(l:msg) let l:info.echoed = 1 elseif get(l:info, 'echoed') diff --git a/doc/ale.txt b/doc/ale.txt index 5638a2c..3a43685 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -643,20 +643,27 @@ g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* g:ale_echo_msg_format *g:ale_echo_msg_format* Type: |String| - Default: `'%s'` + Default: `'%code: %%s'` This variable defines a message format for echoed messages. The following sequences of characters will be replaced. - `%s` - will be replaced with the text for the problem - `%linter%` - will be replaced with the name of the linter - `%severity%` - will be replaced withe severity of the problem + `%s` - replaced with the text for the problem + `%...code...% `- replaced with the error code + `%linter%` - replaced with the name of the linter + `%severity%` - replaced withe severity of the problem The strings for `%severity%` can be configured with the following options. |g:ale_echo_msg_error_str| - Defaults to `'Error'` |g:ale_echo_msg_warning_str| - Defaults to `'Warning'` + `%code%` is replaced with the error code, and replaced with an empty string + when there is no error code. Any extra characters between the percent signs + will be printed when an error code is present. For example, a message like + `(error code): message` will be printed for `'%(code): %%s'` and simply the + message will be printed when there is no code. + |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed. diff --git a/plugin/ale.vim b/plugin/ale.vim index c67e1de..26d3c43 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -148,10 +148,8 @@ let g:ale_sign_offset = get(g:, 'ale_sign_offset', 1000000) " This flag can be set to 1 to keep sign gutter always open let g:ale_sign_column_always = get(g:, 'ale_sign_column_always', 0) -" String format for the echoed message -" A %s is mandatory -" It can contain 2 handlers: %linter%, %severity% -let g:ale_echo_msg_format = get(g:, 'ale_echo_msg_format', '%s') +" A string format for the echoed message +let g:ale_echo_msg_format = get(g:, 'ale_echo_msg_format', '%code: %%s') " Strings used for severity in the echoed message let g:ale_echo_msg_error_str = get(g:, 'ale_echo_msg_error_str', 'Error') diff --git a/test/test_ale_info.vader b/test/test_ale_info.vader index ceb65af..30237a3 100644 --- a/test/test_ale_info.vader +++ b/test/test_ale_info.vader @@ -21,7 +21,7 @@ Before: \ '', \ 'let g:ale_echo_cursor = 1', \ 'let g:ale_echo_msg_error_str = ''Error''', - \ 'let g:ale_echo_msg_format = ''%s''', + \ 'let g:ale_echo_msg_format = ''%code: %%s''', \ 'let g:ale_echo_msg_warning_str = ''Warning''', \ 'let g:ale_enabled = 1', \ 'let g:ale_fix_on_save = 0', diff --git a/test/test_cursor_warnings.vader b/test/test_cursor_warnings.vader index 20ccb15..dbcbe66 100644 --- a/test/test_cursor_warnings.vader +++ b/test/test_cursor_warnings.vader @@ -12,8 +12,9 @@ Before: \ 'linter_name': 'eslint', \ 'nr': -1, \ 'type': 'E', - \ 'text': 'Missing semicolon. (semi)', - \ 'detail': "Every statement should end with a semicolon\nsecond line" + \ 'code': 'semi', + \ 'text': 'Missing semicolon.', + \ 'detail': "Every statement should end with a semicolon\nsecond line", \ }, \ { \ 'lnum': 1, @@ -33,7 +34,8 @@ Before: \ 'linter_name': 'eslint', \ 'nr': -1, \ 'type': 'W', - \ 'text': 'Infix operators must be spaced. (space-infix-ops)' + \ 'code': 'space-infix-ops', + \ 'text': 'Infix operators must be spaced.', \ }, \ { \ 'lnum': 2, @@ -43,7 +45,8 @@ Before: \ 'linter_name': 'eslint', \ 'nr': -1, \ 'type': 'E', - \ 'text': 'Missing radix parameter (radix)' + \ 'code': 'radix', + \ 'text': 'Missing radix parameter', \ }, \ { \ 'lnum': 3, @@ -53,7 +56,7 @@ Before: \ 'linter_name': 'eslint', \ 'nr': -1, \ 'type': 'E', - \ 'text': 'lowercase error' + \ 'text': 'lowercase error', \ }, \ ], \ }, @@ -103,19 +106,19 @@ Execute(Messages should be shown for the correct lines): call cursor(1, 1) call ale#cursor#EchoCursorWarning() - AssertEqual 'Missing semicolon. (semi)', GetLastMessage() + AssertEqual 'semi: Missing semicolon.', GetLastMessage() Execute(Messages should be shown for earlier columns): call cursor(2, 1) call ale#cursor#EchoCursorWarning() - AssertEqual 'Infix operators must be spaced. (space-infix-ops)', GetLastMessage() + AssertEqual 'space-infix-ops: Infix operators must be spaced.', GetLastMessage() Execute(Messages should be shown for later columns): call cursor(2, 16) call ale#cursor#EchoCursorWarning() - AssertEqual 'Missing radix parameter (radix)', GetLastMessage() + AssertEqual 'radix: Missing radix parameter', GetLastMessage() Execute(The message at the cursor should be shown when linting ends): call cursor(1, 1) @@ -124,13 +127,13 @@ Execute(The message at the cursor should be shown when linting ends): \ g:ale_buffer_info[bufnr('%')].loclist, \) - AssertEqual 'Missing semicolon. (semi)', GetLastMessage() + AssertEqual 'semi: Missing semicolon.', GetLastMessage() Execute(The message at the cursor should be shown on InsertLeave): call cursor(2, 9) doautocmd InsertLeave - AssertEqual 'Infix operators must be spaced. (space-infix-ops)', GetLastMessage() + AssertEqual 'space-infix-ops: Infix operators must be spaced.', GetLastMessage() Execute(ALEDetail should print 'detail' attributes): call cursor(1, 1) @@ -148,7 +151,7 @@ Execute(ALEDetail should print regular 'text' attributes): ALEDetail redir END - AssertEqual "\nInfix operators must be spaced. (space-infix-ops)", g:output + AssertEqual "\nInfix operators must be spaced.", g:output Execute(ALEDetail should not capitlise cursor messages): call cursor(3, 1) @@ -163,7 +166,7 @@ Execute(The linter name should be formatted into the message correctly): call ale#cursor#EchoCursorWarning() AssertEqual - \ 'eslint: Infix operators must be spaced. (space-infix-ops)', + \ 'eslint: Infix operators must be spaced.', \ GetLastMessage() Execute(The severity should be formatted into the message correctly): @@ -173,15 +176,33 @@ Execute(The severity should be formatted into the message correctly): call ale#cursor#EchoCursorWarning() AssertEqual - \ 'Warning: Infix operators must be spaced. (space-infix-ops)', + \ 'Warning: Infix operators must be spaced.', \ GetLastMessage() call cursor(1, 10) call ale#cursor#EchoCursorWarning() - AssertEqual 'Error: Missing semicolon. (semi)', GetLastMessage() + AssertEqual 'Error: Missing semicolon.', GetLastMessage() call cursor(1, 14) call ale#cursor#EchoCursorWarning() AssertEqual 'Info: Some information', GetLastMessage() + +Execute(The %code% and %ifcode% should show the code and some text): + let g:ale_echo_msg_format = '%(code) %%s' + + call cursor(2, 9) + call ale#cursor#EchoCursorWarning() + + AssertEqual + \ '(space-infix-ops) Infix operators must be spaced.', + \ GetLastMessage() + +Execute(The %code% and %ifcode% should be removed when there's no code): + let g:ale_echo_msg_format = '%(code) %%s' + + call cursor(1, 14) + call ale#cursor#EchoCursorWarning() + + AssertEqual 'Some information', GetLastMessage() From e9e29e003c23de2e2499f4c641437021891f9269 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 20:52:16 -0500 Subject: [PATCH 119/390] =?UTF-8?q?[eruby]=20Rename=20`erubylint`=20?= =?UTF-8?q?=E2=86=92=20`erb`=20to=20match=20tool=20name?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ale_linters/eruby/{erubylint.vim => erb.vim} | 4 ++-- doc/ale-eruby.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename ale_linters/eruby/{erubylint.vim => erb.vim} (73%) diff --git a/ale_linters/eruby/erubylint.vim b/ale_linters/eruby/erb.vim similarity index 73% rename from ale_linters/eruby/erubylint.vim rename to ale_linters/eruby/erb.vim index 2ff03c3..18f92b3 100644 --- a/ale_linters/eruby/erubylint.vim +++ b/ale_linters/eruby/erb.vim @@ -1,8 +1,8 @@ " Author: Matthias Guenther - https://wikimatze.de -" Description: erb-lint for eruby/erb files +" Description: ERB from the Ruby standard library, for eruby/erb files call ale#linter#Define('eruby', { -\ 'name': 'erubylint', +\ 'name': 'erb', \ 'executable': 'erb', \ 'output_stream': 'stderr', \ 'command': 'erb -P -x %t | ruby -c', diff --git a/doc/ale-eruby.txt b/doc/ale-eruby.txt index b9cd3cb..bfbe9ad 100644 --- a/doc/ale-eruby.txt +++ b/doc/ale-eruby.txt @@ -3,7 +3,7 @@ ALE Eruby Integration *ale-eruby-options* There are two linters for `eruby` files: -- `erubylint` +- `erb` - `erubis` If you don't know which one your project uses, it's probably `erb`. From ea7f68226ecdc0e6be3d6300c46bc8c88a00c756 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:10:03 -0500 Subject: [PATCH 120/390] [eruby] Add GetCommand to erb linter GetCommand conditionally adds a filter (implemented as inline Ruby code in the command line) to transform some of the problematic Rails-specific eRuby syntax. Specifically, <%= tags are replaced with <%. This does not reduce the effectiveness of the linter, because the transformed code is still evaluated. This solution was suggested by @rgo at https://github.com/w0rp/ale/issues/580#issuecomment-337676607. --- ale_linters/eruby/erb.vim | 20 +++++++++++++++--- .../test_erb_command_callback.vader | 21 +++++++++++++++++++ .../app/views/my_great_view.html.erb | 0 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_erb_command_callback.vader create mode 100644 test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb diff --git a/ale_linters/eruby/erb.vim b/ale_linters/eruby/erb.vim index 18f92b3..5d0b400 100644 --- a/ale_linters/eruby/erb.vim +++ b/ale_linters/eruby/erb.vim @@ -1,11 +1,25 @@ -" Author: Matthias Guenther - https://wikimatze.de +" Author: Matthias Guenther - https://wikimatze.de, Eddie Lebow https://github.com/elebow " Description: ERB from the Ruby standard library, for eruby/erb files +function! ale_linters#eruby#erb#GetCommand(buffer) abort + let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) + + if empty(l:rails_root) + return 'erb -P -x %t | ruby -c' + endif + + " Rails-flavored eRuby does not comply with the standard as understood by + " ERB, so we'll have to do some substitution. This does not reduce the + " effectiveness of the linter—the translated code is still evaluated. + return 'ruby -r erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c' +endfunction + call ale#linter#Define('eruby', { \ 'name': 'erb', +\ 'aliases': ['erubylint'], \ 'executable': 'erb', -\ 'output_stream': 'stderr', -\ 'command': 'erb -P -x %t | ruby -c', +\ 'output_stream': 'stderr', +\ 'command_callback': 'ale_linters#eruby#erb#GetCommand', \ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', \}) diff --git a/test/command_callback/test_erb_command_callback.vader b/test/command_callback/test_erb_command_callback.vader new file mode 100644 index 0000000..2cfff7e --- /dev/null +++ b/test/command_callback/test_erb_command_callback.vader @@ -0,0 +1,21 @@ +Before: + runtime ale_linters/eruby/erb.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(Executable should not contain any filter code by default): + call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb') + + AssertEqual + \ 'erb -P -x %t | ruby -c', + \ ale_linters#eruby#erb#GetCommand(bufnr('')) + +Execute(Executable should filter invalid eRuby when inside a Rails project): + call ale#test#SetFilename('../ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb') + + AssertEqual + \ 'ruby -r erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c', + \ ale_linters#eruby#erb#GetCommand(bufnr('')) diff --git a/test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb b/test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb new file mode 100644 index 0000000..e69de29 From ad7ea3630758af51f6be826fcd453dfc42a6cd75 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:59:18 -0500 Subject: [PATCH 121/390] [eruby] Add GetCommand to erubis linter GetCommand conditionally adds a filter (implemented as inline Ruby code in the command line) to transform some of the problematic Rails-specific eRuby syntax. Specifically, <%= tags are replaced with <%. This does not reduce the effectiveness of the linter, because the transformed code is still evaluated. This solution was suggested by @rgo at https://github.com/w0rp/ale/issues/580#issuecomment-337676607. --- ale_linters/eruby/erubis.vim | 18 +++++++++++++--- .../test_erubis_command_callback.vader | 21 +++++++++++++++++++ 2 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_erubis_command_callback.vader diff --git a/ale_linters/eruby/erubis.vim b/ale_linters/eruby/erubis.vim index be9332d..ac356ae 100644 --- a/ale_linters/eruby/erubis.vim +++ b/ale_linters/eruby/erubis.vim @@ -1,11 +1,23 @@ -" Author: Jake Zimmerman +" Author: Jake Zimmerman , Eddie Lebow https://github.com/elebow " Description: eruby checker using `erubis`, instead of `erb` +function! ale_linters#eruby#erubis#GetCommand(buffer) abort + let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) + + if empty(l:rails_root) + return 'erubis -x %t | ruby -c' + endif + + " Rails-flavored eRuby does not comply with the standard as understood by + " Erubis, so we'll have to do some substitution. This does not reduce the + " effectiveness of the linter—the translated code is still evaluated. + return 'ruby -r erubis -e ' . ale#Escape('puts Erubis::Eruby.new($stdin.read.gsub(%{<%=},%{<%})).src') . ' | ruby -c' +endfunction + call ale#linter#Define('eruby', { \ 'name': 'erubis', \ 'executable': 'erubis', \ 'output_stream': 'stderr', -\ 'command': 'erubis -x %t | ruby -c', +\ 'command_callback': 'ale_linters#eruby#erubis#GetCommand', \ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', \}) - diff --git a/test/command_callback/test_erubis_command_callback.vader b/test/command_callback/test_erubis_command_callback.vader new file mode 100644 index 0000000..68624ec --- /dev/null +++ b/test/command_callback/test_erubis_command_callback.vader @@ -0,0 +1,21 @@ +Before: + runtime ale_linters/eruby/erubis.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(Executable should not contain any filter code by default): + call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb') + + AssertEqual + \ 'erubis -x %t | ruby -c', + \ ale_linters#eruby#erubis#GetCommand(bufnr('')) + +Execute(Executable should filter invalid eRuby when inside a Rails project): + call ale#test#SetFilename('../ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb') + + AssertEqual + \ 'ruby -r erubis -e ' . ale#Escape('puts Erubis::Eruby.new($stdin.read.gsub(%{<%=},%{<%})).src') . ' | ruby -c', + \ ale_linters#eruby#erubis#GetCommand(bufnr('')) From a5f7f51c9a13f103a51cb91b6abdd53fade3600a Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 10:27:20 +0000 Subject: [PATCH 122/390] #1121 Tell people how to lint when leaving insert mode with Ctrl+C --- doc/ale.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index 3a43685..353c6db 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -882,9 +882,16 @@ g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave* Type: |Number| Default: `0` - This option will make ALE run the linters whenever leaving insert mode when - it is set to `1` in your vimrc file. + When set to `1` in your vimrc file, this option will cause ALE to run + linters when you leave insert mode. + ALE will not lint files when you escape insert mode with |CTRL-C| by + default. You can make ALE lint files with this option when you use |CTRL-C| + with the following keybind. > + + " Make using Ctrl+C do the same as Escape, to trigger autocmd commands + inoremap +< g:ale_linter_aliases *g:ale_linter_aliases* *b:ale_linter_aliases* From 6c112dd1cc0225d2549f364b5e8a7693755634c2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 16:08:09 +0000 Subject: [PATCH 123/390] Fix #1122 - Handle notes for shellcheck errors again, and use type 'I' for notes --- ale_linters/sh/shellcheck.vim | 37 +++++++++++++++++++- test/handler/test_shellcheck_handler.vader | 40 ++++++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 test/handler/test_shellcheck_handler.vader diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index e79b3b8..3e60ad3 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -70,6 +70,41 @@ function! ale_linters#sh#shellcheck#GetCommand(buffer, version_output) abort \ . ' -f gcc -' endfunction +function! ale_linters#sh#shellcheck#Handle(buffer, lines) abort + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + if l:match[4] is# 'error' + let l:type = 'E' + elseif l:match[4] is# 'note' + let l:type = 'I' + else + let l:type = 'W' + endif + + let l:item = { + \ 'lnum': str2nr(l:match[2]), + \ 'type': l:type, + \ 'text': l:match[5], + \} + + if !empty(l:match[3]) + let l:item.col = str2nr(l:match[3]) + endif + + " If the filename is something like , or -, then + " this is an error for the file we checked. + if l:match[1] isnot# '-' && l:match[1][0] isnot# '<' + let l:item['filename'] = l:match[1] + endif + + call add(l:output, l:item) + endfor + + return l:output +endfunction + call ale#linter#Define('sh', { \ 'name': 'shellcheck', \ 'executable_callback': 'ale_linters#sh#shellcheck#GetExecutable', @@ -77,5 +112,5 @@ call ale#linter#Define('sh', { \ {'callback': 'ale_linters#sh#shellcheck#VersionCheck'}, \ {'callback': 'ale_linters#sh#shellcheck#GetCommand'}, \ ], -\ 'callback': 'ale#handlers#gcc#HandleGCCFormat', +\ 'callback': 'ale_linters#sh#shellcheck#Handle', \}) diff --git a/test/handler/test_shellcheck_handler.vader b/test/handler/test_shellcheck_handler.vader new file mode 100644 index 0000000..5a7607e --- /dev/null +++ b/test/handler/test_shellcheck_handler.vader @@ -0,0 +1,40 @@ +Before: + runtime ale_linters/shell/shellcheck.vim + +After: + call ale#linter#Reset() + +Execute(The shellcheck handler should handle basic errors or warnings): + AssertEqual + \ [ + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'type': 'W', + \ 'text': 'In POSIX sh, ''let'' is not supported. [SC2039]', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 3, + \ 'type': 'E', + \ 'text': 'Don''t put spaces around the = in assignments. [SC1068]', + \ }, + \ ], + \ ale_linters#sh#shellcheck#Handle(bufnr(''), [ + \ '-:2:1: warning: In POSIX sh, ''let'' is not supported. [SC2039]', + \ '-:2:3: error: Don''t put spaces around the = in assignments. [SC1068]', + \ ]) + +Execute(The shellcheck handler should handle notes): + AssertEqual + \ [ + \ { + \ 'lnum': 3, + \ 'col': 3, + \ 'type': 'I', + \ 'text': 'Double quote to prevent globbing and word splitting. [SC2086]', + \ }, + \ ], + \ ale_linters#sh#shellcheck#Handle(bufnr(''), [ + \ '-:3:3: note: Double quote to prevent globbing and word splitting. [SC2086]', + \ ]) From 764a33b1c9dc355f779366762db1645eda478ee4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 22:47:19 +0000 Subject: [PATCH 124/390] Fix #1124 - Handle stack-build errors with leading spaces --- autoload/ale/handlers/haskell.vim | 2 +- test/handler/test_ghc_handler.vader | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/autoload/ale/handlers/haskell.vim b/autoload/ale/handlers/haskell.vim index 9c8d058..0960669 100644 --- a/autoload/ale/handlers/haskell.vim +++ b/autoload/ale/handlers/haskell.vim @@ -19,7 +19,7 @@ function! ale#handlers#haskell#HandleGHCFormat(buffer, lines) abort " in Haskell error messages with the basename for this file. let l:temp_filename_regex = s:temp_regex_prefix . l:basename - let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+):(.*)?$' + let l:pattern = '\v^\s*([a-zA-Z]?:?[^:]+):(\d+):(\d+):(.*)?$' let l:output = [] let l:corrected_lines = [] diff --git a/test/handler/test_ghc_handler.vader b/test/handler/test_ghc_handler.vader index b76046c..b47cdf6 100644 --- a/test/handler/test_ghc_handler.vader +++ b/test/handler/test_ghc_handler.vader @@ -76,3 +76,25 @@ Execute(The ghc handler should handle ghc 7 output): \ ale#path#Winify('src/Main.hs') . ':94:5:Error:', \ ' Some other error', \ ]) + +Execute(The ghc handler should handle stack 1.5.1 output): + call ale#test#SetFilename('src/Main.hs') + + AssertEqual + \ [ + \ { + \ 'lnum': 160, + \ 'col': 14, + \ 'type': 'E', + \ 'text': '• Expecting one fewer arguments to ‘Exp’ Expected kind ‘k0 -> *’, but ‘Exp’ has kind ‘*’ • In the type ‘Exp a’ | 160 | pattern F :: Exp a | ^^^^^', + \ }, + \ ], + \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ + \ ' ' . ale#path#Winify('src/Main.hs') . ':160:14: error:', + \ ' • Expecting one fewer arguments to ‘Exp’', + \ ' Expected kind ‘k0 -> *’, but ‘Exp’ has kind ‘*’', + \ ' • In the type ‘Exp a’', + \ ' |', + \ ' 160 | pattern F :: Exp a', + \ ' | ^^^^^', + \ ]) From 8a3a2da87ed446a7161538e08ce1e961f3dc393c Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 23:21:45 +0000 Subject: [PATCH 125/390] #852 Capture error codes for ESLint --- autoload/ale/handlers/eslint.vim | 22 ++++++++++++--------- test/handler/test_eslint_handler.vader | 27 ++++++++++++++++---------- 2 files changed, 30 insertions(+), 19 deletions(-) diff --git a/autoload/ale/handlers/eslint.vim b/autoload/ale/handlers/eslint.vim index d1a3b60..adfb65b 100644 --- a/autoload/ale/handlers/eslint.vim +++ b/autoload/ale/handlers/eslint.vim @@ -48,7 +48,7 @@ function! ale#handlers#eslint#GetCommand(buffer) abort endfunction let s:col_end_patterns = [ -\ '\vParsing error: Unexpected token (.+) ', +\ '\vParsing error: Unexpected token (.+) ?', \ '\v''(.+)'' is not defined.', \ '\v%(Unexpected|Redundant use of) [''`](.+)[''`]', \ '\vUnexpected (console) statement', @@ -111,7 +111,6 @@ function! ale#handlers#eslint#Handle(buffer, lines) abort let l:output = [] for l:match in ale#util#GetMatches(a:lines, [l:pattern, l:parsing_pattern]) - let l:type = 'Error' let l:text = l:match[3] if ale#Var(a:buffer, 'javascript_eslint_suppress_eslintignore') @@ -120,19 +119,24 @@ function! ale#handlers#eslint#Handle(buffer, lines) abort endif endif - " Take the error type from the output if available. - if !empty(l:match[4]) - let l:type = split(l:match[4], '/')[0] - let l:text .= ' [' . l:match[4] . ']' - endif - let l:obj = { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, \ 'text': l:text, - \ 'type': l:type is# 'Warning' ? 'W' : 'E', + \ 'type': 'E', \} + " Take the error type from the output if available. + let l:split_code = split(l:match[4], '/') + + if get(l:split_code, 0, '') is# 'Warning' + let l:obj.type = 'W' + endif + + if !empty(get(l:split_code, 1)) + let l:obj.code = l:split_code[1] + endif + for l:col_match in ale#util#GetMatches(l:text, s:col_end_patterns) let l:obj.end_col = l:obj.col + len(l:col_match[1]) - 1 endfor diff --git a/test/handler/test_eslint_handler.vader b/test/handler/test_eslint_handler.vader index 0ebeb38..47e84d4 100644 --- a/test/handler/test_eslint_handler.vader +++ b/test/handler/test_eslint_handler.vader @@ -19,13 +19,15 @@ Execute(The eslint handler should parse lines correctly): \ { \ 'lnum': 47, \ 'col': 14, - \ 'text': 'Missing trailing comma. [Warning/comma-dangle]', + \ 'text': 'Missing trailing comma.', + \ 'code': 'comma-dangle', \ 'type': 'W', \ }, \ { \ 'lnum': 56, \ 'col': 41, - \ 'text': 'Missing semicolon. [Error/semi]', + \ 'text': 'Missing semicolon.', + \ 'code': 'semi', \ 'type': 'E', \ }, \ { @@ -259,42 +261,47 @@ Execute(The eslint handler should output end_col values where appropriate): \ 'lnum': 4, \ 'col': 3, \ 'end_col': 15, - \ 'text': 'Parsing error: Unexpected token ''some string'' [Error]', + \ 'text': 'Parsing error: Unexpected token ''some string''', \ 'type': 'E', \ }, \ { \ 'lnum': 70, \ 'col': 3, \ 'end_col': 5, - \ 'text': '''foo'' is not defined. [Error/no-undef]', + \ 'text': '''foo'' is not defined.', + \ 'code': 'no-undef', \ 'type': 'E', \ }, \ { \ 'lnum': 71, \ 'col': 2, \ 'end_col': 6, - \ 'text': 'Unexpected `await` inside a loop. [Error/no-await-in-loop]', + \ 'text': 'Unexpected `await` inside a loop.', + \ 'code': 'no-await-in-loop', \ 'type': 'E', \ }, \ { \ 'lnum': 72, \ 'col': 6, \ 'end_col': 10, - \ 'text': 'Redundant use of `await` on a return value. [Error/no-return-await]', + \ 'text': 'Redundant use of `await` on a return value.', + \ 'code': 'no-return-await', \ 'type': 'E', \ }, \ { \ 'lnum': 73, \ 'col': 4, \ 'end_col': 10, - \ 'text': 'Unexpected console statement [Error/no-console]', + \ 'text': 'Unexpected console statement', + \ 'code': 'no-console', \ 'type': 'E', \ }, \ { \ 'lnum': 74, \ 'col': 4, \ 'end_col': 11, - \ 'text': 'Unexpected ''debugger'' statement. [Error/no-debugger]', + \ 'text': 'Unexpected ''debugger'' statement.', + \ 'code': 'no-debugger', \ 'type': 'E', \ }, \ ], @@ -316,7 +323,7 @@ Execute(The eslint hint about using typescript-eslint-parser): \ 'lnum': 451, \ 'col': 2, \ 'end_col': 2, - \ 'text': 'Parsing error (You may need configure typescript-eslint-parser): Unexpected token ) [Error]', + \ 'text': 'Parsing error (You may need configure typescript-eslint-parser): Unexpected token )', \ 'type': 'E', \ }, \ ], @@ -330,7 +337,7 @@ Execute(eslint should warn about ignored files by default): \ 'lnum': 0, \ 'col': 0, \ 'type': 'W', - \ 'text': 'File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]' + \ 'text': 'File ignored because of a matching ignore pattern. Use "--no-ignore" to override.' \ }], \ ale#handlers#eslint#Handle(bufnr(''), [ \ '/path/to/some/ignored.js:0:0: File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]', From fea708cff33343dbeff496ba2c25ed2fe7268fed Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 23:34:00 +0000 Subject: [PATCH 126/390] #852 Pass on error codes in the loclist corrections --- autoload/ale/engine.vim | 4 ++++ test/test_loclist_corrections.vader | 21 +++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index f2553b2..e08de16 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -374,6 +374,10 @@ function! ale#engine#FixLocList(buffer, linter_name, loclist) abort \ 'linter_name': a:linter_name, \} + if has_key(l:old_item, 'code') + let l:item.code = l:old_item.code + endif + if has_key(l:old_item, 'filename') \&& !ale#path#IsTempName(l:old_item.filename) " Use the filename given. diff --git a/test/test_loclist_corrections.vader b/test/test_loclist_corrections.vader index e6844d8..6224d60 100644 --- a/test/test_loclist_corrections.vader +++ b/test/test_loclist_corrections.vader @@ -327,3 +327,24 @@ Execute(FixLocList should interpret temporary filenames as being the current buf \ {'text': 'a', 'lnum': 3, 'filename': b:temp_name}, \ ], \ ) + +Execute(The error code should be passed on): + AssertEqual + \ [ + \ { + \ 'text': 'a', + \ 'lnum': 10, + \ 'col': 0, + \ 'bufnr': bufnr('%'), + \ 'vcol': 0, + \ 'type': 'E', + \ 'nr': -1, + \ 'linter_name': 'foobar', + \ 'code': 'some-code' + \ }, + \], + \ ale#engine#FixLocList( + \ bufnr('%'), + \ 'foobar', + \ [{'text': 'a', 'lnum': 11, 'code': 'some-code'}], + \ ) From 037aaae593bba96b71d89c6f9bd5f14e3846e067 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 13 Nov 2017 23:36:15 +0000 Subject: [PATCH 127/390] #852 - Capture error codes for TSLint --- ale_linters/typescript/tslint.vim | 14 +++++++++----- test/handler/test_tslint_handler.vader | 17 +++++++++++------ 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/ale_linters/typescript/tslint.vim b/ale_linters/typescript/tslint.vim index e366af8..a1bfbb7 100644 --- a/ale_linters/typescript/tslint.vim +++ b/ale_linters/typescript/tslint.vim @@ -28,17 +28,21 @@ function! ale_linters#typescript#tslint#Handle(buffer, lines) abort continue endif - call add(l:output, { + let l:item = { \ 'filename': ale#path#GetAbsPath(l:dir, l:error.name), \ 'type': (get(l:error, 'ruleSeverity', '') is# 'WARNING' ? 'W' : 'E'), - \ 'text': has_key(l:error, 'ruleName') - \ ? l:error.ruleName . ': ' . l:error.failure - \ : l:error.failure, + \ 'text': l:error.failure, \ 'lnum': l:error.startPosition.line + 1, \ 'col': l:error.startPosition.character + 1, \ 'end_lnum': l:error.endPosition.line + 1, \ 'end_col': l:error.endPosition.character + 1, - \}) + \} + + if has_key(l:error, 'ruleName') + let l:item.code = l:error.ruleName + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index db6294c..d6ed353 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -28,7 +28,8 @@ Execute(The tslint handler should parse lines correctly): \ 'end_lnum': 1, \ 'type': 'E', \ 'end_col': 15, - \ 'text': 'semicolon: Missing semicolon' + \ 'text': 'Missing semicolon', + \ 'code': 'semicolon', \ }, \ { \ 'lnum': 2, @@ -37,7 +38,7 @@ Execute(The tslint handler should parse lines correctly): \ 'end_lnum': 3, \ 'type': 'W', \ 'end_col': 12, - \ 'text': 'Something else' + \ 'text': 'Something else', \ }, \ { \ 'lnum': 2, @@ -46,7 +47,8 @@ Execute(The tslint handler should parse lines correctly): \ 'end_lnum': 3, \ 'type': 'W', \ 'end_col': 12, - \ 'text': 'something: Something else' + \ 'text': 'Something else', + \ 'code': 'something', \ }, \ { \ 'lnum': 31, @@ -55,7 +57,8 @@ Execute(The tslint handler should parse lines correctly): \ 'end_lnum': 31, \ 'type': 'E', \ 'end_col': 20, - \ 'text': 'no-console: Calls to console.log are not allowed.' + \ 'text': 'Calls to console.log are not allowed.', + \ 'code': 'no-console', \ }, \ ] , \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ @@ -155,7 +158,8 @@ Execute(The tslint handler report errors for empty files by default): \ 'end_lnum': 2, \ 'type': 'E', \ 'end_col': 1, - \ 'text': 'no-consecutive-blank-lines: Consecutive blank lines are forbidden', + \ 'text': 'Consecutive blank lines are forbidden', + \ 'code': 'no-consecutive-blank-lines', \ }, \ ], \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([{ @@ -228,7 +232,8 @@ Execute(The tslint handler should report errors when the ignore option is on, bu \ 'end_lnum': 2, \ 'type': 'E', \ 'end_col': 1, - \ 'text': 'no-consecutive-blank-lines: Consecutive blank lines are forbidden', + \ 'text': 'Consecutive blank lines are forbidden', + \ 'code': 'no-consecutive-blank-lines', \ }, \ ], \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([{ From d8f9aef84a1271633cb4fc7ba7a063e4b922d56b Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 09:41:29 +0000 Subject: [PATCH 128/390] #852 - Capture error codes for flake8 --- ale_linters/python/flake8.vim | 3 ++- test/handler/test_flake8_handler.vader | 27 +++++++++++++++++--------- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim index 501db0b..480e605 100644 --- a/ale_linters/python/flake8.vim +++ b/ale_linters/python/flake8.vim @@ -94,7 +94,8 @@ function! ale_linters#python#flake8#Handle(buffer, lines) abort let l:item = { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, - \ 'text': l:code . ': ' . l:match[4], + \ 'text': l:match[4], + \ 'code': l:code, \ 'type': 'W', \} diff --git a/test/handler/test_flake8_handler.vader b/test/handler/test_flake8_handler.vader index 0d6d65f..d8cb51b 100644 --- a/test/handler/test_flake8_handler.vader +++ b/test/handler/test_flake8_handler.vader @@ -11,21 +11,24 @@ Execute(The flake8 handler should handle basic warnings and syntax errors): \ 'lnum': 6, \ 'col': 6, \ 'type': 'E', - \ 'text': 'E111: indentation is not a multiple of four', + \ 'text': 'indentation is not a multiple of four', + \ 'code': 'E111', \ 'sub_type': 'style', \ }, \ { \ 'lnum': 7, \ 'col': 6, \ 'type': 'W', - \ 'text': 'W123: some warning', + \ 'text': 'some warning', + \ 'code': 'W123', \ 'sub_type': 'style', \ }, \ { \ 'lnum': 8, \ 'col': 3, \ 'type': 'E', - \ 'text': 'E999: SyntaxError: invalid syntax', + \ 'text': 'SyntaxError: invalid syntax', + \ 'code': 'E999', \ }, \ ], \ ale_linters#python#flake8#Handle(1, [ @@ -42,35 +45,40 @@ Execute(The flake8 handler should set end column indexes should be set for certa \ 'col': 1, \ 'type': 'E', \ 'end_col': 3, - \ 'text': 'F821: undefined name ''foo''', + \ 'text': 'undefined name ''foo''', + \ 'code': 'F821', \ }, \ { \ 'lnum': 28, \ 'col': 5, \ 'type': 'E', \ 'end_col': 9, - \ 'text': 'F405: hello may be undefined, or defined from star imports: x', + \ 'text': 'hello may be undefined, or defined from star imports: x', + \ 'code': 'F405', \ }, \ { \ 'lnum': 104, \ 'col': 5, \ 'type': 'E', \ 'end_col': 12, - \ 'text': 'F999: ''continue'' not properly in loop', + \ 'text': '''continue'' not properly in loop', + \ 'code': 'F999', \ }, \ { \ 'lnum': 106, \ 'col': 5, \ 'type': 'E', \ 'end_col': 9, - \ 'text': 'F999: ''break'' outside loop', + \ 'text': '''break'' outside loop', + \ 'code': 'F999', \ }, \ { \ 'lnum': 109, \ 'col': 5, \ 'type': 'E', \ 'end_col': 8, - \ 'text': 'F841: local variable ''test'' is assigned to but never used', + \ 'text': 'local variable ''test'' is assigned to but never used', + \ 'code': 'F841', \ }, \ ], \ ale_linters#python#flake8#Handle(1, [ @@ -125,7 +133,8 @@ Execute (The flake8 handler should handle names with spaces): \ 'lnum': 6, \ 'col': 6, \ 'type': 'E', - \ 'text': 'E111: indentation is not a multiple of four', + \ 'text': 'indentation is not a multiple of four', + \ 'code': 'E111', \ 'sub_type': 'style', \ }, \ ], From 16e7dc2371f908204e5191c0e9d55626352097af Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 10:28:36 +0000 Subject: [PATCH 129/390] Fix #1069 Support formatting the loclist messages with g:ale_loclist_msg_format --- autoload/ale.vim | 28 ++++++ autoload/ale/cursor.vim | 26 +---- autoload/ale/list.vim | 11 ++- doc/ale.txt | 12 +++ plugin/ale.vim | 4 +- test/test_list_formatting.vader | 164 ++++++++++++++++++++++++++++++++ 6 files changed, 215 insertions(+), 30 deletions(-) create mode 100644 test/test_list_formatting.vader diff --git a/autoload/ale.vim b/autoload/ale.vim index 15fb53d..f6c06cf 100644 --- a/autoload/ale.vim +++ b/autoload/ale.vim @@ -257,3 +257,31 @@ function! ale#Escape(str) abort return shellescape (a:str) endfunction + +" Get the loclist item message according to a given format string. +" +" See `:help g:ale_loclist_msg_format` and `:help g:ale_echo_msg_format` +function! ale#GetLocItemMessage(item, format_string) abort + let l:msg = a:format_string + let l:severity = g:ale_echo_msg_warning_str + let l:code = get(a:item, 'code', '') + let l:type = get(a:item, 'type', 'E') + let l:linter_name = get(a:item, 'linter_name', '') + let l:code_repl = !empty(l:code) ? '\=submatch(1) . l:code . submatch(2)' : '' + + if l:type is# 'E' + let l:severity = g:ale_echo_msg_error_str + elseif l:type is# 'I' + let l:severity = g:ale_echo_msg_info_str + endif + + " Replace special markers with certain information. + " \=l:variable is used to avoid escaping issues. + let l:msg = substitute(l:msg, '\V%severity%', '\=l:severity', 'g') + let l:msg = substitute(l:msg, '\V%linter%', '\=l:linter_name', 'g') + let l:msg = substitute(l:msg, '\v\%([^\%]*)code([^\%]*)\%', l:code_repl, 'g') + " Replace %s with the text. + let l:msg = substitute(l:msg, '\V%s', '\=a:item.text', 'g') + + return l:msg +endfunction diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 7b84862..1980c19 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -4,30 +4,6 @@ let s:cursor_timer = -1 let s:last_pos = [0, 0, 0] -" Return a formatted message according to g:ale_echo_msg_format variable -function! s:GetMessage(item) abort - let l:msg = g:ale_echo_msg_format - let l:severity = g:ale_echo_msg_warning_str - let l:code = get(a:item, 'code', '') - let l:code_repl = !empty(l:code) ? '\=submatch(1) . l:code . submatch(2)' : '' - - if a:item.type is# 'E' - let l:severity = g:ale_echo_msg_error_str - elseif a:item.type is# 'I' - let l:severity = g:ale_echo_msg_info_str - endif - - " Replace special markers with certain information. - " \=l:variable is used to avoid escaping issues. - let l:msg = substitute(l:msg, '\V%severity%', '\=l:severity', 'g') - let l:msg = substitute(l:msg, '\V%linter%', '\=a:item.linter_name', 'g') - let l:msg = substitute(l:msg, '\v\%([^\%]*)code([^\%]*)\%', l:code_repl, 'g') - " Replace %s with the text. - let l:msg = substitute(l:msg, '\V%s', '\=a:item.text', 'g') - - return l:msg -endfunction - function! s:EchoWithShortMess(setting, message) abort " We need to remember the setting for shormess and reset it again. let l:shortmess_options = getbufvar('%', '&shortmess') @@ -96,7 +72,7 @@ function! s:EchoImpl() abort let [l:info, l:loc] = s:FindItemAtCursor() if !empty(l:loc) - let l:msg = s:GetMessage(l:loc) + let l:msg = ale#GetLocItemMessage(l:loc, g:ale_echo_msg_format) call ale#cursor#TruncatedEcho(l:msg) let l:info.echoed = 1 elseif get(l:info, 'echoed') diff --git a/autoload/ale/list.vim b/autoload/ale/list.vim index ecf088a..fbc71ef 100644 --- a/autoload/ale/list.vim +++ b/autoload/ale/list.vim @@ -41,13 +41,16 @@ function! s:FixList(list) abort let l:new_list = [] for l:item in a:list + let l:fixed_item = copy(l:item) + + let l:fixed_item.text = ale#GetLocItemMessage( + \ l:item, + \ g:ale_loclist_msg_format, + \) + if l:item.bufnr == -1 " If the buffer number is invalid, remove it. - let l:fixed_item = copy(l:item) call remove(l:fixed_item, 'bufnr') - else - " Don't copy the Dictionary if we do not need to. - let l:fixed_item = l:item endif call add(l:new_list, l:fixed_item) diff --git a/doc/ale.txt b/doc/ale.txt index 353c6db..2126687 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -656,6 +656,7 @@ g:ale_echo_msg_format *g:ale_echo_msg_format* The strings for `%severity%` can be configured with the following options. |g:ale_echo_msg_error_str| - Defaults to `'Error'` + |g:ale_echo_msg_info_str| - Defaults to `'Info'` |g:ale_echo_msg_warning_str| - Defaults to `'Warning'` `%code%` is replaced with the error code, and replaced with an empty string @@ -994,6 +995,17 @@ g:ale_linters *g:ale_linters* let b:ale_linters = 'all' < +g:ale_loclist_msg_format *g:ale_loclist_msg_format* + + Type: |String| + Default: `g:ale_echo_msg_format` + + This option is the same as |g:ale_echo_msg_format|, but for formatting the + message used for the loclist and the quickfix list. + + The strings for configuring `%severity%` are also used for this option. + + g:ale_max_buffer_history_size *g:ale_max_buffer_history_size* Type: |Number| diff --git a/plugin/ale.vim b/plugin/ale.vim index 26d3c43..11df520 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -149,7 +149,9 @@ let g:ale_sign_offset = get(g:, 'ale_sign_offset', 1000000) let g:ale_sign_column_always = get(g:, 'ale_sign_column_always', 0) " A string format for the echoed message -let g:ale_echo_msg_format = get(g:, 'ale_echo_msg_format', '%code: %%s') +call ale#Set('echo_msg_format', '%code: %%s') +" The same for the loclist. +call ale#Set('loclist_msg_format', g:ale_echo_msg_format) " Strings used for severity in the echoed message let g:ale_echo_msg_error_str = get(g:, 'ale_echo_msg_error_str', 'Error') diff --git a/test/test_list_formatting.vader b/test/test_list_formatting.vader new file mode 100644 index 0000000..6b494fc --- /dev/null +++ b/test/test_list_formatting.vader @@ -0,0 +1,164 @@ +Before: + Save g:ale_set_loclist + Save g:ale_set_quickfix + Save g:ale_loclist_msg_format + Save g:ale_open_list + Save g:ale_buffer_info + Save g:ale_set_lists_synchronously + + let g:ale_set_lists_synchronously = 1 + let g:ale_loclist_msg_format = '%code: %%s' + let g:ale_open_list = 0 + let g:loclist = [] + let g:ale_buffer_info = {bufnr(''): {'loclist': g:loclist}} + + function! AddItem(data) abort + let l:item = { + \ 'bufnr': bufnr(''), + \ 'lnum': 1, + \ 'col': 1, + \ 'type': 'E', + \ 'linter_name': 'some_linter', + \} + + call add(g:loclist, extend(l:item, a:data)) + endfunction + +After: + Restore + + unlet! g:loclist + + delfunction AddItem + + call setloclist(0, []) + call setqflist([]) + +Execute(Formatting with codes should work for the loclist): + call AddItem({'text': 'nocode'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': 'nocode', + \ }, + \ ], + \ getloclist(0) + + call remove(g:loclist, 0) + call AddItem({'text': 'withcode', 'code': 'E123'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': 'E123: withcode', + \ }, + \ ], + \ getloclist(0) + +Execute(Formatting with codes should work for the quickfix list): + let g:ale_set_loclist = 0 + let g:ale_set_quickfix = 1 + + call AddItem({'text': 'nocode'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': 'nocode', + \ }, + \ ], + \ getqflist() + + call remove(g:loclist, 0) + call AddItem({'text': 'withcode', 'code': 'E123'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': 'E123: withcode', + \ }, + \ ], + \ getqflist() + +Execute(Formatting with the linter name should work for the loclist): + let g:ale_loclist_msg_format = '(%linter%) %s' + + call AddItem({'text': 'whatever'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': '(some_linter) whatever', + \ }, + \ ], + \ getloclist(0) + +Execute(Formatting with the linter name should work for the quickfix list): + let g:ale_loclist_msg_format = '(%linter%) %s' + let g:ale_set_loclist = 0 + let g:ale_set_quickfix = 1 + + call AddItem({'text': 'whatever'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': '(some_linter) whatever', + \ }, + \ ], + \ getqflist() From 425482116ed4f8baa9e568be50968f412bd5ca0f Mon Sep 17 00:00:00 2001 From: Aliou Diallo Date: Tue, 14 Nov 2017 17:50:15 +0100 Subject: [PATCH 130/390] #852 - Capture error codes for Rubocop --- ale_linters/ruby/rubocop.vim | 3 ++- test/handler/test_rubocop_handler.vader | 12 ++++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/ale_linters/ruby/rubocop.vim b/ale_linters/ruby/rubocop.vim index 2a4388f..777f457 100644 --- a/ale_linters/ruby/rubocop.vim +++ b/ale_linters/ruby/rubocop.vim @@ -34,7 +34,8 @@ function! ale_linters#ruby#rubocop#Handle(buffer, lines) abort \ 'lnum': l:error['location']['line'] + 0, \ 'col': l:start_col, \ 'end_col': l:start_col + l:error['location']['length'] - 1, - \ 'text': printf('%s [%s]', l:error['message'], l:error['cop_name']), + \ 'code': l:error['cop_name'], + \ 'text': l:error['message'], \ 'type': ale_linters#ruby#rubocop#GetType(l:error['severity']), \}) endfor diff --git a/test/handler/test_rubocop_handler.vader b/test/handler/test_rubocop_handler.vader index 4d3bbe2..ef0137d 100644 --- a/test/handler/test_rubocop_handler.vader +++ b/test/handler/test_rubocop_handler.vader @@ -12,28 +12,32 @@ Execute(The rubocop handler should parse lines correctly): \ 'lnum': 83, \ 'col': 29, \ 'end_col': 35, - \ 'text': 'Prefer single-quoted strings... [Style/SomeCop]', + \ 'text': 'Prefer single-quoted strings...', + \ 'code': 'Style/SomeCop', \ 'type': 'W', \ }, \ { \ 'lnum': 12, \ 'col': 2, \ 'end_col': 2, - \ 'text': 'Some error [Style/SomeOtherCop]', + \ 'text': 'Some error', + \ 'code': 'Style/SomeOtherCop', \ 'type': 'E', \ }, \ { \ 'lnum': 10, \ 'col': 5, \ 'end_col': 12, - \ 'text': 'Regular warning [Style/WarningCop]', + \ 'text': 'Regular warning', + \ 'code': 'Style/WarningCop', \ 'type': 'W', \ }, \ { \ 'lnum': 11, \ 'col': 1, \ 'end_col': 1, - \ 'text': 'Another error [Style/SpaceBeforeBlockBraces]', + \ 'text': 'Another error', + \ 'code': 'Style/SpaceBeforeBlockBraces', \ 'type': 'E', \ }, \ ], From 20a01404f346f6c633f15b6c5ca45279259f2c5d Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Wed, 15 Nov 2017 02:37:22 +0900 Subject: [PATCH 131/390] Added support for goimports fixer (#1123) * Added support for goimports fixer * added test and executable check * fixed test assertions to reflect executable check --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++++ autoload/ale/fixers/goimports.vim | 22 +++++++++++++++++++ doc/ale.txt | 2 +- .../test_goimports_fixer_callback.vader | 22 +++++++++++++++++++ 5 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/goimports.vim create mode 100644 test/fixers/test_goimports_fixer_callback.vader diff --git a/README.md b/README.md index 4f26896..cf812af 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ formatting. | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang) | -| Go | [gofmt](https://golang.org/cmd/gofmt/), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | +| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 24166da..4ecdae9 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -107,6 +107,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['go'], \ 'description': 'Fix Go files with go fmt.', \ }, +\ 'goimports': { +\ 'function': 'ale#fixers#goimports#Fix', +\ 'suggested_filetypes': ['go'], +\ 'description': 'Fix Go files imports with go fmt.', +\ }, \ 'tslint': { \ 'function': 'ale#fixers#tslint#Fix', \ 'suggested_filetypes': ['typescript'], diff --git a/autoload/ale/fixers/goimports.vim b/autoload/ale/fixers/goimports.vim new file mode 100644 index 0000000..f569513 --- /dev/null +++ b/autoload/ale/fixers/goimports.vim @@ -0,0 +1,22 @@ +" Author: Jeff Willette +" Description: Integration of goimports with ALE. + +call ale#Set('go_goimports_executable', 'goimports') +call ale#Set('go_goimports_options', '') + +function! ale#fixers#goimports#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'go_goimports_executable') + let l:options = ale#Var(a:buffer, 'go_goimports_options') + + if !executable(l:executable) + return 0 + endif + + return { + \ 'command': ale#Escape(l:executable) + \ . ' -l -w' + \ . (empty(l:options) ? '' : ' ' . l:options) + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/doc/ale.txt b/doc/ale.txt index 2126687..b653e5c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -287,7 +287,7 @@ Notes: * Fortran: `gcc` * FusionScript: `fusion-lint` * GLSL: glslang -* Go: `gofmt`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! +* Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` diff --git a/test/fixers/test_goimports_fixer_callback.vader b/test/fixers/test_goimports_fixer_callback.vader new file mode 100644 index 0000000..df57114 --- /dev/null +++ b/test/fixers/test_goimports_fixer_callback.vader @@ -0,0 +1,22 @@ +Before: + Save g:ale_go_goimports_executable + Save g:ale_go_goimports_options + + " Use an invalid global executable, so we don't match it. + let g:ale_go_goimports_executable = 'xxxinvalid' + let g:ale_go_goimports_options = '' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The goimports callback should return 0 with bad executable): + call ale#test#SetFilename('../go_files/testfile.go') + + AssertEqual + \ 0, + \ ale#fixers#goimports#Fix(bufnr('')) + From 48eb362fca164fd792a3b77a4cba888238aea084 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 17:46:40 +0000 Subject: [PATCH 132/390] Add tests for the goimports fixer commands --- .../test_goimports_fixer_callback.vader | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/test/fixers/test_goimports_fixer_callback.vader b/test/fixers/test_goimports_fixer_callback.vader index df57114..1d2763c 100644 --- a/test/fixers/test_goimports_fixer_callback.vader +++ b/test/fixers/test_goimports_fixer_callback.vader @@ -7,16 +7,35 @@ Before: let g:ale_go_goimports_options = '' call ale#test#SetDirectory('/testplugin/test/fixers') + call ale#test#SetFilename('../go_files/testfile.go') After: Restore call ale#test#RestoreDirectory() -Execute(The goimports callback should return 0 with bad executable): - call ale#test#SetFilename('../go_files/testfile.go') - +Execute(The goimports callback should return 0 when the executable isn't executable): AssertEqual \ 0, \ ale#fixers#goimports#Fix(bufnr('')) +Execute(The goimports callback should the command when the executable test passes): + let g:ale_go_goimports_executable = has('win32') ? 'cmd' : 'echo' + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w %t' + \ }, + \ ale#fixers#goimports#Fix(bufnr('')) + +Execute(The goimports callback should include extra options): + let g:ale_go_goimports_executable = has('win32') ? 'cmd' : 'echo' + let g:ale_go_goimports_options = '--xxx' + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w --xxx %t' + \ }, + \ ale#fixers#goimports#Fix(bufnr('')) From 6b2c61a5cc59d61270266dbe399d5dc55cfad5b4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 19:55:28 +0000 Subject: [PATCH 133/390] Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly --- autoload/ale/linter.vim | 27 ++++++++-- doc/ale.txt | 32 ++++++++--- plugin/ale.vim | 4 +- test/test_filetype_linter_defaults.vader | 68 ++++++++++++++++++++++++ test/test_linter_retrieval.vader | 3 +- 5 files changed, 119 insertions(+), 15 deletions(-) create mode 100644 test/test_filetype_linter_defaults.vader diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index c6667d9..e8f30ff 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -21,6 +21,8 @@ let s:default_ale_linter_aliases = { " " Only cargo is enabled for Rust by default. " rpmlint is disabled by default because it can result in code execution. +" +" NOTE: Update the g:ale_linters documentation when modifying this. let s:default_ale_linters = { \ 'csh': ['shell'], \ 'go': ['gofmt', 'golint', 'go vet'], @@ -308,11 +310,26 @@ function! s:GetLinterNames(original_filetype) abort return l:buffer_ale_linters endif - for l:dict in [l:buffer_ale_linters, g:ale_linters, s:default_ale_linters] - if has_key(l:dict, a:original_filetype) - return l:dict[a:original_filetype] - endif - endfor + " Try to get a buffer-local setting for the filetype + if has_key(l:buffer_ale_linters, a:original_filetype) + return l:buffer_ale_linters[a:original_filetype] + endif + + " Try to get a global setting for the filetype + if has_key(g:ale_linters, a:original_filetype) + return g:ale_linters[a:original_filetype] + endif + + " If the user has configured ALE to only enable linters explicitly, then + " don't enable any linters by default. + if g:ale_linters_explicit + return [] + endif + + " Try to get a default setting for the filetype + if has_key(s:default_ale_linters, a:original_filetype) + return s:default_ale_linters[a:original_filetype] + endif return 'all' endfunction diff --git a/doc/ale.txt b/doc/ale.txt index b653e5c..cd6a3a0 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -946,23 +946,25 @@ g:ale_linters *g:ale_linters* Type: |Dictionary| Default: `{}` - The |g:ale_linters| option sets a |Dictionary| mapping a filetype - to a |List| of linter programs to be run when checking particular filetypes. - Only the filetypes specified in the dictionary will be limited in terms - of which linters will be run. + The |g:ale_linters| option sets a |Dictionary| mapping a filetype to a + |List| of linter programs to be run when checking particular filetypes. This |Dictionary| will be merged with a default dictionary containing the following values: > { \ 'csh': ['shell'], + \ 'go': ['gofmt', 'golint', 'go vet'], + \ 'help': [], + \ 'python': ['flake8', 'mypy', 'pylint'], \ 'rust': ['cargo'], + \ 'spec': [], \ 'text': [], \ 'zsh': ['shell'], \} < This option can be used to enable only a particular set of linters for a - file. For example, you can enable only 'eslint' for JavaScript files: > + file. For example, you can enable only `eslint` for JavaScript files: > let g:ale_linters = {'javascript': ['eslint']} < @@ -971,14 +973,15 @@ g:ale_linters *g:ale_linters* let g:ale_linters = {'javascript': []} < - All linters available for a given filetype can be enabled by using the - string `'all'`: > + All linters will be run for unspecified filetypes. All available linters can + be enabled explicitly for a given filetype by passing the string `'all'`, + instead of a List. > let g:ale_linters = {'c': 'all'} < Linters can be configured in each buffer with buffer-local variables. ALE will first look for linters for filetypes in the `b:ale_linters` variable, - then `g:ale_linters`, and then a default Dictionary. + then `g:ale_linters`, and then the default Dictionary mentioned above. `b:ale_linters` can be set to a List, or the string `'all'`. When linters for two different filetypes share the same name, the first linter loaded @@ -994,6 +997,19 @@ g:ale_linters *g:ale_linters* " Explicitly enable all available linters for the filetype. let b:ale_linters = 'all' < + ALE can be configured to disable all linters unless otherwise specified with + `g:ale_enabled` or `b:ale_enabled` with the option |g:ale_linters_explicit|. + + +g:ale_linters_explicit *g:ale_linters_explicit* + + Type: |Number| + Default: `0` + + When set to `1`, only the linters from |g:ale_linters| and |b:ale_linters| + will be enabled. The default behavior for ALE is to enable as many linters + as possible, unless otherwise specified. + g:ale_loclist_msg_format *g:ale_loclist_msg_format* diff --git a/plugin/ale.vim b/plugin/ale.vim index 11df520..31c3377 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -68,7 +68,9 @@ let g:ale_filetype_blacklist = [ \] " This Dictionary configures which linters are enabled for which languages. -let g:ale_linters = get(g:, 'ale_linters', {}) +call ale#Set('linters', {}) +" This option can be changed to only enable explicitly selected linters. +call ale#Set('linters_explicit', 0) " This Dictionary configures which functions will be used for fixing problems. let g:ale_fixers = get(g:, 'ale_fixers', {}) diff --git a/test/test_filetype_linter_defaults.vader b/test/test_filetype_linter_defaults.vader new file mode 100644 index 0000000..ea4a05f --- /dev/null +++ b/test/test_filetype_linter_defaults.vader @@ -0,0 +1,68 @@ +Before: + Save g:ale_linters + Save g:ale_linters_explicit + + let g:ale_linters_explicit = 0 + let g:ale_linters = {} + + function! GetLinterNames(filetype) abort + return map(ale#linter#Get(a:filetype), 'v:val.name') + endfunction + +After: + Restore + + call ale#linter#Reset() + +Execute(The defaults for the csh filetype should be correct): + AssertEqual ['shell'], GetLinterNames('csh') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('csh') + +Execute(The defaults for the go filetype should be correct): + AssertEqual ['gofmt', 'golint', 'go vet'], GetLinterNames('go') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('go') + +Execute(The defaults for the help filetype should be correct): + AssertEqual [], GetLinterNames('help') + +Execute(The defaults for the python filetype should be correct): + AssertEqual ['flake8', 'mypy', 'pylint'], GetLinterNames('python') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('python') + +Execute(The defaults for the rust filetype should be correct): + AssertEqual ['cargo'], GetLinterNames('rust') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('rust') + +Execute(The defaults for the spec filetype should be correct): + AssertEqual [], GetLinterNames('spec') + +Execute(The defaults for the text filetype should be correct): + AssertEqual [], GetLinterNames('text') + +Execute(The defaults for the zsh filetype should be correct): + AssertEqual ['shell'], GetLinterNames('zsh') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('zsh') + +Execute(The defaults for the verilog filetype should be correct): + " This filetype isn't configured with default, so we can test loading all + " available linters with this. + AssertEqual ['iverilog', 'verilator'], GetLinterNames('verilog') + + let g:ale_linters_explicit = 1 + + AssertEqual [], GetLinterNames('verilog') diff --git a/test/test_linter_retrieval.vader b/test/test_linter_retrieval.vader index 5d5b582..5d1ee45 100644 --- a/test/test_linter_retrieval.vader +++ b/test/test_linter_retrieval.vader @@ -1,5 +1,6 @@ Before: - Save g:ale_linters, g:ale_linter_aliases + Save g:ale_linters + Save g:ale_linter_aliases let g:testlinter1 = {'name': 'testlinter1', 'executable': 'testlinter1', 'command': 'testlinter1', 'callback': 'testCB1', 'output_stream': 'stdout', 'read_buffer': 1, 'lint_file': 0, 'aliases': [], 'lsp': '', 'add_newline': 0} let g:testlinter2 = {'name': 'testlinter2', 'executable': 'testlinter2', 'command': 'testlinter2', 'callback': 'testCB2', 'output_stream': 'stdout', 'read_buffer': 0, 'lint_file': 1, 'aliases': [], 'lsp': '', 'add_newline': 0} From d48506f9c17915a72ff773f11728958e723e9e92 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 23:25:01 +0000 Subject: [PATCH 134/390] Fix #757 - Show :ALEDetail messages in a window --- autoload/ale/cursor.vim | 6 ++---- autoload/ale/preview.vim | 18 ++++++++++++++++++ ftplugin/ale-preview.vim | 2 ++ test/test_cursor_warnings.vader | 22 ++++++++++++++-------- 4 files changed, 36 insertions(+), 12 deletions(-) create mode 100644 autoload/ale/preview.vim create mode 100644 ftplugin/ale-preview.vim diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 1980c19..6907610 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -125,9 +125,7 @@ function! ale#cursor#ShowCursorDetail() abort if !empty(l:loc) let l:message = get(l:loc, 'detail', l:loc.text) - call s:EchoWithShortMess('off', l:message) - - " Set the echo marker, so we can clear it by moving the cursor. - let l:info.echoed = 1 + call ale#preview#Show(split(l:message, "\n")) + echo endif endfunction diff --git a/autoload/ale/preview.vim b/autoload/ale/preview.vim new file mode 100644 index 0000000..3b1c16a --- /dev/null +++ b/autoload/ale/preview.vim @@ -0,0 +1,18 @@ +" Author: w0rp +" Description: Preview windows for showing whatever information in. + +" Open a preview window and show some lines in it. +function! ale#preview#Show(lines) abort + silent pedit ALEPreviewWindow + wincmd P + setlocal modifiable + setlocal noreadonly + setlocal nobuflisted + setlocal filetype=ale-preview + setlocal buftype=nofile + setlocal bufhidden=wipe + :%d + call setline(1, a:lines) + setlocal nomodifiable + setlocal readonly +endfunction diff --git a/ftplugin/ale-preview.vim b/ftplugin/ale-preview.vim new file mode 100644 index 0000000..ffbffbd --- /dev/null +++ b/ftplugin/ale-preview.vim @@ -0,0 +1,2 @@ +" Close the ALEPreviewWindow window with the q key. +noremap q :q! diff --git a/test/test_cursor_warnings.vader b/test/test_cursor_warnings.vader index dbcbe66..c6dc526 100644 --- a/test/test_cursor_warnings.vader +++ b/test/test_cursor_warnings.vader @@ -97,6 +97,11 @@ After: " carried over between test cases. echomsg '' + " Close the preview window if it's open. + if &filetype is# 'ale-preview' + noautocmd :q! + endif + Given javascript(A Javscript file with warnings/errors): var x = 3 + 12345678 var x = 5*2 + parseInt("10"); @@ -138,20 +143,21 @@ Execute(The message at the cursor should be shown on InsertLeave): Execute(ALEDetail should print 'detail' attributes): call cursor(1, 1) - redir => g:output - ALEDetail - redir END + ALEDetail - AssertEqual "\nEvery statement should end with a semicolon\nsecond line", g:output + AssertEqual + \ ['Every statement should end with a semicolon', 'second line'], + \ getline(1, '$') Execute(ALEDetail should print regular 'text' attributes): call cursor(2, 10) - redir => g:output - ALEDetail - redir END + ALEDetail - AssertEqual "\nInfix operators must be spaced.", g:output + " ALEDetail opens a window, so check the text in it. + AssertEqual + \ ['Infix operators must be spaced.'], + \ getline(1, '$') Execute(ALEDetail should not capitlise cursor messages): call cursor(3, 1) From 48be035da82c30fe12859179d731720f3819ee4e Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 14 Nov 2017 23:29:48 +0000 Subject: [PATCH 135/390] Update the documentation for :ALEDetail --- doc/ale.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index cd6a3a0..7da027b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1609,10 +1609,12 @@ ALEDisableBuffer *ALEDisableBuffer* For removing problems reported by ALE, but leaving ALE enabled, see |ALEReset| and |ALEResetBuffer|. + *:ALEDetail* ALEDetail *ALEDetail* - Show the full linter message for the current line. This will only have an - effect on lines that contain a linter message. + Show the full linter message for the current line in the preview window. + This will only have an effect on lines that contain a linter message. The + preview window can be easily closed with the `q` key. A plug mapping `(ale_detail)` is defined for this command. From a36129eab0dd5a446cea90cae90a219f9f9d4cd7 Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Wed, 15 Nov 2017 09:40:40 +0900 Subject: [PATCH 136/390] fix goimports typo in registry --- autoload/ale/fix/registry.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 4ecdae9..2e24e02 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -110,7 +110,7 @@ let s:default_registry = { \ 'goimports': { \ 'function': 'ale#fixers#goimports#Fix', \ 'suggested_filetypes': ['go'], -\ 'description': 'Fix Go files imports with go fmt.', +\ 'description': 'Fix Go files imports with goimports.', \ }, \ 'tslint': { \ 'function': 'ale#fixers#tslint#Fix', From 37f2f7043945b9e3a4567e39bfdd3abce5a87f57 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 09:16:26 +0000 Subject: [PATCH 137/390] Update the documentation for GetLoclist --- doc/ale.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index 7da027b..9947d09 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1700,9 +1700,11 @@ ale#engine#EscapeCommandPart(command_part) *ale#engine#EscapeCommandPart()* ale#engine#GetLoclist(buffer) *ale#engine#GetLoclist()* - Given a buffer number, this function will rerurn the list of warnings and - errors reported by ALE for a given buffer in the format accepted by - |setqflist()|. + Given a buffer number, this function will return the list of problems + reported by ALE for a given buffer in the format accepted by |setqflist()|. + + A reference to the buffer's list of problems will be returned. The list must + be copied before applying |map()| or |filter()|. ale#engine#ManageFile(buffer, filename) *ale#engine#ManageFile()* From ff5c6b050955577322c50ffbae15f722d6d82b18 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 10:11:32 +0000 Subject: [PATCH 138/390] #852 - Capture error codes for ansible-lint --- ale_linters/ansible/ansible_lint.vim | 3 ++- test/handler/test_ansible_lint_handler.vader | 6 ++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/ale_linters/ansible/ansible_lint.vim b/ale_linters/ansible/ansible_lint.vim index 7d68cde..27c9632 100644 --- a/ale_linters/ansible/ansible_lint.vim +++ b/ale_linters/ansible/ansible_lint.vim @@ -31,7 +31,8 @@ function! ale_linters#ansible#ansible_lint#Handle(buffer, lines) abort call add(l:output, { \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, - \ 'text': l:code . ': ' . l:match[5], + \ 'text': l:match[5], + \ 'code': l:code, \ 'type': l:code[:0] is# 'E' ? 'E' : 'W', \}) endif diff --git a/test/handler/test_ansible_lint_handler.vader b/test/handler/test_ansible_lint_handler.vader index 3a86429..cd6e513 100644 --- a/test/handler/test_ansible_lint_handler.vader +++ b/test/handler/test_ansible_lint_handler.vader @@ -12,7 +12,8 @@ Execute(The ansible-lint handler should handle basic errors): \ 'lnum': 35, \ 'col': 0, \ 'type': 'E', - \ 'text': 'EANSIBLE0002: Trailing whitespace', + \ 'text': 'Trailing whitespace', + \ 'code': 'EANSIBLE0002', \ }, \ ], \ ale_linters#ansible#ansible_lint#Handle(bufnr(''), [ @@ -26,7 +27,8 @@ Execute (The ansible-lint handler should handle names with spaces): \ 'lnum': 6, \ 'col': 6, \ 'type': 'E', - \ 'text': 'E111: indentation is not a multiple of four', + \ 'text': 'indentation is not a multiple of four', + \ 'code': 'E111', \ }, \ ], \ ale_linters#ansible#ansible_lint#Handle(bufnr(''), [ From 8f80708da6192ccc2914668ff776916c98cb4e82 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 11:28:16 +0000 Subject: [PATCH 139/390] #852 - Capture error codes for cpplint --- autoload/ale/handlers/cpplint.vim | 5 +++-- test/handler/test_cpplint_handler.vader | 14 ++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/autoload/ale/handlers/cpplint.vim b/autoload/ale/handlers/cpplint.vim index 4607863..5c475a5 100644 --- a/autoload/ale/handlers/cpplint.vim +++ b/autoload/ale/handlers/cpplint.vim @@ -4,14 +4,15 @@ function! ale#handlers#cpplint#HandleCppLintFormat(buffer, lines) abort " Look for lines like the following. " test.cpp:5: Estra space after ( in function call [whitespace/parents] [4] - let l:pattern = '^.\{-}:\(\d\+\): \(.\+\)' + let l:pattern = '^.\{-}:\(\d\+\): *\(.\+\) *\[\(.*/.*\)\] ' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) call add(l:output, { \ 'lnum': l:match[1] + 0, \ 'col': 0, - \ 'text': l:match[2], + \ 'text': join(split(l:match[2])), + \ 'code': l:match[3], \ 'type': 'W', \}) endfor diff --git a/test/handler/test_cpplint_handler.vader b/test/handler/test_cpplint_handler.vader index 6df84cc..d8d7b8b 100644 --- a/test/handler/test_cpplint_handler.vader +++ b/test/handler/test_cpplint_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/cpp/cpplint.vim +After: + call ale#linter#Reset() + Execute(cpplint warnings from included files should be parsed correctly): AssertEqual @@ -8,20 +11,19 @@ Execute(cpplint warnings from included files should be parsed correctly): \ { \ 'lnum': 5, \ 'col': 0, - \ 'text': ' Estra space after ( in function call [whitespace/parents] [4]', + \ 'text': 'Extra space after ( in function call', + \ 'code': 'whitespace/parents', \ 'type': 'W', \ }, \ { \ 'lnum': 120, \ 'col': 0, - \ 'text': ' At least two spaces is best between code and comments [whitespace/comments] [2]', + \ 'text': 'At least two spaces is best between code and comments', + \ 'code': 'whitespace/comments', \ 'type': 'W', \ }, \ ], \ ale#handlers#cpplint#HandleCppLintFormat(347, [ - \ 'test.cpp:5: Estra space after ( in function call [whitespace/parents] [4]', + \ 'test.cpp:5: Extra space after ( in function call [whitespace/parents] [4]', \ 'keymap_keys.hpp:120: At least two spaces is best between code and comments [whitespace/comments] [2]', \ ]) - -After: - call ale#linter#Reset() From e12e5c912cd42abe4aebf54c21f57f5a8c735dc6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 12:00:08 +0000 Subject: [PATCH 140/390] Complain about stray echo lines in the codebase --- autoload/ale/cursor.vim | 6 ++-- autoload/ale/debugging.vim | 58 ++++++++++++++++++++------------------ autoload/ale/engine.vim | 4 +-- autoload/ale/fix.vim | 7 +++-- autoload/ale/toggle.vim | 2 +- plugin/ale.vim | 4 +-- test/script/custom-checks | 1 + 7 files changed, 44 insertions(+), 38 deletions(-) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 6907610..5a1d778 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -18,7 +18,7 @@ function! s:EchoWithShortMess(setting, message) abort elseif a:setting is# 'off' setlocal shortmess-=T " Regular echo is needed for printing newline characters. - echo a:message + execute 'echo a:message' else throw 'Invalid setting: ' . string(a:setting) endif @@ -78,7 +78,7 @@ function! s:EchoImpl() abort elseif get(l:info, 'echoed') " We'll only clear the echoed message when moving off errors once, " so we don't continually clear the echo line. - echo + execute 'echo' let l:info.echoed = 0 endif endfunction @@ -126,6 +126,6 @@ function! ale#cursor#ShowCursorDetail() abort let l:message = get(l:loc, 'detail', l:loc.text) call ale#preview#Show(split(l:message, "\n")) - echo + execute 'echo' endif endfunction diff --git a/autoload/ale/debugging.vim b/autoload/ale/debugging.vim index 7454bb1..9ce69ce 100644 --- a/autoload/ale/debugging.vim +++ b/autoload/ale/debugging.vim @@ -29,6 +29,10 @@ let s:global_variable_list = [ \ 'ale_warn_about_trailing_whitespace', \] +function! s:Echo(message) abort + execute 'echo a:message' +endfunction + function! s:GetLinterVariables(filetype, linter_names) abort let l:variable_list = [] let l:filetype_parts = split(a:filetype, '\.') @@ -52,20 +56,20 @@ endfunction function! s:EchoLinterVariables(variable_list) abort for l:key in a:variable_list - echom 'let g:' . l:key . ' = ' . string(g:[l:key]) + call s:Echo('let g:' . l:key . ' = ' . string(g:[l:key])) if has_key(b:, l:key) - echom 'let b:' . l:key . ' = ' . string(b:[l:key]) + call s:Echo('let b:' . l:key . ' = ' . string(b:[l:key])) endif endfor endfunction function! s:EchoGlobalVariables() abort for l:key in s:global_variable_list - echom 'let g:' . l:key . ' = ' . string(get(g:, l:key, v:null)) + call s:Echo('let g:' . l:key . ' = ' . string(get(g:, l:key, v:null))) if has_key(b:, l:key) - echom 'let b:' . l:key . ' = ' . string(b:[l:key]) + call s:Echo('let b:' . l:key . ' = ' . string(b:[l:key])) endif endfor endfunction @@ -79,34 +83,34 @@ function! s:EchoCommand(item) abort let l:status_message .= ' - exit code ' . a:item.exit_code endif - echom '(' . l:status_message . ') ' . string(a:item.command) + call s:Echo('(' . l:status_message . ') ' . string(a:item.command)) if g:ale_history_log_output && has_key(a:item, 'output') if empty(a:item.output) - echom '' - echom '<<>>' - echom '' + call s:Echo('') + call s:Echo('<<>>') + call s:Echo('') else - echom '' - echom '<<>>' + call s:Echo('') + call s:Echo('<<>>') for l:line in a:item.output - echom l:line + call s:Echo(l:line) endfor - echom '<<>>' - echom '' + call s:Echo('<<>>') + call s:Echo('') endif endif endfunction " Echo the results of an executable check. function! s:EchoExecutable(item) abort - echom printf( + call s:Echo(printf( \ '(executable check - %s) %s', \ a:item.status ? 'success' : 'failure', \ a:item.command, - \) + \)) endfunction function! s:EchoCommandHistory() abort @@ -127,12 +131,12 @@ function! s:EchoLinterAliases(all_linters) abort for l:linter in a:all_linters if !empty(l:linter.aliases) if l:first - echom ' Linter Aliases:' + call s:Echo(' Linter Aliases:') endif let l:first = 0 - echom string(l:linter.name) . ' -> ' . string(l:linter.aliases) + call s:Echo(string(l:linter.name) . ' -> ' . string(l:linter.aliases)) endif endfor endfunction @@ -159,18 +163,18 @@ function! ale#debugging#Info() abort " This must be done after linters are loaded. let l:variable_list = s:GetLinterVariables(l:filetype, l:enabled_names) - echom ' Current Filetype: ' . l:filetype - echom 'Available Linters: ' . string(l:all_names) + call s:Echo(' Current Filetype: ' . l:filetype) + call s:Echo('Available Linters: ' . string(l:all_names)) call s:EchoLinterAliases(l:all_linters) - echom ' Enabled Linters: ' . string(l:enabled_names) - echom ' Linter Variables:' - echom '' + call s:Echo(' Enabled Linters: ' . string(l:enabled_names)) + call s:Echo(' Linter Variables:') + call s:Echo('') call s:EchoLinterVariables(l:variable_list) - echom ' Global Variables:' - echom '' + call s:Echo(' Global Variables:') + call s:Echo('') call s:EchoGlobalVariables() - echom ' Command History:' - echom '' + call s:Echo(' Command History:') + call s:Echo('') call s:EchoCommandHistory() endfunction @@ -179,5 +183,5 @@ function! ale#debugging#InfoToClipboard() abort silent call ale#debugging#Info() redir END - echom 'ALEInfo copied to your clipboard' + call s:Echo('ALEInfo copied to your clipboard') endfunction diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index e08de16..f65108f 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -251,10 +251,10 @@ function! s:HandleTSServerDiagnostics(response, error_type) abort endfunction function! s:HandleLSPErrorMessage(error_message) abort - echoerr 'Error from LSP:' + execute 'echoerr ''Error from LSP:''' for l:line in split(a:error_message, "\n") - echoerr l:line + execute 'echoerr l:line' endfor endfunction diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 5a42b74..c4143aa 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -75,7 +75,7 @@ function! ale#fix#ApplyFixes(buffer, output) abort if l:data.lines_before != l:lines call remove(g:ale_fix_buffer_data, a:buffer) - echoerr 'The file was changed before fixing finished' + execute 'echoerr ''The file was changed before fixing finished''' return endif endif @@ -406,17 +406,18 @@ function! ale#fix#Fix(...) abort let l:callback_list = s:GetCallbacks() catch /E700/ let l:function_name = join(split(split(v:exception, ':')[3])) - echom printf( + let l:echo_message = printf( \ 'There is no fixer named `%s`. Check :ALEFixSuggest', \ l:function_name, \) + execute 'echom l:echo_message' return 0 endtry if empty(l:callback_list) if l:fixing_flag is# '' - echom 'No fixers have been defined. Try :ALEFixSuggest' + execute 'echom ''No fixers have been defined. Try :ALEFixSuggest''' endif return 0 diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index aa6d113..7197498 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -158,7 +158,7 @@ function! ale#toggle#ToggleBuffer(buffer) abort " Disabling ALE globally removes autocmd events, so we cannot enable " linting locally when linting is disabled globally if l:enabled && !g:ale_enabled - echom 'ALE cannot be enabled locally when disabled globally' + execute 'echom ''ALE cannot be enabled locally when disabled globally''' return endif diff --git a/plugin/ale.vim b/plugin/ale.vim index 31c3377..d9710fa 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -24,8 +24,8 @@ endif if !s:has_features " Only output a warning if editing some special files. if index(['', 'gitcommit'], &filetype) == -1 - echoerr 'ALE requires NeoVim >= 0.1.5 or Vim 8 with +timers +job +channel' - echoerr 'Please update your editor appropriately.' + execute 'echoerr ''ALE requires NeoVim >= 0.1.5 or Vim 8 with +timers +job +channel''' + execute 'echoerr ''Please update your editor appropriately.''' endif " Stop here, as it won't work. diff --git a/test/script/custom-checks b/test/script/custom-checks index a1a734d..e2c906b 100755 --- a/test/script/custom-checks +++ b/test/script/custom-checks @@ -90,5 +90,6 @@ check_errors '==#' "Use 'is#' instead of '==#'. 0 ==# 'foobar' is true" check_errors '==?' "Use 'is?' instead of '==?'. 0 ==? 'foobar' is true" check_errors '!=#' "Use 'isnot#' instead of '!=#'. 0 !=# 'foobar' is false" check_errors '!=?' "Use 'isnot?' instead of '!=?'. 0 !=? 'foobar' is false" +check_errors '^ *:\?echo' "Stray echo line. Use \`execute echo\` if you want to echo something" exit $RETURN_CODE From 290ed4885b2f0dbbbe9fcbfb12216f89b2e63924 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 16:24:29 +0000 Subject: [PATCH 141/390] Fix #1131 - Capture both output streams for golint --- ale_linters/go/golint.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/go/golint.vim b/ale_linters/go/golint.vim index 708cf15..d580fda 100644 --- a/ale_linters/go/golint.vim +++ b/ale_linters/go/golint.vim @@ -3,7 +3,7 @@ call ale#linter#Define('go', { \ 'name': 'golint', -\ 'output_stream': 'stderr', +\ 'output_stream': 'both', \ 'executable': 'golint', \ 'command': 'golint %t', \ 'callback': 'ale#handlers#unix#HandleAsWarning', From e721f851b41b8f6f31067ae2a137019e1cb5546c Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Thu, 16 Nov 2017 01:34:30 +0900 Subject: [PATCH 142/390] Show problems from other files for gobuild and gometalinter * Added filename keys to gobuild and gometalinter * Removed skipping files not in current package * Removed `--include` for gometalinter * Fixed the tests --- ale_linters/go/gobuild.vim | 10 ++++------ ale_linters/go/gometalinter.vim | 5 +++-- .../test_gometalinter_command_callback.vader | 3 --- test/handler/test_gobuild_handler.vader | 5 +++-- test/handler/test_gometalinter_handler.vader | 8 +++++--- 5 files changed, 15 insertions(+), 16 deletions(-) diff --git a/ale_linters/go/gobuild.vim b/ale_linters/go/gobuild.vim index 143c2fd..783b9e0 100644 --- a/ale_linters/go/gobuild.vim +++ b/ale_linters/go/gobuild.vim @@ -1,4 +1,5 @@ -" Author: Joshua Rubin , Ben Reedy +" Author: Joshua Rubin , Ben Reedy , +" Jeff Willette " Description: go build for Go files " inspired by work from dzhou121 @@ -39,15 +40,12 @@ function! ale_linters#go#gobuild#GetMatches(lines) abort endfunction function! ale_linters#go#gobuild#Handler(buffer, lines) abort + let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gobuild#GetMatches(a:lines) - " Omit errors from imported go packages - if !ale#path#IsBufferPath(a:buffer, l:match[1]) - continue - endif - call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'text': l:match[4], diff --git a/ale_linters/go/gometalinter.vim b/ale_linters/go/gometalinter.vim index f1abfc8..7f75c44 100644 --- a/ale_linters/go/gometalinter.vim +++ b/ale_linters/go/gometalinter.vim @@ -1,4 +1,4 @@ -" Author: Ben Reedy +" Author: Ben Reedy , Jeff Willette " Description: Adds support for the gometalinter suite for Go files call ale#Set('go_gometalinter_options', '') @@ -14,7 +14,6 @@ function! ale_linters#go#gometalinter#GetCommand(buffer) abort let l:options = ale#Var(a:buffer, 'go_gometalinter_options') return ale#Escape(l:executable) - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(l:filename)) \ . (!empty(l:options) ? ' ' . l:options : '') \ . ' ' . ale#Escape(fnamemodify(l:filename, ':h')) endfunction @@ -26,10 +25,12 @@ function! ale_linters#go#gometalinter#GetMatches(lines) abort endfunction function! ale_linters#go#gometalinter#Handler(buffer, lines) abort + let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gometalinter#GetMatches(a:lines) call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'type': tolower(l:match[4]) is# 'warning' ? 'W' : 'E', diff --git a/test/command_callback/test_gometalinter_command_callback.vader b/test/command_callback/test_gometalinter_command_callback.vader index 912396c..b45d811 100644 --- a/test/command_callback/test_gometalinter_command_callback.vader +++ b/test/command_callback/test_gometalinter_command_callback.vader @@ -22,7 +22,6 @@ Execute(The gometalinter callback should return the right defaults): \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual \ ale#Escape('gometalinter') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) @@ -34,7 +33,6 @@ Execute(The gometalinter callback should use a configured executable): \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual \ ale#Escape('something else') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) @@ -43,7 +41,6 @@ Execute(The gometalinter callback should use configured options): AssertEqual \ ale#Escape('gometalinter') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' --foobar' \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) diff --git a/test/handler/test_gobuild_handler.vader b/test/handler/test_gobuild_handler.vader index ce2119c..ec77f9c 100644 --- a/test/handler/test_gobuild_handler.vader +++ b/test/handler/test_gobuild_handler.vader @@ -28,7 +28,7 @@ Execute (The gobuild handler should handle names with spaces): \ ]), 'v:val[1:4]') Execute (The gobuild handler should handle relative paths correctly): - silent file! /foo/bar/baz.go + call ale#test#SetFilename('app/test.go') AssertEqual \ [ @@ -37,8 +37,9 @@ Execute (The gobuild handler should handle relative paths correctly): \ 'col': 0, \ 'text': 'missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ 'type': 'E', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gobuild#Handler(bufnr(''), [ - \ 'baz.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', + \ 'test.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ ]) diff --git a/test/handler/test_gometalinter_handler.vader b/test/handler/test_gometalinter_handler.vader index 603ba22..127d093 100644 --- a/test/handler/test_gometalinter_handler.vader +++ b/test/handler/test_gometalinter_handler.vader @@ -30,7 +30,7 @@ Execute (The gometalinter handler should handle names with spaces): \ ]), 'v:val[1:5]') Execute (The gometalinter handler should handle relative paths correctly): - silent file /foo/bar/baz.go + call ale#test#SetFilename('app/test.go') AssertEqual \ [ @@ -39,15 +39,17 @@ Execute (The gometalinter handler should handle relative paths correctly): \ 'col': 3, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (staticcheck)', \ 'type': 'W', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ { \ 'lnum': 37, \ 'col': 5, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (golint)', \ 'type': 'E', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gometalinter#Handler(bufnr(''), [ - \ 'baz.go:12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', - \ 'baz.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', + \ 'test.go:12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', + \ 'test.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', \ ]) From b14377915b9948454322cd95a86bcc298c03f77a Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 17:21:17 +0000 Subject: [PATCH 143/390] Clean up tests to stop people copy and pasting the wrong examples --- .../test_proto_command_callback.vader | 2 -- .../test_pycodestyle_command_callback.vader | 10 +++++---- .../test_swaglint_command_callback.vader | 4 +++- ...st_terraform_tflint_command_callback.vader | 4 +--- .../test_thrift_command_callback.vader | 1 + .../test_xmllint_command_callback.vader | 4 ++-- test/handler/test_asm_handler.vader | 10 +++++---- test/handler/test_checkmake_handler.vader | 9 +++++--- test/handler/test_coffeelint_handler.vader | 10 +++++---- test/handler/test_credo_handler.vader | 10 ++++----- test/handler/test_crystal_handler.vader | 10 +++++---- test/handler/test_dafny_handler.vader | 10 +++++---- test/handler/test_dogma_handler.vader | 10 +++++---- .../test_embertemplatelint_handler.vader | 7 +++---- test/handler/test_fortran_handler.vader | 21 +++++-------------- test/handler/test_llc_handler.vader | 4 +++- test/handler/test_lua_handler.vader | 6 ++---- test/handler/test_nagelfar_handler.vader | 3 +++ test/handler/test_nim_handler.vader | 7 ++++++- test/handler/test_nix_handler.vader | 9 ++++---- test/handler/test_php_handler.vader | 6 +++--- test/handler/test_php_phan_handler.vader | 6 +++--- test/handler/test_php_phpmd_handler.vader | 6 +++--- test/handler/test_remark_lint_handler.vader | 3 +++ test/handler/test_rpmlint_handler.vader | 6 +++++- test/handler/test_rstcheck_lint_handler.vader | 3 +++ test/handler/test_ruby_handler.vader | 10 +++++---- test/handler/test_scalac_handler.vader | 4 ++-- test/handler/test_shell_handler.vader | 5 +++-- test/handler/test_slim_handler.vader | 9 ++++---- test/handler/test_sml_handler.vader | 1 - test/handler/test_sqlint_handler.vader | 9 ++++---- test/handler/test_swaglint_handler.vader | 3 +++ test/handler/test_typecheck_handler.vader | 9 ++++---- test/handler/test_xmllint_handler.vader | 6 +++--- 35 files changed, 133 insertions(+), 104 deletions(-) diff --git a/test/command_callback/test_proto_command_callback.vader b/test/command_callback/test_proto_command_callback.vader index 2730bb8..2fd7775 100644 --- a/test/command_callback/test_proto_command_callback.vader +++ b/test/command_callback/test_proto_command_callback.vader @@ -9,8 +9,6 @@ After: call ale#linter#Reset() Execute(The default command should be correct): - AssertEqual \ 'protoc' . ' -I ' . ale#Escape(getcwd()) . ' --lint_out=. ' . '%s', \ ale_linters#proto#protoc_gen_lint#GetCommand(bufnr('')) - diff --git a/test/command_callback/test_pycodestyle_command_callback.vader b/test/command_callback/test_pycodestyle_command_callback.vader index 58aefa2..5b309e1 100644 --- a/test/command_callback/test_pycodestyle_command_callback.vader +++ b/test/command_callback/test_pycodestyle_command_callback.vader @@ -1,13 +1,15 @@ Before: + Save g:ale_python_pycodestyle_executable + Save g:ale_python_pycodestyle_options + Save g:ale_python_pycodestyle_use_global + runtime ale_linters/python/pycodestyle.vim - Save g:ale_python_pycodestyle_executable, - \ g:ale_python_pycodestyle_options, - \ g:ale_python_pycodestyle_use_global After: - call ale#linter#Reset() Restore + call ale#linter#Reset() + Execute(The pycodestyle command callback should return default string): AssertEqual ale#Escape('pycodestyle') . ' -', \ ale_linters#python#pycodestyle#GetCommand(bufnr('')) diff --git a/test/command_callback/test_swaglint_command_callback.vader b/test/command_callback/test_swaglint_command_callback.vader index 379aa0c..0f1d870 100644 --- a/test/command_callback/test_swaglint_command_callback.vader +++ b/test/command_callback/test_swaglint_command_callback.vader @@ -1,12 +1,14 @@ Before: runtime ale_linters/yaml/swaglint.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') After: - call ale#linter#Reset() let g:ale_yaml_swaglint_executable = 'swaglint' let g:ale_yaml_swaglint_use_global = 0 + call ale#linter#Reset() + Execute(The yaml swaglint command callback should return the correct default string): AssertEqual 'swaglint', \ ale_linters#yaml#swaglint#GetExecutable(bufnr('')) diff --git a/test/command_callback/test_terraform_tflint_command_callback.vader b/test/command_callback/test_terraform_tflint_command_callback.vader index b0b4c95..a4ae56b 100644 --- a/test/command_callback/test_terraform_tflint_command_callback.vader +++ b/test/command_callback/test_terraform_tflint_command_callback.vader @@ -1,15 +1,13 @@ Before: - Save g:ale_terraform_tflint_executable Save g:ale_terraform_tflint_options runtime ale_linters/terraform/tflint.vim - After: Restore - call ale#linter#Reset() + call ale#linter#Reset() Execute(The default executable should be configurable): AssertEqual 'tflint', ale_linters#terraform#tflint#GetExecutable(bufnr('')) diff --git a/test/command_callback/test_thrift_command_callback.vader b/test/command_callback/test_thrift_command_callback.vader index 6700891..7d4e436 100644 --- a/test/command_callback/test_thrift_command_callback.vader +++ b/test/command_callback/test_thrift_command_callback.vader @@ -28,6 +28,7 @@ Before: After: Restore + delfunction GetCommand unlet! b:ale_thrift_thrift_executable unlet! b:ale_thrift_thrift_generators diff --git a/test/command_callback/test_xmllint_command_callback.vader b/test/command_callback/test_xmllint_command_callback.vader index 3cffde8..12ca15d 100644 --- a/test/command_callback/test_xmllint_command_callback.vader +++ b/test/command_callback/test_xmllint_command_callback.vader @@ -2,10 +2,11 @@ Before: runtime ale_linters/xml/xmllint.vim After: - call ale#linter#Reset() let g:ale_xml_xmllint_options = '' let g:ale_xml_xmllint_executable = 'xmllint' + call ale#linter#Reset() + Execute(The xml xmllint command callback should return the correct default string): AssertEqual ale#Escape('xmllint') . ' --noout -', \ join(split(ale_linters#xml#xmllint#GetCommand(1))) @@ -22,4 +23,3 @@ Execute(The xmllint executable should be configurable): AssertEqual '~/.local/bin/xmllint', ale_linters#xml#xmllint#GetExecutable(1) AssertEqual ale#Escape('~/.local/bin/xmllint') . ' --noout -', \ join(split(ale_linters#xml#xmllint#GetCommand(1))) - diff --git a/test/handler/test_asm_handler.vader b/test/handler/test_asm_handler.vader index 2868628..4ab9999 100644 --- a/test/handler/test_asm_handler.vader +++ b/test/handler/test_asm_handler.vader @@ -1,6 +1,11 @@ -Execute(The asm GCC handler should parse lines from GCC 6.3.1 correctly): +Before: runtime ale_linters/asm/gcc.vim +After: + call ale#linter#Reset() + +Execute(The asm GCC handler should parse lines from GCC 6.3.1 correctly): + AssertEqual \ [ \ { @@ -19,6 +24,3 @@ Execute(The asm GCC handler should parse lines from GCC 6.3.1 correctly): \ "{standard_input}:38: Error: too many memory references for `mov'", \ "{standard input}:42: Error: incorrect register `%ax' used with `l' suffix", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_checkmake_handler.vader b/test/handler/test_checkmake_handler.vader index 61fe141..718c881 100644 --- a/test/handler/test_checkmake_handler.vader +++ b/test/handler/test_checkmake_handler.vader @@ -1,5 +1,10 @@ -Execute(Parsing checkmake errors should work): +Before: runtime ale_linters/make/checkmake.vim + +After: + call ale#linter#Reset() + +Execute(Parsing checkmake errors should work): silent file Makefile AssertEqual @@ -15,5 +20,3 @@ Execute(Parsing checkmake errors should work): \ 'This shouldnt match', \ '1:woops:an error has occurred', \ ]) -After: - call ale#linter#Reset() diff --git a/test/handler/test_coffeelint_handler.vader b/test/handler/test_coffeelint_handler.vader index 4426e44..a061f3a 100644 --- a/test/handler/test_coffeelint_handler.vader +++ b/test/handler/test_coffeelint_handler.vader @@ -1,6 +1,11 @@ -Execute(The coffeelint handler should parse lines correctly): +Before: runtime ale_linters/coffee/coffeelint.vim +After: + call ale#linter#Reset() + +Execute(The coffeelint handler should parse lines correctly): + AssertEqual \ [ \ { @@ -13,6 +18,3 @@ Execute(The coffeelint handler should parse lines correctly): \ "path,lineNumber,lineNumberEnd,level,message", \ "stdin,125,,error,Line exceeds maximum allowed length Length is 122, max is 120.", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_credo_handler.vader b/test/handler/test_credo_handler.vader index 73f98ba..5eb0e96 100644 --- a/test/handler/test_credo_handler.vader +++ b/test/handler/test_credo_handler.vader @@ -1,6 +1,10 @@ -Execute(The credo handler should parse lines correctly): +Before: runtime ale_linters/elixir/credo.vim +After: + call ale#linter#Reset() + +Execute(The credo handler should parse lines correctly): AssertEqual \ [ \ { @@ -23,7 +27,3 @@ Execute(The credo handler should parse lines correctly): \ 'lib/filename.ex:1:4: C: There is no whitespace around parentheses/brackets most of the time, but here there is.', \ 'lib/phoenix/channel.ex:26: R: If/else blocks should not have a negated condition in `if`.', \ ]) - -After: - call ale#linter#Reset() - diff --git a/test/handler/test_crystal_handler.vader b/test/handler/test_crystal_handler.vader index 984b976..a7b7f3a 100644 --- a/test/handler/test_crystal_handler.vader +++ b/test/handler/test_crystal_handler.vader @@ -1,5 +1,10 @@ -Execute(The crystal handler should parse lines correctly and add the column if it can): +Before: runtime ale_linters/crystal/crystal.vim + +After: + call ale#linter#Reset() + +Execute(The crystal handler should parse lines correctly and add the column if it can): AssertEqual \ [ \ { @@ -11,6 +16,3 @@ Execute(The crystal handler should parse lines correctly and add the column if i \ ale_linters#crystal#crystal#Handle(255, [ \ '[{"file":"/tmp/test.cr","line":2,"column":1,"size":null,"message":"unexpected token: EOF"}]' \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_dafny_handler.vader b/test/handler/test_dafny_handler.vader index 1de9a77..674f691 100644 --- a/test/handler/test_dafny_handler.vader +++ b/test/handler/test_dafny_handler.vader @@ -1,5 +1,10 @@ -Execute(The Dafny handler should parse output correctly): +Before: runtime ale_linters/dafny/dafny.vim + +After: + call ale#linter#Reset() + +Execute(The Dafny handler should parse output correctly): AssertEqual \ [ \ { @@ -21,6 +26,3 @@ Execute(The Dafny handler should parse output correctly): \ 'File.dfy(123,45): Error BP5002: A precondition for this call might not hold.', \ 'File.dfy(678,90): Related location: This is the precondition that might not hold.' \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_dogma_handler.vader b/test/handler/test_dogma_handler.vader index ee9795e..ead6d09 100644 --- a/test/handler/test_dogma_handler.vader +++ b/test/handler/test_dogma_handler.vader @@ -1,6 +1,11 @@ -Execute(The dogma handler should parse lines correctly): +Before: runtime ale_linters/elixir/dogma.vim +After: + call ale#linter#Reset() + +Execute(The dogma handler should parse lines correctly): + AssertEqual \ [ \ { @@ -23,6 +28,3 @@ Execute(The dogma handler should parse lines correctly): \ 'lib/filename.ex:18:5: C: Some error', \ 'lib/filename.ex:19:7: R: Some warning', \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_embertemplatelint_handler.vader b/test/handler/test_embertemplatelint_handler.vader index 8e132d3..ea5313c 100644 --- a/test/handler/test_embertemplatelint_handler.vader +++ b/test/handler/test_embertemplatelint_handler.vader @@ -1,8 +1,10 @@ " Author: Adrian Zalewski - Before: runtime ale_linters/handlebars/embertemplatelint.vim +After: + call ale#linter#Reset() + Execute(The ember-template-lint handler should parse lines correctly): let input_lines = split('{ \ "/ember-project/app/templates/application.hbs": [ @@ -80,6 +82,3 @@ Execute(The ember-template-lint handler should handle no lint errors/warnings): AssertEqual \ [], \ ale_linters#handlebars#embertemplatelint#Handle(347, ['{}']) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_fortran_handler.vader b/test/handler/test_fortran_handler.vader index acd83e3..c55a4c6 100644 --- a/test/handler/test_fortran_handler.vader +++ b/test/handler/test_fortran_handler.vader @@ -1,6 +1,10 @@ -Execute(The fortran handler should parse lines from GCC 4.1.2 correctly): +Before: runtime ale_linters/fortran/gcc.vim +After: + call ale#linter#Reset() + +Execute(The fortran handler should parse lines from GCC 4.1.2 correctly): AssertEqual \ [ \ { @@ -31,13 +35,8 @@ Execute(The fortran handler should parse lines from GCC 4.1.2 correctly): \ "Error: Symbol ‘a’ at (1) has no IMPLICIT type", \ ]) -After: - call ale#linter#Reset() - Execute(The fortran handler should parse lines from GCC 4.9.3 correctly): - runtime ale_linters/fortran/gcc.vim - AssertEqual \ [ \ { @@ -68,14 +67,7 @@ Execute(The fortran handler should parse lines from GCC 4.9.3 correctly): \ "Error: Symbol ‘b’ at (1) has no IMPLICIT type", \ ]) -After: - call ale#linter#Reset() - - - Execute(The fortran handler should parse lines from GCC 6.3.1 correctly): - runtime ale_linters/fortran/gcc.vim - AssertEqual \ [ \ { @@ -101,6 +93,3 @@ Execute(The fortran handler should parse lines from GCC 6.3.1 correctly): \ "", \ "Error: Symbol ‘b’ at (1) has no IMPLICIT type", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_llc_handler.vader b/test/handler/test_llc_handler.vader index edea233..bbe686f 100644 --- a/test/handler/test_llc_handler.vader +++ b/test/handler/test_llc_handler.vader @@ -1,6 +1,9 @@ Before: runtime! ale_linters/llvm/llc.vim +After: + call ale#linter#Reset() + Execute(llc handler should parse errors output for STDIN): AssertEqual \ [ @@ -53,4 +56,3 @@ Execute(llc handler should parse errors output for some file): \ 'call void @foo(i64 %0)', \ ' ^', \ ]) - diff --git a/test/handler/test_lua_handler.vader b/test/handler/test_lua_handler.vader index 712c7c5..035dac2 100644 --- a/test/handler/test_lua_handler.vader +++ b/test/handler/test_lua_handler.vader @@ -1,13 +1,13 @@ Before: Save g:ale_warn_about_trailing_whitespace + runtime ale_linters/lua/luacheck.vim + After: Restore call ale#linter#Reset() Execute(The luacheck handler should parse lines correctly): - runtime ale_linters/lua/luacheck.vim - AssertEqual \ [ \ { @@ -36,8 +36,6 @@ Execute(The luacheck handler should parse lines correctly): \ ]) Execute(The luacheck handler should respect the warn_about_trailing_whitespace option): - runtime ale_linters/lua/luacheck.vim - let g:ale_warn_about_trailing_whitespace = 0 AssertEqual diff --git a/test/handler/test_nagelfar_handler.vader b/test/handler/test_nagelfar_handler.vader index 2a31f19..ceaee19 100644 --- a/test/handler/test_nagelfar_handler.vader +++ b/test/handler/test_nagelfar_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/tcl/nagelfar.vim +After: + call ale#linter#Reset() + Execute(The nagelfar handler should parse lines correctly): AssertEqual \ [ diff --git a/test/handler/test_nim_handler.vader b/test/handler/test_nim_handler.vader index c9a1b71..1f9de58 100644 --- a/test/handler/test_nim_handler.vader +++ b/test/handler/test_nim_handler.vader @@ -1,5 +1,10 @@ -Execute(Parsing nim errors should work): +Before: runtime ale_linters/nim/nimcheck.vim + +After: + call ale#linter#Reset() + +Execute(Parsing nim errors should work): silent file foobar.nim AssertEqual diff --git a/test/handler/test_nix_handler.vader b/test/handler/test_nix_handler.vader index 1555e59..398e1ac 100644 --- a/test/handler/test_nix_handler.vader +++ b/test/handler/test_nix_handler.vader @@ -1,6 +1,10 @@ -Execute(The nix handler should parse nix-instantiate error messages correctly): +Before: runtime ale_linters/nix/nix.vim +After: + call ale#linter#Reset() + +Execute(The nix handler should parse nix-instantiate error messages correctly): AssertEqual \ [ \ { @@ -22,6 +26,3 @@ Execute(The nix handler should parse nix-instantiate error messages correctly): \ 'error: syntax error, unexpected IN, at /path/to/filename.nix:23:14', \ 'error: syntax error, unexpected ''='', expecting '';'', at /path/to/filename.nix:3:12', \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_php_handler.vader b/test/handler/test_php_handler.vader index 0d4d427..a6a4ba0 100644 --- a/test/handler/test_php_handler.vader +++ b/test/handler/test_php_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/php/php.vim +After: + call ale#linter#Reset() + Given (Some invalid lines of PHP): [foo;] class Foo { / } @@ -76,6 +79,3 @@ Execute (The php handler should parse lines without column indication): \ "Parse error: syntax error, unexpected end of file in - on line 21", \ "Parse error: Invalid numeric literal in - on line 47", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_php_phan_handler.vader b/test/handler/test_php_phan_handler.vader index 68ed6d0..2374792 100644 --- a/test/handler/test_php_phan_handler.vader +++ b/test/handler/test_php_phan_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/php/phan.vim +After: + call ale#linter#Reset() + Execute(The php static analyzer handler should parse errors from phan): AssertEqual \ [ @@ -19,6 +22,3 @@ Execute(The php static analyzer handler should parse errors from phan): \ "example.php:25 PhanUndeclaredTypeReturnType Return type of getValidator is undeclared type \\Respect\\Validation\\Validator", \ "example.php:66 PhanUndeclaredClassMethod Call to method string from undeclared class \\Respect\\Validation\\Validator", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_php_phpmd_handler.vader b/test/handler/test_php_phpmd_handler.vader index be36f3d..f161d73 100644 --- a/test/handler/test_php_phpmd_handler.vader +++ b/test/handler/test_php_phpmd_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/php/phpmd.vim +After: + call ale#linter#Reset() + Execute(The php static analyzer handler should parse errors from phpmd): AssertEqual \ [ @@ -19,6 +22,3 @@ Execute(The php static analyzer handler should parse errors from phpmd): \ "example.php:22 Avoid unused local variables such as '$response'.", \ "example.php:14 The method test uses an else expression. Else is never necessary and you can simplify the code to work without else.", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_remark_lint_handler.vader b/test/handler/test_remark_lint_handler.vader index f63e0c5..f61da19 100644 --- a/test/handler/test_remark_lint_handler.vader +++ b/test/handler/test_remark_lint_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/markdown/remark_lint.vim +After: + call ale#linter#Reset() + Execute(Warning and error messages should be handled correctly): AssertEqual \ [ diff --git a/test/handler/test_rpmlint_handler.vader b/test/handler/test_rpmlint_handler.vader index 45f5071..2ea9e5c 100644 --- a/test/handler/test_rpmlint_handler.vader +++ b/test/handler/test_rpmlint_handler.vader @@ -1,6 +1,10 @@ -Execute(The rpmlint handler should parse error messages correctly): +Before: runtime ale_linters/spec/rpmlint.vim +After: + call ale#linter#Reset() + +Execute(The rpmlint handler should parse error messages correctly): AssertEqual \ [ \ { diff --git a/test/handler/test_rstcheck_lint_handler.vader b/test/handler/test_rstcheck_lint_handler.vader index 64cb587..928c599 100644 --- a/test/handler/test_rstcheck_lint_handler.vader +++ b/test/handler/test_rstcheck_lint_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/rstcheck/rstcheck.vim +After: + call ale#linter#Reset() + Execute(Warning and error messages should be handled correctly): AssertEqual \ [ diff --git a/test/handler/test_ruby_handler.vader b/test/handler/test_ruby_handler.vader index ba67650..824d8c5 100644 --- a/test/handler/test_ruby_handler.vader +++ b/test/handler/test_ruby_handler.vader @@ -1,5 +1,10 @@ -Execute(The ruby handler should parse lines correctly and add the column if it can): +Before: runtime ale_linters/ruby/ruby.vim + +After: + call ale#linter#Reset() + +Execute(The ruby handler should parse lines correctly and add the column if it can): " Point Error " Warning " Line Error @@ -31,6 +36,3 @@ Execute(The ruby handler should parse lines correctly and add the column if it c \ "test.rb:9: warning: statement not reached", \ "test.rb:12: syntax error, unexpected end-of-input, expecting keyword_end", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_scalac_handler.vader b/test/handler/test_scalac_handler.vader index a4c7363..fd222f6 100644 --- a/test/handler/test_scalac_handler.vader +++ b/test/handler/test_scalac_handler.vader @@ -1,8 +1,8 @@ Before: - runtime ale_linters/scala/scalac.vim + runtime ale_linters/scala/scalac.vim After: - call ale#linter#Reset() + call ale#linter#Reset() Given scala(An empty Scala file): diff --git a/test/handler/test_shell_handler.vader b/test/handler/test_shell_handler.vader index ecfbf02..2465f17 100644 --- a/test/handler/test_shell_handler.vader +++ b/test/handler/test_shell_handler.vader @@ -1,9 +1,10 @@ +Before: + runtime ale_linters/sh/shell.vim + After: call ale#linter#Reset() Execute(The shell handler should parse lines correctly): - runtime ale_linters/sh/shell.vim - AssertEqual \ [ \ { diff --git a/test/handler/test_slim_handler.vader b/test/handler/test_slim_handler.vader index 21c1ec9..e8b6dcd 100644 --- a/test/handler/test_slim_handler.vader +++ b/test/handler/test_slim_handler.vader @@ -1,7 +1,11 @@ " Author: Markus Doits +Before: + runtime ale_linters/slim/slimlint.vim + +After: + call ale#linter#Reset() Execute(The slim handler should parse lines correctly): - runtime ale_linters/slim/slimlint.vim AssertEqual \ [ @@ -26,6 +30,3 @@ Execute(The slim handler should parse lines correctly): \ 'inv.slim:2 [W] LineLength: Line is too long. [136/80]', \ 'inv.slim:3 [E] Invalid syntax', \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_sml_handler.vader b/test/handler/test_sml_handler.vader index f711cc9..90e7c2c 100644 --- a/test/handler/test_sml_handler.vader +++ b/test/handler/test_sml_handler.vader @@ -85,4 +85,3 @@ Execute (Testing a warning): \ "val f = fn : int -> int", \ "-", \]) - diff --git a/test/handler/test_sqlint_handler.vader b/test/handler/test_sqlint_handler.vader index 62d2ea7..5567ca4 100644 --- a/test/handler/test_sqlint_handler.vader +++ b/test/handler/test_sqlint_handler.vader @@ -1,6 +1,10 @@ -Execute(The sqlint handler should parse lines correctly): +Before: runtime! ale_linters/sql/sqlint.vim +After: + call ale#linter#Reset() + +Execute(The sqlint handler should parse lines correctly): AssertEqual \ [ \ { @@ -28,6 +32,3 @@ Execute(The sqlint handler should parse lines correctly): \ 'stdin:47:11:ERROR unterminated quoted string at or near "''', \ 'stdin:50:12:WARNING some warning at end of input', \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_swaglint_handler.vader b/test/handler/test_swaglint_handler.vader index e2c2730..fbbae26 100644 --- a/test/handler/test_swaglint_handler.vader +++ b/test/handler/test_swaglint_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/yaml/swaglint.vim +After: + call ale#linter#Reset() + Execute(The swaglint handler should parse lines correctly): AssertEqual \ [ diff --git a/test/handler/test_typecheck_handler.vader b/test/handler/test_typecheck_handler.vader index cf93798..fda55d6 100644 --- a/test/handler/test_typecheck_handler.vader +++ b/test/handler/test_typecheck_handler.vader @@ -1,6 +1,10 @@ -Execute(The typecheck handler should parse lines correctly): +Before: runtime ale_linters/typescript/typecheck.vim +After: + call ale#linter#Reset() + +Execute(The typecheck handler should parse lines correctly): AssertEqual \ [ \ { @@ -18,6 +22,3 @@ Execute(The typecheck handler should parse lines correctly): \ "somets.ts[16, 7]: Type 'A' is not assignable to type 'B'", \ "somets.ts[7, 41]: Property 'a' does not exist on type 'A'", \ ]) - -After: - call ale#linter#Reset() diff --git a/test/handler/test_xmllint_handler.vader b/test/handler/test_xmllint_handler.vader index 4a377ab..a17d74a 100644 --- a/test/handler/test_xmllint_handler.vader +++ b/test/handler/test_xmllint_handler.vader @@ -1,6 +1,9 @@ Before: runtime ale_linters/xml/xmllint.vim +After: + call ale#linter#Reset() + Execute(The xmllint handler should parse error messages correctly): AssertEqual \ [ @@ -25,6 +28,3 @@ Execute(The xmllint handler should parse error messages correctly): \ 'blahblah>', \ '^' \ ]) - -After: - call ale#linter#Reset() From 08f4f8f0fc2a6698dd48da7871209070ddfdb754 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 17:26:52 +0000 Subject: [PATCH 144/390] #852 Capture error codes for shellcheck --- ale_linters/sh/shellcheck.vim | 3 ++- test/handler/test_shellcheck_handler.vader | 9 ++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 3e60ad3..27c7453 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -71,7 +71,7 @@ function! ale_linters#sh#shellcheck#GetCommand(buffer, version_output) abort endfunction function! ale_linters#sh#shellcheck#Handle(buffer, lines) abort - let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+)$' + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+) \[([^\]]+)\]$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) @@ -87,6 +87,7 @@ function! ale_linters#sh#shellcheck#Handle(buffer, lines) abort \ 'lnum': str2nr(l:match[2]), \ 'type': l:type, \ 'text': l:match[5], + \ 'code': l:match[6], \} if !empty(l:match[3]) diff --git a/test/handler/test_shellcheck_handler.vader b/test/handler/test_shellcheck_handler.vader index 5a7607e..bfb73ff 100644 --- a/test/handler/test_shellcheck_handler.vader +++ b/test/handler/test_shellcheck_handler.vader @@ -11,13 +11,15 @@ Execute(The shellcheck handler should handle basic errors or warnings): \ 'lnum': 2, \ 'col': 1, \ 'type': 'W', - \ 'text': 'In POSIX sh, ''let'' is not supported. [SC2039]', + \ 'text': 'In POSIX sh, ''let'' is not supported.', + \ 'code': 'SC2039', \ }, \ { \ 'lnum': 2, \ 'col': 3, \ 'type': 'E', - \ 'text': 'Don''t put spaces around the = in assignments. [SC1068]', + \ 'text': 'Don''t put spaces around the = in assignments.', + \ 'code': 'SC1068', \ }, \ ], \ ale_linters#sh#shellcheck#Handle(bufnr(''), [ @@ -32,7 +34,8 @@ Execute(The shellcheck handler should handle notes): \ 'lnum': 3, \ 'col': 3, \ 'type': 'I', - \ 'text': 'Double quote to prevent globbing and word splitting. [SC2086]', + \ 'text': 'Double quote to prevent globbing and word splitting.', + \ 'code': 'SC2086', \ }, \ ], \ ale_linters#sh#shellcheck#Handle(bufnr(''), [ From cf538c3a58d61cfe1a77d79455efb9175479fba3 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 17:35:34 +0000 Subject: [PATCH 145/390] #852 Capture error codes for pylint, throw away the msgid values --- ale_linters/python/pylint.vim | 3 +- test/handler/test_pylint_handler.vader | 50 ++++++++++++++++++++++---- 2 files changed, 45 insertions(+), 8 deletions(-) diff --git a/ale_linters/python/pylint.vim b/ale_linters/python/pylint.vim index befc51a..e3e6624 100644 --- a/ale_linters/python/pylint.vim +++ b/ale_linters/python/pylint.vim @@ -45,7 +45,8 @@ function! ale_linters#python#pylint#Handle(buffer, lines) abort call add(l:output, { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 1, - \ 'text': l:code . ': ' . l:match[5] . ' (' . l:match[4] . ')', + \ 'text': l:match[5], + \ 'code': l:match[4], \ 'type': l:code[:0] is# 'E' ? 'E' : 'W', \}) endfor diff --git a/test/handler/test_pylint_handler.vader b/test/handler/test_pylint_handler.vader index 2314e9b..aff4084 100644 --- a/test/handler/test_pylint_handler.vader +++ b/test/handler/test_pylint_handler.vader @@ -1,47 +1,60 @@ Before: + Save g:ale_warn_about_trailing_whitespace + + let g:ale_warn_about_trailing_whitespace = 1 + runtime ale_linters/python/pylint.vim After: + Restore + call ale#linter#Reset() + silent file something_else.py -Execute(pylint handler parsing, translating columns to 1-based index): +Execute(Basic pylint errors should be handle): AssertEqual \ [ \ { \ 'lnum': 4, \ 'col': 1, - \ 'text': 'C0303: Trailing whitespace (trailing-whitespace)', + \ 'text': 'Trailing whitespace', + \ 'code': 'trailing-whitespace', \ 'type': 'W', \ }, \ { \ 'lnum': 1, \ 'col': 1, - \ 'text': 'C0111: Missing module docstring (missing-docstring)', + \ 'text': 'Missing module docstring', + \ 'code': 'missing-docstring', \ 'type': 'W', \ }, \ { \ 'lnum': 2, \ 'col': 1, - \ 'text': 'C0111: Missing function docstring (missing-docstring)', + \ 'text': 'Missing function docstring', + \ 'code': 'missing-docstring', \ 'type': 'W', \ }, \ { \ 'lnum': 3, \ 'col': 5, - \ 'text': 'E0103: ''break'' not properly in loop (not-in-loop)', + \ 'text': '''break'' not properly in loop', + \ 'code': 'not-in-loop', \ 'type': 'E', \ }, \ { \ 'lnum': 4, \ 'col': 5, - \ 'text': 'W0101: Unreachable code (unreachable)', + \ 'text': 'Unreachable code', + \ 'code': 'unreachable', \ 'type': 'W', \ }, \ { \ 'lnum': 7, \ 'col': 33, - \ 'text': 'W0702: No exception type(s) specified (bare-except)', + \ 'text': 'No exception type(s) specified', + \ 'code': 'bare-except', \ 'type': 'W', \ }, \ ], @@ -58,3 +71,26 @@ Execute(pylint handler parsing, translating columns to 1-based index): \ '------------------------------------------------------------------', \ 'Your code has been rated at 0.00/10 (previous run: 2.50/10, -2.50)', \ ]) + +Execute(Ignoring trailing whitespace messages should work): + let g:ale_warn_about_trailing_whitespace = 0 + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 1, + \ 'text': 'Missing module docstring', + \ 'code': 'missing-docstring', + \ 'type': 'W', + \ }, + \ ], + \ ale_linters#python#pylint#Handle(bufnr(''), [ + \ 'No config file found, using default configuration', + \ '************* Module test', + \ 'test.py:4:0: C0303 (trailing-whitespace) Trailing whitespace', + \ 'test.py:1:0: C0111 (missing-docstring) Missing module docstring', + \ '', + \ '------------------------------------------------------------------', + \ 'Your code has been rated at 0.00/10 (previous run: 2.50/10, -2.50)', + \ ]) From 1d65e5692f7075bad6806d88eb11961ea32d3e7d Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 15 Nov 2017 17:47:24 +0000 Subject: [PATCH 146/390] #852 Capture error codes for pycodestyle, and consider every code except E999 to be style errors or warnings --- ale_linters/python/pycodestyle.vim | 19 ++++++++++---- test/handler/test_pycodestyle_handler.vader | 28 +++++++++++++++++---- 2 files changed, 37 insertions(+), 10 deletions(-) diff --git a/ale_linters/python/pycodestyle.vim b/ale_linters/python/pycodestyle.vim index ad89599..0382e9d 100644 --- a/ale_linters/python/pycodestyle.vim +++ b/ale_linters/python/pycodestyle.vim @@ -17,18 +17,27 @@ function! ale_linters#python#pycodestyle#GetCommand(buffer) abort endfunction function! ale_linters#python#pycodestyle#Handle(buffer, lines) abort - let l:pattern = '\v^(\S*):(\d*):(\d*): ((([EW])\d+) .*)$' + let l:pattern = '\v^(\S*):(\d*):(\d*): ([EW]\d+) (.*)$' let l:output = [] " lines are formatted as follows: " file.py:21:26: W291 trailing whitespace for l:match in ale#util#GetMatches(a:lines, l:pattern) - call add(l:output, { + let l:item = { \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, - \ 'type': l:match[6], - \ 'text': l:match[4], - \}) + \ 'type': l:match[4][0], + \ 'sub_type': 'style', + \ 'text': l:match[5], + \ 'code': l:match[4], + \} + + " E999 is not a style error, it's a syntax error. + if l:match[4] is# 'E999' + unlet l:item.sub_type + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_pycodestyle_handler.vader b/test/handler/test_pycodestyle_handler.vader index cc83fc8..856f429 100644 --- a/test/handler/test_pycodestyle_handler.vader +++ b/test/handler/test_pycodestyle_handler.vader @@ -9,37 +9,55 @@ Execute(The pycodestyle handler should parse output): AssertEqual \ [ \ { + \ 'lnum': 8, + \ 'col': 3, + \ 'type': 'E', + \ 'text': 'SyntaxError: invalid syntax', + \ 'code': 'E999', + \ }, + \ { \ 'lnum': 69, \ 'col': 11, - \ 'text': 'E401 multiple imports on one line', + \ 'text': 'multiple imports on one line', + \ 'code': 'E401', \ 'type': 'E', + \ 'sub_type': 'style', \ }, \ { \ 'lnum': 77, \ 'col': 1, - \ 'text': 'E302 expected 2 blank lines, found 1', + \ 'text': 'expected 2 blank lines, found 1', + \ 'code': 'E302', \ 'type': 'E', + \ 'sub_type': 'style', \ }, \ { \ 'lnum': 88, \ 'col': 5, - \ 'text': 'E301 expected 1 blank line, found 0', + \ 'text': 'expected 1 blank line, found 0', + \ 'code': 'E301', \ 'type': 'E', + \ 'sub_type': 'style', \ }, \ { \ 'lnum': 222, \ 'col': 34, - \ 'text': 'W602 deprecated form of raising exception', + \ 'text': 'deprecated form of raising exception', + \ 'code': 'W602', \ 'type': 'W', + \ 'sub_type': 'style', \ }, \ { \ 'lnum': 544, \ 'col': 21, - \ 'text': 'W601 .has_key() is deprecated, use ''in''', + \ 'text': '.has_key() is deprecated, use ''in''', + \ 'code': 'W601', \ 'type': 'W', + \ 'sub_type': 'style', \ }, \ ], \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'stdin:8:3: E999 SyntaxError: invalid syntax', \ 'stdin:69:11: E401 multiple imports on one line', \ 'stdin:77:1: E302 expected 2 blank lines, found 1', \ 'stdin:88:5: E301 expected 1 blank line, found 0', From eda20d0585567b22befa0e011324aaa91b9bebca Mon Sep 17 00:00:00 2001 From: Nic West Date: Wed, 15 Nov 2017 21:46:51 +0000 Subject: [PATCH 147/390] add joker handler for clojure Adds new linter for clojure using joker https://github.com/candid82/joker fixes #975 ref #544 #1040 --- README.md | 1 + ale_linters/clojure/joker.vim | 32 ++++++++ doc/ale-clojure.txt | 21 ++++++ doc/ale.txt | 3 + test/handler/test_clojure_joker_handler.vader | 75 +++++++++++++++++++ 5 files changed, 132 insertions(+) create mode 100644 ale_linters/clojure/joker.vim create mode 100644 doc/ale-clojure.txt create mode 100644 test/handler/test_clojure_joker_handler.vader diff --git a/README.md b/README.md index cf812af..6084cce 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ formatting. | CUDA | [nvcc](http://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/index.html) | | C# | [mcs](http://www.mono-project.com/docs/about-mono/languages/csharp/) see:`help ale-cs-mcs` for details, [mcsc](http://www.mono-project.com/docs/about-mono/languages/csharp/) !! see:`help ale-cs-mcsc` for details and configuration| | Chef | [foodcritic](http://www.foodcritic.io/) | +| Clojure | [joker](https://github.com/candid82/joker) | | CMake | [cmakelint](https://github.com/richq/cmake-lint) | | CoffeeScript | [coffee](http://coffeescript.org/), [coffeelint](https://www.npmjs.com/package/coffeelint) | | Crystal | [crystal](https://crystal-lang.org/) !! | diff --git a/ale_linters/clojure/joker.vim b/ale_linters/clojure/joker.vim new file mode 100644 index 0000000..e78066f --- /dev/null +++ b/ale_linters/clojure/joker.vim @@ -0,0 +1,32 @@ +" Author: Nic West +" Description: linter for clojure using joker https://github.com/candid82/joker + +function! ale_linters#clojure#joker#HandleJokerFormat(buffer, lines) abort + " output format + " ::: : + let l:pattern = '\v^[a-zA-Z]?:?[^:]+:(\d+):(\d+):? ((Read error|Parse error|Parse warning|Exception): ?(.+))$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:type = 'E' + if l:match[4] is? 'Parse warning' + let l:type = 'W' + endif + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'col': l:match[2] + 0, + \ 'text': l:match[3], + \ 'type': l:type, + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('clojure', { +\ 'name': 'joker', +\ 'output_stream': 'stderr', +\ 'executable': 'joker', +\ 'command': 'joker --lint %t', +\ 'callback': 'ale_linters#clojure#joker#HandleJokerFormat', +\}) diff --git a/doc/ale-clojure.txt b/doc/ale-clojure.txt new file mode 100644 index 0000000..a83e336 --- /dev/null +++ b/doc/ale-clojure.txt @@ -0,0 +1,21 @@ +=============================================================================== +ALE Clojure Integration *ale-clojure-options* + + +=============================================================================== +joker *ale-clojure-joker* + +Joker is a small Clojure interpreter and linter written in Go. + +https://github.com/candid82/joker + +Linting options are not configurable by ale, but instead are controlled by a +`.joker` file in same directory as the file (or current working directory if +linting stdin), a parent directory relative to the file, or the users home +directory. + +see https://github.com/candid82/joker#linter-mode for more information. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: + diff --git a/doc/ale.txt b/doc/ale.txt index 9947d09..3290721 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -29,6 +29,8 @@ CONTENTS *ale-contents* gcc.................................|ale-c-gcc| chef..................................|ale-chef-options| foodcritic..........................|ale-chef-foodcritic| + clojure...............................|ale-clojure-options| + joker...............................|ale-clojure-joker| cmake.................................|ale-cmake-options| cmakelint...........................|ale-cmake-cmakelint| cpp...................................|ale-cpp-options| @@ -271,6 +273,7 @@ Notes: * CUDA: `nvcc`!! * C#: `mcs`, `mcsc`!! * Chef: `foodcritic` +* Clojure: `joker` * CMake: `cmakelint` * CoffeeScript: `coffee`, `coffeelint` * Crystal: `crystal`!! diff --git a/test/handler/test_clojure_joker_handler.vader b/test/handler/test_clojure_joker_handler.vader new file mode 100644 index 0000000..460c62e --- /dev/null +++ b/test/handler/test_clojure_joker_handler.vader @@ -0,0 +1,75 @@ +Before: + runtime ale_linters/clojure/joker.vim + +After: + call ale#linter#Reset() + +Execute(the clojure joker handler should be able to handle errors): + AssertEqual + \ [ + \ { + \ 'lnum': 123, + \ 'col': 44, + \ 'type': 'E', + \ 'text': 'Read error: Unexpected )', + \ }, + \ ], + \ ale_linters#clojure#joker#HandleJokerFormat(0, [ + \ 'test.clj:123:44: Read error: Unexpected )', + \ ]) + +Execute(the clojure joker handler should be able to handle warnings): + AssertEqual + \ [ + \ { + \ 'lnum': 654, + \ 'col': 321, + \ 'type': 'W', + \ 'text': 'Parse warning: let form with empty body', + \ } + \ ], + \ ale_linters#clojure#joker#HandleJokerFormat(0, [ + \ 'test.clj:654:321: Parse warning: let form with empty body' + \ ]) + +Execute(the clojure joker handler should be able to handle exceptions): + AssertEqual + \ [ + \ { + \ 'lnum': 123, + \ 'col': 321, + \ 'type': 'E', + \ 'text': 'Exception: something horrible happen', + \ } + \ ], + \ ale_linters#clojure#joker#HandleJokerFormat(0, [ + \ 'test.clj:123:321: Exception: something horrible happen' + \ ]) + +Execute(the clojure joker handler should be able to handle errors from stdin): + AssertEqual + \ [ + \ { + \ 'lnum': 16, + \ 'col': 1, + \ 'type': 'E', + \ 'text': 'Read error: Unexpected )', + \ }, + \ ], + \ ale_linters#clojure#joker#HandleJokerFormat(0, [ + \ ':16:1: Read error: Unexpected )', + \ ]) + +Execute(the clojure joker handler should be able to handle windows files): + AssertEqual + \ [ + \ { + \ 'lnum': 123, + \ 'col': 44, + \ 'type': 'E', + \ 'text': 'Read error: Unexpected )', + \ } + \ ], + \ ale_linters#clojure#joker#HandleJokerFormat(0, [ + \ 'C:\my\operating\system\is\silly\core.clj:123:44: Read error: Unexpected )', + \ ]) From d585123d646200ceb7e0580dcad2d28d00331332 Mon Sep 17 00:00:00 2001 From: aurieh Date: Thu, 16 Nov 2017 00:58:33 +0200 Subject: [PATCH 148/390] #852 Capture error codes for checkmake --- ale_linters/make/checkmake.vim | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ale_linters/make/checkmake.vim b/ale_linters/make/checkmake.vim index 3dd8cc9..63c35db 100644 --- a/ale_linters/make/checkmake.vim +++ b/ale_linters/make/checkmake.vim @@ -5,12 +5,12 @@ function! ale_linters#make#checkmake#Handle(buffer, lines) abort let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - let l:text = l:match[2] . ': ' . l:match[3] call add(l:output, { \ 'bufnr': a:buffer, \ 'lnum': l:match[1] + 0, \ 'type': 'E', - \ 'text': l:text, + \ 'code': l:match[2], + \ 'text': l:match[3], \}) endfor return l:output From 7565a45b6f9ce4528a639065c4dc32874b0c147a Mon Sep 17 00:00:00 2001 From: aurieh Date: Thu, 16 Nov 2017 01:01:59 +0200 Subject: [PATCH 149/390] Modify vader tests for d585123 --- test/handler/test_checkmake_handler.vader | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/handler/test_checkmake_handler.vader b/test/handler/test_checkmake_handler.vader index 718c881..e2e1842 100644 --- a/test/handler/test_checkmake_handler.vader +++ b/test/handler/test_checkmake_handler.vader @@ -13,7 +13,8 @@ Execute(Parsing checkmake errors should work): \ 'bufnr': 42, \ 'lnum': 1, \ 'type': 'E', - \ 'text': 'woops: an error has occurred', + \ 'code': 'woops', + \ 'text': 'an error has occurred', \ } \ ], \ ale_linters#make#checkmake#Handle(42, [ From 981cb95d80714fd70b55d99f164c2d3158315206 Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 16 Nov 2017 18:12:08 +0900 Subject: [PATCH 150/390] add redpen support --- ale_linters/markdown/redpen.vim | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 ale_linters/markdown/redpen.vim diff --git a/ale_linters/markdown/redpen.vim b/ale_linters/markdown/redpen.vim new file mode 100644 index 0000000..00a19a9 --- /dev/null +++ b/ale_linters/markdown/redpen.vim @@ -0,0 +1,32 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +function! ale_linters#markdown#redpen#HandleErrors(buffer, lines) abort + " Only one file was passed to redpen. So response array has only one + " element. + let l:res = json_decode(join(a:lines))[0] + let l:errors = [] + for l:err in l:res.errors + if has_key(l:err, 'startPosition') + let l:lnum = l:err.startPosition.lineNum + let l:col = l:err.startPosition.offset + else + let l:lnum = l:err.lineNum + let l:col = l:err.sentenceStartColumnNum + 1 + endif + call add(l:errors, { + \ 'lnum': l:lnum, + \ 'col': l:col, + \ 'text': l:err.message . ' (' . l:err.validator . ')', + \ 'type': 'W', + \}) + endfor + return l:errors +endfunction + +call ale#linter#Define('markdown', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -r json %t', +\ 'callback': 'ale_linters#markdown#redpen#HandleErrors', +\}) From 71d34fc0c6eba0935b97a8d9dc5fd29c432be452 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 16 Nov 2017 09:34:24 +0000 Subject: [PATCH 151/390] Fix #1132 - Parse react error codes again for ESLint --- autoload/ale/handlers/eslint.vim | 3 ++- test/handler/test_eslint_handler.vader | 20 +++++++++++++++++--- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/autoload/ale/handlers/eslint.vim b/autoload/ale/handlers/eslint.vim index adfb65b..ff59016 100644 --- a/autoload/ale/handlers/eslint.vim +++ b/autoload/ale/handlers/eslint.vim @@ -133,8 +133,9 @@ function! ale#handlers#eslint#Handle(buffer, lines) abort let l:obj.type = 'W' endif + " The code can be something like 'Error/foo/bar', or just 'Error' if !empty(get(l:split_code, 1)) - let l:obj.code = l:split_code[1] + let l:obj.code = join(l:split_code[1:], '/') endif for l:col_match in ale#util#GetMatches(l:text, s:col_end_patterns) diff --git a/test/handler/test_eslint_handler.vader b/test/handler/test_eslint_handler.vader index 47e84d4..2e8bfd2 100644 --- a/test/handler/test_eslint_handler.vader +++ b/test/handler/test_eslint_handler.vader @@ -3,13 +3,12 @@ Before: Save g:ale_javascript_eslint_suppress_missing_config let g:ale_javascript_eslint_suppress_eslintignore = 0 - let b:ale_javascript_eslint_suppress_missing_config = 0 - - unlet! b:ale_javascript_eslint_suppress_missing_config + let g:ale_javascript_eslint_suppress_missing_config = 0 After: Restore + unlet! b:ale_javascript_eslint_suppress_eslintignore unlet! b:ale_javascript_eslint_suppress_missing_config unlet! g:config_error_lines @@ -351,3 +350,18 @@ Execute(eslint should not warn about ignored files when explicitly disabled): \ ale#handlers#eslint#Handle(bufnr(''), [ \ '/path/to/some/ignored.js:0:0: File ignored because of a matching ignore pattern. Use "--no-ignore" to override. [Warning]', \ ]) + +Execute(eslint should handle react errors correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 59, + \ 'col': 9, + \ 'type': 'E', + \ 'text': 'Property should be placed on the same line as the component declaration', + \ 'code': 'react/jsx-first-prop-new-line', + \ }, + \ ], + \ ale#handlers#eslint#Handle(bufnr(''), [ + \ '/path/editor-help.jsx:59:9: Property should be placed on the same line as the component declaration [Error/react/jsx-first-prop-new-line]', + \ ]) From c9c52ef370f6abbcf60220e047faebd294bd738b Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 16 Nov 2017 18:36:53 +0900 Subject: [PATCH 152/390] add tests and doc for redpen support --- README.md | 2 +- doc/ale.txt | 2 +- test/handler/test_redpen_handler.vader | 65 ++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 test/handler/test_redpen_handler.vader diff --git a/README.md b/README.md index cf812af..810b90e 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ formatting. | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good) | +| Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | diff --git a/doc/ale.txt b/doc/ale.txt index 9947d09..8e2e595 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -304,7 +304,7 @@ Notes: * Lua: `luacheck` * Mail: `proselint`, `vale` * Make: `checkmake` -* Markdown: `mdl`, `proselint`, `vale`, `remark-lint`, `write-good` +* Markdown: `mdl`, `proselint`, `vale`, `remark-lint`, `write-good`, `redpen` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader new file mode 100644 index 0000000..2ea3a2f --- /dev/null +++ b/test/handler/test_redpen_handler.vader @@ -0,0 +1,65 @@ +Before: + runtime! ale_linters/markdown/redpen.vim + +After: + call ale#linter#Reset() + +Execute(redpen handler should handle errors output): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 9, + \ 'text': 'Found possibly misspelled word "plugin". (Spelling)', + \ 'type': 'W', + \ }, + \ { + \ 'lnum': 1, + \ 'col': 1, + \ 'text': 'Found possibly misspelled word "NeoVim". (Spelling)', + \ 'type': 'W', + \ }, + \ ], + \ ale_linters#markdown#redpen#HandleErrors(bufnr(''), [ + \ '[', + \ ' {', + \ ' "document": "test.md",', + \ ' "errors": [', + \ ' {', + \ ' "sentence": "ALE is a plugin for providing linting in NeoVim and Vim 8 while you edit your text files.",', + \ ' "endPosition": {', + \ ' "offset": 15,', + \ ' "lineNum": 1', + \ ' },', + \ ' "validator": "Spelling",', + \ ' "lineNum": 1,', + \ ' "sentenceStartColumnNum": 0,', + \ ' "message": "Found possibly misspelled word \"plugin\".",', + \ ' "startPosition": {', + \ ' "offset": 9,', + \ ' "lineNum": 1', + \ ' }', + \ ' },', + \ ' {', + \ ' "sentence": "ALE is a plugin for providing linting in NeoVim and Vim 8 while you edit your text files.",', + \ ' "validator": "Spelling",', + \ ' "lineNum": 1,', + \ ' "sentenceStartColumnNum": 0,', + \ ' "message": "Found possibly misspelled word \"NeoVim\".",', + \ ' }', + \ ' ]', + \ ' }', + \ ']', + \ ]) + +Execute(redpen handler should no error output): + AssertEqual + \ [], + \ ale_linters#markdown#redpen#HandleErrors(bufnr(''), [ + \ '[', + \ ' {', + \ ' "document": "test.md",', + \ ' "errors": []', + \ ' }', + \ ']', + \ ]) From f1314b285c7b489f7b879a1afd703b60a877a52e Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 16 Nov 2017 19:28:30 +0900 Subject: [PATCH 153/390] redpen: support end_lnum and end_col if possible --- ale_linters/markdown/redpen.vim | 29 ++++++++++++++------------ test/handler/test_redpen_handler.vader | 2 ++ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/ale_linters/markdown/redpen.vim b/ale_linters/markdown/redpen.vim index 00a19a9..38fe230 100644 --- a/ale_linters/markdown/redpen.vim +++ b/ale_linters/markdown/redpen.vim @@ -5,23 +5,26 @@ function! ale_linters#markdown#redpen#HandleErrors(buffer, lines) abort " Only one file was passed to redpen. So response array has only one " element. let l:res = json_decode(join(a:lines))[0] - let l:errors = [] + let l:output = [] for l:err in l:res.errors - if has_key(l:err, 'startPosition') - let l:lnum = l:err.startPosition.lineNum - let l:col = l:err.startPosition.offset - else - let l:lnum = l:err.lineNum - let l:col = l:err.sentenceStartColumnNum + 1 - endif - call add(l:errors, { - \ 'lnum': l:lnum, - \ 'col': l:col, + let l:item = { \ 'text': l:err.message . ' (' . l:err.validator . ')', \ 'type': 'W', - \}) + \} + if has_key(l:err, 'startPosition') + let l:item.lnum = l:err.startPosition.lineNum + let l:item.col = l:err.startPosition.offset + if has_key(l:err, 'endPosition') + let l:item.end_lnum = l:err.endPosition.lineNum + let l:item.end_col = l:err.endPosition.offset + endif + else + let l:item.lnum = l:err.lineNum + let l:item.col = l:err.sentenceStartColumnNum + 1 + endif + call add(l:output, l:item) endfor - return l:errors + return l:output endfunction call ale#linter#Define('markdown', { diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader index 2ea3a2f..a1ad65d 100644 --- a/test/handler/test_redpen_handler.vader +++ b/test/handler/test_redpen_handler.vader @@ -10,6 +10,8 @@ Execute(redpen handler should handle errors output): \ { \ 'lnum': 1, \ 'col': 9, + \ 'end_lnum': 1, + \ 'end_col': 15, \ 'text': 'Found possibly misspelled word "plugin". (Spelling)', \ 'type': 'W', \ }, From e232ea07c23d3e6f1b6e621e896f27545e5b10c7 Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 16 Nov 2017 19:42:51 +0900 Subject: [PATCH 154/390] redpen: fix trailing comma in test data --- test/handler/test_redpen_handler.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader index a1ad65d..d0782d9 100644 --- a/test/handler/test_redpen_handler.vader +++ b/test/handler/test_redpen_handler.vader @@ -47,7 +47,7 @@ Execute(redpen handler should handle errors output): \ ' "validator": "Spelling",', \ ' "lineNum": 1,', \ ' "sentenceStartColumnNum": 0,', - \ ' "message": "Found possibly misspelled word \"NeoVim\".",', + \ ' "message": "Found possibly misspelled word \"NeoVim\"."', \ ' }', \ ' ]', \ ' }', From b390c696424f51b0d8a198ce252ae14d0b0cd8aa Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Thu, 16 Nov 2017 23:02:30 -0500 Subject: [PATCH 155/390] erb, erubis: Redirect file into first command. The previous version relied on a zsh-specific behavior where ` Date: Fri, 17 Nov 2017 15:21:18 +0900 Subject: [PATCH 156/390] redpen support for asciidoc, reST, LaTeX and Re:VIEW --- README.md | 7 +++--- ale_linters/asciidoc/redpen.vim | 9 ++++++++ ale_linters/markdown/redpen.vim | 30 ++------------------------ ale_linters/review/redpen.vim | 9 ++++++++ ale_linters/rst/redpen.vim | 9 ++++++++ ale_linters/tex/redpen.vim | 9 ++++++++ autoload/ale/handlers/redpen.vim | 29 +++++++++++++++++++++++++ doc/ale.txt | 7 +++--- test/handler/test_redpen_handler.vader | 4 ++-- 9 files changed, 77 insertions(+), 36 deletions(-) create mode 100644 ale_linters/asciidoc/redpen.vim create mode 100644 ale_linters/review/redpen.vim create mode 100644 ale_linters/rst/redpen.vim create mode 100644 ale_linters/tex/redpen.vim create mode 100644 autoload/ale/handlers/redpen.vim diff --git a/README.md b/README.md index ba1aca9..891692c 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ formatting. | -------- | ----- | | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | -| AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/)| | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | @@ -109,7 +109,7 @@ formatting. | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | -| LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | @@ -132,7 +132,8 @@ formatting. | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) | +| reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| Re:VIEW | [redpen](http://redpen.cc/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | | Rust | cargo !! (see `:help ale-integration-rust` for configuration instructions), [rls](https://github.com/rust-lang-nursery/rls), [rustc](https://www.rust-lang.org/), [rustfmt](https://github.com/rust-lang-nursery/rustfmt) | diff --git a/ale_linters/asciidoc/redpen.vim b/ale_linters/asciidoc/redpen.vim new file mode 100644 index 0000000..819e385 --- /dev/null +++ b/ale_linters/asciidoc/redpen.vim @@ -0,0 +1,9 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +call ale#linter#Define('asciidoc', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -f asciidoc -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', +\}) diff --git a/ale_linters/markdown/redpen.vim b/ale_linters/markdown/redpen.vim index 38fe230..ff2cbaf 100644 --- a/ale_linters/markdown/redpen.vim +++ b/ale_linters/markdown/redpen.vim @@ -1,35 +1,9 @@ " Author: rhysd https://rhysd.github.io " Description: Redpen, a proofreading tool (http://redpen.cc) -function! ale_linters#markdown#redpen#HandleErrors(buffer, lines) abort - " Only one file was passed to redpen. So response array has only one - " element. - let l:res = json_decode(join(a:lines))[0] - let l:output = [] - for l:err in l:res.errors - let l:item = { - \ 'text': l:err.message . ' (' . l:err.validator . ')', - \ 'type': 'W', - \} - if has_key(l:err, 'startPosition') - let l:item.lnum = l:err.startPosition.lineNum - let l:item.col = l:err.startPosition.offset - if has_key(l:err, 'endPosition') - let l:item.end_lnum = l:err.endPosition.lineNum - let l:item.end_col = l:err.endPosition.offset - endif - else - let l:item.lnum = l:err.lineNum - let l:item.col = l:err.sentenceStartColumnNum + 1 - endif - call add(l:output, l:item) - endfor - return l:output -endfunction - call ale#linter#Define('markdown', { \ 'name': 'redpen', \ 'executable': 'redpen', -\ 'command': 'redpen -r json %t', -\ 'callback': 'ale_linters#markdown#redpen#HandleErrors', +\ 'command': 'redpen -f markdown -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', \}) diff --git a/ale_linters/review/redpen.vim b/ale_linters/review/redpen.vim new file mode 100644 index 0000000..0006cab --- /dev/null +++ b/ale_linters/review/redpen.vim @@ -0,0 +1,9 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +call ale#linter#Define('review', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -f review -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', +\}) diff --git a/ale_linters/rst/redpen.vim b/ale_linters/rst/redpen.vim new file mode 100644 index 0000000..ac966c5 --- /dev/null +++ b/ale_linters/rst/redpen.vim @@ -0,0 +1,9 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +call ale#linter#Define('rst', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -f rest -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', +\}) diff --git a/ale_linters/tex/redpen.vim b/ale_linters/tex/redpen.vim new file mode 100644 index 0000000..952a600 --- /dev/null +++ b/ale_linters/tex/redpen.vim @@ -0,0 +1,9 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +call ale#linter#Define('tex', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -f latex -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', +\}) diff --git a/autoload/ale/handlers/redpen.vim b/autoload/ale/handlers/redpen.vim new file mode 100644 index 0000000..89ad5fc --- /dev/null +++ b/autoload/ale/handlers/redpen.vim @@ -0,0 +1,29 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +function! ale#handlers#redpen#HandleRedpenOutput(buffer, lines) abort + " Only one file was passed to redpen. So response array has only one + " element. + let l:res = json_decode(join(a:lines))[0] + let l:output = [] + for l:err in l:res.errors + let l:item = { + \ 'text': l:err.message . ' (' . l:err.validator . ')', + \ 'type': 'W', + \} + if has_key(l:err, 'startPosition') + let l:item.lnum = l:err.startPosition.lineNum + let l:item.col = l:err.startPosition.offset + if has_key(l:err, 'endPosition') + let l:item.end_lnum = l:err.endPosition.lineNum + let l:item.end_col = l:err.endPosition.offset + endif + else + let l:item.lnum = l:err.lineNum + let l:item.col = l:err.sentenceStartColumnNum + 1 + endif + call add(l:output, l:item) + endfor + return l:output +endfunction + diff --git a/doc/ale.txt b/doc/ale.txt index 697c592..1d2bed3 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -264,7 +264,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` -* AsciiDoc: `proselint`, `write-good` +* AsciiDoc: `proselint`, `write-good`, `redpen` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` * Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` @@ -301,7 +301,7 @@ Notes: * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` +* LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good`, `redpen` * Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` * Lua: `luacheck` @@ -324,7 +324,8 @@ Notes: * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` -* reStructuredText: `proselint`, `rstcheck`, `write-good` +* reStructuredText: `proselint`, `rstcheck`, `write-good`, `redpen` +* Re:VIEW: `redpen` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader index d0782d9..32ff0ba 100644 --- a/test/handler/test_redpen_handler.vader +++ b/test/handler/test_redpen_handler.vader @@ -22,7 +22,7 @@ Execute(redpen handler should handle errors output): \ 'type': 'W', \ }, \ ], - \ ale_linters#markdown#redpen#HandleErrors(bufnr(''), [ + \ ale#handlers#redpen#HandleRedpenOutput(bufnr(''), [ \ '[', \ ' {', \ ' "document": "test.md",', @@ -57,7 +57,7 @@ Execute(redpen handler should handle errors output): Execute(redpen handler should no error output): AssertEqual \ [], - \ ale_linters#markdown#redpen#HandleErrors(bufnr(''), [ + \ ale#handlers#redpen#HandleRedpenOutput(bufnr(''), [ \ '[', \ ' {', \ ' "document": "test.md",', From ca345ffb624ba399458eb7b2954ce2efbc381248 Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 17 Nov 2017 15:21:54 +0900 Subject: [PATCH 157/390] redpen: fix start column --- autoload/ale/handlers/redpen.vim | 2 +- test/handler/test_redpen_handler.vader | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/autoload/ale/handlers/redpen.vim b/autoload/ale/handlers/redpen.vim index 89ad5fc..35ff8c1 100644 --- a/autoload/ale/handlers/redpen.vim +++ b/autoload/ale/handlers/redpen.vim @@ -13,7 +13,7 @@ function! ale#handlers#redpen#HandleRedpenOutput(buffer, lines) abort \} if has_key(l:err, 'startPosition') let l:item.lnum = l:err.startPosition.lineNum - let l:item.col = l:err.startPosition.offset + let l:item.col = l:err.startPosition.offset + 1 if has_key(l:err, 'endPosition') let l:item.end_lnum = l:err.endPosition.lineNum let l:item.end_col = l:err.endPosition.offset diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader index 32ff0ba..4627614 100644 --- a/test/handler/test_redpen_handler.vader +++ b/test/handler/test_redpen_handler.vader @@ -9,7 +9,7 @@ Execute(redpen handler should handle errors output): \ [ \ { \ 'lnum': 1, - \ 'col': 9, + \ 'col': 10, \ 'end_lnum': 1, \ 'end_col': 15, \ 'text': 'Found possibly misspelled word "plugin". (Spelling)', From 79f15b0e3050b9ca2ddd82a6712b5bfcb934cadb Mon Sep 17 00:00:00 2001 From: rhysd Date: Fri, 17 Nov 2017 15:35:20 +0900 Subject: [PATCH 158/390] add redpen as text linter --- README.md | 2 +- ale_linters/text/redpen.vim | 9 +++++++++ doc/ale.txt | 2 +- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 ale_linters/text/redpen.vim diff --git a/README.md b/README.md index 891692c..25fb72b 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ formatting. | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | | Terraform | [tflint](https://github.com/wata727/tflint) | | Texinfo | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| -| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | +| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Thrift | [thrift](http://thrift.apache.org/) | | TypeScript | [eslint](http://eslint.org/), [prettier](https://github.com/prettier/prettier), [tslint](https://github.com/palantir/tslint), tsserver, typecheck | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | diff --git a/ale_linters/text/redpen.vim b/ale_linters/text/redpen.vim new file mode 100644 index 0000000..ec4433b --- /dev/null +++ b/ale_linters/text/redpen.vim @@ -0,0 +1,9 @@ +" Author: rhysd https://rhysd.github.io +" Description: Redpen, a proofreading tool (http://redpen.cc) + +call ale#linter#Define('text', { +\ 'name': 'redpen', +\ 'executable': 'redpen', +\ 'command': 'redpen -f plain -r json %t', +\ 'callback': 'ale#handlers#redpen#HandleRedpenOutput', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index 1d2bed3..4fb7100 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -341,7 +341,7 @@ Notes: * Tcl: `nagelfar`!! * Terraform: `tflint` * Texinfo: `proselint`, `write-good` -* Text^: `proselint`, `vale`, `write-good` +* Text^: `proselint`, `vale`, `write-good`, `redpen` * Thrift: `thrift` * TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck` * Verilog: `iverilog`, `verilator` From 22ec81e1de48cf442238dac9f85a579e04bf70cb Mon Sep 17 00:00:00 2001 From: Thomas van der Burgt Date: Fri, 17 Nov 2017 11:02:30 +0100 Subject: [PATCH 159/390] add ale_asm_gcc_executable option (#1138) * add ale_asm_gcc_executable option * add Vader tests for asm gcc linter command callbacks --- ale_linters/asm/gcc.vim | 12 ++++-- doc/ale-asm.txt | 8 ++++ .../test_asm_gcc_command_callbacks.vader | 39 +++++++++++++++++++ 3 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_asm_gcc_command_callbacks.vader diff --git a/ale_linters/asm/gcc.vim b/ale_linters/asm/gcc.vim index 39b1f7c..4ac876f 100644 --- a/ale_linters/asm/gcc.vim +++ b/ale_linters/asm/gcc.vim @@ -1,10 +1,16 @@ " Author: Lucas Kolstad " Description: gcc linter for asm files -let g:ale_asm_gcc_options = get(g:, 'ale_asm_gcc_options', '-Wall') +call ale#Set('asm_gcc_executable', 'gcc') +call ale#Set('asm_gcc_options', '-Wall') + +function! ale_linters#asm#gcc#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'asm_gcc_executable') +endfunction function! ale_linters#asm#gcc#GetCommand(buffer) abort - return 'gcc -x assembler -fsyntax-only ' + return ale#Escape(ale_linters#asm#gcc#GetExecutable(a:buffer)) + \ . ' -x assembler -fsyntax-only ' \ . '-iquote ' . ale#Escape(fnamemodify(bufname(a:buffer), ':p:h')) \ . ' ' . ale#Var(a:buffer, 'asm_gcc_options') . ' -' endfunction @@ -27,7 +33,7 @@ endfunction call ale#linter#Define('asm', { \ 'name': 'gcc', \ 'output_stream': 'stderr', -\ 'executable': 'gcc', +\ 'executable_callback': 'ale_linters#asm#gcc#GetExecutable', \ 'command_callback': 'ale_linters#asm#gcc#GetCommand', \ 'callback': 'ale_linters#asm#gcc#Handle', \}) diff --git a/doc/ale-asm.txt b/doc/ale-asm.txt index 63b5441..a97c6d0 100644 --- a/doc/ale-asm.txt +++ b/doc/ale-asm.txt @@ -5,6 +5,14 @@ ALE ASM Integration *ale-asm-options* =============================================================================== gcc *ale-asm-gcc* +g:ale_asm_gcc_executable *g:ale_asm_gcc_executable* + *b:ale_asm_gcc_executable* + Type: |String| + Default: `'gcc'` + +This variable can be changed to use a different executable for gcc. + + g:ale_asm_gcc_options *g:ale_asm_gcc_options* *b:ale_asm_gcc_options* Type: |String| diff --git a/test/command_callback/test_asm_gcc_command_callbacks.vader b/test/command_callback/test_asm_gcc_command_callbacks.vader new file mode 100644 index 0000000..ce8b906 --- /dev/null +++ b/test/command_callback/test_asm_gcc_command_callbacks.vader @@ -0,0 +1,39 @@ +Before: + Save g:ale_asm_gcc_executable + Save g:ale_asm_gcc_options + + unlet! g:ale_asm_gcc_executable + unlet! b:ale_asm_gcc_executable + unlet! g:ale_asm_gcc_options + unlet! b:ale_asm_gcc_options + + runtime ale_linters/asm/gcc.vim + + let b:command_tail = ' -x assembler -fsyntax-only -iquote' + \ . ' ' . ale#Escape(getcwd()) + \ . ' -Wall -' + +After: + Restore + unlet! b:command_tail + unlet! b:ale_asm_gcc_executable + unlet! b:ale_asm_gcc_options + call ale#linter#Reset() + +Execute(The executable should be configurable): + AssertEqual 'gcc', ale_linters#asm#gcc#GetExecutable(bufnr('')) + + let b:ale_asm_gcc_executable = 'foobar' + + AssertEqual 'foobar', ale_linters#asm#gcc#GetExecutable(bufnr('')) + +Execute(The executable should be used in the command): + AssertEqual + \ ale#Escape('gcc') . b:command_tail, + \ ale_linters#asm#gcc#GetCommand(bufnr('')) + + let b:ale_asm_gcc_executable = 'foobar' + + AssertEqual + \ ale#Escape('foobar') . b:command_tail, + \ ale_linters#asm#gcc#GetCommand(bufnr('')) From 5635b3c86437f22123a19601bebcaa335c1ceb2e Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 17 Nov 2017 14:29:51 +0000 Subject: [PATCH 160/390] Fix #741 - Set highlights for entire lines when signs are disabled --- autoload/ale/highlight.vim | 16 ++++++++++++++++ doc/ale.txt | 26 +++++++++++++++++++++++--- test/test_highlight_placement.vader | 21 +++++++++++++++++++++ 3 files changed, 60 insertions(+), 3 deletions(-) diff --git a/autoload/ale/highlight.vim b/autoload/ale/highlight.vim index 47256f0..e3c749f 100644 --- a/autoload/ale/highlight.vim +++ b/autoload/ale/highlight.vim @@ -91,6 +91,22 @@ function! ale#highlight#UpdateHighlights() abort \ 'matchaddpos(l:group, v:val)' \) endfor + + " If highlights are enabled and signs are not enabled, we should still + " offer line highlights by adding a separate set of highlights. + if !g:ale_set_signs + for l:item in l:item_list + if l:item.type is# 'W' + let l:group = 'ALEWarningLine' + elseif l:item.type is# 'I' + let l:group = 'ALEInfoLine' + else + let l:group = 'ALEErrorLine' + endif + + call matchaddpos(l:group, [l:item.lnum]) + endfor + endif endfunction function! ale#highlight#BufferHidden(buffer) abort diff --git a/doc/ale.txt b/doc/ale.txt index 697c592..7b9deee 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1149,6 +1149,17 @@ g:ale_set_highlights *g:ale_set_highlights* |ALEStyleError| - Items with `'type': 'E'` and `'sub_type': 'style'` |ALEStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'` + When |g:ale_set_signs| is set to `0`, the following highlights for entire + lines will be set. + + |ALEErrorLine| - All items with `'type': 'E'` + |ALEWarningLine| - All items with `'type': 'W'` + |ALEInfoLine| - All items with `'type': 'I'` + + Vim can only highlight the characters up to the last column in a buffer for + match highlights, whereas the line highlights when signs are enabled will + run to the edge of the screen. + g:ale_set_loclist *g:ale_set_loclist* @@ -1366,7 +1377,10 @@ ALEErrorLine *ALEErrorLine* Default: Undefined - The highlight for lines where error signs appear. See |g:ale_set_signs|. + The highlight for an entire line where errors appear. Only the first + line for a problem will be highlighted. + + See |g:ale_set_signs| and |g:ale_set_highlights|. ALEErrorSign *ALEErrorSign* @@ -1394,7 +1408,10 @@ ALEInfoLine *ALEInfoLine* Default: Undefined - The highlight for lines where info signs appear. See |g:ale_set_signs|. + The highlight for entire lines where info messages appear. Only the first + line for a problem will be highlighted. + + See |g:ale_set_signs| and |g:ale_set_highlights|. ALEStyleError *ALEStyleError* @@ -1436,7 +1453,10 @@ ALEWarningLine *ALEWarningLine* Default: Undefined - The highlight for lines where warning signs appear. See |g:ale_set_signs|. + The highlight for entire lines where warnings appear. Only the first line + for a problem will be highlighted. + + See |g:ale_set_signs| and |g:ale_set_highlights|. ALEWarningSign *ALEWarningSign* diff --git a/test/test_highlight_placement.vader b/test/test_highlight_placement.vader index 6a84e57..725faff 100644 --- a/test/test_highlight_placement.vader +++ b/test/test_highlight_placement.vader @@ -1,5 +1,6 @@ Before: Save g:ale_enabled + Save g:ale_set_signs function! GenerateResults(buffer, output) return [ @@ -258,3 +259,23 @@ Execute(Highlights should be cleared when ALE is disabled): call ale#highlight#UpdateHighlights() AssertEqual [], GetMatchesWithoutIDs() + +Execute(Line highlights should be set when signs are disabled): + let g:ale_set_signs = 0 + + call ale#highlight#SetHighlights(bufnr(''), [ + \ {'bufnr': bufnr(''), 'type': 'E', 'lnum': 1, 'col': 1}, + \ {'bufnr': bufnr(''), 'type': 'W', 'lnum': 2, 'col': 1}, + \ {'bufnr': bufnr(''), 'type': 'I', 'lnum': 3, 'col': 1}, + \]) + + AssertEqual + \ [ + \ {'group': 'ALEError', 'priority': 10, 'pos1': [1, 1, 1]}, + \ {'group': 'ALEWarning', 'priority': 10, 'pos1': [2, 1, 1]}, + \ {'group': 'ALEInfo', 'priority': 10, 'pos1': [3, 1, 1]}, + \ {'group': 'ALEErrorLine', 'priority': 10, 'pos1': [1]}, + \ {'group': 'ALEWarningLine', 'priority': 10, 'pos1': [2]}, + \ {'group': 'ALEInfoLine', 'priority': 10, 'pos1': [3]}, + \ ], + \ GetMatchesWithoutIDs() From 49ccfb1a00e09f6757b6e597883c95a34d612771 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 17 Nov 2017 18:11:22 +0000 Subject: [PATCH 161/390] Fix #516 - Add support for pyflakes for Python --- ale_linters/python/pyflakes.vim | 38 ++++++++++++++ .../with_virtualenv/env/Scripts/pyflakes.exe | 0 .../with_virtualenv/env/bin/pyflakes | 0 .../test_pyflakes_command_callback.vader | 49 +++++++++++++++++++ test/handler/test_pyflakes_handler.vader | 24 +++++++++ 5 files changed, 111 insertions(+) create mode 100644 ale_linters/python/pyflakes.vim create mode 100755 test/command_callback/python_paths/with_virtualenv/env/Scripts/pyflakes.exe create mode 100755 test/command_callback/python_paths/with_virtualenv/env/bin/pyflakes create mode 100644 test/command_callback/test_pyflakes_command_callback.vader create mode 100644 test/handler/test_pyflakes_handler.vader diff --git a/ale_linters/python/pyflakes.vim b/ale_linters/python/pyflakes.vim new file mode 100644 index 0000000..b4a0b5f --- /dev/null +++ b/ale_linters/python/pyflakes.vim @@ -0,0 +1,38 @@ +" Author: w0rp +" Description: pyflakes for python files + +call ale#Set('python_pyflakes_executable', 'pyflakes') +call ale#Set('python_pyflakes_use_global', 0) + +function! ale_linters#python#pyflakes#GetExecutable(buffer) abort + return ale#python#FindExecutable(a:buffer, 'python_pyflakes', ['pyflakes']) +endfunction + +function! ale_linters#python#pyflakes#GetCommand(buffer) abort + let l:executable = ale_linters#python#pyflakes#GetExecutable(a:buffer) + + return ale#Escape(l:executable) . ' %t' +endfunction + +function! ale_linters#python#pyflakes#Handle(buffer, lines) abort + let l:pattern = '\v^[a-zA-Z]?:?[^:]+:(\d+):(\d+)?:? (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'col': l:match[2] + 0, + \ 'text': l:match[3], + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('python', { +\ 'name': 'pyflakes', +\ 'executable_callback': 'ale_linters#python#pyflakes#GetExecutable', +\ 'command_callback': 'ale_linters#python#pyflakes#GetCommand', +\ 'callback': 'ale_linters#python#pyflakes#Handle', +\ 'output_stream': 'both', +\}) diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyflakes.exe b/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyflakes.exe new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/python_paths/with_virtualenv/env/bin/pyflakes b/test/command_callback/python_paths/with_virtualenv/env/bin/pyflakes new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/test_pyflakes_command_callback.vader b/test/command_callback/test_pyflakes_command_callback.vader new file mode 100644 index 0000000..30a106c --- /dev/null +++ b/test/command_callback/test_pyflakes_command_callback.vader @@ -0,0 +1,49 @@ +Before: + Save g:ale_python_pyflakes_executable + Save g:ale_python_pyflakes_use_global + + unlet! g:ale_python_pyflakes_executable + unlet! g:ale_python_pyflakes_use_global + + let b:bin_dir = has('win32') ? 'Scripts' : 'bin' + + call ale#test#SetDirectory('/testplugin/test/command_callback') + + runtime ale_linters/python/pyflakes.vim + +After: + Restore + + unlet! b:bin_dir + unlet! b:executable + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The pyflakes command callback should return default string): + AssertEqual ale#Escape('pyflakes') . ' %t', + \ ale_linters#python#pyflakes#GetCommand(bufnr('')) + +Execute(The pyflakes executable should be configurable): + let g:ale_python_pyflakes_executable = '~/.local/bin/pyflakes' + + AssertEqual ale#Escape('~/.local/bin/pyflakes') . ' %t', + \ ale_linters#python#pyflakes#GetCommand(bufnr('')) + +Execute(The pyflakes executable should be run from the virtualenv path): + call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') + + let b:executable = ale#path#Winify( + \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/pyflakes' + \) + + AssertEqual ale#Escape(b:executable) . ' %t', + \ ale_linters#python#pyflakes#GetCommand(bufnr('')) + +Execute(You should be able to override the pyflakes virtualenv lookup): + call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') + + let g:ale_python_pyflakes_use_global = 1 + + AssertEqual ale#Escape('pyflakes') . ' %t', + \ ale_linters#python#pyflakes#GetCommand(bufnr('')) diff --git a/test/handler/test_pyflakes_handler.vader b/test/handler/test_pyflakes_handler.vader new file mode 100644 index 0000000..ab4fab4 --- /dev/null +++ b/test/handler/test_pyflakes_handler.vader @@ -0,0 +1,24 @@ +Before: + runtime ale_linters/python/pyflakes.vim + +After: + call ale#linter#Reset() + +Execute(The pyflakes handler should handle basic errors): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 0, + \ 'text': 'undefined name ''foo''', + \ }, + \ { + \ 'lnum': 1, + \ 'col': 7, + \ 'text': 'invalid syntax', + \ }, + \ ], + \ ale_linters#python#pyflakes#Handle(bufnr(''), [ + \ 'test.py:1: undefined name ''foo''', + \ 'test.py:1:7: invalid syntax', + \ ]) From 7455e2e97d0244c420c344ee1c737c93379bca4f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 18 Nov 2017 18:29:12 +0000 Subject: [PATCH 162/390] #852 - Capture error codes for checkstyle --- ale_linters/java/checkstyle.vim | 26 +++++++--------------- test/handler/test_checkstyle_handler.vader | 11 +++++---- 2 files changed, 15 insertions(+), 22 deletions(-) diff --git a/ale_linters/java/checkstyle.vim b/ale_linters/java/checkstyle.vim index d3d4884..8155170 100644 --- a/ale_linters/java/checkstyle.vim +++ b/ale_linters/java/checkstyle.vim @@ -2,27 +2,17 @@ " Description: checkstyle for Java files function! ale_linters#java#checkstyle#Handle(buffer, lines) abort - let l:patterns = [ - \ '\v\[(WARN|ERROR)\] .*:(\d+):(\d+): (.*)', - \ '\v\[(WARN|ERROR)\] .*:(\d+): (.*)', - \] + let l:pattern = '\v\[(WARN|ERROR)\] [a-zA-Z]?:?[^:]+:(\d+):(\d+)?:? (.*) \[(.+)\]$' let l:output = [] - for l:match in ale#util#GetMatches(a:lines, l:patterns) - let l:args = { + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'type': l:match[1] is? 'WARN' ? 'W' : 'E', \ 'lnum': l:match[2] + 0, - \ 'type': l:match[1] =~? 'WARN' ? 'W' : 'E' - \ } - - let l:col = l:match[3] + 0 - if l:col > 0 - let l:args['col'] = l:col - let l:args['text'] = l:match[4] - else - let l:args['text'] = l:match[3] - endif - - call add(l:output, l:args) + \ 'col': l:match[3] + 0, + \ 'text': l:match[4], + \ 'code': l:match[5], + \}) endfor return l:output diff --git a/test/handler/test_checkstyle_handler.vader b/test/handler/test_checkstyle_handler.vader index 0384451..2f1f0f8 100644 --- a/test/handler/test_checkstyle_handler.vader +++ b/test/handler/test_checkstyle_handler.vader @@ -9,17 +9,20 @@ Execute(The checkstyle handler should parse lines correctly): \ [ \ { \ 'lnum': 101, - \ 'text': "'method def rcurly' has incorrect indentation level 4, expected level should be 2. [Indentation]", + \ 'col': 0, + \ 'text': '''method def rcurly'' has incorrect indentation level 4, expected level should be 2.', + \ 'code': 'Indentation', \ 'type': 'W', \ }, \ { \ 'lnum': 63, \ 'col': 3, - \ 'text': "Missing a Javadoc comment. [JavadocMethod]", + \ 'text': 'Missing a Javadoc comment.', + \ 'code': 'JavadocMethod', \ 'type': 'W', \ }, \ ], \ ale_linters#java#checkstyle#Handle(666, [ - \ "[WARN] whatever:101: 'method def rcurly' has incorrect indentation level 4, expected level should be 2. [Indentation]", - \ "[WARN] whatever:63:3: Missing a Javadoc comment. [JavadocMethod]", + \ '[WARN] whatever:101: ''method def rcurly'' has incorrect indentation level 4, expected level should be 2. [Indentation]', + \ '[WARN] whatever:63:3: Missing a Javadoc comment. [JavadocMethod]', \ ]) From 2b50e68c7e2fb5df831f83ba89a7bd088629e1aa Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 18 Nov 2017 18:59:03 +0000 Subject: [PATCH 163/390] Add an FAQ entry explaining how to configure C or C++ projects --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 25fb72b..481e95a 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ servers with similar enough protocols, like `tsserver`. 11. [How can I use the quickfix list instead of the loclist?](#faq-quickfix) 12. [How can I check JSX files with both stylelint and eslint?](#faq-jsx-stylelint-eslint) 13. [Will this plugin eat all of my laptop battery power?](#faq-my-battery-is-sad) + 14. [How can I configure my C or C++ project?](#faq-c-configuration) @@ -614,3 +615,28 @@ still be an advantage. If you are still concerned, you can turn the automatic linting off altogether, including the option `g:ale_lint_on_enter`, and you can run ALE manually with `:ALELint`. + + + +### 5.xiv. How can I configure my C or C++ project? + +The structure of C and C++ projects varies wildly from project to project, with +many different build tools being used for building them, and many different +formats for project configuration files. ALE can run compilers easily, but +ALE cannot easily detect which compiler flags to use. + +Some tools and build configurations can generate +[compile_commands.json](https://clang.llvm.org/docs/JSONCompilationDatabase.html) +files. The `cppcheck`, `clangcheck` and `clangtidy` linters can read these +files for automatically determining the appropriate compiler flags to use. + +For linting with compilers like `gcc` and `clang`, and with other tools, you +will need to tell ALE which compiler flags to use yourself. You can use +different options for different projects with the `g:ale_pattern_options` +setting. Consult the documentation for that setting for more information. +`b:ale_linters` can be used to select which tools you want to run, say if you +want to use only `gcc` for one project, and only `clang` for another. + +You may also configure buffer-local settings for linters with project-specific +vimrc files. [local_vimrc](https://github.com/LucHermitte/local_vimrc) can be +used for executing local vimrc files which can be shared in your project. From cefc5dc5b8fc7cec75222f3cd4d090c1bd48f796 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 18 Nov 2017 23:15:23 +0000 Subject: [PATCH 164/390] #852 - Capture error codes for csslint --- autoload/ale/handlers/css.vim | 29 ++++++++++++------------- test/handler/test_common_handlers.vader | 6 +++-- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/autoload/ale/handlers/css.vim b/autoload/ale/handlers/css.vim index 4c1b81c..c7ae7c4 100644 --- a/autoload/ale/handlers/css.vim +++ b/autoload/ale/handlers/css.vim @@ -14,23 +14,22 @@ function! ale#handlers#css#HandleCSSLintFormat(buffer, lines) abort let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - let l:text = l:match[4] - let l:type = l:match[3] - - let l:group_match = matchlist(l:text, '\v^(.+) \((.+)\)$') - - " Put the error group at the front, so we can see what kind of error - " it is on small echo lines. - if !empty(l:group_match) - let l:text = '(' . l:group_match[2] . ') ' . l:group_match[1] - endif - - call add(l:output, { + let l:item = { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, - \ 'text': l:text, - \ 'type': l:type is# 'Warning' ? 'W' : 'E', - \}) + \ 'type': l:match[3] is# 'Warning' ? 'W' : 'E', + \ 'text': l:match[4], + \} + + let l:code_match = matchlist(l:match[4], '\v(.+) \(([^(]+)\)$') + + " Split up the error code and the text if we find one. + if !empty(l:code_match) + let l:item.text = l:code_match[1] + let l:item.code = l:code_match[2] + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_common_handlers.vader b/test/handler/test_common_handlers.vader index 65026d8..ee29da3 100644 --- a/test/handler/test_common_handlers.vader +++ b/test/handler/test_common_handlers.vader @@ -5,13 +5,15 @@ Execute(HandleCSSLintFormat should handle CSS errors): \ 'lnum': 2, \ 'col': 1, \ 'type': 'E', - \ 'text': '(errors) Expected RBRACE at line 2, col 1.', + \ 'text': 'Expected RBRACE at line 2, col 1.', + \ 'code': 'errors', \ }, \ { \ 'lnum': 2, \ 'col': 5, \ 'type': 'W', - \ 'text': '(known-properties) Expected ... but found ''wat''.', + \ 'text': 'Expected ... but found ''wat''.', + \ 'code': 'known-properties', \ }, \ ], \ ale#handlers#css#HandleCSSLintFormat(42, [ From 41cb174f3aeaa38e3d558a197a194c0161fa5b66 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 18 Nov 2017 23:55:47 +0000 Subject: [PATCH 165/390] #852 - Capture error codes for jscs --- ale_linters/javascript/jscs.vim | 14 +++++++++----- test/handler/test_jscs_handler.vader | 15 ++++++++++++--- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/ale_linters/javascript/jscs.vim b/ale_linters/javascript/jscs.vim index b3f826c..bcf3ee3 100644 --- a/ale_linters/javascript/jscs.vim +++ b/ale_linters/javascript/jscs.vim @@ -35,19 +35,23 @@ function! ale_linters#javascript#jscs#Handle(buffer, lines) abort " " foobar.js: line 2, col 1, Expected indentation of 1 characters " - let l:pattern = '^.*:\s\+line \(\d\+\),\s\+col\s\+\(\d\+\),\s\+\(.*\)$' + let l:pattern = '\v^.*:\s+line (\d+),\s+col\s+(\d+),\s+(.*)$' let l:output = [] - let l:m = ale#util#GetMatches(a:lines, [l:pattern]) - - for l:match in l:m - let l:text = l:match[3] + for l:match in ale#util#GetMatches(a:lines, l:pattern) let l:obj = { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, \ 'text': l:match[3] \} + let l:code_match = matchlist(l:match[3], '\v([^ :]+): (.+)$') + + if !empty(l:code_match) + let l:obj.code = l:code_match[1] + let l:obj.text = l:code_match[2] + endif + call add(l:output, l:obj) endfor diff --git a/test/handler/test_jscs_handler.vader b/test/handler/test_jscs_handler.vader index 6247307..5566116 100644 --- a/test/handler/test_jscs_handler.vader +++ b/test/handler/test_jscs_handler.vader @@ -10,21 +10,30 @@ Execute(jscs should parse lines correctly): \ { \ 'lnum': 1, \ 'col': 7, - \ 'text': 'disallowVar: Variable declarations should use `let` or `const` not `var`', + \ 'text': 'Variable declarations should use `let` or `const` not `var`', + \ 'code': 'disallowVar', \ }, \ { \ 'lnum': 3, \ 'col': 21, - \ 'text': 'disallowTrailingWhitespace: Illegal trailing whitespace', + \ 'text': 'Illegal trailing whitespace', + \ 'code': 'disallowTrailingWhitespace', \ }, \ { \ 'lnum': 5, \ 'col': 9, - \ 'text': 'disallowUnusedVariables: Variable `hello` is not used', + \ 'text': 'Variable `hello` is not used', + \ 'code': 'disallowUnusedVariables', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'text': 'Expected indentation of 1 characters', \ }, \ ], \ ale_linters#javascript#jscs#Handle(347, [ \ 'foobar.js: line 1, col 7, disallowVar: Variable declarations should use `let` or `const` not `var`', \ 'foobar.js: line 3, col 21, disallowTrailingWhitespace: Illegal trailing whitespace', \ 'foobar.js: line 5, col 9, disallowUnusedVariables: Variable `hello` is not used', + \ 'foobar.js: line 2, col 1, Expected indentation of 1 characters', \ ]) From 40e26f0bc2a00d25defe190bc277a0cf6ea71479 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 00:02:35 +0000 Subject: [PATCH 166/390] #852 - Capture error codes for luacheck --- ale_linters/lua/luacheck.vim | 3 ++- test/handler/test_lua_handler.vader | 14 ++++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/ale_linters/lua/luacheck.vim b/ale_linters/lua/luacheck.vim index 9f9ca4c..725153c 100644 --- a/ale_linters/lua/luacheck.vim +++ b/ale_linters/lua/luacheck.vim @@ -35,8 +35,9 @@ function! ale_linters#lua#luacheck#Handle(buffer, lines) abort call add(l:output, { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, - \ 'text': l:match[3] . l:match[4] . ': ' . l:match[5], \ 'type': l:match[3], + \ 'code': l:match[3] . l:match[4], + \ 'text': l:match[5], \}) endfor diff --git a/test/handler/test_lua_handler.vader b/test/handler/test_lua_handler.vader index 035dac2..7cebb01 100644 --- a/test/handler/test_lua_handler.vader +++ b/test/handler/test_lua_handler.vader @@ -1,6 +1,8 @@ Before: Save g:ale_warn_about_trailing_whitespace + let g:ale_warn_about_trailing_whitespace = 1 + runtime ale_linters/lua/luacheck.vim After: @@ -13,19 +15,22 @@ Execute(The luacheck handler should parse lines correctly): \ { \ 'lnum': 1, \ 'col': 8, - \ 'text': 'W612: line contains trailing whitespace', + \ 'text': 'line contains trailing whitespace', + \ 'code': 'W612', \ 'type': 'W', \ }, \ { \ 'lnum': 3, \ 'col': 5, - \ 'text': 'W213: unused loop variable ''k''', + \ 'text': 'unused loop variable ''k''', + \ 'code': 'W213', \ 'type': 'W', \ }, \ { \ 'lnum': 3, \ 'col': 19, - \ 'text': 'W113: accessing undefined variable ''x''', + \ 'text': 'accessing undefined variable ''x''', + \ 'code': 'W113', \ 'type': 'W', \ }, \ ], @@ -43,7 +48,8 @@ Execute(The luacheck handler should respect the warn_about_trailing_whitespace o \ { \ 'lnum': 5, \ 'col': 43, - \ 'text': 'W212: unused argument ''g''', + \ 'text': 'unused argument ''g''', + \ 'code': 'W212', \ 'type': 'W', \ } \ ], From 3c8f3221df1afe40ab8476c6b71a50a6f21df9c7 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 00:19:09 +0000 Subject: [PATCH 167/390] #852 - Capture error codes for mcs and mcsc --- ale_linters/cs/mcs.vim | 11 ++++++----- ale_linters/cs/mcsc.vim | 7 ++++--- test/handler/test_mcs_handler.vader | 9 ++++++--- test/handler/test_mcsc_handler.vader | 9 ++++++--- 4 files changed, 22 insertions(+), 14 deletions(-) diff --git a/ale_linters/cs/mcs.vim b/ale_linters/cs/mcs.vim index 3d042f9..b5c4054 100644 --- a/ale_linters/cs/mcs.vim +++ b/ale_linters/cs/mcs.vim @@ -8,15 +8,16 @@ function! ale_linters#cs#mcs#Handle(buffer, lines) abort " Look for lines like the following. " " Tests.cs(12,29): error CSXXXX: ; expected - let l:pattern = '^.\+.cs(\(\d\+\),\(\d\+\)): \(.\+\): \(.\+\)' + let l:pattern = '^\v(.+\.cs)\((\d+),(\d+)\)\: ([^ ]+) ([^ ]+): (.+)$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) call add(l:output, { - \ 'lnum': l:match[1] + 0, - \ 'col': l:match[2] + 0, - \ 'text': l:match[3] . ': ' . l:match[4], - \ 'type': l:match[3] =~# '^error' ? 'E' : 'W', + \ 'lnum': l:match[2] + 0, + \ 'col': l:match[3] + 0, + \ 'type': l:match[4] is# 'error' ? 'E' : 'W', + \ 'code': l:match[5], + \ 'text': l:match[6], \}) endfor diff --git a/ale_linters/cs/mcsc.vim b/ale_linters/cs/mcsc.vim index 38a0855..6e51ef3 100644 --- a/ale_linters/cs/mcsc.vim +++ b/ale_linters/cs/mcsc.vim @@ -60,7 +60,7 @@ function! ale_linters#cs#mcsc#Handle(buffer, lines) abort " NOTE: pattern also captures file name as linter compiles all " files within the source tree rooted at the specified source " path and not just the file loaded in the buffer - let l:pattern = '^\(.\+\.cs\)(\(\d\+\),\(\d\+\)): \(.\+\): \(.\+\)' + let l:pattern = '^\v(.+\.cs)\((\d+),(\d+)\)\: ([^ ]+) ([^ ]+): (.+)$' let l:output = [] let l:source = ale#Var(a:buffer, 'cs_mcsc_source') @@ -69,8 +69,9 @@ function! ale_linters#cs#mcsc#Handle(buffer, lines) abort \ 'filename': fnamemodify(l:source . '/' . l:match[1], ':p'), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, - \ 'text': l:match[4] . ': ' . l:match[5], - \ 'type': l:match[4] =~# '^error' ? 'E' : 'W', + \ 'type': l:match[4] is# 'error' ? 'E' : 'W', + \ 'code': l:match[5], + \ 'text': l:match[6], \}) endfor diff --git a/test/handler/test_mcs_handler.vader b/test/handler/test_mcs_handler.vader index 75a764a..3defc32 100644 --- a/test/handler/test_mcs_handler.vader +++ b/test/handler/test_mcs_handler.vader @@ -10,19 +10,22 @@ Execute(The mcs handler should handle cannot find symbol errors): \ { \ 'lnum': 12, \ 'col' : 29, - \ 'text': 'error CS1001: ; expected', + \ 'text': '; expected', + \ 'code': 'CS1001', \ 'type': 'E', \ }, \ { \ 'lnum': 101, \ 'col': 0, - \ 'text': 'error CS1028: Unexpected processor directive (no #if for this #endif)', + \ 'text': 'Unexpected processor directive (no #if for this #endif)', + \ 'code': 'CS1028', \ 'type': 'E', \ }, \ { \ 'lnum': 10, \ 'col': 12, - \ 'text': 'warning CS0123: some warning', + \ 'text': 'some warning', + \ 'code': 'CS0123', \ 'type': 'W', \ }, \ ], diff --git a/test/handler/test_mcsc_handler.vader b/test/handler/test_mcsc_handler.vader index 5f4c133..a000792 100644 --- a/test/handler/test_mcsc_handler.vader +++ b/test/handler/test_mcsc_handler.vader @@ -17,21 +17,24 @@ Execute(The mcs handler should handle cannot find symbol errors): \ { \ 'lnum': 12, \ 'col' : 29, - \ 'text': 'error CS1001: ; expected', + \ 'text': '; expected', + \ 'code': 'CS1001', \ 'type': 'E', \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), \ }, \ { \ 'lnum': 101, \ 'col': 0, - \ 'text': 'error CS1028: Unexpected processor directive (no #if for this #endif)', + \ 'text': 'Unexpected processor directive (no #if for this #endif)', + \ 'code': 'CS1028', \ 'type': 'E', \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), \ }, \ { \ 'lnum': 10, \ 'col': 12, - \ 'text': 'warning CS0123: some warning', + \ 'text': 'some warning', + \ 'code': 'CS0123', \ 'type': 'W', \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), \ }, From c012563984f0470a7c637b3b55cebea28b7a50b0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 00:38:00 +0000 Subject: [PATCH 168/390] #852 - Capture error codes for nimcheck --- ale_linters/nim/nimcheck.vim | 39 +++++++++++++++++------------ test/handler/test_nim_handler.vader | 10 +++++--- 2 files changed, 29 insertions(+), 20 deletions(-) diff --git a/ale_linters/nim/nimcheck.vim b/ale_linters/nim/nimcheck.vim index cdd8c56..bff45f7 100644 --- a/ale_linters/nim/nimcheck.vim +++ b/ale_linters/nim/nimcheck.vim @@ -10,33 +10,40 @@ function! ale_linters#nim#nimcheck#Handle(buffer, lines) abort " Only show errors of the current buffer " NOTE: Checking filename only is OK because nim enforces unique " module names. - let l:temp_buffer_filename = fnamemodify(l:match[1], ':p:t') + if l:buffer_filename isnot# '' && l:temp_buffer_filename isnot# l:buffer_filename continue endif - let l:line = l:match[2] + 0 - let l:column = l:match[3] + 0 - let l:text = l:match[4] - let l:type = 'W' + let l:item = { + \ 'lnum': l:match[2] + 0, + \ 'col': l:match[3] + 0, + \ 'text': l:match[4], + \ 'type': 'W', + \} " Extract error type from message of type 'Error: Some error message' - let l:textmatch = matchlist(l:match[4], '^\(.\{-}\): .\+$') + let l:error_match = matchlist(l:item.text, '^\(.\{-}\): \(.\+\)$') - if len(l:textmatch) > 0 - let l:errortype = l:textmatch[1] - if l:errortype is# 'Error' - let l:type = 'E' + if !empty(l:error_match) + if l:error_match[1] is# 'Error' + let l:item.type = 'E' + let l:item.text = l:error_match[2] + elseif l:error_match[1] is# 'Warning' + \|| l:error_match[1] is# 'Hint' + let l:item.text = l:error_match[2] endif endif - call add(l:output, { - \ 'lnum': l:line, - \ 'col': l:column, - \ 'text': l:text, - \ 'type': l:type, - \}) + let l:code_match = matchlist(l:item.text, '\v^(.+) \[([^ \[]+)\]$') + + if !empty(l:code_match) + let l:item.text = l:code_match[1] + let l:item.code = l:code_match[2] + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_nim_handler.vader b/test/handler/test_nim_handler.vader index 1f9de58..e484000 100644 --- a/test/handler/test_nim_handler.vader +++ b/test/handler/test_nim_handler.vader @@ -12,25 +12,27 @@ Execute(Parsing nim errors should work): \ { \ 'lnum': 8, \ 'col': 8, - \ 'text': 'Warning: use {.base.} for base methods; baseless methods are deprecated [UseBase]', + \ 'text': 'use {.base.} for base methods; baseless methods are deprecated', + \ 'code': 'UseBase', \ 'type': 'W', \ }, \ { \ 'lnum': 12, \ 'col': 2, - \ 'text': 'Error: identifier expected, but found ''a.barfoo''', + \ 'text': 'identifier expected, but found ''a.barfoo''', \ 'type': 'E', \ }, \ { \ 'lnum': 2, \ 'col': 5, - \ 'text': 'Hint: ''NotUsed'' is declared but not used [XDeclaredButNotUsed]', + \ 'text': '''NotUsed'' is declared but not used', + \ 'code': 'XDeclaredButNotUsed', \ 'type': 'W', \ }, \ { \ 'lnum': 12, \ 'col': 2, - \ 'text': 'Error: with : character', + \ 'text': 'with : character', \ 'type': 'E', \ }, \ ], From 7123f7236b5415c29f1b48c01d2528f71c457be2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 00:54:09 +0000 Subject: [PATCH 169/390] #852 - Capture error codes for reek --- ale_linters/ruby/reek.vim | 11 ++++++----- test/handler/test_reek_handler.vader | 15 ++++++++++----- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/ale_linters/ruby/reek.vim b/ale_linters/ruby/reek.vim index 10bc9a8..a11b9cf 100644 --- a/ale_linters/ruby/reek.vim +++ b/ale_linters/ruby/reek.vim @@ -13,6 +13,7 @@ function! ale_linters#ruby#reek#Handle(buffer, lines) abort \ 'lnum': l:location, \ 'type': 'W', \ 'text': s:BuildText(a:buffer, l:error), + \ 'code': l:error.smell_type, \}) endfor endfor @@ -21,19 +22,19 @@ function! ale_linters#ruby#reek#Handle(buffer, lines) abort endfunction function! s:BuildText(buffer, error) abort - let l:text = a:error.smell_type . ':' + let l:parts = [] if ale#Var(a:buffer, 'ruby_reek_show_context') - let l:text .= ' ' . a:error.context + call add(l:parts, a:error.context) endif - let l:text .= ' ' . a:error.message + call add(l:parts, a:error.message) if ale#Var(a:buffer, 'ruby_reek_show_wiki_link') - let l:text .= ' [' . a:error.wiki_link . ']' + call add(l:parts, '[' . a:error.wiki_link . ']') endif - return l:text + return join(l:parts, ' ') endfunction call ale#linter#Define('ruby', { diff --git a/test/handler/test_reek_handler.vader b/test/handler/test_reek_handler.vader index 6861428..db0a111 100644 --- a/test/handler/test_reek_handler.vader +++ b/test/handler/test_reek_handler.vader @@ -12,17 +12,20 @@ Execute(The reek handler should parse JSON correctly, with only context enabled) \ [ \ { \ 'lnum': 12, - \ 'text': 'Rule1: Context#method violates rule number one', + \ 'text': 'Context#method violates rule number one', + \ 'code': 'Rule1', \ 'type': 'W', \ }, \ { \ 'lnum': 34, - \ 'text': 'Rule2: Context#method violates rule number two', + \ 'text': 'Context#method violates rule number two', + \ 'code': 'Rule2', \ 'type': 'W', \ }, \ { \ 'lnum': 56, - \ 'text': 'Rule2: Context#method violates rule number two', + \ 'text': 'Context#method violates rule number two', + \ 'code': 'Rule2', \ 'type': 'W', \ }, \ ], @@ -38,7 +41,8 @@ Execute(The reek handler should parse JSON correctly, with no context or wiki li \ [ \ { \ 'lnum': 12, - \ 'text': 'Rule1: violates rule number one', + \ 'text': 'violates rule number one', + \ 'code': 'Rule1', \ 'type': 'W', \ }, \ ], @@ -54,7 +58,8 @@ Execute(The reek handler should parse JSON correctly, with both context and wiki \ [ \ { \ 'lnum': 12, - \ 'text': 'Rule1: Context#method violates rule number one [https://example.com/Rule1.md]', + \ 'text': 'Context#method violates rule number one [https://example.com/Rule1.md]', + \ 'code': 'Rule1', \ 'type': 'W', \ }, \ ], From 01b2971d0432d6d25af0c592b4e0b2fdc7adcf7d Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 01:08:20 +0000 Subject: [PATCH 170/390] #852 - Capture error codes for slim-lint --- ale_linters/slim/slimlint.vim | 13 +++++++++++-- test/handler/test_slim_handler.vader | 6 ++++-- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/ale_linters/slim/slimlint.vim b/ale_linters/slim/slimlint.vim index bb62c73..00c6b26 100644 --- a/ale_linters/slim/slimlint.vim +++ b/ale_linters/slim/slimlint.vim @@ -28,11 +28,20 @@ function! ale_linters#slim#slimlint#Handle(buffer, lines) abort let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - call add(l:output, { + let l:item = { \ 'lnum': l:match[1] + 0, \ 'type': l:match[2], \ 'text': l:match[3] - \}) + \} + + let l:code_match = matchlist(l:item.text, '\v^([^:]+): (.+)$') + + if !empty(l:code_match) + let l:item.code = l:code_match[1] + let l:item.text = l:code_match[2] + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_slim_handler.vader b/test/handler/test_slim_handler.vader index e8b6dcd..bfd29f3 100644 --- a/test/handler/test_slim_handler.vader +++ b/test/handler/test_slim_handler.vader @@ -11,12 +11,14 @@ Execute(The slim handler should parse lines correctly): \ [ \ { \ 'lnum': 1, - \ 'text': 'RedundantDiv: `div` is redundant when class attribute shortcut is present', + \ 'text': '`div` is redundant when class attribute shortcut is present', + \ 'code': 'RedundantDiv', \ 'type': 'W', \ }, \ { \ 'lnum': 2, - \ 'text': 'LineLength: Line is too long. [136/80]', + \ 'text': 'Line is too long. [136/80]', + \ 'code': 'LineLength', \ 'type': 'W', \ }, \ { From d7a60ade77a30d4eed517030a0c50a5eee059be0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 12:30:20 +0000 Subject: [PATCH 171/390] #852 - Capture error codes for stylelint --- autoload/ale/handlers/css.vim | 3 ++- test/handler/test_stylelint_handler.vader | 6 ++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/autoload/ale/handlers/css.vim b/autoload/ale/handlers/css.vim index c7ae7c4..de9eadc 100644 --- a/autoload/ale/handlers/css.vim +++ b/autoload/ale/handlers/css.vim @@ -61,7 +61,8 @@ function! ale#handlers#css#HandleStyleLintFormat(buffer, lines) abort \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, \ 'type': l:match[3] is# '✖' ? 'E' : 'W', - \ 'text': l:match[4] . ' [' . l:match[5] . ']', + \ 'text': l:match[4], + \ 'code': l:match[5], \}) endfor diff --git a/test/handler/test_stylelint_handler.vader b/test/handler/test_stylelint_handler.vader index 69de1ee..5cb3460 100644 --- a/test/handler/test_stylelint_handler.vader +++ b/test/handler/test_stylelint_handler.vader @@ -10,13 +10,15 @@ Execute (stylelint errors should be handled correctly): \ 'lnum': 108, \ 'col': 10, \ 'type': 'E', - \ 'text': 'Unexpected leading zero [number-leading-zero]', + \ 'text': 'Unexpected leading zero', + \ 'code': 'number-leading-zero', \ }, \ { \ 'lnum': 116, \ 'col': 20, \ 'type': 'E', - \ 'text': 'Expected a trailing semicolon [declaration-block-trailing-semicolon]', + \ 'text': 'Expected a trailing semicolon', + \ 'code': 'declaration-block-trailing-semicolon', \ }, \ ], \ ale#handlers#css#HandleStyleLintFormat(42, [ From b16c82f2f19aa7b1f1472e6d3cd2908708b56a00 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 12:46:06 +0000 Subject: [PATCH 172/390] #852 - Capture error codes for swaglint --- ale_linters/yaml/swaglint.vim | 8 ++++++++ test/handler/test_swaglint_handler.vader | 21 ++++++++++++++------- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/ale_linters/yaml/swaglint.vim b/ale_linters/yaml/swaglint.vim index 454cad0..75a496c 100644 --- a/ale_linters/yaml/swaglint.vim +++ b/ale_linters/yaml/swaglint.vim @@ -27,6 +27,14 @@ function! ale_linters#yaml#swaglint#Handle(buffer, lines) abort \ 'text': l:match[4], \} + " Parse the code if it's there. + let l:code_match = matchlist(l:obj.text, '\v^(.+) \(([^ (]+)\)$') + + if !empty(l:code_match) + let l:obj.text = l:code_match[1] + let l:obj.code = l:code_match[2] + endif + call add(l:output, l:obj) endfor diff --git a/test/handler/test_swaglint_handler.vader b/test/handler/test_swaglint_handler.vader index fbbae26..7ab1043 100644 --- a/test/handler/test_swaglint_handler.vader +++ b/test/handler/test_swaglint_handler.vader @@ -10,43 +10,50 @@ Execute(The swaglint handler should parse lines correctly): \ { \ 'lnum': 1, \ 'col': 1, - \ 'text': 'Missing required property: info (sway_object_missing_required_property)', + \ 'text': 'Missing required property: info', + \ 'code': 'sway_object_missing_required_property', \ 'type': 'E', \ }, \ { \ 'lnum': 6, \ 'col': 9, - \ 'text': 'Not a valid response definition (sway_one_of_missing)', + \ 'text': 'Not a valid response definition', + \ 'code': 'sway_one_of_missing', \ 'type': 'E', \ }, \ { \ 'lnum': 7, \ 'col': 11, - \ 'text': 'Missing required property: description (sway_object_missing_required_property)', + \ 'text': 'Missing required property: description', + \ 'code': 'sway_object_missing_required_property', \ 'type': 'E', \ }, \ { \ 'lnum': 7, \ 'col': 11, - \ 'text': 'Missing required property: $ref (sway_object_missing_required_property)', + \ 'text': 'Missing required property: $ref', + \ 'code': 'sway_object_missing_required_property', \ 'type': 'E', \ }, \ { \ 'lnum': 1, \ 'col': 10, - \ 'text': 'Expected type string but found type integer (sway_invalid_type)', + \ 'text': 'Expected type string but found type integer', + \ 'code': 'sway_invalid_type', \ 'type': 'E', \ }, \ { \ 'lnum': 1, \ 'col': 10, - \ 'text': 'No enum match for: 2 (sway_enum_mismatch)', + \ 'text': 'No enum match for: 2', + \ 'code': 'sway_enum_mismatch', \ 'type': 'E', \ }, \ { \ 'lnum': 14, \ 'col': 3, - \ 'text': 'Definition is not used: #/definitions/Foo (sway_unused_definition)', + \ 'text': 'Definition is not used: #/definitions/Foo', + \ 'code': 'sway_unused_definition', \ 'type': 'W', \ }, \ ], From fa7f0e2b85a252598023450336bbf4f3b320c1ef Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 13:33:20 +0000 Subject: [PATCH 173/390] #852 - Capture error codes for swiftlint --- ale_linters/swift/swiftlint.vim | 44 ++++++++++++++++++++++- test/handler/test_swiftlint_handler.vader | 14 ++++++-- 2 files changed, 54 insertions(+), 4 deletions(-) diff --git a/ale_linters/swift/swiftlint.vim b/ale_linters/swift/swiftlint.vim index b7dcf93..697d246 100644 --- a/ale_linters/swift/swiftlint.vim +++ b/ale_linters/swift/swiftlint.vim @@ -1,9 +1,51 @@ " Author: David Mohundro " Description: swiftlint for swift files + +function! ale_linters#swift#swiftlint#Handle(buffer, lines) abort + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:item = { + \ 'lnum': str2nr(l:match[2]), + \ 'type': l:match[4] is# 'error' ? 'E' : 'W', + \ 'text': l:match[5], + \} + + if l:match[4] is# 'error' + let l:item.type = 'E' + elseif l:match[4] is# 'note' + let l:item.type = 'I' + endif + + if !empty(l:match[3]) + let l:item.col = str2nr(l:match[3]) + endif + + " If the filename is something like , or -, then + " this is an error for the file we checked. + if l:match[1] isnot# '-' && l:match[1][0] isnot# '<' + let l:item['filename'] = l:match[1] + endif + + " Parse the code if it's there. + let l:code_match = matchlist(l:item.text, '\v^(.+) \(([^ (]+)\)$') + + if !empty(l:code_match) + let l:item.text = l:code_match[1] + let l:item.code = l:code_match[2] + endif + + call add(l:output, l:item) + endfor + + return l:output +endfunction + call ale#linter#Define('swift', { \ 'name': 'swiftlint', \ 'executable': 'swiftlint', \ 'command': 'swiftlint lint --use-stdin', -\ 'callback': 'ale#handlers#gcc#HandleGCCFormat', +\ 'callback': 'ale_linters#swift#swiftlint#Handle', \}) diff --git a/test/handler/test_swiftlint_handler.vader b/test/handler/test_swiftlint_handler.vader index b77b442..725ff97 100644 --- a/test/handler/test_swiftlint_handler.vader +++ b/test/handler/test_swiftlint_handler.vader @@ -1,21 +1,29 @@ +Before: + runtime ale_linters/swift/swiftlint.vim + +After: + call ale#linter#Reset() + Execute(The swiftint handler should parse error messages correctly): AssertEqual \ [ \ { \ 'lnum': 1, \ 'col': 7, - \ 'text': 'Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used. (operator_usage_whitespace)', + \ 'text': 'Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used.', + \ 'code': 'operator_usage_whitespace', \ 'type': 'W', \ }, \ { \ 'lnum': 1, \ 'col': 11, - \ 'text': 'Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used. (operator_usage_whitespace)', + \ 'text': 'Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used.', + \ 'code': 'operator_usage_whitespace', \ 'type': 'W', \ }, \ \ ], - \ ale#handlers#gcc#HandleGCCFormat(347, [ + \ ale_linters#swift#swiftlint#Handle(bufnr(''), [ \ 'This line should be ignored', \ ':1:7: warning: Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used. (operator_usage_whitespace)', \ ':1:11: warning: Operator Usage Whitespace Violation: Operators should be surrounded by a single whitespace when they are being used. (operator_usage_whitespace)', From 62904d39ee5dd89d14ff809cc505f7492cdddf4a Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 13:37:56 +0000 Subject: [PATCH 174/390] #852 - Capture error codes for tflint --- ale_linters/terraform/tflint.vim | 1 + test/handler/test_tflint_handler.vader | 3 +++ 2 files changed, 4 insertions(+) diff --git a/ale_linters/terraform/tflint.vim b/ale_linters/terraform/tflint.vim index 894be22..93966ff 100644 --- a/ale_linters/terraform/tflint.vim +++ b/ale_linters/terraform/tflint.vim @@ -23,6 +23,7 @@ function! ale_linters#terraform#tflint#Handle(buffer, lines) abort \ 'lnum': l:error.line, \ 'text': l:error.message, \ 'type': l:type, + \ 'code': l:error.detector, \}) endfor diff --git a/test/handler/test_tflint_handler.vader b/test/handler/test_tflint_handler.vader index 95671b8..099d092 100644 --- a/test/handler/test_tflint_handler.vader +++ b/test/handler/test_tflint_handler.vader @@ -10,16 +10,19 @@ Execute(The tflint handler should parse items correctly): \ { \ 'lnum': 12, \ 'text': 'be warned, traveller', + \ 'code': 'aws_db_instance_readable_password', \ 'type': 'W', \ }, \ { \ 'lnum': 9, \ 'text': 'error message', + \ 'code': 'aws_elasticache_cluster_invalid_type', \ 'type': 'E', \ }, \ { \ 'lnum': 5, \ 'text': 'just so ya know', + \ 'code': 'aws_instance_not_specified_iam_profile', \ 'type': 'I', \ }, \ ], From 151f9f857c415164f5865be270649a0797a0a7e7 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 13:56:09 +0000 Subject: [PATCH 175/390] Add an FAQ entry explaining how to configure ALE for different buffers. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ doc/ale.txt | 3 ++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 481e95a..1c69fb2 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ servers with similar enough protocols, like `tsserver`. 12. [How can I check JSX files with both stylelint and eslint?](#faq-jsx-stylelint-eslint) 13. [Will this plugin eat all of my laptop battery power?](#faq-my-battery-is-sad) 14. [How can I configure my C or C++ project?](#faq-c-configuration) + 15. [How can I configure ALE differently for different buffers?](#faq-buffer-configuration) @@ -640,3 +641,39 @@ want to use only `gcc` for one project, and only `clang` for another. You may also configure buffer-local settings for linters with project-specific vimrc files. [local_vimrc](https://github.com/LucHermitte/local_vimrc) can be used for executing local vimrc files which can be shared in your project. + + + +### 5.xv. How can I configure ALE differently for different buffers? + +ALE offers various ways to configure which linters or fixers are run, and +other settings. For the majority of ALE's settings, they can either be +configured globally with a `g:` variable prefix, or for a specific buffer +with a `b:` variable prefix. For example, you can configure a Python ftplugin +file like so. + +```vim +" In ~/.vim/ftplugin/python.vim + +" Check Python files with flake8 and pylint. +let b:ale_linters = ['flake8', 'pylint'] +" Fix Python files with autopep8 and yapf. +let b:ale_fixers = ['autopep8', 'yapf'] +" Disable warnings about trailing whitespace for Python files. +let b:ale_warn_about_trailing_whitespace = 0 +``` + +For configuring files based on regular expression patterns matched against the +absolute path to a file, you can use `g:ale_pattern_options`. + +```vim +" Do not lint or fix minified files. +let g:ale_pattern_options = { +\ '\.min\.js$': {'ale_linters': [], 'ale_fixers: []}, +\ '\.min\.css$': {'ale_linters': [], 'ale_fixers: []}, +\} +" If you configure g:ale_pattern_options outside of vimrc, you need this. +let g:ale_pattern_options_enabled = 1 +``` + +Buffer-local variables for settings always override the global settings. diff --git a/doc/ale.txt b/doc/ale.txt index 04f187d..ec201b1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -414,7 +414,8 @@ including disabling ALE for certain buffers with |b:ale_enabled|. The |g:ale_pattern_options| setting can be used to configure files differently based on regular expressions for filenames. For configuring entire projects, the buffer-local options can be used with external plugins for reading Vim -project configuration files. +project configuration files. Buffer-local settings can also be used in +ftplugin files for different filetypes. =============================================================================== From 344add6a28a5ee3ba0c6cae0182fdd20ca17d5ad Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 13:57:04 +0000 Subject: [PATCH 176/390] Fix a typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c69fb2..6ed4b1d 100644 --- a/README.md +++ b/README.md @@ -669,8 +669,8 @@ absolute path to a file, you can use `g:ale_pattern_options`. ```vim " Do not lint or fix minified files. let g:ale_pattern_options = { -\ '\.min\.js$': {'ale_linters': [], 'ale_fixers: []}, -\ '\.min\.css$': {'ale_linters': [], 'ale_fixers: []}, +\ '\.min\.js$': {'ale_linters': [], 'ale_fixers': []}, +\ '\.min\.css$': {'ale_linters': [], 'ale_fixers': []}, \} " If you configure g:ale_pattern_options outside of vimrc, you need this. let g:ale_pattern_options_enabled = 1 From 1afe2992e29c40e445ce29394d8923eb85cec6e2 Mon Sep 17 00:00:00 2001 From: RedBug312 Date: Mon, 20 Nov 2017 06:59:17 +0800 Subject: [PATCH 177/390] Make options configurable for iverilog (#1143) --- ale_linters/verilog/iverilog.vim | 10 +++++++++- test/test_verilog_iverilog_options.vader | 18 ++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 test/test_verilog_iverilog_options.vader diff --git a/ale_linters/verilog/iverilog.vim b/ale_linters/verilog/iverilog.vim index 18769d5..c64a3be 100644 --- a/ale_linters/verilog/iverilog.vim +++ b/ale_linters/verilog/iverilog.vim @@ -1,6 +1,14 @@ " Author: Masahiro H https://github.com/mshr-h " Description: iverilog for verilog files +call ale#Set('verilog_iverilog_options', '') + +function! ale_linters#verilog#iverilog#GetCommand(buffer) abort + return 'iverilog -t null -Wall ' + \ . ale#Var(a:buffer, 'verilog_iverilog_options') + \ . ' %t' +endfunction + function! ale_linters#verilog#iverilog#Handle(buffer, lines) abort " Look for lines like the following. " @@ -30,6 +38,6 @@ call ale#linter#Define('verilog', { \ 'name': 'iverilog', \ 'output_stream': 'stderr', \ 'executable': 'iverilog', -\ 'command': 'iverilog -t null -Wall %t', +\ 'command_callback': 'ale_linters#verilog#iverilog#GetCommand', \ 'callback': 'ale_linters#verilog#iverilog#Handle', \}) diff --git a/test/test_verilog_iverilog_options.vader b/test/test_verilog_iverilog_options.vader new file mode 100644 index 0000000..1fbaea2 --- /dev/null +++ b/test/test_verilog_iverilog_options.vader @@ -0,0 +1,18 @@ +Before: + Save g:ale_verilog_iverilog_options + let g:ale_verilog_iverilog_options = '' + +After: + Restore + call ale#linter#Reset() + +Execute(Set Verilog iverilog linter additional options to `-y.`): + runtime! ale_linters/verilog/iverilog.vim + + " Additional args for the linter + let g:ale_verilog_iverilog_options = '-y.' + + call ale#Lint() + + let g:cmd = ale_linters#verilog#iverilog#GetCommand(bufnr('')) + AssertEqual g:cmd, 'iverilog -t null -Wall -y. %t' From cc04a7aaa030de9e030728b86c0428de9cbb112c Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 23:06:12 +0000 Subject: [PATCH 178/390] Make the iverilog tests match the other tests --- .../test_iverilog_command_callback.vader | 24 +++++++++++++++++++ test/test_verilog_iverilog_options.vader | 18 -------------- 2 files changed, 24 insertions(+), 18 deletions(-) create mode 100644 test/command_callback/test_iverilog_command_callback.vader delete mode 100644 test/test_verilog_iverilog_options.vader diff --git a/test/command_callback/test_iverilog_command_callback.vader b/test/command_callback/test_iverilog_command_callback.vader new file mode 100644 index 0000000..2c63317 --- /dev/null +++ b/test/command_callback/test_iverilog_command_callback.vader @@ -0,0 +1,24 @@ +Before: + Save g:ale_verilog_iverilog_options + + unlet! g:ale_verilog_iverilog_options + + runtime ale_linters/verilog/iverilog.vim + +After: + Restore + + call ale#linter#Reset() + +Execute(The default iverilog command should be correct): + AssertEqual + \ 'iverilog -t null -Wall %t', + \ ale_linters#verilog#iverilog#GetCommand(bufnr('')) + +Execute(iverilog options should be configurable): + " Additional args for the linter + let g:ale_verilog_iverilog_options = '-y.' + + AssertEqual + \ 'iverilog -t null -Wall -y. %t', + \ ale_linters#verilog#iverilog#GetCommand(bufnr('')) diff --git a/test/test_verilog_iverilog_options.vader b/test/test_verilog_iverilog_options.vader deleted file mode 100644 index 1fbaea2..0000000 --- a/test/test_verilog_iverilog_options.vader +++ /dev/null @@ -1,18 +0,0 @@ -Before: - Save g:ale_verilog_iverilog_options - let g:ale_verilog_iverilog_options = '' - -After: - Restore - call ale#linter#Reset() - -Execute(Set Verilog iverilog linter additional options to `-y.`): - runtime! ale_linters/verilog/iverilog.vim - - " Additional args for the linter - let g:ale_verilog_iverilog_options = '-y.' - - call ale#Lint() - - let g:cmd = ale_linters#verilog#iverilog#GetCommand(bufnr('')) - AssertEqual g:cmd, 'iverilog -t null -Wall -y. %t' From 0cb8130d0e65d9a239c43ddb21d2f89b2815f10d Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 23:09:20 +0000 Subject: [PATCH 179/390] Stop the completion tests from failing randomly --- autoload/ale/completion.vim | 13 ++++++++++--- test/test_completion.vader | 4 ++++ 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index 90c9ae2..e471a3b 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -282,6 +282,15 @@ function! s:TimerHandler(...) abort endif endfunction +" Stop any completion timer that is queued. This is useful for tests. +function! ale#completion#StopTimer() abort + if s:timer_id != -1 + call timer_stop(s:timer_id) + endif + + let s:timer_id = -1 +endfunction + function! ale#completion#Queue() abort let l:time = get(b:, 'ale_complete_done_time', 0) @@ -298,9 +307,7 @@ function! ale#completion#Queue() abort let b:ale_completion_info.request_id = 0 endif - if s:timer_id != -1 - call timer_stop(s:timer_id) - endif + call ale#completion#StopTimer() let s:timer_id = timer_start(g:ale_completion_delay, function('s:TimerHandler')) endfunction diff --git a/test/test_completion.vader b/test/test_completion.vader index 18e50f5..3dfc205 100644 --- a/test/test_completion.vader +++ b/test/test_completion.vader @@ -41,6 +41,10 @@ After: delfunction CheckCompletionCalled + " Stop any timers we left behind. + " This stops the tests from failing randomly. + call ale#completion#StopTimer() + runtime autoload/ale/completion.vim runtime autoload/ale/lsp.vim From 597507e5197ef51037d01d30ad819a048eea9c9b Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 19 Nov 2017 23:44:02 +0000 Subject: [PATCH 180/390] Make the message formats configurable with buffer local variables --- autoload/ale/cursor.vim | 4 +++- autoload/ale/list.vim | 22 ++++++++++------------ doc/ale.txt | 6 ++++++ test/test_cursor_warnings.vader | 10 ++++++++++ test/test_list_formatting.vader | 24 ++++++++++++++++++++++++ 5 files changed, 53 insertions(+), 13 deletions(-) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 5a1d778..abe3c5a 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -69,10 +69,12 @@ function! s:EchoImpl() abort return endif + let l:buffer = bufnr('') let [l:info, l:loc] = s:FindItemAtCursor() if !empty(l:loc) - let l:msg = ale#GetLocItemMessage(l:loc, g:ale_echo_msg_format) + let l:format = ale#Var(l:buffer, 'echo_msg_format') + let l:msg = ale#GetLocItemMessage(l:loc, l:format) call ale#cursor#TruncatedEcho(l:msg) let l:info.echoed = 1 elseif get(l:info, 'echoed') diff --git a/autoload/ale/list.vim b/autoload/ale/list.vim index fbc71ef..b1a8d4a 100644 --- a/autoload/ale/list.vim +++ b/autoload/ale/list.vim @@ -37,16 +37,14 @@ function! ale#list#GetCombinedList() abort return l:list endfunction -function! s:FixList(list) abort +function! s:FixList(buffer, list) abort + let l:format = ale#Var(a:buffer, 'loclist_msg_format') let l:new_list = [] for l:item in a:list let l:fixed_item = copy(l:item) - let l:fixed_item.text = ale#GetLocItemMessage( - \ l:item, - \ g:ale_loclist_msg_format, - \) + let l:fixed_item.text = ale#GetLocItemMessage(l:item, l:format) if l:item.bufnr == -1 " If the buffer number is invalid, remove it. @@ -70,22 +68,22 @@ function! s:SetListsImpl(timer_id, buffer, loclist) abort let l:quickfix_list = ale#list#GetCombinedList() if has('nvim') - call setqflist(s:FixList(l:quickfix_list), ' ', l:title) + call setqflist(s:FixList(a:buffer, l:quickfix_list), ' ', l:title) else - call setqflist(s:FixList(l:quickfix_list)) + call setqflist(s:FixList(a:buffer, l:quickfix_list)) call setqflist([], 'r', {'title': l:title}) endif elseif g:ale_set_loclist " If windows support is off, bufwinid() may not exist. " We'll set result in the current window, which might not be correct, - " but is better than nothing. - let l:win_id = s:BufWinId(a:buffer) + " but it's better than nothing. + let l:id = s:BufWinId(a:buffer) if has('nvim') - call setloclist(l:win_id, s:FixList(a:loclist), ' ', l:title) + call setloclist(l:id, s:FixList(a:buffer, a:loclist), ' ', l:title) else - call setloclist(l:win_id, s:FixList(a:loclist)) - call setloclist(l:win_id, [], 'r', {'title': l:title}) + call setloclist(l:id, s:FixList(a:buffer, a:loclist)) + call setloclist(l:id, [], 'r', {'title': l:title}) endif endif diff --git a/doc/ale.txt b/doc/ale.txt index ec201b1..223f16c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -646,6 +646,7 @@ g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* g:ale_echo_msg_format *g:ale_echo_msg_format* +b:ale_echo_msg_format *b:ale_echo_msg_format* Type: |String| Default: `'%code: %%s'` @@ -672,6 +673,10 @@ g:ale_echo_msg_format *g:ale_echo_msg_format* |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed. + The echo message format can also be configured separately for each buffer, + so different formats can be used for differnt languages. (Say in ftplugin + files.) + g:ale_echo_msg_info_str *g:ale_echo_msg_info_str* @@ -1017,6 +1022,7 @@ g:ale_linters_explicit *g:ale_linters_explicit* g:ale_loclist_msg_format *g:ale_loclist_msg_format* +b:ale_loclist_msg_format *b:ale_loclist_msg_format* Type: |String| Default: `g:ale_echo_msg_format` diff --git a/test/test_cursor_warnings.vader b/test/test_cursor_warnings.vader index c6dc526..f112d8d 100644 --- a/test/test_cursor_warnings.vader +++ b/test/test_cursor_warnings.vader @@ -89,6 +89,7 @@ After: let g:ale_buffer_info = {} unlet! g:output + unlet! b:ale_loclist_msg_format delfunction GetLastMessage @@ -212,3 +213,12 @@ Execute(The %code% and %ifcode% should be removed when there's no code): call ale#cursor#EchoCursorWarning() AssertEqual 'Some information', GetLastMessage() + +Execute(The buffer message format option should take precedence): + let g:ale_echo_msg_format = '%(code) %%s' + let b:ale_echo_msg_format = 'FOO %s' + + call cursor(1, 14) + call ale#cursor#EchoCursorWarning() + + AssertEqual 'FOO Some information', GetLastMessage() diff --git a/test/test_list_formatting.vader b/test/test_list_formatting.vader index 6b494fc..0c52f10 100644 --- a/test/test_list_formatting.vader +++ b/test/test_list_formatting.vader @@ -28,6 +28,7 @@ After: Restore unlet! g:loclist + unlet! b:ale_loclist_msg_format delfunction AddItem @@ -162,3 +163,26 @@ Execute(Formatting with the linter name should work for the quickfix list): \ }, \ ], \ getqflist() + +Execute(The buffer loclist format option should take precedence): + let g:ale_loclist_msg_format = '(%linter%) %s' + let b:ale_loclist_msg_format = 'FOO %s' + + call AddItem({'text': 'whatever'}) + call ale#list#SetLists(bufnr(''), g:loclist) + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'bufnr': bufnr(''), + \ 'col': 1, + \ 'valid': 1, + \ 'vcol': 0, + \ 'nr': 0, + \ 'type': 'E', + \ 'pattern': '', + \ 'text': 'FOO whatever', + \ }, + \ ], + \ getloclist(0) From 9420c411bda14348a435a76bb415a3081940b285 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 20 Nov 2017 00:02:33 +0000 Subject: [PATCH 181/390] #1149 Fix conversion from URIs to filenames on Windows --- autoload/ale/path.vim | 9 ++++++++- test/test_path_uri.vader | 3 +++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index 83f6e85..bca0fe8 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -185,5 +185,12 @@ function! ale#path#FromURI(uri) abort let l:i = len('file://') let l:encoded_path = a:uri[: l:i - 1] is# 'file://' ? a:uri[l:i :] : a:uri - return ale#uri#Decode(l:encoded_path) + let l:path = ale#uri#Decode(l:encoded_path) + + " If the path is like /C:/foo/bar, it should be C:\foo\bar instead. + if l:path =~# '^/[a-zA-Z]:' + let l:path = substitute(l:path[1:], '/', '\\', 'g') + endif + + return l:path endfunction diff --git a/test/test_path_uri.vader b/test/test_path_uri.vader index dbceac3..a3e68d9 100644 --- a/test/test_path_uri.vader +++ b/test/test_path_uri.vader @@ -2,6 +2,9 @@ Execute(ale#path#ToURI should work for Windows paths): AssertEqual 'file:///C:/foo/bar/baz.tst', ale#path#ToURI('C:\foo\bar\baz.tst') AssertEqual 'foo/bar/baz.tst', ale#path#ToURI('foo\bar\baz.tst') +Execute(ale#path#FromURI should work for Windows paths): + AssertEqual 'C:\foo\bar\baz.tst', ale#path#FromURI('file:///C:/foo/bar/baz.tst') + Execute(ale#path#ToURI should work for Unix paths): AssertEqual 'file:///foo/bar/baz.tst', ale#path#ToURI('/foo/bar/baz.tst') AssertEqual 'foo/bar/baz.tst', ale#path#ToURI('foo/bar/baz.tst') From f224ce8a377bbb3a0deb78b98fdc6c43555791e2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 20 Nov 2017 10:43:45 +0000 Subject: [PATCH 182/390] Revert "Show problems from other files for gobuild and gometalinter" This reverts commit e721f851b41b8f6f31067ae2a137019e1cb5546c. --- ale_linters/go/gobuild.vim | 10 ++++++---- ale_linters/go/gometalinter.vim | 5 ++--- .../test_gometalinter_command_callback.vader | 3 +++ test/handler/test_gobuild_handler.vader | 5 ++--- test/handler/test_gometalinter_handler.vader | 8 +++----- 5 files changed, 16 insertions(+), 15 deletions(-) diff --git a/ale_linters/go/gobuild.vim b/ale_linters/go/gobuild.vim index 783b9e0..143c2fd 100644 --- a/ale_linters/go/gobuild.vim +++ b/ale_linters/go/gobuild.vim @@ -1,5 +1,4 @@ -" Author: Joshua Rubin , Ben Reedy , -" Jeff Willette +" Author: Joshua Rubin , Ben Reedy " Description: go build for Go files " inspired by work from dzhou121 @@ -40,12 +39,15 @@ function! ale_linters#go#gobuild#GetMatches(lines) abort endfunction function! ale_linters#go#gobuild#Handler(buffer, lines) abort - let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gobuild#GetMatches(a:lines) + " Omit errors from imported go packages + if !ale#path#IsBufferPath(a:buffer, l:match[1]) + continue + endif + call add(l:output, { - \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'text': l:match[4], diff --git a/ale_linters/go/gometalinter.vim b/ale_linters/go/gometalinter.vim index 7f75c44..f1abfc8 100644 --- a/ale_linters/go/gometalinter.vim +++ b/ale_linters/go/gometalinter.vim @@ -1,4 +1,4 @@ -" Author: Ben Reedy , Jeff Willette +" Author: Ben Reedy " Description: Adds support for the gometalinter suite for Go files call ale#Set('go_gometalinter_options', '') @@ -14,6 +14,7 @@ function! ale_linters#go#gometalinter#GetCommand(buffer) abort let l:options = ale#Var(a:buffer, 'go_gometalinter_options') return ale#Escape(l:executable) + \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(l:filename)) \ . (!empty(l:options) ? ' ' . l:options : '') \ . ' ' . ale#Escape(fnamemodify(l:filename, ':h')) endfunction @@ -25,12 +26,10 @@ function! ale_linters#go#gometalinter#GetMatches(lines) abort endfunction function! ale_linters#go#gometalinter#Handler(buffer, lines) abort - let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gometalinter#GetMatches(a:lines) call add(l:output, { - \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'type': tolower(l:match[4]) is# 'warning' ? 'W' : 'E', diff --git a/test/command_callback/test_gometalinter_command_callback.vader b/test/command_callback/test_gometalinter_command_callback.vader index b45d811..912396c 100644 --- a/test/command_callback/test_gometalinter_command_callback.vader +++ b/test/command_callback/test_gometalinter_command_callback.vader @@ -22,6 +22,7 @@ Execute(The gometalinter callback should return the right defaults): \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual \ ale#Escape('gometalinter') + \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) @@ -33,6 +34,7 @@ Execute(The gometalinter callback should use a configured executable): \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual \ ale#Escape('something else') + \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) @@ -41,6 +43,7 @@ Execute(The gometalinter callback should use configured options): AssertEqual \ ale#Escape('gometalinter') + \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) \ . ' --foobar' \ . ' ' . ale#Escape(getcwd()), \ ale_linters#go#gometalinter#GetCommand(bufnr('')) diff --git a/test/handler/test_gobuild_handler.vader b/test/handler/test_gobuild_handler.vader index ec77f9c..ce2119c 100644 --- a/test/handler/test_gobuild_handler.vader +++ b/test/handler/test_gobuild_handler.vader @@ -28,7 +28,7 @@ Execute (The gobuild handler should handle names with spaces): \ ]), 'v:val[1:4]') Execute (The gobuild handler should handle relative paths correctly): - call ale#test#SetFilename('app/test.go') + silent file! /foo/bar/baz.go AssertEqual \ [ @@ -37,9 +37,8 @@ Execute (The gobuild handler should handle relative paths correctly): \ 'col': 0, \ 'text': 'missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ 'type': 'E', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gobuild#Handler(bufnr(''), [ - \ 'test.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', + \ 'baz.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ ]) diff --git a/test/handler/test_gometalinter_handler.vader b/test/handler/test_gometalinter_handler.vader index 127d093..603ba22 100644 --- a/test/handler/test_gometalinter_handler.vader +++ b/test/handler/test_gometalinter_handler.vader @@ -30,7 +30,7 @@ Execute (The gometalinter handler should handle names with spaces): \ ]), 'v:val[1:5]') Execute (The gometalinter handler should handle relative paths correctly): - call ale#test#SetFilename('app/test.go') + silent file /foo/bar/baz.go AssertEqual \ [ @@ -39,17 +39,15 @@ Execute (The gometalinter handler should handle relative paths correctly): \ 'col': 3, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (staticcheck)', \ 'type': 'W', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ { \ 'lnum': 37, \ 'col': 5, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (golint)', \ 'type': 'E', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gometalinter#Handler(bufnr(''), [ - \ 'test.go:12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', - \ 'test.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', + \ 'baz.go:12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', + \ 'baz.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', \ ]) From f20e5a4cf0e56c3c89ef7be4730924be377e5f61 Mon Sep 17 00:00:00 2001 From: Shogo NAMEKI Date: Mon, 20 Nov 2017 19:57:13 +0900 Subject: [PATCH 183/390] Add `drafter` for checking API Blueprint files (#1152) --- README.md | 1 + ale_linters/apiblueprint/drafter.vim | 36 ++++++++++++++++++++++++ doc/ale.txt | 1 + test/handler/test_drafter_handler.vader | 37 +++++++++++++++++++++++++ 4 files changed, 75 insertions(+) create mode 100644 ale_linters/apiblueprint/drafter.vim create mode 100644 test/handler/test_drafter_handler.vader diff --git a/README.md b/README.md index 6ed4b1d..7382789 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ formatting. | -------- | ----- | | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | +| API Blueprint | [drafter](https://github.com/apiaryio/drafter) | | AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/)| | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | diff --git a/ale_linters/apiblueprint/drafter.vim b/ale_linters/apiblueprint/drafter.vim new file mode 100644 index 0000000..9cded35 --- /dev/null +++ b/ale_linters/apiblueprint/drafter.vim @@ -0,0 +1,36 @@ +" Author: nametake https://nametake.github.io +" Description: apiblueprint parser + +function! ale_linters#apiblueprint#drafter#HandleErrors(buffer, lines) abort + " Matches patterns line the following: + " + " warning: (3) unable to parse response signature, expected 'response [] [()]'; line 4, column 3k - line 4, column 22 + " warning: (10) message-body asset is expected to be a pre-formatted code block, separate it by a newline and indent every of its line by 12 spaces or 3 tabs; line 30, column 5 - line 30, column 9; line 31, column 9 - line 31, column 14; line 32, column 9 - line 32, column 14 + let l:pattern = '\(^.*\): (\d\+) \(.\{-\}\); line \(\d\+\), column \(\d\+\) - line \d\+, column \d\+\(.*; line \d\+, column \d\+ - line \(\d\+\), column \(\d\+\)\)\{-\}$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines[2:], l:pattern) + let l:item = { + \ 'type': l:match[1] is# 'warning' ? 'W' : 'E', + \ 'text': l:match[2], + \ 'lnum': l:match[3] + 0, + \ 'col': l:match[4] + 0, + \} + if l:match[5] isnot# '' + let l:item.end_lnum = l:match[6] + 0 + let l:item.end_col = l:match[7] + 0 + endif + call add(l:output, l:item) + endfor + + return l:output +endfunction + + +call ale#linter#Define('apiblueprint', { +\ 'name': 'drafter', +\ 'output_stream': 'stderr', +\ 'executable': 'drafter', +\ 'command': 'drafter --use-line-num --validate %t', +\ 'callback': 'ale_linters#apiblueprint#drafter#HandleErrors', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index 223f16c..6399111 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -264,6 +264,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` +* API Blueprint: `drafter` * AsciiDoc: `proselint`, `write-good`, `redpen` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` diff --git a/test/handler/test_drafter_handler.vader b/test/handler/test_drafter_handler.vader new file mode 100644 index 0000000..1524dde --- /dev/null +++ b/test/handler/test_drafter_handler.vader @@ -0,0 +1,37 @@ +Before: + runtime! ale_linters/apiblueprint/drafter.vim + +After: + call ale#linter#Reset() + +Execute(drafter handler should handle errors output): + AssertEqual + \ [ + \ { + \ 'lnum': 25, + \ 'col': 3, + \ 'text': "unable to parse response signature, expected 'response [] [()]'", + \ 'type': "W", + \ }, + \ { + \ 'lnum': 25, + \ 'col': 3, + \ 'text': "missing response HTTP status code, assuming 'Response 200'", + \ 'type': "W", + \ }, + \ { + \ 'lnum': 30, + \ 'col': 7, + \ 'end_lnum': 32, + \ 'end_col': 7, + \ 'text': "message-body asset is expected to be a pre-formatted code block, separate it by a newline and indent every of its line by 12 spaces or 3 tabs", + \ 'type': "W", + \ }, + \ ], + \ ale_linters#apiblueprint#drafter#HandleErrors(bufnr(''), [ + \ "", + \ "OK.", + \ "warning: (3) unable to parse response signature, expected 'response [] [()]'; line 25, column 3 - line 25, column 29", + \ "warning: (6) missing response HTTP status code, assuming 'Response 200'; line 25, column 3 - line 25, column 29", + \ "warning: (10) message-body asset is expected to be a pre-formatted code block, separate it by a newline and indent every of its line by 12 spaces or 3 tabs; line 30, column 7 - line 30, column 11; line 31, column 6 - line 31, column 7; line 32, column 6 - line 32, column 7" + \ ]) From b9f02ffb275b1d120967ab163e79959d3673ffd6 Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Mon, 20 Nov 2017 23:50:14 +0900 Subject: [PATCH 184/390] Added filename key for `go build` linter - Re: f224ce8a377bbb3a0deb78b98fdc6c43555791e2 - The issues that prompted the above commit which reverted changes made to `go build` and `gometalinter` seemed to suggest that the main issue was with gometalinter and that changes should be put into different commits so they are independent of each other - This commit reinstates the changes to the `go build` linter which seem to be uncontested and it also seems absolutely necessary to show errors from all files in the package which may have caused a build failure. --- ale_linters/go/gobuild.vim | 10 ++++------ test/handler/test_gobuild_handler.vader | 5 +++-- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/ale_linters/go/gobuild.vim b/ale_linters/go/gobuild.vim index 143c2fd..783b9e0 100644 --- a/ale_linters/go/gobuild.vim +++ b/ale_linters/go/gobuild.vim @@ -1,4 +1,5 @@ -" Author: Joshua Rubin , Ben Reedy +" Author: Joshua Rubin , Ben Reedy , +" Jeff Willette " Description: go build for Go files " inspired by work from dzhou121 @@ -39,15 +40,12 @@ function! ale_linters#go#gobuild#GetMatches(lines) abort endfunction function! ale_linters#go#gobuild#Handler(buffer, lines) abort + let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gobuild#GetMatches(a:lines) - " Omit errors from imported go packages - if !ale#path#IsBufferPath(a:buffer, l:match[1]) - continue - endif - call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'text': l:match[4], diff --git a/test/handler/test_gobuild_handler.vader b/test/handler/test_gobuild_handler.vader index ce2119c..ec77f9c 100644 --- a/test/handler/test_gobuild_handler.vader +++ b/test/handler/test_gobuild_handler.vader @@ -28,7 +28,7 @@ Execute (The gobuild handler should handle names with spaces): \ ]), 'v:val[1:4]') Execute (The gobuild handler should handle relative paths correctly): - silent file! /foo/bar/baz.go + call ale#test#SetFilename('app/test.go') AssertEqual \ [ @@ -37,8 +37,9 @@ Execute (The gobuild handler should handle relative paths correctly): \ 'col': 0, \ 'text': 'missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ 'type': 'E', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gobuild#Handler(bufnr(''), [ - \ 'baz.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', + \ 'test.go:27: missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ ]) From c9e203e6204314b55aed76c49f57aaf8ab826c90 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 20 Nov 2017 16:42:43 +0000 Subject: [PATCH 185/390] Fix #859 Include test and jaxb Java source paths when available --- ale_linters/java/javac.vim | 26 ++++++++++++++- .../src/test/java/com/something/dummy | 0 .../src/main/java/com/something/dummy | 0 .../src/main/jaxb/com/something/dummy | 0 .../test_javac_command_callback.vader | 32 ++++++++++++++++++- 5 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 test/command_callback/java_paths/src/test/java/com/something/dummy create mode 100644 test/command_callback/java_paths_with_jaxb/src/main/java/com/something/dummy create mode 100644 test/command_callback/java_paths_with_jaxb/src/main/jaxb/com/something/dummy diff --git a/ale_linters/java/javac.vim b/ale_linters/java/javac.vim index f7da560..73e8414 100644 --- a/ale_linters/java/javac.vim +++ b/ale_linters/java/javac.vim @@ -41,9 +41,33 @@ function! ale_linters#java#javac#GetCommand(buffer, import_paths) abort " Find the src directory, for files in this project. let l:src_dir = ale#path#FindNearestDirectory(a:buffer, 'src/main/java') + let l:sp_dirs = [] if !empty(l:src_dir) - let l:sp_option = '-sourcepath ' . ale#Escape(l:src_dir) + call add(l:sp_dirs, l:src_dir) + + " Automatically include the jaxb directory too, if it's there. + let l:jaxb_dir = fnamemodify(l:src_dir, ':h:h') + \ . (has('win32') ? '\jaxb\' : '/jaxb/') + + if isdirectory(l:jaxb_dir) + call add(l:sp_dirs, l:jaxb_dir) + endif + + " Automatically include the test directory, but only for test code. + if expand('#' . a:buffer . ':p') =~? '\vsrc[/\\]test[/\\]java' + let l:test_dir = fnamemodify(l:src_dir, ':h:h:h') + \ . (has('win32') ? '\test\java\' : '/test/java/') + + if isdirectory(l:test_dir) + call add(l:sp_dirs, l:test_dir) + endif + endif + endif + + if !empty(l:sp_dirs) + let l:sp_option = '-sourcepath ' + \ . ale#Escape(join(l:sp_dirs, s:classpath_sep)) endif " Create .class files in a temporary directory, which we will delete later. diff --git a/test/command_callback/java_paths/src/test/java/com/something/dummy b/test/command_callback/java_paths/src/test/java/com/something/dummy new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/java_paths_with_jaxb/src/main/java/com/something/dummy b/test/command_callback/java_paths_with_jaxb/src/main/java/com/something/dummy new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/java_paths_with_jaxb/src/main/jaxb/com/something/dummy b/test/command_callback/java_paths_with_jaxb/src/main/jaxb/com/something/dummy new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_javac_command_callback.vader b/test/command_callback/test_javac_command_callback.vader index 77be1d5..fe54530 100644 --- a/test/command_callback/test_javac_command_callback.vader +++ b/test/command_callback/test_javac_command_callback.vader @@ -116,7 +116,7 @@ Execute(The javac callback should combine discovered classpaths and manual ones) Execute(The javac callback should detect source directories): call ale#engine#Cleanup(bufnr('')) - :e! java_paths/src/main/java/com/something/dummy + noautocmd e! java_paths/src/main/java/com/something/dummy call ale#engine#InitBufferInfo(bufnr('')) AssertEqual @@ -155,3 +155,33 @@ Execute(The javac callback should use g:ale_java_javac_options correctly): \ g:prefix \ . ' -d TEMP --anything --else %t', \ GetCommand([]) + +Execute(The javac callback should include src/test/java for test paths): + call ale#engine#Cleanup(bufnr('')) + " The test path is only included for test files. + " Regular Java files shouldn't import from tests. + noautocmd e! java_paths/src/test/java/com/something/dummy + call ale#engine#InitBufferInfo(bufnr('')) + + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' + \ . ' -sourcepath ' . ale#Escape(join([ + \ ale#path#Winify(g:dir . '/java_paths/src/main/java/'), + \ ale#path#Winify(g:dir . '/java_paths/src/test/java/'), + \ ], g:cp_sep)) + \ . ' -d TEMP %t', + \ GetCommand([]) + +Execute(The javac callback should include src/main/jaxb when available): + call ale#engine#Cleanup(bufnr('')) + noautocmd e! java_paths_with_jaxb/src/main/java/com/something/dummy + call ale#engine#InitBufferInfo(bufnr('')) + + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' + \ . ' -sourcepath ' . ale#Escape(join([ + \ ale#path#Winify(g:dir . '/java_paths_with_jaxb/src/main/java/'), + \ ale#path#Winify(g:dir . '/java_paths_with_jaxb/src/main/jaxb/'), + \ ], g:cp_sep)) + \ . ' -d TEMP %t', + \ GetCommand([]) From 7ea3aba5e587f1993c0377ed270b5cbd823e3711 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 00:21:45 +0000 Subject: [PATCH 186/390] Quietly add go to definition support for tsserver --- autoload/ale/definition.vim | 82 ++++++++++++++ autoload/ale/lsp/tsserver_message.vim | 8 ++ plugin/ale.vim | 6 ++ test/lsp/test_lsp_client_messages.vader | 13 +++ test/test_go_to_definition.vader | 138 ++++++++++++++++++++++++ 5 files changed, 247 insertions(+) create mode 100644 autoload/ale/definition.vim create mode 100644 test/test_go_to_definition.vader diff --git a/autoload/ale/definition.vim b/autoload/ale/definition.vim new file mode 100644 index 0000000..4b062b3 --- /dev/null +++ b/autoload/ale/definition.vim @@ -0,0 +1,82 @@ +" Author: w0rp +" Description: Go to definition support for LSP linters. + +let s:go_to_definition_map = {} + +" Used to get the definition map in tests. +function! ale#definition#GetMap() abort + return deepcopy(s:go_to_definition_map) +endfunction + +" Used to set the definition map in tests. +function! ale#definition#SetMap(map) abort + let s:go_to_definition_map = a:map +endfunction + +" This function is used so we can check the execution of commands without +" running them. +function! ale#definition#Execute(expr) abort + execute a:expr +endfunction + +function! ale#definition#Open(options, filename, line, column) abort + if a:options.open_in_tab + call ale#definition#Execute('tabedit ' . fnameescape(a:filename)) + else + call ale#definition#Execute('edit ' . fnameescape(a:filename)) + endif + + call cursor(a:line, a:column) +endfunction + +function! ale#definition#HandleTSServerResponse(conn_id, response) abort + if get(a:response, 'command', '') is# 'definition' + \&& has_key(s:go_to_definition_map, a:response.request_seq) + let l:options = remove(s:go_to_definition_map, a:response.request_seq) + + if get(a:response, 'success', v:false) is v:true + let l:filename = a:response.body[0].file + let l:line = a:response.body[0].start.line + let l:column = a:response.body[0].start.offset + + call ale#definition#Open(l:options, l:filename, l:line, l:column) + endif + endif +endfunction + +function! s:GoToLSPDefinition(linter, options) abort + let l:buffer = bufnr('') + let [l:line, l:column] = getcurpos()[1:2] + + let l:lsp_details = ale#linter#StartLSP( + \ l:buffer, + \ a:linter, + \ function('ale#definition#HandleTSServerResponse'), + \) + + if empty(l:lsp_details) + return 0 + endif + + let l:id = l:lsp_details.connection_id + let l:root = l:lsp_details.project_root + + let l:message = ale#lsp#tsserver_message#Definition( + \ l:buffer, + \ l:line, + \ l:column + \) + let l:request_id = ale#lsp#Send(l:id, l:message, l:root) + + let s:go_to_definition_map[l:request_id] = { + \ 'open_in_tab': get(a:options, 'open_in_tab', 0), + \} +endfunction + +function! ale#definition#GoTo(options) abort + for l:linter in ale#linter#Get(&filetype) + if l:linter.lsp is# 'tsserver' + call s:GoToLSPDefinition(l:linter, a:options) + endif + endfor +endfunction diff --git a/autoload/ale/lsp/tsserver_message.vim b/autoload/ale/lsp/tsserver_message.vim index e2706ed..b9bd7a0 100644 --- a/autoload/ale/lsp/tsserver_message.vim +++ b/autoload/ale/lsp/tsserver_message.vim @@ -53,3 +53,11 @@ function! ale#lsp#tsserver_message#CompletionEntryDetails(buffer, line, column, \ 'entryNames': a:entry_names, \}] endfunction + +function! ale#lsp#tsserver_message#Definition(buffer, line, column) abort + return [0, 'ts@definition', { + \ 'line': a:line, + \ 'offset': a:column, + \ 'file': expand('#' . a:buffer . ':p'), + \}] +endfunction diff --git a/plugin/ale.vim b/plugin/ale.vim index d9710fa..a8bce1b 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -247,6 +247,10 @@ command! -bar ALEFix :call ale#fix#Fix() " Suggest registered functions to use for fixing problems. command! -bar ALEFixSuggest :call ale#fix#registry#Suggest(&filetype) +" Go to definition for tsserver and LSP +command! -bar ALEGoToDefinition :call ale#definition#GoTo({}) +command! -bar ALEGoToDefinitionInTab :call ale#definition#GoTo({'open_in_tab': 1}) + " mappings for commands nnoremap (ale_previous) :ALEPrevious nnoremap (ale_previous_wrap) :ALEPreviousWrap @@ -265,6 +269,8 @@ nnoremap (ale_reset_buffer) :ALEResetBuffer nnoremap (ale_lint) :ALELint nnoremap (ale_detail) :ALEDetail nnoremap (ale_fix) :ALEFix +nnoremap (ale_go_to_definition) :ALEGoToDefinition +nnoremap (ale_go_to_definition_in_tab) :ALEGoToDefinitionInTab " Set up autocmd groups now. call ale#toggle#InitAuGroups() diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index a7660ce..c6d82b6 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -177,3 +177,16 @@ Execute(ale#lsp#tsserver_message#CompletionEntryDetails() should return correct \ } \ ], \ ale#lsp#tsserver_message#CompletionEntryDetails(bufnr(''), 347, 12, ['foo', 'bar']) + +Execute(ale#lsp#tsserver_message#Definition() should return correct messages): + AssertEqual + \ [ + \ 0, + \ 'ts@definition', + \ { + \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'line': 347, + \ 'offset': 12, + \ } + \ ], + \ ale#lsp#tsserver_message#Definition(bufnr(''), 347, 12) diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader new file mode 100644 index 0000000..c6e8771 --- /dev/null +++ b/test/test_go_to_definition.vader @@ -0,0 +1,138 @@ +Before: + call ale#test#SetDirectory('/testplugin/test') + call ale#test#SetFilename('dummy.txt') + + let g:old_filename = expand('%:p') + let g:Callback = 0 + let g:message = [] + let g:expr_list = [] + + runtime autoload/ale/definition.vim + runtime autoload/ale/linter.vim + runtime autoload/ale/lsp.vim + + function! ale#linter#StartLSP(buffer, linter, callback) abort + let g:Callback = a:callback + + return { + \ 'connection_id': 347, + \ 'project_root': '/foo/bar', + \} + endfunction + + function! ale#lsp#Send(conn_id, message, root) abort + let g:message = a:message + + return 42 + endfunction + + function! ale#definition#Execute(expr) abort + call add(g:expr_list, a:expr) + endfunction + +After: + call ale#test#RestoreDirectory() + call ale#linter#Reset() + + unlet! g:old_filename + unlet! g:Callback + unlet! g:message + unlet! g:expr_list + + runtime autoload/ale/definition.vim + runtime autoload/ale/linter.vim + runtime autoload/ale/lsp.vim + +Execute(Other messages for the tsserver handler should be ignored): + call ale#definition#HandleTSServerResponse(1, {'command': 'foo'}) + +Execute(Failed definition responses should be handled correctly): + call ale#definition#SetMap({3: {'open_in_tab': 0}}) + call ale#definition#HandleTSServerResponse( + \ 1, + \ {'command': 'definition', 'request_seq': 3} + \) + AssertEqual {}, ale#definition#GetMap() + +Given typescript(Some typescript file): + foo + somelongerline + bazxyzxyzxyz + +Execute(Other files should be jumped to for definition responses): + call ale#definition#SetMap({3: {'open_in_tab': 0}}) + call ale#definition#HandleTSServerResponse( + \ 1, + \ { + \ 'command': 'definition', + \ 'request_seq': 3, + \ 'success': v:true, + \ 'body': [ + \ { + \ 'file': g:dir . '/completion_dummy_file', + \ 'start': {'line': 3, 'offset': 7}, + \ }, + \ ], + \ } + \) + + AssertEqual + \ [ + \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ ], + \ g:expr_list + AssertEqual [3, 7], getpos('.')[1:2] + AssertEqual {}, ale#definition#GetMap() + +Execute(Other files should be jumped to for definition responses in tabs too): + call ale#definition#SetMap({3: {'open_in_tab': 1}}) + call ale#definition#HandleTSServerResponse( + \ 1, + \ { + \ 'command': 'definition', + \ 'request_seq': 3, + \ 'success': v:true, + \ 'body': [ + \ { + \ 'file': g:dir . '/completion_dummy_file', + \ 'start': {'line': 3, 'offset': 7}, + \ }, + \ ], + \ } + \) + + AssertEqual + \ [ + \ 'tabedit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ ], + \ g:expr_list + AssertEqual [3, 7], getpos('.')[1:2] + AssertEqual {}, ale#definition#GetMap() + +Execute(tsserver completion requests should be sent): + runtime ale_linters/typescript/tsserver.vim + call setpos('.', [bufnr(''), 2, 5, 0]) + + ALEGoToDefinition + + AssertEqual + \ 'function(''ale#definition#HandleTSServerResponse'')', + \ string(g:Callback) + AssertEqual + \ [0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}], + \ g:message + AssertEqual {'42': {'open_in_tab': 0}}, ale#definition#GetMap() + +Execute(tsserver tab completion requests should be sent): + runtime ale_linters/typescript/tsserver.vim + call setpos('.', [bufnr(''), 2, 5, 0]) + + ALEGoToDefinitionInTab + + AssertEqual + \ 'function(''ale#definition#HandleTSServerResponse'')', + \ string(g:Callback) + AssertEqual + \ [0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}], + \ g:message + AssertEqual {'42': {'open_in_tab': 1}}, ale#definition#GetMap() From d465b7136277d2dbf2b2fd905711eecc3a355475 Mon Sep 17 00:00:00 2001 From: rhysd Date: Tue, 21 Nov 2017 15:41:19 +0900 Subject: [PATCH 187/390] redpen: use 'code' key to show validator instead of embedding it into text --- autoload/ale/handlers/redpen.vim | 5 ++++- test/handler/test_redpen_handler.vader | 6 ++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/autoload/ale/handlers/redpen.vim b/autoload/ale/handlers/redpen.vim index 35ff8c1..2fb0568 100644 --- a/autoload/ale/handlers/redpen.vim +++ b/autoload/ale/handlers/redpen.vim @@ -8,8 +8,9 @@ function! ale#handlers#redpen#HandleRedpenOutput(buffer, lines) abort let l:output = [] for l:err in l:res.errors let l:item = { - \ 'text': l:err.message . ' (' . l:err.validator . ')', + \ 'text': l:err.message, \ 'type': 'W', + \ 'code': l:err.validator, \} if has_key(l:err, 'startPosition') let l:item.lnum = l:err.startPosition.lineNum @@ -19,6 +20,8 @@ function! ale#handlers#redpen#HandleRedpenOutput(buffer, lines) abort let l:item.end_col = l:err.endPosition.offset endif else + " Fallback to a whole sentence region when a region is not + " specified by the error. let l:item.lnum = l:err.lineNum let l:item.col = l:err.sentenceStartColumnNum + 1 endif diff --git a/test/handler/test_redpen_handler.vader b/test/handler/test_redpen_handler.vader index 4627614..f28d692 100644 --- a/test/handler/test_redpen_handler.vader +++ b/test/handler/test_redpen_handler.vader @@ -12,14 +12,16 @@ Execute(redpen handler should handle errors output): \ 'col': 10, \ 'end_lnum': 1, \ 'end_col': 15, - \ 'text': 'Found possibly misspelled word "plugin". (Spelling)', + \ 'text': 'Found possibly misspelled word "plugin".', \ 'type': 'W', + \ 'code': 'Spelling', \ }, \ { \ 'lnum': 1, \ 'col': 1, - \ 'text': 'Found possibly misspelled word "NeoVim". (Spelling)', + \ 'text': 'Found possibly misspelled word "NeoVim".', \ 'type': 'W', + \ 'code': 'Spelling', \ }, \ ], \ ale#handlers#redpen#HandleRedpenOutput(bufnr(''), [ From ac7f69063db30edfad14fac19b9d06be487885b1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 13:38:27 +0000 Subject: [PATCH 188/390] #1151 - Overhaul the foodcritic linter for checking files on disk --- ale_linters/chef/foodcritic.vim | 40 ++++++++++------- .../test_foodcritic_command_callback.vader | 44 +++++++++++++++++++ test/handler/test_foodcritic_handler.vader | 44 +++++++++++++++++++ test/test_foodcritic_command_callback.vader | 18 -------- 4 files changed, 111 insertions(+), 35 deletions(-) create mode 100644 test/command_callback/test_foodcritic_command_callback.vader create mode 100644 test/handler/test_foodcritic_handler.vader delete mode 100644 test/test_foodcritic_command_callback.vader diff --git a/ale_linters/chef/foodcritic.vim b/ale_linters/chef/foodcritic.vim index 079e304..2c28246 100644 --- a/ale_linters/chef/foodcritic.vim +++ b/ale_linters/chef/foodcritic.vim @@ -1,24 +1,37 @@ " Author: Edward Larkey " Author: Jose Junior +" Author: w0rp " Description: This file adds the foodcritic linter for Chef files. -" Support options! -let g:ale_chef_foodcritic_options = get(g:, 'ale_chef_foodcritic_options', '') -let g:ale_chef_foodcritic_executable = get(g:, 'ale_chef_foodcritic_executable', 'foodcritic') +call ale#Set('chef_foodcritic_executable', 'foodcritic') +call ale#Set('chef_foodcritic_options', '') + +function! ale_linters#chef#foodcritic#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'chef_foodcritic_executable') +endfunction + +function! ale_linters#chef#foodcritic#GetCommand(buffer) abort + let l:executable = ale_linters#chef#foodcritic#GetExecutable(a:buffer) + let l:options = ale#Var(a:buffer, 'chef_foodcritic_options') + + return ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . escape(l:options, '~') : '') + \ . ' %s' +endfunction function! ale_linters#chef#foodcritic#Handle(buffer, lines) abort " Matches patterns line the following: " " FC002: Avoid string interpolation where not required: httpd.rb:13 - let l:pattern = '^\(.\+:\s.\+\):\s\(.\+\):\(\d\+\)$' + let l:pattern = '\v([^:]+): (.+): ([a-zA-Z]?:?[^:]+):(\d+)$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) - let l:text = l:match[1] - call add(l:output, { - \ 'lnum': l:match[3] + 0, - \ 'text': l:text, + \ 'code': l:match[1], + \ 'text': l:match[2], + \ 'filename': l:match[3], + \ 'lnum': l:match[4] + 0, \ 'type': 'W', \}) endfor @@ -26,17 +39,10 @@ function! ale_linters#chef#foodcritic#Handle(buffer, lines) abort return l:output endfunction -function! ale_linters#chef#foodcritic#GetCommand(buffer) abort - return printf('%s %s %%t', - \ ale#Var(a:buffer, 'chef_foodcritic_executable'), - \ escape(ale#Var(a:buffer, 'chef_foodcritic_options'), '~') - \) -endfunction - - call ale#linter#Define('chef', { \ 'name': 'foodcritic', -\ 'executable': 'foodcritic', +\ 'executable_callback': 'ale_linters#chef#foodcritic#GetExecutable', \ 'command_callback': 'ale_linters#chef#foodcritic#GetCommand', \ 'callback': 'ale_linters#chef#foodcritic#Handle', +\ 'lint_file': 1, \}) diff --git a/test/command_callback/test_foodcritic_command_callback.vader b/test/command_callback/test_foodcritic_command_callback.vader new file mode 100644 index 0000000..e3ad8a7 --- /dev/null +++ b/test/command_callback/test_foodcritic_command_callback.vader @@ -0,0 +1,44 @@ +Before: + Save g:ale_chef_foodcritic_executable + Save g:ale_chef_foodcritic_options + + unlet! g:ale_chef_foodcritic_executable + unlet! g:ale_chef_foodcritic_options + + call ale#test#SetDirectory('/testplugin/test') + + runtime ale_linters/chef/foodcritic.vim + +After: + Restore + + unlet! b:ale_chef_foodcritic_executable + unlet! b:ale_chef_foodcritic_options + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual + \ 'foodcritic', + \ ale_linters#chef#foodcritic#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('foodcritic') . ' %s', + \ ale_linters#chef#foodcritic#GetCommand(bufnr('')) + +Execute(Extra options should be included with escapeed tildes (~)): + let b:ale_chef_foodcritic_options = '-t ~F011' + + AssertEqual + \ ale#Escape('foodcritic') . ' -t \~F011 %s', + \ ale_linters#chef#foodcritic#GetCommand(bufnr('')) + +Execute(The executable should be configurable): + let b:ale_chef_foodcritic_executable = 'foobar' + + AssertEqual + \ 'foobar', + \ ale_linters#chef#foodcritic#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('foobar') . ' %s', + \ ale_linters#chef#foodcritic#GetCommand(bufnr('')) diff --git a/test/handler/test_foodcritic_handler.vader b/test/handler/test_foodcritic_handler.vader new file mode 100644 index 0000000..67cb6ca --- /dev/null +++ b/test/handler/test_foodcritic_handler.vader @@ -0,0 +1,44 @@ +Before: + runtime ale_linters/chef/foodcritic.vim + +After: + call ale#linter#Reset() + +Execute(Basic warnings should be handled): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'code': 'CINK001', + \ 'type': 'W', + \ 'text': 'Missing CHANGELOG in markdown format', + \ 'filename': '/foo/bar/CHANGELOG.md', + \ }, + \ { + \ 'lnum': 1, + \ 'code': 'FC011', + \ 'type': 'W', + \ 'text': 'Missing README in markdown format', + \ 'filename': '/foo/bar/README.md', + \ }, + \ { + \ 'lnum': 1, + \ 'code': 'FC031', + \ 'type': 'W', + \ 'text': 'Cookbook without metadata.rb file', + \ 'filename': '/foo/bar/metadata.rb', + \ }, + \ { + \ 'lnum': 1, + \ 'code': 'FC071', + \ 'type': 'W', + \ 'text': 'Missing LICENSE file', + \ 'filename': '/foo/bar/LICENSE', + \ }, + \ ], + \ ale_linters#chef#foodcritic#Handle(bufnr(''), [ + \ 'CINK001: Missing CHANGELOG in markdown format: /foo/bar/CHANGELOG.md:1', + \ 'FC011: Missing README in markdown format: /foo/bar/README.md:1', + \ 'FC031: Cookbook without metadata.rb file: /foo/bar/metadata.rb:1', + \ 'FC071: Missing LICENSE file: /foo/bar/LICENSE:1', + \ ]) diff --git a/test/test_foodcritic_command_callback.vader b/test/test_foodcritic_command_callback.vader deleted file mode 100644 index a5b02e4..0000000 --- a/test/test_foodcritic_command_callback.vader +++ /dev/null @@ -1,18 +0,0 @@ -Before: - let g:ale_chef_foodcritic_options = '-t ~F011' - let g:ale_chef_foodcritic_executable = 'foodcritic' - - call ale#test#SetDirectory('/testplugin/test') - runtime ale_linters/chef/foodcritic.vim - -After: - let g:ale_chef_foodcritic_options = '' - let g:ale_chef_foodcritic_executable = '' - - call ale#test#RestoreDirectory() - call ale#linter#Reset() - -Execute(command line should be assembled correctly): - AssertEqual - \ 'foodcritic -t \~F011 %t', - \ ale_linters#chef#foodcritic#GetCommand(bufnr('')) From 3ef98f42bdb0d692346d4aab29bd0809a6d5bdd4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 14:37:01 +0000 Subject: [PATCH 189/390] Fix #783 - Do not run Flow with home directory configuration files by default --- ale_linters/javascript/flow.vim | 44 ++++++++++++++++++++++----------- autoload/ale/engine.vim | 5 ++++ doc/ale-javascript.txt | 11 +++++++++ 3 files changed, 46 insertions(+), 14 deletions(-) diff --git a/ale_linters/javascript/flow.vim b/ale_linters/javascript/flow.vim index 8dc930c..643ea19 100755 --- a/ale_linters/javascript/flow.vim +++ b/ale_linters/javascript/flow.vim @@ -1,24 +1,12 @@ " Author: Zach Perrault -- @zperrault +" Author: Florian Beeres " Description: FlowType checking for JavaScript files -" Flow extra errors -" Author: Florian Beeres - call ale#Set('javascript_flow_executable', 'flow') +call ale#Set('javascript_flow_use_home_config', 0) call ale#Set('javascript_flow_use_global', 0) function! ale_linters#javascript#flow#GetExecutable(buffer) abort - return ale#node#FindExecutable(a:buffer, 'javascript_flow', [ - \ 'node_modules/.bin/flow', - \]) -endfunction - -function! ale_linters#javascript#flow#VersionCheck(buffer) abort - return ale#Escape(ale_linters#javascript#flow#GetExecutable(a:buffer)) - \ . ' --version' -endfunction - -function! ale_linters#javascript#flow#GetCommand(buffer, version_lines) abort let l:flow_config = ale#path#FindNearestFile(a:buffer, '.flowconfig') if empty(l:flow_config) @@ -26,7 +14,35 @@ function! ale_linters#javascript#flow#GetCommand(buffer, version_lines) abort return '' endif + " Don't run Flow with a configuration file from the home directory by + " default, which can eat all of your RAM. + if fnamemodify(l:flow_config, ':h') is? $HOME + \&& !ale#Var(a:buffer, 'javascript_flow_use_home_config') + return '' + endif + + return ale#node#FindExecutable(a:buffer, 'javascript_flow', [ + \ 'node_modules/.bin/flow', + \]) +endfunction + +function! ale_linters#javascript#flow#VersionCheck(buffer) abort let l:executable = ale_linters#javascript#flow#GetExecutable(a:buffer) + + if empty(l:executable) + return '' + endif + + return ale#Escape(l:executable) . ' --version' +endfunction + +function! ale_linters#javascript#flow#GetCommand(buffer, version_lines) abort + let l:executable = ale_linters#javascript#flow#GetExecutable(a:buffer) + + if empty(l:executable) + return '' + endif + let l:version = ale#semver#GetVersion(l:executable, a:version_lines) " If we can parse the version number, then only use --respect-pragma diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index f65108f..811b243 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -27,6 +27,11 @@ endfunction " Check if files are executable, and if they are, remember that they are " for subsequent calls. We'll keep checking until programs can be executed. function! ale#engine#IsExecutable(buffer, executable) abort + if empty(a:executable) + " Don't log the executable check if the executable string is empty. + return 0 + endif + if has_key(s:executable_cache_map, a:executable) return 1 endif diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 1b8e3f5..5a2969a 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -84,6 +84,17 @@ g:ale_javascript_flow_executable *g:ale_javascript_flow_executable* See |ale-integrations-local-executables| +g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config* + *b:ale_javascript_flow_use_home_config* + Type: |Number| + Default: `0` + + When set to `1`, ALE will allow Flow to be executed with configuration files + from your home directory. ALE will not run Flow with home directory + configuration files by default, as doing so can lead to Vim consuming all of + your RAM and CPU power. + + g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global* *b:ale_javascript_flow_use_global* Type: |Number| From 8be85c2997a56c753a820ebaccb30fe7ea953d2c Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 16:18:08 +0000 Subject: [PATCH 190/390] Use some default regex for completion support in other filetypes --- autoload/ale/completion.vim | 6 +++--- test/test_completion.vader | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index e471a3b..e5f1dbb 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -12,14 +12,14 @@ function! s:GetRegex(map, filetype) abort endif endfor - return '' + " Use the default regex for other files. + return s:should_complete_map[''] endfunction " Regular expressions for checking the characters in the line before where " the insert cursor is. If one of these matches, we'll check for completions. let s:should_complete_map = { -\ 'javascript': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$|\.$', -\ 'typescript': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$|\.$', +\ '': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$|\.$', \} " Check if we should look for completions for a language. diff --git a/test/test_completion.vader b/test/test_completion.vader index 3dfc205..9662fc2 100644 --- a/test/test_completion.vader +++ b/test/test_completion.vader @@ -230,6 +230,9 @@ Execute(Completion should be done after words in parens in TypeScript): Execute(Completion should not be done after parens in TypeScript): AssertEqual '', ale#completion#GetPrefix(&filetype, 3, 15) +Execute(Completion prefixes should work for other filetypes): + AssertEqual 'ab', ale#completion#GetPrefix('xxxyyyzzz', 3, 14) + Execute(ale#completion#Show() should remember the omnifunc setting and replace it): let &l:omnifunc = 'FooBar' From e6fb32b7920fbe3d58c055eb7151d1316b2a40ac Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 16:39:05 +0000 Subject: [PATCH 191/390] Remove a Unicode character Vint complains about --- ale_linters/eruby/erubis.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/eruby/erubis.vim b/ale_linters/eruby/erubis.vim index c9c8ac1..1ebd4a0 100644 --- a/ale_linters/eruby/erubis.vim +++ b/ale_linters/eruby/erubis.vim @@ -10,7 +10,7 @@ function! ale_linters#eruby#erubis#GetCommand(buffer) abort " Rails-flavored eRuby does not comply with the standard as understood by " Erubis, so we'll have to do some substitution. This does not reduce the - " effectiveness of the linter—the translated code is still evaluated. + " effectiveness of the linter - the translated code is still evaluated. return 'ruby -r erubis -e ' . ale#Escape('puts Erubis::Eruby.new($stdin.read.gsub(%{<%=},%{<%})).src') . '< %t | ruby -c' endfunction From 52f3ad7c75273af3b32d1085a248d14ccc1886df Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 21 Nov 2017 23:51:18 +0000 Subject: [PATCH 192/390] Escape the pyls executable in the command, and support running virtualenv pyls executables --- ale_linters/python/pyls.vim | 11 ++++- doc/ale-python.txt | 12 ++++- .../with_virtualenv/env/Scripts/pyls | 0 .../python_paths/with_virtualenv/env/bin/pyls | 0 .../test_pyls_command_callback.vader | 49 +++++++++++++++++++ 5 files changed, 69 insertions(+), 3 deletions(-) create mode 100755 test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls create mode 100755 test/command_callback/python_paths/with_virtualenv/env/bin/pyls create mode 100644 test/command_callback/test_pyls_command_callback.vader diff --git a/ale_linters/python/pyls.vim b/ale_linters/python/pyls.vim index 1b91c2c..9888853 100644 --- a/ale_linters/python/pyls.vim +++ b/ale_linters/python/pyls.vim @@ -2,9 +2,16 @@ " Description: A language server for Python call ale#Set('python_pyls_executable', 'pyls') +call ale#Set('python_pyls_use_global', 0) function! ale_linters#python#pyls#GetExecutable(buffer) abort - return ale#Var(a:buffer, 'python_pyls_executable') + return ale#python#FindExecutable(a:buffer, 'python_pyls', ['pyls']) +endfunction + +function! ale_linters#python#pyls#GetCommand(buffer) abort + let l:executable = ale_linters#python#pyls#GetExecutable(a:buffer) + + return ale#Escape(l:executable) endfunction function! ale_linters#python#pyls#GetLanguage(buffer) abort @@ -15,7 +22,7 @@ call ale#linter#Define('python', { \ 'name': 'pyls', \ 'lsp': 'stdio', \ 'executable_callback': 'ale_linters#python#pyls#GetExecutable', -\ 'command_callback': 'ale_linters#python#pyls#GetExecutable', +\ 'command_callback': 'ale_linters#python#pyls#GetCommand', \ 'language_callback': 'ale_linters#python#pyls#GetLanguage', \ 'project_root_callback': 'ale#python#FindProjectRoot', \}) diff --git a/doc/ale-python.txt b/doc/ale-python.txt index e34b548..a78cb5a 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -189,16 +189,26 @@ g:ale_python_pylint_use_global *g:ale_python_pylint_use_global* See |ale-integrations-local-executables| + =============================================================================== pyls *ale-python-pyls* g:ale_python_pyls_executable *g:ale_python_pyls_executable* *b:ale_python_pyls_executable* Type: |String| - Default: `pyls` + Default: `'pyls'` See |ale-integrations-local-executables| + +g:ale_python_pyls_use_global *g:ale_python_pyls_use_global* + *b:ale_python_pyls_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== yapf *ale-python-yapf* diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls b/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/python_paths/with_virtualenv/env/bin/pyls b/test/command_callback/python_paths/with_virtualenv/env/bin/pyls new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/test_pyls_command_callback.vader b/test/command_callback/test_pyls_command_callback.vader new file mode 100644 index 0000000..9f9703d --- /dev/null +++ b/test/command_callback/test_pyls_command_callback.vader @@ -0,0 +1,49 @@ +Before: + Save g:ale_python_pyls_executable + Save g:ale_python_pyls_use_global + + unlet! g:ale_python_pyls_executable + unlet! g:ale_python_pyls_use_global + + let b:bin_dir = has('win32') ? 'Scripts' : 'bin' + + call ale#test#SetDirectory('/testplugin/test/command_callback') + + runtime ale_linters/python/pyls.vim + +After: + Restore + + unlet! b:bin_dir + unlet! b:executable + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The pyls command callback should return default string): + AssertEqual ale#Escape('pyls'), + \ ale_linters#python#pyls#GetCommand(bufnr('')) + +Execute(The pyls executable should be configurable): + let g:ale_python_pyls_executable = '~/.local/bin/pyls' + + AssertEqual ale#Escape('~/.local/bin/pyls'), + \ ale_linters#python#pyls#GetCommand(bufnr('')) + +Execute(The pyls executable should be run from the virtualenv path): + call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') + + let b:executable = ale#path#Winify( + \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/pyls' + \) + + AssertEqual ale#Escape(b:executable), + \ ale_linters#python#pyls#GetCommand(bufnr('')) + +Execute(You should be able to override the pyls virtualenv lookup): + call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') + + let g:ale_python_pyls_use_global = 1 + + AssertEqual ale#Escape('pyls'), + \ ale_linters#python#pyls#GetCommand(bufnr('')) From 796fb651d646b3cc34a397c08daa3b85465929d3 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 00:42:39 +0000 Subject: [PATCH 193/390] Fix the Windows tests for pyls --- .../python_paths/with_virtualenv/env/Scripts/{pyls => pyls.exe} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename test/command_callback/python_paths/with_virtualenv/env/Scripts/{pyls => pyls.exe} (100%) diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls b/test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls.exe similarity index 100% rename from test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls rename to test/command_callback/python_paths/with_virtualenv/env/Scripts/pyls.exe From 074a011b0831f89252f62c3ab498c9337d4651a2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 12:01:21 +0000 Subject: [PATCH 194/390] Make fixing ignore empty output better --- autoload/ale/fix.vim | 8 +++++--- test/test_ale_fix.vader | 15 +++++++++++++++ 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index c4143aa..76cd135 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -114,9 +114,11 @@ function! s:HandleExit(job_id, exit_code) abort " otherwise skip this job and use the input from before. " " We'll use the input from before for chained commands. - let l:input = l:chain_callback is v:null && !empty(l:job_info.output) - \ ? l:job_info.output - \ : l:job_info.input + if l:chain_callback is v:null && !empty(split(join(l:job_info.output))) + let l:input = l:job_info.output + else + let l:input = l:job_info.input + endif let l:next_index = l:chain_callback is v:null \ ? l:job_info.callback_index + 1 diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index ac6427a..c5deabb 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -105,6 +105,11 @@ Before: return {'command': ''} endfunction + " echo will output a single blank line, and we should ingore it. + function! IgnoredEmptyOutput(buffer, output) + return {'command': 'echo'} + endfunction + function! SetUpLinters() call ale#linter#Define('testft', { \ 'name': 'testlinter', @@ -149,6 +154,7 @@ After: delfunction ChainEndSkipped delfunction SetUpLinters delfunction GetLastMessage + delfunction IgnoredEmptyOutput call ale#test#RestoreDirectory() @@ -568,3 +574,12 @@ Expect(The lines should be the same): a b c + +Execute(Empty output should be ignored): + let g:ale_fixers.testft = ['IgnoredEmptyOutput'] + ALEFix + +Expect(The lines should be the same): + a + b + c From e7865d2f9482497b568c11cf1f07a740d2da3907 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 12:41:16 +0000 Subject: [PATCH 195/390] Fix the empty echo fixer test on Windows --- test/test_ale_fix.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index c5deabb..aeb5bd0 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -107,7 +107,7 @@ Before: " echo will output a single blank line, and we should ingore it. function! IgnoredEmptyOutput(buffer, output) - return {'command': 'echo'} + return {'command': has('win32') ? 'echo(' : 'echo'} endfunction function! SetUpLinters() From 3f70f1cbf1baee707fe78968f57950b78fc6c19b Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 13:01:13 +0000 Subject: [PATCH 196/390] Disable piping buffer data into commands for fixing files where needed --- autoload/ale/fix.vim | 15 +++++++++++++-- doc/ale.txt | 12 ++++++++++++ test/test_ale_fix.vader | 24 ++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 2 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 76cd135..cbca68e 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -185,6 +185,7 @@ function! s:RunJob(options) abort let l:output_stream = a:options.output_stream let l:read_temporary_file = a:options.read_temporary_file let l:chain_with = a:options.chain_with + let l:read_buffer = a:options.read_buffer if empty(l:command) " If there's nothing further to chain the command with, stop here. @@ -205,7 +206,11 @@ function! s:RunJob(options) abort return 1 endif - let [l:temporary_file, l:command] = ale#command#FormatCommand(l:buffer, l:command, 1) + let [l:temporary_file, l:command] = ale#command#FormatCommand( + \ l:buffer, + \ l:command, + \ l:read_buffer, + \) call s:CreateTemporaryFileForJob(l:buffer, l:temporary_file, l:input) let l:command = ale#job#PrepareCommand(l:command) @@ -309,13 +314,19 @@ function! s:RunFixer(options) abort let l:input = l:result let l:index += 1 else + " Capitals are required for funcrefs. + let l:Chain_with = get(l:result, 'chain_with', v:null) + " Default to piping the buffer for the last fixer in the chain. + let l:read_buffer = get(l:result, 'read_buffer', l:Chain_with is v:null) + let l:job_ran = s:RunJob({ \ 'buffer': l:buffer, \ 'command': l:result.command, \ 'input': l:input, \ 'output_stream': get(l:result, 'output_stream', 'stdout'), \ 'read_temporary_file': get(l:result, 'read_temporary_file', 0), - \ 'chain_with': get(l:result, 'chain_with', v:null), + \ 'read_buffer': l:read_buffer, + \ 'chain_with': l:Chain_with, \ 'callback_list': a:options.callback_list, \ 'callback_index': l:index, \}) diff --git a/doc/ale.txt b/doc/ale.txt index 6399111..ff8ac08 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -479,6 +479,18 @@ are supported for running the commands. that are cached. An empty List will be passed to the next callback in the chain for the `output`. + `read_buffer` An optional key for disabling reading the buffer. + + When set to `0`, ALE will not pipe the buffer's data + into the command via stdin. This option is ignored and + the buffer is not read when `read_temporary_file` is + `1`. + + This option defaults to `0` when `chain_with` is defined + as anything other than `v:null`, and defaults to `1` + otherwise. This is so earlier commands in a chain + do not receive the buffer's data by default. + *ale-fix-configuration* Synchronous functions and asynchronous jobs will be run in a sequence for diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index aeb5bd0..07a53c7 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -110,6 +110,10 @@ Before: return {'command': has('win32') ? 'echo(' : 'echo'} endfunction + function! EchoLineNoPipe(buffer, output) + return {'command': 'echo new line', 'read_buffer': 0} + endfunction + function! SetUpLinters() call ale#linter#Define('testft', { \ 'name': 'testlinter', @@ -155,6 +159,7 @@ After: delfunction SetUpLinters delfunction GetLastMessage delfunction IgnoredEmptyOutput + delfunction EchoLineNoPipe call ale#test#RestoreDirectory() @@ -540,6 +545,14 @@ Execute(Test fixing with chained callbacks): let g:ale_fixers.testft = ['FirstChainCallback'] ALEFix + " The buffer shouldn't be piped in for earlier commands in the chain. + AssertEqual + \ [ + \ string(ale#job#PrepareCommand('echo echoline')), + \ string(ale#job#PrepareCommand('echo echoline')), + \ ], + \ map(ale#history#Get(bufnr(''))[-2:-1], 'string(v:val.command)') + Expect(The echoed line should be added): a b @@ -583,3 +596,14 @@ Expect(The lines should be the same): a b c + +Execute(A temporary file shouldn't be piped into the command when disabled): + let g:ale_fixers.testft = ['EchoLineNoPipe'] + ALEFix + + AssertEqual + \ string(ale#job#PrepareCommand('echo new line')), + \ string(ale#history#Get(bufnr(''))[-1].command) + +Expect(The new line should be used): + new line From 520541cd2d8ebd22a9990875655fb2d10289fd22 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 13:46:11 +0000 Subject: [PATCH 197/390] #1095 - Use --stdin-filepath for prettier, where available --- autoload/ale/fixers/prettier.vim | 69 ++++++-------- doc/ale-javascript.txt | 8 -- .../fixers/test_prettier_fixer_callback.vader | 91 ++++++------------- 3 files changed, 55 insertions(+), 113 deletions(-) diff --git a/autoload/ale/fixers/prettier.vim b/autoload/ale/fixers/prettier.vim index d66e00f..d75299e 100644 --- a/autoload/ale/fixers/prettier.vim +++ b/autoload/ale/fixers/prettier.vim @@ -4,31 +4,8 @@ call ale#Set('javascript_prettier_executable', 'prettier') call ale#Set('javascript_prettier_use_global', 0) -call ale#Set('javascript_prettier_use_local_config', 0) call ale#Set('javascript_prettier_options', '') -function! s:FindConfig(buffer) abort - for l:filename in [ - \ '.prettierrc', - \ '.prettierrc.json', - \ '.prettierrc.yaml', - \ '.prettierrc.yml', - \ '.prettierrc.js', - \ 'prettier.config.js', - \ 'package.json', - \ ] - - let l:config = ale#path#FindNearestFile(a:buffer, l:filename) - - if !empty(l:config) - return l:config - endif - endfor - - return '' -endfunction - - function! ale#fixers#prettier#GetExecutable(buffer) abort return ale#node#FindExecutable(a:buffer, 'javascript_prettier', [ \ 'node_modules/.bin/prettier_d', @@ -38,32 +15,38 @@ function! ale#fixers#prettier#GetExecutable(buffer) abort endfunction function! ale#fixers#prettier#Fix(buffer) abort - let l:options = ale#Var(a:buffer, 'javascript_prettier_options') - let l:config = s:FindConfig(a:buffer) - let l:use_config = ale#Var(a:buffer, 'javascript_prettier_use_local_config') - \ && !empty(l:config) - let l:filetype = getbufvar(a:buffer, '&filetype') + let l:executable = ale#fixers#prettier#GetExecutable(a:buffer) - " Append the --parser flag depending on the current filetype (unless it's - " already set in g:javascript_prettier_options). - if match(l:options, '--parser') == -1 - if l:filetype is# 'typescript' - let l:parser = 'typescript' - elseif l:filetype =~# 'css\|scss\|less' - let l:parser = 'postcss' - elseif l:filetype is# 'json' - let l:parser = 'json' - else - let l:parser = 'babylon' - endif - let l:options = (!empty(l:options) ? l:options . ' ' : '') . '--parser ' . l:parser + let l:command = ale#semver#HasVersion(l:executable) + \ ? '' + \ : ale#Escape(l:executable) . ' --version' + + return { + \ 'command': l:command, + \ 'chain_with': 'ale#fixers#prettier#ApplyFixForVersion', + \} +endfunction + +function! ale#fixers#prettier#ApplyFixForVersion(buffer, version_output) abort + let l:executable = ale#fixers#prettier#GetExecutable(a:buffer) + let l:options = ale#Var(a:buffer, 'javascript_prettier_options') + + let l:version = ale#semver#GetVersion(l:executable, a:version_output) + + " 1.4.0 is the first version with --stdin-filepath + if ale#semver#GTE(l:version, [1, 4, 0]) + return { + \ 'command': ale#path#BufferCdString(a:buffer) + \ . ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' --stdin-filepath %s --stdin', + \} endif return { - \ 'command': ale#Escape(ale#fixers#prettier#GetExecutable(a:buffer)) + \ 'command': ale#Escape(l:executable) \ . ' %t' \ . (!empty(l:options) ? ' ' . l:options : '') - \ . (l:use_config ? ' --config ' . ale#Escape(l:config) : '') \ . ' --write', \ 'read_temporary_file': 1, \} diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 5a2969a..365dfa6 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -167,14 +167,6 @@ g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global* See |ale-integrations-local-executables| -g:ale_javascript_prettier_use_local_config - *g:ale_javascript_prettier_use_local_config* - *b:ale_javascript_prettier_use_local_config* - Type: |Number| - Default: `0` - - This variable can be set to use the local prettier configuration file. - =============================================================================== prettier-eslint *ale-javascript-prettier-eslint* diff --git a/test/fixers/test_prettier_fixer_callback.vader b/test/fixers/test_prettier_fixer_callback.vader index 471a863..3480b41 100644 --- a/test/fixers/test_prettier_fixer_callback.vader +++ b/test/fixers/test_prettier_fixer_callback.vader @@ -14,7 +14,9 @@ Before: After: let g:ale_has_override = {} + call ale#test#RestoreDirectory() + call ale#semver#ResetVersionCache() Execute(The prettier callback should return the correct default values): call ale#test#SetFilename('../prettier-test-files/testfile.js') @@ -24,12 +26,11 @@ Execute(The prettier callback should return the correct default values): \ 'read_temporary_file': 1, \ 'command': ale#Escape(g:ale_javascript_prettier_executable) \ . ' %t' - \ . ' --parser babylon' \ . ' --write', \ }, - \ ale#fixers#prettier#Fix(bufnr('')) + \ ale#fixers#prettier#ApplyFixForVersion(bufnr(''), []) -Execute(The prettier callback should include configuration files when the option is set): +Execute(The --config option should not be set automatically): let g:ale_javascript_prettier_use_local_config = 1 call ale#test#SetFilename('../prettier-test-files/with_config/testfile.js') @@ -38,11 +39,9 @@ Execute(The prettier callback should include configuration files when the option \ 'read_temporary_file': 1, \ 'command': ale#Escape(g:ale_javascript_prettier_executable) \ . ' %t' - \ . ' --parser babylon' - \ . ' --config ' . ale#Escape(ale#path#Winify(g:dir . '/../prettier-test-files/with_config/.prettierrc')) \ . ' --write', \ }, - \ ale#fixers#prettier#Fix(bufnr('')) + \ ale#fixers#prettier#ApplyFixForVersion(bufnr(''), []) Execute(The prettier callback should include custom prettier options): let g:ale_javascript_prettier_options = '--no-semi' @@ -53,78 +52,46 @@ Execute(The prettier callback should include custom prettier options): \ 'read_temporary_file': 1, \ 'command': ale#Escape(g:ale_javascript_prettier_executable) \ . ' %t' - \ . ' --no-semi --parser babylon' - \ . ' --config ' . ale#Escape(ale#path#Winify(g:dir . '/../prettier-test-files/with_config/.prettierrc')) + \ . ' --no-semi' \ . ' --write', \ }, - \ ale#fixers#prettier#Fix(bufnr('')) + \ ale#fixers#prettier#ApplyFixForVersion(bufnr(''), []) -Execute(Append '--parser typescript' for filetype=typescript): - set filetype=typescript - call ale#test#SetFilename('../prettier-test-files/testfile.ts') +Execute(The version check should be correct): + call ale#test#SetFilename('../prettier-test-files/testfile.js') AssertEqual \ { - \ 'read_temporary_file': 1, + \ 'chain_with': 'ale#fixers#prettier#ApplyFixForVersion', \ 'command': ale#Escape(g:ale_javascript_prettier_executable) - \ . ' %t' - \ . ' --parser typescript' - \ . ' --write', + \ . ' --version', \ }, \ ale#fixers#prettier#Fix(bufnr('')) -Execute(Append '--parser json' for filetype=json): - set filetype=json - call ale#test#SetFilename('../prettier-test-files/testfile.json') +Execute(--stdin-filepath should be used when prettier is new enough): + let g:ale_javascript_prettier_options = '--no-semi' + call ale#test#SetFilename('../prettier-test-files/with_config/testfile.js') AssertEqual \ { - \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_javascript_prettier_executable) - \ . ' %t' - \ . ' --parser json' - \ . ' --write', + \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape(g:ale_javascript_prettier_executable) + \ . ' --no-semi' + \ . ' --stdin-filepath %s --stdin', \ }, - \ ale#fixers#prettier#Fix(bufnr('')) + \ ale#fixers#prettier#ApplyFixForVersion(bufnr(''), ['1.6.0']) -Execute(Append '--parser postcss' for filetype=scss): - set filetype=scss - call ale#test#SetFilename('../prettier-test-files/testfile.scss') +Execute(The version number should be cached): + call ale#test#SetFilename('../prettier-test-files/with_config/testfile.js') + " Call the second callback with the version output. + call ale#fixers#prettier#ApplyFixForVersion(bufnr(''), ['1.6.0']) + + " Call it again without the vesrion output. We should use the newer command. AssertEqual \ { - \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_javascript_prettier_executable) - \ . ' %t' - \ . ' --parser postcss' - \ . ' --write', + \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape(g:ale_javascript_prettier_executable) + \ . ' --stdin-filepath %s --stdin', \ }, - \ ale#fixers#prettier#Fix(bufnr('')) - -Execute(Append '--parser postcss' for filetype=css): - set filetype=css - call ale#test#SetFilename('../prettier-test-files/testfile.css') - - AssertEqual - \ { - \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_javascript_prettier_executable) - \ . ' %t' - \ . ' --parser postcss' - \ . ' --write', - \ }, - \ ale#fixers#prettier#Fix(bufnr('')) - -Execute(Append '--parser postcss' for filetype=less): - set filetype=less - call ale#test#SetFilename('../prettier-test-files/testfile.less') - - AssertEqual - \ { - \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_javascript_prettier_executable) - \ . ' %t' - \ . ' --parser postcss' - \ . ' --write', - \ }, - \ ale#fixers#prettier#Fix(bufnr('')) + \ ale#fixers#prettier#ApplyFixForVersion(bufnr(''), []) From 382cb4d5389725bf85865a87359d6ab744fb35f4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 14:06:37 +0000 Subject: [PATCH 198/390] Fix a fixer test on Windows --- test/test_ale_fix.vader | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/test/test_ale_fix.vader b/test/test_ale_fix.vader index 07a53c7..c36de78 100644 --- a/test/test_ale_fix.vader +++ b/test/test_ale_fix.vader @@ -605,5 +605,10 @@ Execute(A temporary file shouldn't be piped into the command when disabled): \ string(ale#job#PrepareCommand('echo new line')), \ string(ale#history#Get(bufnr(''))[-1].command) + " Remove trailing whitespace for Windows. + if has('win32') + %s/[[:space:]]*$//g + endif + Expect(The new line should be used): new line From 4b4762697c03e3b82b032d442289deaac9bd38e6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 14:46:14 +0000 Subject: [PATCH 199/390] #1095 Use --stdin-filepath where available for prettier-eslint --- autoload/ale/fixers/prettier_eslint.vim | 30 +++++++++- doc/ale-javascript.txt | 13 ----- .../test_prettier_eslint_fixer.callback.vader | 55 ++++++++++++++++--- 3 files changed, 74 insertions(+), 24 deletions(-) diff --git a/autoload/ale/fixers/prettier_eslint.vim b/autoload/ale/fixers/prettier_eslint.vim index 524c52d..5dd9102 100644 --- a/autoload/ale/fixers/prettier_eslint.vim +++ b/autoload/ale/fixers/prettier_eslint.vim @@ -6,7 +6,6 @@ function! ale#fixers#prettier_eslint#SetOptionDefaults() abort call ale#Set('javascript_prettier_eslint_executable', 'prettier-eslint') call ale#Set('javascript_prettier_eslint_use_global', 0) call ale#Set('javascript_prettier_eslint_options', '') - call ale#Set('javascript_prettier_eslint_legacy', 0) endfunction call ale#fixers#prettier_eslint#SetOptionDefaults() @@ -19,16 +18,43 @@ function! ale#fixers#prettier_eslint#GetExecutable(buffer) abort endfunction function! ale#fixers#prettier_eslint#Fix(buffer) abort + let l:executable = ale#fixers#prettier_eslint#GetExecutable(a:buffer) + + let l:command = ale#semver#HasVersion(l:executable) + \ ? '' + \ : ale#Escape(l:executable) . ' --version' + + return { + \ 'command': l:command, + \ 'chain_with': 'ale#fixers#prettier_eslint#ApplyFixForVersion', + \} +endfunction + +function! ale#fixers#prettier_eslint#ApplyFixForVersion(buffer, version_output) abort let l:options = ale#Var(a:buffer, 'javascript_prettier_eslint_options') let l:executable = ale#fixers#prettier_eslint#GetExecutable(a:buffer) - let l:config = !ale#Var(a:buffer, 'javascript_prettier_eslint_legacy') + let l:version = ale#semver#GetVersion(l:executable, a:version_output) + + " 4.2.0 is the first version with --eslint-config-path + let l:config = ale#semver#GTE(l:version, [4, 2, 0]) \ ? ale#handlers#eslint#FindConfig(a:buffer) \ : '' let l:eslint_config_option = !empty(l:config) \ ? ' --eslint-config-path ' . ale#Escape(l:config) \ : '' + " 4.4.0 is the first version with --stdin-filepath + if ale#semver#GTE(l:version, [4, 4, 0]) + return { + \ 'command': ale#path#BufferCdString(a:buffer) + \ . ale#Escape(l:executable) + \ . l:eslint_config_option + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' --stdin-filepath %s --stdin', + \} + endif + return { \ 'command': ale#Escape(l:executable) \ . ' %t' diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 365dfa6..3934dfb 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -171,11 +171,6 @@ g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global* =============================================================================== prettier-eslint *ale-javascript-prettier-eslint* -ALE supports `prettier-eslint` >= 4.2.0. Using lower version is not recommended -because it cannot be configured to use the ESLint configuration file for input -given via stdin. However ALE could be set up on your own risk with older -versions with |g:ale_javascript_prettier_eslint_legacy| - g:ale_javascript_prettier_eslint_executable *g:ale_javascript_prettier_eslint_executable* *b:ale_javascript_prettier_eslint_executable* @@ -202,14 +197,6 @@ g:ale_javascript_prettier_eslint_use_global See |ale-integrations-local-executables| -g:ale_javascript_prettier_eslint_legacy - *g:ale_javascript_prettier_eslint_legacy* - *b:ale_javascript_prettier_eslint_legacy* - Type: |Number| - Default: `0` - - Fallback option for `prettier-eslint` < 4.2.0 - =============================================================================== prettier-standard *ale-javascript-prettier-standard* diff --git a/test/fixers/test_prettier_eslint_fixer.callback.vader b/test/fixers/test_prettier_eslint_fixer.callback.vader index b48a708..1ff11fe 100644 --- a/test/fixers/test_prettier_eslint_fixer.callback.vader +++ b/test/fixers/test_prettier_eslint_fixer.callback.vader @@ -4,12 +4,10 @@ Before: Save g:ale_javascript_prettier_eslint_executable Save g:ale_javascript_prettier_eslint_use_global Save g:ale_javascript_prettier_eslint_options - Save g:ale_javascript_prettier_eslint_legacy unlet! g:ale_javascript_prettier_eslint_executable unlet! g:ale_javascript_prettier_eslint_use_global unlet! g:ale_javascript_prettier_eslint_options - unlet! g:ale_javascript_prettier_eslint_legacy call ale#fixers#prettier_eslint#SetOptionDefaults() @@ -19,9 +17,9 @@ After: unlet! b:ale_javascript_prettier_eslint_executable unlet! b:ale_javascript_prettier_eslint_use_global unlet! b:ale_javascript_prettier_eslint_options - unlet! b:ale_javascript_prettier_eslint_legacy call ale#test#RestoreDirectory() + call ale#semver#ResetVersionCache() Execute(The default command should be correct): AssertEqual @@ -32,7 +30,7 @@ Execute(The default command should be correct): \ . ' %t' \ . ' --write' \ }, - \ ale#fixers#prettier_eslint#Fix(bufnr('')) + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), []) Execute(Additional options should be used when set): let b:ale_javascript_prettier_eslint_options = '--foobar' @@ -45,9 +43,9 @@ Execute(Additional options should be used when set): \ . ' %t' \ . ' --foobar --write' \ }, - \ ale#fixers#prettier_eslint#Fix(bufnr('')) + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), []) -Execute(Configuration files should be detected): +Execute(--eslint-config-path should be set for 4.2.0 and up): call ale#test#SetFilename('eslint-test-files/react-app/foo/bar.js') AssertEqual @@ -59,11 +57,10 @@ Execute(Configuration files should be detected): \ . ' --eslint-config-path ' . ale#Escape(ale#path#Winify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) \ . ' --write' \ }, - \ ale#fixers#prettier_eslint#Fix(bufnr('')) + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), ['4.2.0']) -Execute(Configuration files should be disabled if the legacy option is on): +Execute(--eslint-config-path shouldn't be used for older versions): call ale#test#SetFilename('eslint-test-files/react-app/foo/bar.js') - let b:ale_javascript_prettier_eslint_legacy = 1 AssertEqual \ { @@ -73,4 +70,44 @@ Execute(Configuration files should be disabled if the legacy option is on): \ . ' %t' \ . ' --write' \ }, + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), []) + +Execute(The version check should be correct): + AssertEqual + \ { + \ 'chain_with': 'ale#fixers#prettier_eslint#ApplyFixForVersion', + \ 'command': ale#Escape('prettier-eslint') . ' --version', + \ }, \ ale#fixers#prettier_eslint#Fix(bufnr('')) + +Execute(The new --stdin-filepath option should be used when the version is new enough): + call ale#test#SetFilename('eslint-test-files/react-app/foo/bar.js') + + AssertEqual + \ { + \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('prettier-eslint') + \ . ' --eslint-config-path ' . ale#Escape(ale#path#Winify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) + \ . ' --stdin-filepath %s --stdin', + \ }, + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), ['4.4.0']) + +Execute(The version number should be cached): + call ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), ['4.4.0']) + + " The version command should be skipped. + AssertEqual + \ { + \ 'chain_with': 'ale#fixers#prettier_eslint#ApplyFixForVersion', + \ 'command': '', + \ }, + \ ale#fixers#prettier_eslint#Fix(bufnr('')) + + " The newer command should be used. + AssertEqual + \ { + \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('prettier-eslint') + \ . ' --stdin-filepath %s --stdin', + \ }, + \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), []) From 5ed6f66f7779bea092671521ad5743914612a18a Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 14:55:08 +0000 Subject: [PATCH 200/390] Reorganise the ALEFix tests --- test/{ => fix}/test_ale_fix.vader | 2 +- test/{ => fix}/test_ale_fix_suggest.vader | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename test/{ => fix}/test_ale_fix.vader (99%) rename test/{ => fix}/test_ale_fix_suggest.vader (100%) diff --git a/test/test_ale_fix.vader b/test/fix/test_ale_fix.vader similarity index 99% rename from test/test_ale_fix.vader rename to test/fix/test_ale_fix.vader index c36de78..4793293 100644 --- a/test/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -6,7 +6,7 @@ Before: Save g:ale_lint_on_save Save g:ale_echo_cursor - silent! cd /testplugin/test + silent! cd /testplugin/test/fix let g:ale_enabled = 0 let g:ale_echo_cursor = 0 diff --git a/test/test_ale_fix_suggest.vader b/test/fix/test_ale_fix_suggest.vader similarity index 100% rename from test/test_ale_fix_suggest.vader rename to test/fix/test_ale_fix_suggest.vader From 5d2ab192cf4ecce604cee4e8870ff7d5d3f47ed8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 15:31:39 +0000 Subject: [PATCH 201/390] Support fixer aliases, and make prettier-eslint and prettier-standard just work --- autoload/ale/fix/registry.vim | 60 +++++++++++++++++++++++++++-- doc/ale.txt | 8 +++- syntax/ale-fix-suggest.vim | 2 +- test/fix/test_ale_fix_aliases.vader | 5 +++ test/fix/test_ale_fix_suggest.vader | 4 +- 5 files changed, 71 insertions(+), 8 deletions(-) create mode 100644 test/fix/test_ale_fix_aliases.vader diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 2e24e02..4fb229b 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -21,6 +21,7 @@ let s:default_registry = { \ 'function': 'ale#fixers#prettier_standard#Fix', \ 'suggested_filetypes': ['javascript'], \ 'description': 'Apply prettier-standard to a file.', +\ 'aliases': ['prettier-standard'], \ }, \ 'eslint': { \ 'function': 'ale#fixers#eslint#Fix', @@ -51,6 +52,7 @@ let s:default_registry = { \ 'function': 'ale#fixers#prettier_eslint#Fix', \ 'suggested_filetypes': ['javascript'], \ 'description': 'Apply prettier-eslint to a file.', +\ 'aliases': ['prettier-eslint'], \ }, \ 'puppetlint': { \ 'function': 'ale#fixers#puppetlint#Fix', @@ -147,6 +149,14 @@ let s:default_registry = { " Reset the function registry to the default entries. function! ale#fix#registry#ResetToDefaults() abort let s:entries = deepcopy(s:default_registry) + let s:aliases = {} + + " Set up aliases for fixers too. + for [l:key, l:entry] in items(s:entries) + for l:alias in get(l:entry, 'aliases', []) + let s:aliases[l:alias] = l:key + endfor + endfor endfunction " Set up entries now. @@ -155,10 +165,12 @@ call ale#fix#registry#ResetToDefaults() " Remove everything from the registry, useful for tests. function! ale#fix#registry#Clear() abort let s:entries = {} + let s:aliases = {} endfunction " Add a function for fixing problems to the registry. -function! ale#fix#registry#Add(name, func, filetypes, desc) abort +" (name, func, filetypes, desc, aliases) +function! ale#fix#registry#Add(name, func, filetypes, desc, ...) abort if type(a:name) != type('') throw '''name'' must be a String' endif @@ -181,16 +193,37 @@ function! ale#fix#registry#Add(name, func, filetypes, desc) abort throw '''desc'' must be a String' endif + let l:aliases = get(a:000, 0, []) + + if type(l:aliases) != type([]) + \|| !empty(filter(copy(l:aliases), 'type(v:val) != type('''')')) + throw '''aliases'' must be a List of String values' + endif + let s:entries[a:name] = { \ 'function': a:func, \ 'suggested_filetypes': a:filetypes, \ 'description': a:desc, \} + + " Set up aliases for the fixer. + if !empty(l:aliases) + let s:entries[a:name].aliases = l:aliases + + for l:alias in l:aliases + let s:aliases[l:alias] = a:name + endfor + endif endfunction " Get a function from the registry by its short name. function! ale#fix#registry#GetFunc(name) abort - return get(s:entries, a:name, {'function': ''}).function + " Use the exact name, or an alias. + let l:resolved_name = !has_key(s:entries, a:name) + \ ? get(s:aliases, a:name, a:name) + \ : a:name + + return get(s:entries, l:resolved_name, {'function': ''}).function endfunction function! s:ShouldSuggestForType(suggested_filetypes, type_list) abort @@ -203,6 +236,25 @@ function! s:ShouldSuggestForType(suggested_filetypes, type_list) abort return 0 endfunction +function! s:FormatEntry(key, entry) abort + let l:aliases_str = '' + + " Show aliases in :ALEFixSuggest if they are there. + if !empty(get(a:entry, 'aliases', [])) + let l:aliases_str = ', ' . join( + \ map(copy(a:entry.aliases), 'string(v:val)'), + \ ',' + \) + endif + + return printf( + \ '%s%s - %s', + \ string(a:key), + \ l:aliases_str, + \ a:entry.description, + \) +endfunction + " Suggest functions to use from the registry. function! ale#fix#registry#Suggest(filetype) abort let l:type_list = split(a:filetype, '\.') @@ -214,7 +266,7 @@ function! ale#fix#registry#Suggest(filetype) abort if s:ShouldSuggestForType(l:suggested_filetypes, l:type_list) call add( \ l:filetype_fixer_list, - \ printf('%s - %s', string(l:key), s:entries[l:key].description), + \ s:FormatEntry(l:key, s:entries[l:key]), \) endif endfor @@ -225,7 +277,7 @@ function! ale#fix#registry#Suggest(filetype) abort if empty(s:entries[l:key].suggested_filetypes) call add( \ l:generic_fixer_list, - \ printf('%s - %s', string(l:key), s:entries[l:key].description), + \ s:FormatEntry(l:key, s:entries[l:key]), \) endif endfor diff --git a/doc/ale.txt b/doc/ale.txt index ff8ac08..f7141cf 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1780,7 +1780,8 @@ ale#engine#ManageDirectory(buffer, directory) *ale#engine#ManageDirectory()* files. -ale#fix#registry#Add(name, func, filetypes, desc) *ale#fix#registry#Add()* +ale#fix#registry#Add(name, func, filetypes, desc, [aliases]) + *ale#fix#registry#Add()* Given a |String| `name` for a name to add to the registry, a |String| `func` for a function name, a |List| `filetypes` for a list of filetypes to @@ -1790,6 +1791,11 @@ ale#fix#registry#Add(name, func, filetypes, desc) *ale#fix#registry#Add()* The `name` can then be used for |g:ale_fixers| in place of the function name, and suggested for fixing files. + An optional |List| of |String|s for aliases can be passed as the `aliases` + argument. These aliases can also be used for looking up a fixer function. + ALE will search for fixers in the registry first by `name`, then by their + `aliases`. + ale#linter#Define(filetype, linter) *ale#linter#Define()* diff --git a/syntax/ale-fix-suggest.vim b/syntax/ale-fix-suggest.vim index be3d45e..b112f5b 100644 --- a/syntax/ale-fix-suggest.vim +++ b/syntax/ale-fix-suggest.vim @@ -3,7 +3,7 @@ if exists('b:current_syntax') endif syn match aleFixerComment /^.*$/ -syn match aleFixerName /^'[^']*'/ +syn match aleFixerName /\(^\|, \)'[^']*'/ syn match aleFixerHelp /^See :help ale-fix-configuration/ hi def link aleFixerComment Comment diff --git a/test/fix/test_ale_fix_aliases.vader b/test/fix/test_ale_fix_aliases.vader new file mode 100644 index 0000000..d3c47b3 --- /dev/null +++ b/test/fix/test_ale_fix_aliases.vader @@ -0,0 +1,5 @@ +Execute(prettier-eslint should be aliased): + AssertEqual 'ale#fixers#prettier_eslint#Fix', ale#fix#registry#GetFunc('prettier-eslint') + +Execute(prettier-standard should be aliased): + AssertEqual 'ale#fixers#prettier_standard#Fix', ale#fix#registry#GetFunc('prettier-standard') diff --git a/test/fix/test_ale_fix_suggest.vader b/test/fix/test_ale_fix_suggest.vader index 97227b4..1100aee 100644 --- a/test/fix/test_ale_fix_suggest.vader +++ b/test/fix/test_ale_fix_suggest.vader @@ -80,7 +80,7 @@ Execute(ALEFixSuggest output should be correct for only filetype handlers): Execute(ALEFixSuggest should suggest filetype and generic handlers): let &filetype = 'testft2.testft' - call ale#fix#registry#Add('zed', 'XYZ', ['testft2'], 'Zedify things.') + call ale#fix#registry#Add('zed', 'XYZ', ['testft2'], 'Zedify things.', ['foobar']) call ale#fix#registry#Add('alpha', 'XYZ', ['testft'], 'Alpha things.') call ale#fix#registry#Add('generic', 'XYZ', [], 'Generic things.') @@ -89,7 +89,7 @@ Execute(ALEFixSuggest should suggest filetype and generic handlers): \ 'Try the following fixers appropriate for the filetype:', \ '', \ '''alpha'' - Alpha things.', - \ '''zed'' - Zedify things.', + \ '''zed'', ''foobar'' - Zedify things.', \ '', \ 'Try the following generic fixers:', \ '', From 91fe749d037d8f11b8b34346392ebb840594994c Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 16:39:05 +0000 Subject: [PATCH 202/390] Fix a bug with resetting pattern options when ALE is enabled again --- autoload/ale/toggle.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index 7197498..dcca703 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -133,7 +133,7 @@ function! ale#toggle#Enable() abort if !g:ale_enabled " Set pattern options again, if enabled. if g:ale_pattern_options_enabled - call ale#pattern_options#SetOptions() + call ale#pattern_options#SetOptions(bufnr('')) endif call ale#toggle#Toggle() From b5ec1a5fd01a9c3076487741d4279391a236ce57 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 16:51:04 +0000 Subject: [PATCH 203/390] Fix #988 - Support --fix-dry-run for ESLint where available, and --fix-to-stdout for eslint_d --- autoload/ale/fixers/eslint.vim | 31 +++++++ test/fixers/test_eslint_fixer_callback.vader | 86 +++++++++++++++++++- 2 files changed, 114 insertions(+), 3 deletions(-) diff --git a/autoload/ale/fixers/eslint.vim b/autoload/ale/fixers/eslint.vim index ad9e9e0..969ac20 100644 --- a/autoload/ale/fixers/eslint.vim +++ b/autoload/ale/fixers/eslint.vim @@ -3,12 +3,43 @@ function! ale#fixers#eslint#Fix(buffer) abort let l:executable = ale#handlers#eslint#GetExecutable(a:buffer) + + let l:command = ale#semver#HasVersion(l:executable) + \ ? '' + \ : ale#node#Executable(a:buffer, l:executable) . ' --version' + + return { + \ 'command': l:command, + \ 'chain_with': 'ale#fixers#eslint#ApplyFixForVersion', + \} +endfunction + +function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort + let l:executable = ale#handlers#eslint#GetExecutable(a:buffer) + let l:version = ale#semver#GetVersion(l:executable, a:version_output) + let l:config = ale#handlers#eslint#FindConfig(a:buffer) if empty(l:config) return 0 endif + " Use --fix-to-stdout with eslint_d + if l:executable =~# 'eslint_d$' && ale#semver#GTE(l:version, [3, 19, 0]) + return { + \ 'command': ale#node#Executable(a:buffer, l:executable) + \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \} + endif + + " 4.9.0 is the first version with --fix-dry-run + if ale#semver#GTE(l:version, [4, 9, 0]) + return { + \ 'command': ale#node#Executable(a:buffer, l:executable) + \ . ' --stdin-filename %s --stdin --fix-dry-run', + \} + endif + return { \ 'command': ale#node#Executable(a:buffer, l:executable) \ . ' -c ' . ale#Escape(l:config) diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index d4783fc..60bb859 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -3,10 +3,12 @@ Before: After: call ale#test#RestoreDirectory() + call ale#semver#ResetVersionCache() Execute(The executable path should be correct): call ale#test#SetFilename('../eslint-test-files/react-app/subdir/testfile.js') + " eslint_d output with an older eslint version is used here. AssertEqual \ { \ 'read_temporary_file': 1, @@ -15,7 +17,7 @@ Execute(The executable path should be correct): \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) \ . ' --fix %t', \ }, - \ ale#fixers#eslint#Fix(bufnr('')) + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['v4.4.1 (eslint_d v5.1.0)']) Execute(The lower priority configuration file in a nested directory should be preferred): call ale#test#SetFilename('../eslint-test-files/react-app/subdir-with-config/testfile.js') @@ -28,7 +30,7 @@ Execute(The lower priority configuration file in a nested directory should be pr \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/subdir-with-config/.eslintrc')) \ . ' --fix %t', \ }, - \ ale#fixers#eslint#Fix(bufnr('')) + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) Execute(package.json should be used as a last resort): call ale#test#SetFilename('../eslint-test-files/react-app/subdir-with-package-json/testfile.js') @@ -41,7 +43,7 @@ Execute(package.json should be used as a last resort): \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) \ . ' --fix %t', \ }, - \ ale#fixers#eslint#Fix(bufnr('')) + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) call ale#test#SetFilename('../eslint-test-files/package.json') @@ -53,4 +55,82 @@ Execute(package.json should be used as a last resort): \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/package.json')) \ . ' --fix %t', \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) + +Execute(The version check should be correct): + call ale#test#SetFilename('../eslint-test-files/react-app/subdir/testfile.js') + + AssertEqual + \ { + \ 'chain_with': 'ale#fixers#eslint#ApplyFixForVersion', + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' --version' + \ }, \ ale#fixers#eslint#Fix(bufnr('')) + +Execute(--fix-dry-run should be used for 4.9.0 and up): + call ale#test#SetFilename('../eslint-test-files/react-app/subdir/testfile.js') + + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' --stdin-filename %s --stdin --fix-dry-run', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) + +Execute(--fix-to-stdout should be used for eslint_d): + call ale#test#SetFilename('../eslint-test-files/app-with-eslint-d/testfile.js') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/package.json')) + \ . ' --fix %t', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['']) + + " The option should be used when eslint_d is new enough. + " We look at the ESLint version instead of the eslint_d version. + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['v3.19.0 (eslint_d v4.2.0)']) + + " The option should be used for new versions too. + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) + +Execute(The version number should be cached): + call ale#test#SetFilename('../eslint-test-files/react-app/subdir-with-config/testfile.js') + + " Call the second callback with the version output. + call ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) + + " The version command should be skipped. + AssertEqual + \ { + \ 'chain_with': 'ale#fixers#eslint#ApplyFixForVersion', + \ 'command': '', + \ }, + \ ale#fixers#eslint#Fix(bufnr('')) + + " Call it again without the version output. We should use the newer command. + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' --stdin-filename %s --stdin --fix-dry-run', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) From 6e65998ca7ebd6eace6313be694100922f2229f4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 17:01:50 +0000 Subject: [PATCH 204/390] #988 Take --fix-dry-run away again, because it is dumb --- autoload/ale/fixers/eslint.vim | 8 -------- test/fixers/test_eslint_fixer_callback.vader | 20 -------------------- 2 files changed, 28 deletions(-) diff --git a/autoload/ale/fixers/eslint.vim b/autoload/ale/fixers/eslint.vim index 969ac20..d30f1ba 100644 --- a/autoload/ale/fixers/eslint.vim +++ b/autoload/ale/fixers/eslint.vim @@ -32,14 +32,6 @@ function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort \} endif - " 4.9.0 is the first version with --fix-dry-run - if ale#semver#GTE(l:version, [4, 9, 0]) - return { - \ 'command': ale#node#Executable(a:buffer, l:executable) - \ . ' --stdin-filename %s --stdin --fix-dry-run', - \} - endif - return { \ 'command': ale#node#Executable(a:buffer, l:executable) \ . ' -c ' . ale#Escape(l:config) diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index 60bb859..4ced3a1 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -69,17 +69,6 @@ Execute(The version check should be correct): \ }, \ ale#fixers#eslint#Fix(bufnr('')) -Execute(--fix-dry-run should be used for 4.9.0 and up): - call ale#test#SetFilename('../eslint-test-files/react-app/subdir/testfile.js') - - AssertEqual - \ { - \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) - \ . ' --stdin-filename %s --stdin --fix-dry-run', - \ }, - \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) - Execute(--fix-to-stdout should be used for eslint_d): call ale#test#SetFilename('../eslint-test-files/app-with-eslint-d/testfile.js') @@ -125,12 +114,3 @@ Execute(The version number should be cached): \ 'command': '', \ }, \ ale#fixers#eslint#Fix(bufnr('')) - - " Call it again without the version output. We should use the newer command. - AssertEqual - \ { - \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) - \ . ' --stdin-filename %s --stdin --fix-dry-run', - \ }, - \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) From 9857e0a4b7cf2a91453c50791b8cf0d9d7994792 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 17:25:37 +0000 Subject: [PATCH 205/390] Fix the eslint_d fixer tests for Windows --- test/fixers/test_eslint_fixer_callback.vader | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index 4ced3a1..8a5eaa4 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -75,8 +75,8 @@ Execute(--fix-to-stdout should be used for eslint_d): AssertEqual \ { \ 'read_temporary_file': 1, - \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ 'command': + \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/package.json')) \ . ' --fix %t', \ }, @@ -86,8 +86,8 @@ Execute(--fix-to-stdout should be used for eslint_d): " We look at the ESLint version instead of the eslint_d version. AssertEqual \ { - \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ 'command': + \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['v3.19.0 (eslint_d v4.2.0)']) @@ -95,8 +95,8 @@ Execute(--fix-to-stdout should be used for eslint_d): " The option should be used for new versions too. AssertEqual \ { - \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ 'command': + \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) From fbfde6968a562abb88373588687d9b26cac68469 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 17:44:21 +0000 Subject: [PATCH 206/390] Fix a typo --- test/fixers/test_prettier_fixer_callback.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/fixers/test_prettier_fixer_callback.vader b/test/fixers/test_prettier_fixer_callback.vader index 3480b41..c4f36f5 100644 --- a/test/fixers/test_prettier_fixer_callback.vader +++ b/test/fixers/test_prettier_fixer_callback.vader @@ -87,7 +87,7 @@ Execute(The version number should be cached): " Call the second callback with the version output. call ale#fixers#prettier#ApplyFixForVersion(bufnr(''), ['1.6.0']) - " Call it again without the vesrion output. We should use the newer command. + " Call it again without the version output. We should use the newer command. AssertEqual \ { \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' From d07b5b71a460eb0eeb5956f0da9dc409c24723aa Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 22:32:53 +0000 Subject: [PATCH 207/390] Add support for post-processing fixer output --- autoload/ale/fix.vim | 11 +++++++++++ doc/ale.txt | 9 +++++++++ test/fix/test_ale_fix.vader | 30 ++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index cbca68e..4d94f7b 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -109,6 +109,15 @@ function! s:HandleExit(job_id, exit_code) abort endif let l:chain_callback = get(l:job_info, 'chain_with', v:null) + let l:ProcessWith = get(l:job_info, 'process_with', v:null) + + " Post-process the output with a function if we have one. + if l:ProcessWith isnot v:null + let l:job_info.output = call( + \ ale#util#GetFunction(l:ProcessWith), + \ [l:buffer, l:job_info.output] + \) + endif " Use the output of the job for changing the file if it isn't empty, " otherwise skip this job and use the input from before. @@ -226,6 +235,7 @@ function! s:RunJob(options) abort \ 'chain_with': l:chain_with, \ 'callback_index': a:options.callback_index, \ 'callback_list': a:options.callback_list, + \ 'process_with': a:options.process_with, \} if l:read_temporary_file @@ -329,6 +339,7 @@ function! s:RunFixer(options) abort \ 'chain_with': l:Chain_with, \ 'callback_list': a:options.callback_list, \ 'callback_index': l:index, + \ 'process_with': get(l:result, 'process_with', v:null), \}) if !l:job_ran diff --git a/doc/ale.txt b/doc/ale.txt index f7141cf..12a8b86 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -459,6 +459,15 @@ are supported for running the commands. for commands which need to modify some file on disk in order to fix files. + `process_with` An optional callback for post-processing. + + The callback must accept two arguments, + `(buffer, output)`, which can be used for converting + the output from a command into lines to replace the + buffer's contents with. + + A |List| of |String|s must be returned. + `chain_with` An optional key for defining a callback to call next. The callback must accept two or three arguments, diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index 4793293..0987416 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -133,6 +133,25 @@ Before: return empty(l:lines) ? '' : l:lines[-1] endfunction + function! FixWithJSONPostProcessing(buffer) abort + let l:ProcessWith = 'JSONPostProcessor' + + " Test with lambdas where support is available. + if has('lambda') + let l:ProcessWith = {buffer, output -> JSONPostProcessor(buffer, output)} + endif + + return { + \ 'command': 'echo ' . ale#Escape('{"output": ["x", "y", "z"]}'), + \ 'read_buffer': 0, + \ 'process_with': l:ProcessWith, + \} + endfunction + + function! JSONPostProcessor(buffer, output) abort + return json_decode(a:output[0]).output + endfunction + After: Restore unlet! g:ale_run_synchronously @@ -160,6 +179,8 @@ After: delfunction GetLastMessage delfunction IgnoredEmptyOutput delfunction EchoLineNoPipe + delfunction FixWithJSONPostProcessing + delfunction JSONPostProcessor call ale#test#RestoreDirectory() @@ -612,3 +633,12 @@ Execute(A temporary file shouldn't be piped into the command when disabled): Expect(The new line should be used): new line + +Execute(Post-processing should work): + let g:ale_fixers.testft = ['FixWithJSONPostProcessing'] + ALEFix + +Expect(The lines in the JSON should be used): + x + y + z From 8dd542bed0dd39f4af6897410d36a048fe796518 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 22:39:43 +0000 Subject: [PATCH 208/390] Fix lambda and funcref chain values --- autoload/ale/fix.vim | 31 +++++++++++++++---------------- test/fix/test_ale_fix.vader | 9 ++++++++- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 4d94f7b..49ea1bb 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -108,7 +108,7 @@ function! s:HandleExit(job_id, exit_code) abort let l:job_info.output = readfile(l:job_info.file_to_read) endif - let l:chain_callback = get(l:job_info, 'chain_with', v:null) + let l:ChainCallback = get(l:job_info, 'chain_with', v:null) let l:ProcessWith = get(l:job_info, 'process_with', v:null) " Post-process the output with a function if we have one. @@ -123,13 +123,13 @@ function! s:HandleExit(job_id, exit_code) abort " otherwise skip this job and use the input from before. " " We'll use the input from before for chained commands. - if l:chain_callback is v:null && !empty(split(join(l:job_info.output))) + if l:ChainCallback is v:null && !empty(split(join(l:job_info.output))) let l:input = l:job_info.output else let l:input = l:job_info.input endif - let l:next_index = l:chain_callback is v:null + let l:next_index = l:ChainCallback is v:null \ ? l:job_info.callback_index + 1 \ : l:job_info.callback_index @@ -139,7 +139,7 @@ function! s:HandleExit(job_id, exit_code) abort \ 'output': l:job_info.output, \ 'callback_list': l:job_info.callback_list, \ 'callback_index': l:next_index, - \ 'chain_callback': l:chain_callback, + \ 'chain_callback': l:ChainCallback, \}) endfunction @@ -193,12 +193,12 @@ function! s:RunJob(options) abort let l:input = a:options.input let l:output_stream = a:options.output_stream let l:read_temporary_file = a:options.read_temporary_file - let l:chain_with = a:options.chain_with + let l:ChainWith = a:options.chain_with let l:read_buffer = a:options.read_buffer if empty(l:command) " If there's nothing further to chain the command with, stop here. - if l:chain_with is v:null + if l:ChainWith is v:null return 0 endif @@ -208,7 +208,7 @@ function! s:RunJob(options) abort \ 'input': l:input, \ 'callback_index': a:options.callback_index, \ 'callback_list': a:options.callback_list, - \ 'chain_callback': l:chain_with, + \ 'chain_callback': l:ChainWith, \ 'output': [], \}) @@ -232,7 +232,7 @@ function! s:RunJob(options) abort \ 'buffer': l:buffer, \ 'input': l:input, \ 'output': [], - \ 'chain_with': l:chain_with, + \ 'chain_with': l:ChainWith, \ 'callback_index': a:options.callback_index, \ 'callback_list': a:options.callback_list, \ 'process_with': a:options.process_with, @@ -298,14 +298,14 @@ function! s:RunFixer(options) abort let l:buffer = a:options.buffer let l:input = a:options.input let l:index = a:options.callback_index - let l:chain_callback = get(a:options, 'chain_callback', v:null) + let l:ChainCallback = get(a:options, 'chain_callback', v:null) while len(a:options.callback_list) > l:index - let l:Function = l:chain_callback isnot v:null - \ ? ale#util#GetFunction(l:chain_callback) + let l:Function = l:ChainCallback isnot v:null + \ ? ale#util#GetFunction(l:ChainCallback) \ : a:options.callback_list[l:index] - if l:chain_callback isnot v:null + if l:ChainCallback isnot v:null " Chained commands accept (buffer, output, [input]) let l:result = ale#util#FunctionArgCount(l:Function) == 2 \ ? call(l:Function, [l:buffer, a:options.output]) @@ -324,10 +324,9 @@ function! s:RunFixer(options) abort let l:input = l:result let l:index += 1 else - " Capitals are required for funcrefs. - let l:Chain_with = get(l:result, 'chain_with', v:null) + let l:ChainWith = get(l:result, 'chain_with', v:null) " Default to piping the buffer for the last fixer in the chain. - let l:read_buffer = get(l:result, 'read_buffer', l:Chain_with is v:null) + let l:read_buffer = get(l:result, 'read_buffer', l:ChainWith is v:null) let l:job_ran = s:RunJob({ \ 'buffer': l:buffer, @@ -336,7 +335,7 @@ function! s:RunFixer(options) abort \ 'output_stream': get(l:result, 'output_stream', 'stdout'), \ 'read_temporary_file': get(l:result, 'read_temporary_file', 0), \ 'read_buffer': l:read_buffer, - \ 'chain_with': l:Chain_with, + \ 'chain_with': l:ChainWith, \ 'callback_list': a:options.callback_list, \ 'callback_index': l:index, \ 'process_with': get(l:result, 'process_with', v:null), diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index 0987416..7e0ea33 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -67,7 +67,14 @@ Before: endfunction function! FirstChainCallbackSkipped(buffer) - return {'command': '', 'chain_with': 'SecondChainCallback'} + let l:ChainWith = 'SecondChainCallback' + + " Test with lambdas where support is available. + if has('lambda') + let l:ChainWith = {buffer, output -> SecondChainCallback(buffer, output)} + endif + + return {'command': '', 'chain_with': l:ChainWith} endfunction function! FirstChainCallbackSecondSkipped(buffer) From 6318a08e08716d460f8441457813875495050023 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 22:50:27 +0000 Subject: [PATCH 209/390] Fix a fixer test on Windows --- test/fix/test_ale_fix.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index 7e0ea33..c630ab2 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -156,7 +156,7 @@ Before: endfunction function! JSONPostProcessor(buffer, output) abort - return json_decode(a:output[0]).output + return json_decode(join(split(a:output[0]))).output endfunction After: From 5160f814d929e0936c3d920087e0c4d16040ae9c Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 23:23:14 +0000 Subject: [PATCH 210/390] Fix #988 - Support --fix-dry-run for ESLint by processing the JSON output --- autoload/ale/fixers/eslint.vim | 17 +++++++++ autoload/ale/util.vim | 9 ++++- test/fixers/test_eslint_fixer_callback.vader | 36 ++++++++++++++++++++ test/test_fuzzy_json_decode.vader | 8 +++++ 4 files changed, 69 insertions(+), 1 deletion(-) diff --git a/autoload/ale/fixers/eslint.vim b/autoload/ale/fixers/eslint.vim index d30f1ba..76615fb 100644 --- a/autoload/ale/fixers/eslint.vim +++ b/autoload/ale/fixers/eslint.vim @@ -14,6 +14,14 @@ function! ale#fixers#eslint#Fix(buffer) abort \} endfunction +function! ale#fixers#eslint#ProcessFixDryRunOutput(buffer, output) abort + for l:item in ale#util#FuzzyJSONDecode(a:output, []) + return split(get(l:item, 'output', ''), "\n") + endfor + + return [] +endfunction + function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort let l:executable = ale#handlers#eslint#GetExecutable(a:buffer) let l:version = ale#semver#GetVersion(l:executable, a:version_output) @@ -32,6 +40,15 @@ function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort \} endif + " 4.9.0 is the first version with --fix-dry-run + if ale#semver#GTE(l:version, [4, 9, 0]) + return { + \ 'command': ale#node#Executable(a:buffer, l:executable) + \ . ' --stdin-filename %s --stdin --fix-dry-run --format=json', + \ 'process_with': 'ale#fixers#eslint#ProcessFixDryRunOutput', + \} + endif + return { \ 'command': ale#node#Executable(a:buffer, l:executable) \ . ' -c ' . ale#Escape(l:config) diff --git a/autoload/ale/util.vim b/autoload/ale/util.vim index cf8d5be..1f590ad 100644 --- a/autoload/ale/util.vim +++ b/autoload/ale/util.vim @@ -250,7 +250,14 @@ function! ale#util#FuzzyJSONDecode(data, default) abort let l:str = type(a:data) == type('') ? a:data : join(a:data, '') try - return json_decode(l:str) + let l:result = json_decode(l:str) + + " Vim 8 only uses the value v:none for decoding blank strings. + if !has('nvim') && l:result is v:none + return a:default + endif + + return l:result catch /E474/ return a:default endtry diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index 8a5eaa4..afb267a 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -69,6 +69,18 @@ Execute(The version check should be correct): \ }, \ ale#fixers#eslint#Fix(bufnr('')) +Execute(--fix-dry-run should be used for 4.9.0 and up): + call ale#test#SetFilename('../eslint-test-files/react-app/subdir/testfile.js') + + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' --stdin-filename %s --stdin --fix-dry-run --format=json', + \ 'process_with': 'ale#fixers#eslint#ProcessFixDryRunOutput', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) + Execute(--fix-to-stdout should be used for eslint_d): call ale#test#SetFilename('../eslint-test-files/app-with-eslint-d/testfile.js') @@ -114,3 +126,27 @@ Execute(The version number should be cached): \ 'command': '', \ }, \ ale#fixers#eslint#Fix(bufnr('')) + + " Call it again without the version output. We should use the newer command. + AssertEqual + \ { + \ 'command': (has('win32') ? 'node.exe ' : '') + \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' --stdin-filename %s --stdin --fix-dry-run --format=json', + \ 'process_with': 'ale#fixers#eslint#ProcessFixDryRunOutput', + \ }, + \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) + +Execute(The --fix-dry-run post-processor should handle JSON output correctly): + AssertEqual + \ [], + \ ale#fixers#eslint#ProcessFixDryRunOutput(bufnr(''), []) + AssertEqual + \ [], + \ ale#fixers#eslint#ProcessFixDryRunOutput(bufnr(''), ['']) + AssertEqual + \ [], + \ ale#fixers#eslint#ProcessFixDryRunOutput(bufnr(''), ['[{}]']) + AssertEqual + \ ['foo', 'bar'], + \ ale#fixers#eslint#ProcessFixDryRunOutput(bufnr(''), ['[{"output": "foo\nbar"}]']) diff --git a/test/test_fuzzy_json_decode.vader b/test/test_fuzzy_json_decode.vader index 4ac0ca1..4b1c608 100644 --- a/test/test_fuzzy_json_decode.vader +++ b/test/test_fuzzy_json_decode.vader @@ -6,6 +6,14 @@ Execute(FuzzyJSONDecode should return the default for empty Strings): AssertEqual [], ale#util#FuzzyJSONDecode('', []) AssertEqual {}, ale#util#FuzzyJSONDecode('', {}) +Execute(FuzzyJSONDecode should return the default value for ['']): + AssertEqual [], ale#util#FuzzyJSONDecode([''], []) + AssertEqual {}, ale#util#FuzzyJSONDecode([''], {}) + +Execute(FuzzyJSONDecode should return the default value for only whitespace lines): + AssertEqual [], ale#util#FuzzyJSONDecode(['', "\n"], []) + AssertEqual {}, ale#util#FuzzyJSONDecode(['', "\n"], {}) + Execute(FuzzyJSONDecode should return the default for Lists with invalid JSON): AssertEqual [], ale#util#FuzzyJSONDecode(['x'], []) AssertEqual {}, ale#util#FuzzyJSONDecode(['x'], {}) From f99b027cc675ddd66119d0da0b120f5a22c2e54e Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 22 Nov 2017 23:45:51 +0000 Subject: [PATCH 211/390] Fix the JSON fixer post-processor test harder on Windows --- test/fix/test_ale_fix.vader | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index c630ab2..2a3e62c 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -148,15 +148,20 @@ Before: let l:ProcessWith = {buffer, output -> JSONPostProcessor(buffer, output)} endif + " Escaping needs to be handled specially for CMD on Windows. + let l:json_string = has('win32') + \ ? '{"output":["x","y","z"]}' + \ : ale#Escape('{"output": ["x", "y", "z"]}') + return { - \ 'command': 'echo ' . ale#Escape('{"output": ["x", "y", "z"]}'), + \ 'command': 'echo ' . l:json_string, \ 'read_buffer': 0, \ 'process_with': l:ProcessWith, \} endfunction function! JSONPostProcessor(buffer, output) abort - return json_decode(join(split(a:output[0]))).output + return json_decode(a:output[0]).output endfunction After: From 7dfe690b0b626489bfd0ba1eb54ec4ef5769f771 Mon Sep 17 00:00:00 2001 From: Martin Tournoij Date: Sat, 25 Nov 2017 03:36:36 +0000 Subject: [PATCH 212/390] Delete to black hole register in fixer Otherwise it'll be in "" and "0, which is an unexpected side-effect IMHO. --- autoload/ale/fix.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 49ea1bb..0a270ec 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -35,7 +35,7 @@ function! ale#fix#ApplyQueuedFixes() abort if l:end_line >= l:start_line let l:save = winsaveview() - silent execute l:start_line . ',' . l:end_line . 'd' + silent execute l:start_line . ',' . l:end_line . 'd_' call winrestview(l:save) endif From b1a6abdda6f23ba314799f21c04d30e3411cebc7 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 12:24:18 +0000 Subject: [PATCH 213/390] #1162 Add unfinished experimental code for supporting LSP completion, clean up the tests, and make the completion cancelling better --- autoload/ale/completion.vim | 191 ++++++++-- autoload/ale/lsp/message.vim | 21 ++ test/completion/test_completion_events.vader | 172 +++++++++ .../test_completion_filtering.vader | 36 ++ .../completion/test_completion_prefixes.vader | 19 + .../test_lsp_completion_messages.vader | 171 +++++++++ .../test_tsserver_completion_parsing.vader | 75 ++++ test/lsp/test_lsp_client_messages.vader | 29 ++ test/test_completion.vader | 347 ------------------ 9 files changed, 677 insertions(+), 384 deletions(-) create mode 100644 test/completion/test_completion_events.vader create mode 100644 test/completion/test_completion_filtering.vader create mode 100644 test/completion/test_completion_prefixes.vader create mode 100644 test/completion/test_lsp_completion_messages.vader create mode 100644 test/completion/test_tsserver_completion_parsing.vader delete mode 100644 test/test_completion.vader diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index e5f1dbb..f814390 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -2,8 +2,45 @@ " Description: Completion support for LSP linters let s:timer_id = -1 +let s:last_done_pos = [] -function! s:GetRegex(map, filetype) abort +" CompletionItemKind values from the LSP protocol. +let s:LSP_COMPLETION_TEXT_KIND = 1 +let s:LSP_COMPLETION_METHOD_KIND = 2 +let s:LSP_COMPLETION_FUNCTION_KIND = 3 +let s:LSP_COMPLETION_CONSTRUCTOR_KIND = 4 +let s:LSP_COMPLETION_FIELD_KIND = 5 +let s:LSP_COMPLETION_VARIABLE_KIND = 6 +let s:LSP_COMPLETION_CLASS_KIND = 7 +let s:LSP_COMPLETION_INTERFACE_KIND = 8 +let s:LSP_COMPLETION_MODULE_KIND = 9 +let s:LSP_COMPLETION_PROPERTY_KIND = 10 +let s:LSP_COMPLETION_UNIT_KIND = 11 +let s:LSP_COMPLETION_VALUE_KIND = 12 +let s:LSP_COMPLETION_ENUM_KIND = 13 +let s:LSP_COMPLETION_KEYWORD_KIND = 14 +let s:LSP_COMPLETION_SNIPPET_KIND = 15 +let s:LSP_COMPLETION_COLOR_KIND = 16 +let s:LSP_COMPLETION_FILE_KIND = 17 +let s:LSP_COMPLETION_REFERENCE_KIND = 18 + +" Regular expressions for checking the characters in the line before where +" the insert cursor is. If one of these matches, we'll check for completions. +let s:should_complete_map = { +\ '': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$|\.$', +\} + +" Regular expressions for finding the start column to replace with completion. +let s:omni_start_map = { +\ '': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$', +\} + +" A map of exact characters for triggering LSP completions. +let s:trigger_character_map = { +\ '': ['.'], +\} + +function! s:GetFiletypeValue(map, filetype) abort for l:part in reverse(split(a:filetype, '\.')) let l:regex = get(a:map, l:part, []) @@ -13,18 +50,12 @@ function! s:GetRegex(map, filetype) abort endfor " Use the default regex for other files. - return s:should_complete_map[''] + return a:map[''] endfunction -" Regular expressions for checking the characters in the line before where -" the insert cursor is. If one of these matches, we'll check for completions. -let s:should_complete_map = { -\ '': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$|\.$', -\} - " Check if we should look for completions for a language. function! ale#completion#GetPrefix(filetype, line, column) abort - let l:regex = s:GetRegex(s:should_complete_map, a:filetype) + let l:regex = s:GetFiletypeValue(s:should_complete_map, a:filetype) " The column we're using completions for is where we are inserting text, " like so: " abc @@ -33,11 +64,15 @@ function! ale#completion#GetPrefix(filetype, line, column) abort return matchstr(getline(a:line)[: a:column - 2], l:regex) endfunction -" Regular expressions for finding the start column to replace with completion. -let s:omni_start_map = { -\ 'javascript': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$', -\ 'typescript': '\v[a-zA-Z$_][a-zA-Z$_0-9]*$', -\} +function! ale#completion#GetTriggerCharacter(filetype, prefix) abort + let l:char_list = s:GetFiletypeValue(s:trigger_character_map, a:filetype) + + if index(l:char_list, a:prefix) >= 0 + return a:prefix + endif + + return '' +endfunction function! ale#completion#Filter(suggestions, prefix) abort " For completing... @@ -82,7 +117,7 @@ function! ale#completion#OmniFunc(findstart, base) abort if a:findstart let l:line = b:ale_completion_info.line let l:column = b:ale_completion_info.column - let l:regex = s:GetRegex(s:omni_start_map, &filetype) + let l:regex = s:GetFiletypeValue(s:omni_start_map, &filetype) let l:up_to_column = getline(l:line)[: l:column - 2] let l:match = matchstr(l:up_to_column, l:regex) @@ -180,7 +215,47 @@ function! ale#completion#ParseTSServerCompletionEntryDetails(response) abort return l:results endfunction -function! ale#completion#HandleTSServerLSPResponse(conn_id, response) abort +function! ale#completion#ParseLSPCompletions(response) abort + let l:item_list = [] + + if type(get(a:response, 'result')) is type([]) + let l:item_list = a:response.result + elseif type(get(a:response, 'result')) is type({}) + \&& type(get(a:response.result, 'items')) is type([]) + let l:item_list = a:response.result.items + endif + + let l:results = [] + + for l:item in l:item_list + " See :help complete-items for Vim completion kinds + if l:item.kind is s:LSP_COMPLETION_METHOD_KIND + let l:kind = 'm' + elseif l:item.kind is s:LSP_COMPLETION_CONSTRUCTOR_KIND + let l:kind = 'm' + elseif l:item.kind is s:LSP_COMPLETION_FUNCTION_KIND + let l:kind = 'f' + elseif l:item.kind is s:LSP_COMPLETION_CLASS_KIND + let l:kind = 'f' + elseif l:item.kind is s:LSP_COMPLETION_INTERFACE_KIND + let l:kind = 'f' + else + let l:kind = 'v' + endif + + call add(l:results, { + \ 'word': l:item.label, + \ 'kind': l:kind, + \ 'icase': 1, + \ 'menu': l:item.detail, + \ 'info': l:item.documentation, + \}) + endfor + + return l:results +endfunction + +function! ale#completion#HandleTSServerResponse(conn_id, response) abort if !s:CompletionStillValid(get(a:response, 'request_seq')) return endif @@ -216,28 +291,55 @@ function! ale#completion#HandleTSServerLSPResponse(conn_id, response) abort endif endfunction + +function! ale#completion#HandleLSPResponse(conn_id, response) abort + if !s:CompletionStillValid(get(a:response, 'id')) + return + endif + + call ale#completion#Show( + \ a:response, + \ 'ale#completion#ParseLSPCompletions', + \) +endfunction + function! s:GetLSPCompletions(linter) abort let l:buffer = bufnr('') - let l:lsp_details = ale#linter#StartLSP( - \ l:buffer, - \ a:linter, - \ function('ale#completion#HandleTSServerLSPResponse'), - \) + let l:Callback = a:linter.lsp is# 'tsserver' + \ ? function('ale#completion#HandleTSServerResponse') + \ : function('ale#completion#HandleLSPResponse') + + let l:lsp_details = ale#linter#StartLSP(l:buffer, a:linter, l:Callback) if empty(l:lsp_details) return 0 endif let l:id = l:lsp_details.connection_id - let l:command = l:lsp_details.command let l:root = l:lsp_details.project_root - let l:message = ale#lsp#tsserver_message#Completions( - \ l:buffer, - \ b:ale_completion_info.line, - \ b:ale_completion_info.column, - \ b:ale_completion_info.prefix, - \) + if a:linter.lsp is# 'tsserver' + let l:message = ale#lsp#tsserver_message#Completions( + \ l:buffer, + \ b:ale_completion_info.line, + \ b:ale_completion_info.column, + \ b:ale_completion_info.prefix, + \) + else + " For LSP completions, we need to clamp the column to the length of + " the line. python-language-server and perhaps others do not implement + " this correctly. + let l:message = ale#lsp#message#Completion( + \ l:buffer, + \ b:ale_completion_info.line, + \ min([ + \ b:ale_completion_info.line_length, + \ b:ale_completion_info.column + \ ]), + \ '', + \) + endif + let l:request_id = ale#lsp#Send(l:id, l:message, l:root) if l:request_id @@ -247,6 +349,10 @@ function! s:GetLSPCompletions(linter) abort endfunction function! ale#completion#GetCompletions() abort + if !g:ale_completion_enabled + return + endif + let [l:line, l:column] = getcurpos()[1:2] let l:prefix = ale#completion#GetPrefix(&filetype, l:line, l:column) @@ -255,8 +361,11 @@ function! ale#completion#GetCompletions() abort return endif + let l:line_length = len(getline('.')) + let b:ale_completion_info = { \ 'line': l:line, + \ 'line_length': l:line_length, \ 'column': l:column, \ 'prefix': l:prefix, \ 'conn_id': 0, @@ -264,8 +373,11 @@ function! ale#completion#GetCompletions() abort \} for l:linter in ale#linter#Get(&filetype) - if l:linter.lsp is# 'tsserver' - call s:GetLSPCompletions(l:linter) + if !empty(l:linter.lsp) + if l:linter.lsp is# 'tsserver' + \|| get(g:, 'ale_completion_experimental_lsp_support', 0) + call s:GetLSPCompletions(l:linter) + endif endif endfor endfunction @@ -292,15 +404,18 @@ function! ale#completion#StopTimer() abort endfunction function! ale#completion#Queue() abort - let l:time = get(b:, 'ale_complete_done_time', 0) - - if l:time && ale#util#ClockMilliseconds() - l:time < 100 - " Do not ask for completions shortly after we just closed the menu. + if !g:ale_completion_enabled return endif let s:timer_pos = getcurpos()[1:2] + if s:timer_pos == s:last_done_pos + " Do not ask for completions if the cursor rests on the position we + " last completed on. + return + endif + " If we changed the text again while we're still waiting for a response, " then invalidate the requests before the timer ticks again. if exists('b:ale_completion_info') @@ -317,7 +432,10 @@ function! ale#completion#Done() abort " Reset settings when completion is done. if exists('b:ale_old_omnifunc') - let &l:omnifunc = b:ale_old_omnifunc + if b:ale_old_omnifunc isnot# 'pythoncomplete#Complete' + let &l:omnifunc = b:ale_old_omnifunc + endif + unlet b:ale_old_omnifunc endif @@ -326,8 +444,7 @@ function! ale#completion#Done() abort unlet b:ale_old_completopt endif - " Set a timestamp, so we can avoid requesting completions again. - let b:ale_complete_done_time = ale#util#ClockMilliseconds() + let s:last_done_pos = getcurpos()[1:2] endfunction function! s:Setup(enabled) abort diff --git a/autoload/ale/lsp/message.vim b/autoload/ale/lsp/message.vim index 31a9b21..a90d4e7 100644 --- a/autoload/ale/lsp/message.vim +++ b/autoload/ale/lsp/message.vim @@ -86,3 +86,24 @@ function! ale#lsp#message#DidClose(buffer) abort \ }, \}] endfunction + +let s:COMPLETION_TRIGGER_INVOKED = 1 +let s:COMPLETION_TRIGGER_CHARACTER = 2 + +function! ale#lsp#message#Completion(buffer, line, column, trigger_character) abort + let l:message = [0, 'textDocument/completion', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('#' . a:buffer . ':p')), + \ }, + \ 'position': {'line': a:line - 1, 'character': a:column - 1}, + \}] + + if !empty(a:trigger_character) + let l:message[2].context = { + \ 'triggerKind': s:COMPLETION_TRIGGER_CHARACTER, + \ 'triggerCharacter': a:trigger_character, + \} + endif + + return l:message +endfunction diff --git a/test/completion/test_completion_events.vader b/test/completion/test_completion_events.vader new file mode 100644 index 0000000..49d485f --- /dev/null +++ b/test/completion/test_completion_events.vader @@ -0,0 +1,172 @@ +Before: + Save g:ale_completion_enabled + Save g:ale_completion_delay + Save g:ale_completion_max_suggestions + Save g:ale_completion_experimental_lsp_support + Save &l:omnifunc + Save &l:completeopt + + unlet! g:ale_completion_experimental_lsp_support + + let g:ale_completion_enabled = 1 + let g:get_completions_called = 0 + let g:feedkeys_calls = [] + + runtime autoload/ale/util.vim + + function! ale#util#FeedKeys(string, mode) abort + call add(g:feedkeys_calls, [a:string, a:mode]) + endfunction + + function! CheckCompletionCalled(expect_success) abort + let g:get_completions_called = 0 + + " We just want to check if the function is called. + function! ale#completion#GetCompletions() + let g:get_completions_called = 1 + endfunction + + let g:ale_completion_delay = 0 + call ale#completion#Queue() + sleep 1m + + AssertEqual a:expect_success, g:get_completions_called + endfunction + +After: + Restore + + unlet! g:get_completions_called + unlet! b:ale_old_omnifunc + unlet! b:ale_old_completopt + unlet! b:ale_completion_info + unlet! b:ale_completion_response + unlet! b:ale_completion_parser + unlet! b:ale_complete_done_time + unlet! g:ale_completion_experimental_lsp_support + + delfunction CheckCompletionCalled + + " Stop any timers we left behind. + " This stops the tests from failing randomly. + call ale#completion#StopTimer() + + runtime autoload/ale/completion.vim + runtime autoload/ale/util.vim + +Execute(ale#completion#GetCompletions should be called when the cursor position stays the same): + call CheckCompletionCalled(1) + +Given typescript(): + let abc = y. + let foo = ab + let foo = (ab) + +Execute(ale#completion#GetCompletions should not be called when the cursor position changes): + call setpos('.', [bufnr(''), 1, 2, 0]) + + " We just want to check if the function is called. + function! ale#completion#GetCompletions() + let g:get_completions_called = 1 + endfunction + + let g:ale_completion_delay = 0 + call ale#completion#Queue() + + " Change the cursor position before the callback is triggered. + call setpos('.', [bufnr(''), 2, 2, 0]) + + sleep 1m + + Assert !g:get_completions_called + +Execute(Completion should not be done shortly after the CompleteDone function): + call CheckCompletionCalled(1) + call ale#completion#Done() + call CheckCompletionCalled(0) + +Execute(ale#completion#Show() should remember the omnifunc setting and replace it): + let &l:omnifunc = 'FooBar' + + call ale#completion#Show('Response', 'Parser') + + AssertEqual 'FooBar', b:ale_old_omnifunc + AssertEqual 'ale#completion#OmniFunc', &l:omnifunc + +Execute(ale#completion#Show() should remember the completeopt setting and replace it): + let &l:completeopt = 'menu' + + call ale#completion#Show('Response', 'Parser') + + AssertEqual 'menu', b:ale_old_completopt + AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt + +Execute(ale#completion#OmniFunc() should also remember the completeopt setting and replace it): + let &l:completeopt = 'menu' + + call ale#completion#OmniFunc(0, '') + + AssertEqual 'menu', b:ale_old_completopt + AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt + +Execute(ale#completion#Show() should make the correct feedkeys() call): + call ale#completion#Show('Response', 'Parser') + + AssertEqual [["\\", 'n']], g:feedkeys_calls + +Execute(ale#completion#Show() should set up the response and parser): + call ale#completion#Show('Response', 'Parser') + + AssertEqual 'Response', b:ale_completion_response + AssertEqual 'Parser', b:ale_completion_parser + +Execute(ale#completion#Done() should restore old omnifunc values): + let b:ale_old_omnifunc = 'FooBar' + + call ale#completion#Done() + + " We reset the old omnifunc setting and remove the buffer variable. + AssertEqual 'FooBar', &l:omnifunc + Assert !has_key(b:, 'ale_old_omnifunc') + +Execute(ale#completion#Done() should restore the old completeopt setting): + let b:ale_old_completopt = 'menu' + let &l:completeopt = 'menu,menuone,preview,noselect,noinsert' + + call ale#completion#Done() + + AssertEqual 'menu', &l:completeopt + Assert !has_key(b:, 'ale_old_completopt') + +Execute(ale#completion#Done() should leave settings alone when none were remembered): + let &l:omnifunc = 'BazBoz' + let &l:completeopt = 'menu' + + call ale#completion#Done() + + AssertEqual 'BazBoz', &l:omnifunc + AssertEqual 'menu', &l:completeopt + +Execute(The completion request_id should be reset when queuing again): + let b:ale_completion_info = {'request_id': 123} + + let g:ale_completion_delay = 0 + call ale#completion#Queue() + sleep 1m + + AssertEqual 0, b:ale_completion_info.request_id + +Execute(b:ale_completion_info should be set up correctly when requesting completions): + call setpos('.', [bufnr(''), 3, 14, 0]) + call ale#completion#GetCompletions() + + AssertEqual + \ { + \ 'request_id': 0, + \ 'conn_id': 0, + \ 'column': 14, + \ 'line_length': 14, + \ 'line': 3, + \ 'prefix': 'ab', + \ }, + \ b:ale_completion_info diff --git a/test/completion/test_completion_filtering.vader b/test/completion/test_completion_filtering.vader new file mode 100644 index 0000000..3e461ae --- /dev/null +++ b/test/completion/test_completion_filtering.vader @@ -0,0 +1,36 @@ +Execute(Prefix filtering should work for Lists of strings): + AssertEqual + \ ['FooBar', 'foo'], + \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], 'foo') + AssertEqual + \ ['FooBar', 'FongBar', 'baz', 'foo'], + \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], '.') + +Execute(Prefix filtering should work for completion items): + AssertEqual + \ [{'word': 'FooBar'}, {'word': 'foo'}], + \ ale#completion#Filter( + \ [ + \ {'word': 'FooBar'}, + \ {'word': 'FongBar'}, + \ {'word': 'baz'}, + \ {'word': 'foo'}, + \ ], + \ 'foo' + \ ) + AssertEqual + \ [ + \ {'word': 'FooBar'}, + \ {'word': 'FongBar'}, + \ {'word': 'baz'}, + \ {'word': 'foo'}, + \ ], + \ ale#completion#Filter( + \ [ + \ {'word': 'FooBar'}, + \ {'word': 'FongBar'}, + \ {'word': 'baz'}, + \ {'word': 'foo'}, + \ ], + \ '.' + \ ) diff --git a/test/completion/test_completion_prefixes.vader b/test/completion/test_completion_prefixes.vader new file mode 100644 index 0000000..8ac2932 --- /dev/null +++ b/test/completion/test_completion_prefixes.vader @@ -0,0 +1,19 @@ +Given typescript(): + let abc = y. + let foo = ab + let foo = (ab) + +Execute(Completion should be done after dots in TypeScript): + AssertEqual '.', ale#completion#GetPrefix(&filetype, 1, 13) + +Execute(Completion should be done after words in TypeScript): + AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 2, 13) + +Execute(Completion should be done after words in parens in TypeScript): + AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 3, 14) + +Execute(Completion should not be done after parens in TypeScript): + AssertEqual '', ale#completion#GetPrefix(&filetype, 3, 15) + +Execute(Completion prefixes should work for other filetypes): + AssertEqual 'ab', ale#completion#GetPrefix('xxxyyyzzz', 3, 14) diff --git a/test/completion/test_lsp_completion_messages.vader b/test/completion/test_lsp_completion_messages.vader new file mode 100644 index 0000000..df340fb --- /dev/null +++ b/test/completion/test_lsp_completion_messages.vader @@ -0,0 +1,171 @@ +Before: + Save g:ale_completion_delay + Save g:ale_completion_max_suggestions + Save g:ale_completion_info + Save g:ale_completion_experimental_lsp_support + Save &l:omnifunc + Save &l:completeopt + + unlet! g:ale_completion_experimental_lsp_support + + let g:ale_completion_enabled = 1 + + call ale#test#SetDirectory('/testplugin/test/completion') + call ale#test#SetFilename('dummy.txt') + + runtime autoload/ale/lsp.vim + + let g:message = [] + let g:Callback = '' + + function! ale#linter#StartLSP(buffer, linter, callback) abort + let g:Callback = a:callback + + return { + \ 'connection_id': 347, + \ 'project_root': '/foo/bar', + \} + endfunction + + " Replace the Send function for LSP, so we can monitor calls to it. + function! ale#lsp#Send(conn_id, message, ...) abort + let g:message = a:message + endfunction + +After: + Restore + + unlet! g:message + unlet! g:Callback + unlet! b:ale_old_omnifunc + unlet! b:ale_old_completopt + unlet! b:ale_completion_info + unlet! b:ale_completion_response + unlet! b:ale_completion_parser + unlet! b:ale_complete_done_time + unlet! b:ale_linters + unlet! g:ale_completion_experimental_lsp_support + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + + " Stop any timers we left behind. + " This stops the tests from failing randomly. + call ale#completion#StopTimer() + + runtime autoload/ale/completion.vim + runtime autoload/ale/lsp.vim + +Given typescript(Some typescript file): + foo + somelongerline + bazxyzxyzxyz + +Execute(The right message should be sent for the initial tsserver request): + runtime ale_linters/typescript/tsserver.vim + let b:ale_linters = ['tsserver'] + " The cursor position needs to match what was saved before. + call setpos('.', [bufnr(''), 1, 3, 0]) + + call ale#completion#GetCompletions() + + " We should send the right callback. + AssertEqual + \ 'function(''ale#completion#HandleTSServerResponse'')', + \ string(g:Callback) + " We should send the right message. + AssertEqual + \ [0, 'ts@completions', {'file': expand('%:p'), 'line': 1, 'offset': 3, 'prefix': 'fo'}], + \ g:message + " We should set up the completion info correctly. + AssertEqual + \ { + \ 'line_length': 3, + \ 'conn_id': 0, + \ 'column': 3, + \ 'request_id': 0, + \ 'line': 1, + \ 'prefix': 'fo', + \ }, + \ get(b:, 'ale_completion_info', {}) + +Execute(The right message sent to the tsserver LSP when the first completion message is received): + " The cursor position needs to match what was saved before. + call setpos('.', [bufnr(''), 1, 1, 0]) + let b:ale_completion_info = { + \ 'conn_id': 123, + \ 'prefix': 'f', + \ 'request_id': 4, + \ 'line': 1, + \ 'column': 1, + \} + " We should only show up to this many suggestions. + let g:ale_completion_max_suggestions = 3 + + " Handle the response for completions. + call ale#completion#HandleTSServerResponse(123, { + \ 'request_seq': 4, + \ 'command': 'completions', + \ 'body': [ + \ {'name': 'Baz'}, + \ {'name': 'dingDong'}, + \ {'name': 'Foo'}, + \ {'name': 'FooBar'}, + \ {'name': 'frazzle'}, + \ {'name': 'FFS'}, + \ ], + \}) + + " The entry details messages should have been sent. + AssertEqual + \ [ + \ 0, + \ 'ts@completionEntryDetails', + \ { + \ 'file': expand('%:p'), + \ 'entryNames': ['Foo', 'FooBar', 'frazzle'], + \ 'offset': 1, + \ 'line': 1, + \ }, + \ ], + \ g:message + +Given python(Some Python file): + foo + somelongerline + bazxyzxyzxyz + +Execute(The right message should be sent for the initial LSP request): + let g:ale_completion_experimental_lsp_support = 1 + + runtime ale_linters/python/pyls.vim + let b:ale_linters = ['pyls'] + " The cursor position needs to match what was saved before. + call setpos('.', [bufnr(''), 1, 5, 0]) + + call ale#completion#GetCompletions() + + " We should send the right callback. + AssertEqual + \ 'function(''ale#completion#HandleLSPResponse'')', + \ string(g:Callback) + " We should send the right message. + " The character index needs to be at most the index of the last character on + " the line, or integration with pyls will be broken. + AssertEqual + \ [0, 'textDocument/completion', { + \ 'textDocument': {'uri': ale#path#ToURI(expand('%:p'))}, + \ 'position': {'line': 0, 'character': 2}, + \ }], + \ g:message + " We should set up the completion info correctly. + AssertEqual + \ { + \ 'line_length': 3, + \ 'conn_id': 0, + \ 'column': 3, + \ 'request_id': 0, + \ 'line': 1, + \ 'prefix': 'fo', + \ }, + \ get(b:, 'ale_completion_info', {}) diff --git a/test/completion/test_tsserver_completion_parsing.vader b/test/completion/test_tsserver_completion_parsing.vader new file mode 100644 index 0000000..b663ef4 --- /dev/null +++ b/test/completion/test_tsserver_completion_parsing.vader @@ -0,0 +1,75 @@ +Execute(TypeScript completions responses should be parsed correctly): + AssertEqual [], + \ ale#completion#ParseTSServerCompletions({ + \ 'body': [], + \}) + AssertEqual ['foo', 'bar', 'baz'], + \ ale#completion#ParseTSServerCompletions({ + \ 'body': [ + \ {'name': 'foo'}, + \ {'name': 'bar'}, + \ {'name': 'baz'}, + \ ], + \}) + +Execute(TypeScript completion details responses should be parsed correctly): + AssertEqual + \ [ + \ { + \ 'word': 'abc', + \ 'menu': '(property) Foo.abc: number', + \ 'info': '', + \ 'kind': 'f', + \ 'icase': 1, + \ }, + \ { + \ 'word': 'def', + \ 'menu': '(property) Foo.def: number', + \ 'info': 'foo bar baz', + \ 'kind': 'f', + \ 'icase': 1, + \ }, + \ ], + \ ale#completion#ParseTSServerCompletionEntryDetails({ + \ 'body': [ + \ { + \ 'name': 'abc', + \ 'kind': 'parameterName', + \ 'displayParts': [ + \ {'text': '('}, + \ {'text': 'property'}, + \ {'text': ')'}, + \ {'text': ' '}, + \ {'text': 'Foo'}, + \ {'text': '.'}, + \ {'text': 'abc'}, + \ {'text': ':'}, + \ {'text': ' '}, + \ {'text': 'number'}, + \ ], + \ }, + \ { + \ 'name': 'def', + \ 'kind': 'parameterName', + \ 'displayParts': [ + \ {'text': '('}, + \ {'text': 'property'}, + \ {'text': ')'}, + \ {'text': ' '}, + \ {'text': 'Foo'}, + \ {'text': '.'}, + \ {'text': 'def'}, + \ {'text': ':'}, + \ {'text': ' '}, + \ {'text': 'number'}, + \ ], + \ 'documentation': [ + \ {'text': 'foo'}, + \ {'text': ' '}, + \ {'text': 'bar'}, + \ {'text': ' '}, + \ {'text': 'baz'}, + \ ], + \ }, + \ ], + \}) diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index c6d82b6..bd0cd10 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -101,6 +101,35 @@ Execute(ale#lsp#message#DidClose() should return correct messages): \ ], \ ale#lsp#message#DidClose(bufnr('')) +Execute(ale#lsp#message#Completion() should return correct messages): + AssertEqual + \ [ + \ 0, + \ 'textDocument/completion', + \ { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), + \ }, + \ 'position': {'line': 11, 'character': 33}, + \ } + \ ], + \ ale#lsp#message#Completion(bufnr(''), 12, 34, '') + +Execute(ale#lsp#message#Completion() should return correct messages with a trigger charaacter): + AssertEqual + \ [ + \ 0, + \ 'textDocument/completion', + \ { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), + \ }, + \ 'position': {'line': 11, 'character': 33}, + \ 'context': {'triggerKind': 2, 'triggerCharacter': '.'}, + \ } + \ ], + \ ale#lsp#message#Completion(bufnr(''), 12, 34, '.') + Execute(ale#lsp#tsserver_message#Open() should return correct messages): AssertEqual \ [ diff --git a/test/test_completion.vader b/test/test_completion.vader deleted file mode 100644 index 9662fc2..0000000 --- a/test/test_completion.vader +++ /dev/null @@ -1,347 +0,0 @@ -Before: - Save g:ale_completion_enabled - Save g:ale_completion_delay - Save g:ale_completion_max_suggestions - Save &l:omnifunc - Save &l:completeopt - - let g:test_vars = { - \ 'feedkeys_calls': [], - \} - - function! ale#util#FeedKeys(string, mode) abort - call add(g:test_vars.feedkeys_calls, [a:string, a:mode]) - endfunction - - function! CheckCompletionCalled(expect_success) abort - let g:test_vars.get_completions_called = 0 - - " We just want to check if the function is called. - function! ale#completion#GetCompletions() - let g:test_vars.get_completions_called = 1 - endfunction - - let g:ale_completion_delay = 0 - call ale#completion#Queue() - sleep 1m - - AssertEqual a:expect_success, g:test_vars.get_completions_called - endfunction - -After: - Restore - - unlet! g:test_vars - unlet! b:ale_old_omnifunc - unlet! b:ale_old_completopt - unlet! b:ale_completion_info - unlet! b:ale_completion_response - unlet! b:ale_completion_parser - unlet! b:ale_complete_done_time - - delfunction CheckCompletionCalled - - " Stop any timers we left behind. - " This stops the tests from failing randomly. - call ale#completion#StopTimer() - - runtime autoload/ale/completion.vim - runtime autoload/ale/lsp.vim - - if g:ale_completion_enabled - call ale#completion#Enable() - else - call ale#completion#Disable() - endif - -Execute(TypeScript completions responses should be parsed correctly): - AssertEqual [], - \ ale#completion#ParseTSServerCompletions({ - \ 'body': [], - \}) - AssertEqual ['foo', 'bar', 'baz'], - \ ale#completion#ParseTSServerCompletions({ - \ 'body': [ - \ {'name': 'foo'}, - \ {'name': 'bar'}, - \ {'name': 'baz'}, - \ ], - \}) - -Execute(TypeScript completion details responses should be parsed correctly): - AssertEqual - \ [ - \ { - \ 'word': 'abc', - \ 'menu': '(property) Foo.abc: number', - \ 'info': '', - \ 'kind': 'f', - \ 'icase': 1, - \ }, - \ { - \ 'word': 'def', - \ 'menu': '(property) Foo.def: number', - \ 'info': 'foo bar baz', - \ 'kind': 'f', - \ 'icase': 1, - \ }, - \ ], - \ ale#completion#ParseTSServerCompletionEntryDetails({ - \ 'body': [ - \ { - \ 'name': 'abc', - \ 'kind': 'parameterName', - \ 'displayParts': [ - \ {'text': '('}, - \ {'text': 'property'}, - \ {'text': ')'}, - \ {'text': ' '}, - \ {'text': 'Foo'}, - \ {'text': '.'}, - \ {'text': 'abc'}, - \ {'text': ':'}, - \ {'text': ' '}, - \ {'text': 'number'}, - \ ], - \ }, - \ { - \ 'name': 'def', - \ 'kind': 'parameterName', - \ 'displayParts': [ - \ {'text': '('}, - \ {'text': 'property'}, - \ {'text': ')'}, - \ {'text': ' '}, - \ {'text': 'Foo'}, - \ {'text': '.'}, - \ {'text': 'def'}, - \ {'text': ':'}, - \ {'text': ' '}, - \ {'text': 'number'}, - \ ], - \ 'documentation': [ - \ {'text': 'foo'}, - \ {'text': ' '}, - \ {'text': 'bar'}, - \ {'text': ' '}, - \ {'text': 'baz'}, - \ ], - \ }, - \ ], - \}) - -Execute(Prefix filtering should work for Lists of strings): - AssertEqual - \ ['FooBar', 'foo'], - \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], 'foo') - AssertEqual - \ ['FooBar', 'FongBar', 'baz', 'foo'], - \ ale#completion#Filter(['FooBar', 'FongBar', 'baz', 'foo'], '.') - -Execute(Prefix filtering should work for completion items): - AssertEqual - \ [{'word': 'FooBar'}, {'word': 'foo'}], - \ ale#completion#Filter( - \ [ - \ {'word': 'FooBar'}, - \ {'word': 'FongBar'}, - \ {'word': 'baz'}, - \ {'word': 'foo'}, - \ ], - \ 'foo' - \ ) - AssertEqual - \ [ - \ {'word': 'FooBar'}, - \ {'word': 'FongBar'}, - \ {'word': 'baz'}, - \ {'word': 'foo'}, - \ ], - \ ale#completion#Filter( - \ [ - \ {'word': 'FooBar'}, - \ {'word': 'FongBar'}, - \ {'word': 'baz'}, - \ {'word': 'foo'}, - \ ], - \ '.' - \ ) - -Execute(The right message sent to the tsserver LSP when the first completion message is received): - " The cursor position needs to match what was saved before. - call setpos('.', [bufnr(''), 1, 1, 0]) - let b:ale_completion_info = { - \ 'conn_id': 123, - \ 'prefix': 'f', - \ 'request_id': 4, - \ 'line': 1, - \ 'column': 1, - \} - " We should only show up to this many suggestions. - let g:ale_completion_max_suggestions = 3 - - " Replace the Send function for LSP, so we can monitor calls to it. - function! ale#lsp#Send(conn_id, message) abort - let g:test_vars.message = a:message - endfunction - - " Handle the response for completions. - call ale#completion#HandleTSServerLSPResponse(123, { - \ 'request_seq': 4, - \ 'command': 'completions', - \ 'body': [ - \ {'name': 'Baz'}, - \ {'name': 'dingDong'}, - \ {'name': 'Foo'}, - \ {'name': 'FooBar'}, - \ {'name': 'frazzle'}, - \ {'name': 'FFS'}, - \ ], - \}) - - " The entry details messages should have been sent. - AssertEqual - \ [ - \ 0, - \ 'ts@completionEntryDetails', - \ { - \ 'file': expand('%:p'), - \ 'entryNames': ['Foo', 'FooBar', 'frazzle'], - \ 'offset': 1, - \ 'line': 1, - \ }, - \ ], - \ g:test_vars.message - -Given typescript(): - let abc = y. - let foo = ab - let foo = (ab) - -Execute(Completion should be done after dots in TypeScript): - AssertEqual '.', ale#completion#GetPrefix(&filetype, 1, 13) - -Execute(Completion should be done after words in TypeScript): - AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 2, 13) - -Execute(Completion should be done after words in parens in TypeScript): - AssertEqual 'ab', ale#completion#GetPrefix(&filetype, 3, 14) - -Execute(Completion should not be done after parens in TypeScript): - AssertEqual '', ale#completion#GetPrefix(&filetype, 3, 15) - -Execute(Completion prefixes should work for other filetypes): - AssertEqual 'ab', ale#completion#GetPrefix('xxxyyyzzz', 3, 14) - -Execute(ale#completion#Show() should remember the omnifunc setting and replace it): - let &l:omnifunc = 'FooBar' - - call ale#completion#Show('Response', 'Parser') - - AssertEqual 'FooBar', b:ale_old_omnifunc - AssertEqual 'ale#completion#OmniFunc', &l:omnifunc - -Execute(ale#completion#Show() should remember the completeopt setting and replace it): - let &l:completeopt = 'menu' - - call ale#completion#Show('Response', 'Parser') - - AssertEqual 'menu', b:ale_old_completopt - AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt - -Execute(ale#completion#OmniFunc() should also remember the completeopt setting and replace it): - let &l:completeopt = 'menu' - - call ale#completion#OmniFunc(0, '') - - AssertEqual 'menu', b:ale_old_completopt - AssertEqual 'menu,menuone,preview,noselect,noinsert', &l:completeopt - -Execute(ale#completion#Show() should make the correct feedkeys() call): - call ale#completion#Show('Response', 'Parser') - - AssertEqual [["\\", 'n']], g:test_vars.feedkeys_calls - -Execute(ale#completion#Show() should set up the response and parser): - call ale#completion#Show('Response', 'Parser') - - AssertEqual 'Response', b:ale_completion_response - AssertEqual 'Parser', b:ale_completion_parser - -Execute(ale#completion#Done() should restore old omnifunc values): - let b:ale_old_omnifunc = 'FooBar' - - call ale#completion#Done() - - " We reset the old omnifunc setting and remove the buffer variable. - AssertEqual 'FooBar', &l:omnifunc - Assert !has_key(b:, 'ale_old_omnifunc') - -Execute(ale#completion#Done() should restore the old completeopt setting): - let b:ale_old_completopt = 'menu' - let &l:completeopt = 'menu,menuone,preview,noselect,noinsert' - - call ale#completion#Done() - - AssertEqual 'menu', &l:completeopt - Assert !has_key(b:, 'ale_old_completopt') - -Execute(ale#completion#Done() should leave settings alone when none were remembered): - let &l:omnifunc = 'BazBoz' - let &l:completeopt = 'menu' - - call ale#completion#Done() - - AssertEqual 'BazBoz', &l:omnifunc - AssertEqual 'menu', &l:completeopt - -Execute(The completion request_id should be reset when queuing again): - let b:ale_completion_info = {'request_id': 123} - - let g:ale_completion_delay = 0 - call ale#completion#Queue() - sleep 1m - - AssertEqual 0, b:ale_completion_info.request_id - -Execute(b:ale_completion_info should be set up correctly when requesting completions): - call setpos('.', [bufnr(''), 3, 14, 0]) - call ale#completion#GetCompletions() - - AssertEqual - \ { - \ 'request_id': 0, - \ 'conn_id': 0, - \ 'column': 14, - \ 'line': 3, - \ 'prefix': 'ab', - \ }, - \ b:ale_completion_info - -Execute(ale#completion#GetCompletions should be called when the cursor position stays the same): - call CheckCompletionCalled(1) - -Execute(ale#completion#GetCompletions should not be called when the cursor position changes): - call setpos('.', [bufnr(''), 1, 2, 0]) - - let g:test_vars.get_completions_called = 0 - - " We just want to check if the function is called. - function! ale#completion#GetCompletions() - let g:test_vars.get_completions_called = 1 - endfunction - - let g:ale_completion_delay = 0 - call ale#completion#Queue() - - " Change the cursor position before the callback is triggered. - call setpos('.', [bufnr(''), 2, 2, 0]) - - sleep 1m - - Assert !g:test_vars.get_completions_called - -Execute(Completion should not be done shortly after the CompleteDone function): - call CheckCompletionCalled(1) - call ale#completion#Done() - call CheckCompletionCalled(0) From 8254e507d67bde88081602dbf4ff9bca03ab23cd Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 13:01:01 +0000 Subject: [PATCH 214/390] #1162 Get LSP completions working reasonably well --- autoload/ale/completion.vim | 12 +++++-- autoload/ale/lsp/message.vim | 2 +- .../test_lsp_completion_messages.vader | 35 ++++++++++++------- test/lsp/test_lsp_client_messages.vader | 4 +-- 4 files changed, 36 insertions(+), 17 deletions(-) diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index f814390..6a723a6 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -326,6 +326,14 @@ function! s:GetLSPCompletions(linter) abort \ b:ale_completion_info.prefix, \) else + " Send a message saying the buffer has changed first, otherwise + " completions won't know what text is nearby. + call ale#lsp#Send( + \ l:id, + \ ale#lsp#message#DidChange(l:buffer), + \ l:root + \) + " For LSP completions, we need to clamp the column to the length of " the line. python-language-server and perhaps others do not implement " this correctly. @@ -334,9 +342,9 @@ function! s:GetLSPCompletions(linter) abort \ b:ale_completion_info.line, \ min([ \ b:ale_completion_info.line_length, - \ b:ale_completion_info.column + \ b:ale_completion_info.column, \ ]), - \ '', + \ ale#completion#GetTriggerCharacter(&filetype, b:ale_completion_info.prefix), \) endif diff --git a/autoload/ale/lsp/message.vim b/autoload/ale/lsp/message.vim index a90d4e7..b3a039c 100644 --- a/autoload/ale/lsp/message.vim +++ b/autoload/ale/lsp/message.vim @@ -95,7 +95,7 @@ function! ale#lsp#message#Completion(buffer, line, column, trigger_character) ab \ 'textDocument': { \ 'uri': ale#path#ToURI(expand('#' . a:buffer . ':p')), \ }, - \ 'position': {'line': a:line - 1, 'character': a:column - 1}, + \ 'position': {'line': a:line - 1, 'character': a:column}, \}] if !empty(a:trigger_character) diff --git a/test/completion/test_lsp_completion_messages.vader b/test/completion/test_lsp_completion_messages.vader index df340fb..f21acfb 100644 --- a/test/completion/test_lsp_completion_messages.vader +++ b/test/completion/test_lsp_completion_messages.vader @@ -15,7 +15,7 @@ Before: runtime autoload/ale/lsp.vim - let g:message = [] + let g:message_list = [] let g:Callback = '' function! ale#linter#StartLSP(buffer, linter, callback) abort @@ -29,13 +29,13 @@ Before: " Replace the Send function for LSP, so we can monitor calls to it. function! ale#lsp#Send(conn_id, message, ...) abort - let g:message = a:message + call add(g:message_list, a:message) endfunction After: Restore - unlet! g:message + unlet! g:message_list unlet! g:Callback unlet! b:ale_old_omnifunc unlet! b:ale_old_completopt @@ -75,8 +75,8 @@ Execute(The right message should be sent for the initial tsserver request): \ string(g:Callback) " We should send the right message. AssertEqual - \ [0, 'ts@completions', {'file': expand('%:p'), 'line': 1, 'offset': 3, 'prefix': 'fo'}], - \ g:message + \ [[0, 'ts@completions', {'file': expand('%:p'), 'line': 1, 'offset': 3, 'prefix': 'fo'}]], + \ g:message_list " We should set up the completion info correctly. AssertEqual \ { @@ -118,7 +118,7 @@ Execute(The right message sent to the tsserver LSP when the first completion mes " The entry details messages should have been sent. AssertEqual - \ [ + \ [[ \ 0, \ 'ts@completionEntryDetails', \ { @@ -127,8 +127,8 @@ Execute(The right message sent to the tsserver LSP when the first completion mes \ 'offset': 1, \ 'line': 1, \ }, - \ ], - \ g:message + \ ]], + \ g:message_list Given python(Some Python file): foo @@ -152,12 +152,23 @@ Execute(The right message should be sent for the initial LSP request): " We should send the right message. " The character index needs to be at most the index of the last character on " the line, or integration with pyls will be broken. + " + " We need to send the message for changing the document first. AssertEqual - \ [0, 'textDocument/completion', { + \ [ + \ [1, 'textDocument/didChange', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ 'version': g:ale_lsp_next_version_id - 1, + \ }, + \ 'contentChanges': [{'text': join(getline(1, '$'), "\n") . "\n"}] + \ }], + \ [0, 'textDocument/completion', { \ 'textDocument': {'uri': ale#path#ToURI(expand('%:p'))}, - \ 'position': {'line': 0, 'character': 2}, - \ }], - \ g:message + \ 'position': {'line': 0, 'character': 3}, + \ }], + \ ], + \ g:message_list " We should set up the completion info correctly. AssertEqual \ { diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index bd0cd10..346f79c 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -110,7 +110,7 @@ Execute(ale#lsp#message#Completion() should return correct messages): \ 'textDocument': { \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), \ }, - \ 'position': {'line': 11, 'character': 33}, + \ 'position': {'line': 11, 'character': 34}, \ } \ ], \ ale#lsp#message#Completion(bufnr(''), 12, 34, '') @@ -124,7 +124,7 @@ Execute(ale#lsp#message#Completion() should return correct messages with a trigg \ 'textDocument': { \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), \ }, - \ 'position': {'line': 11, 'character': 33}, + \ 'position': {'line': 11, 'character': 34}, \ 'context': {'triggerKind': 2, 'triggerCharacter': '.'}, \ } \ ], From ae7cd2c0907573c9c4996296b642e547fd1ee04f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 18:24:10 +0000 Subject: [PATCH 215/390] Fix #918 - Save prettier details for Haskell linters --- autoload/ale/handlers/haskell.vim | 32 +++++++++++++++++-------- test/handler/test_ghc_handler.vader | 36 +++++++++++++++++++++++++++-- 2 files changed, 56 insertions(+), 12 deletions(-) diff --git a/autoload/ale/handlers/haskell.vim b/autoload/ale/handlers/haskell.vim index 0960669..8a0d001 100644 --- a/autoload/ale/handlers/haskell.vim +++ b/autoload/ale/handlers/haskell.vim @@ -24,20 +24,25 @@ function! ale#handlers#haskell#HandleGHCFormat(buffer, lines) abort let l:corrected_lines = [] + " Group the lines into smaller lists. for l:line in a:lines if len(matchlist(l:line, l:pattern)) > 0 - call add(l:corrected_lines, l:line) + call add(l:corrected_lines, [l:line]) elseif l:line is# '' - call add(l:corrected_lines, l:line) - else - if len(l:corrected_lines) > 0 - let l:line = substitute(l:line, '\v^\s+', ' ', '') - let l:corrected_lines[-1] .= l:line - endif + call add(l:corrected_lines, [l:line]) + elseif len(l:corrected_lines) > 0 + call add(l:corrected_lines[-1], l:line) endif endfor - for l:line in l:corrected_lines + for l:line_list in l:corrected_lines + " Join the smaller lists into one large line to parse. + let l:line = l:line_list[0] + + for l:extra_line in l:line_list[1:] + let l:line .= substitute(l:extra_line, '\v^\s+', ' ', '') + endfor + let l:match = matchlist(l:line, l:pattern) if len(l:match) == 0 @@ -67,12 +72,19 @@ function! ale#handlers#haskell#HandleGHCFormat(buffer, lines) abort " Replace temporary filenames in problem messages with the basename let l:text = substitute(l:text, l:temp_filename_regex, l:basename, 'g') - call add(l:output, { + let l:item = { \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'text': l:text, \ 'type': l:type, - \}) + \} + + " Include extra lines as details if they are there. + if len(l:line_list) > 1 + let l:item.detail = join(l:line_list[1:], "\n") + endif + + call add(l:output, l:item) endfor return l:output diff --git a/test/handler/test_ghc_handler.vader b/test/handler/test_ghc_handler.vader index b47cdf6..2a26f86 100644 --- a/test/handler/test_ghc_handler.vader +++ b/test/handler/test_ghc_handler.vader @@ -8,6 +8,10 @@ Execute(The ghc handler should handle hdevtools output): \ 'type': 'W', \ 'col': 62, \ 'text': '• Couldnt match type ‘a -> T.Text’ with ‘T.Text’ Expected type: [T.Text]', + \ 'detail': join([ + \ '• Couldnt match type ‘a -> T.Text’ with ‘T.Text’', + \ ' Expected type: [T.Text]', + \ ], "\n"), \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ @@ -26,12 +30,20 @@ Execute(The ghc handler should handle ghc 8 output): \ 'type': 'E', \ 'col': 1, \ 'text': 'Failed to load interface for ‘GitHub.Data’ Use -v to see a list of the files searched for.', + \ 'detail': join([ + \ ' Failed to load interface for ‘GitHub.Data’', + \ ' Use -v to see a list of the files searched for.', + \ ], "\n"), \ }, \ { \ 'lnum': 7, \ 'type': 'W', \ 'col': 1, \ 'text': 'Failed to load interface for ‘GitHub.Endpoints.PullRequests’ Use -v to see a list of the files searched for.', + \ 'detail': join([ + \ ' Failed to load interface for ‘GitHub.Endpoints.PullRequests’', + \ ' Use -v to see a list of the files searched for.', + \ ], "\n"), \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ @@ -55,24 +67,36 @@ Execute(The ghc handler should handle ghc 7 output): \ 'type': 'E', \ 'col': 1, \ 'text': 'parse error (possibly incorrect indentation or mismatched brackets)', + \ 'detail': join([ + \ ' parse error (possibly incorrect indentation or mismatched brackets)', + \ ], "\n"), \ }, \ { \ 'lnum': 84, \ 'col': 1, \ 'type': 'W', - \ 'text': 'Top-level binding with no type signature:^@ myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', + \ 'text': 'Top-level binding with no type signature: myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', + \ 'detail': join([ + \ ' Top-level binding with no type signature:', + \ ' myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', + \ ], "\n"), \ }, \ { \ 'lnum': 94, \ 'col': 5, \ 'type': 'E', \ 'text': 'Some other error', + \ 'detail': join([ + \ ' Some other error', + \ ], "\n"), \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ \ ale#path#Winify('src/Main.hs') . ':168:1:', \ ' parse error (possibly incorrect indentation or mismatched brackets)', - \ ale#path#Winify('src/Main.hs') . ':84:1:Warning: Top-level binding with no type signature:^@ myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', + \ ale#path#Winify('src/Main.hs') . ':84:1:Warning:', + \ ' Top-level binding with no type signature:', + \ ' myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', \ ale#path#Winify('src/Main.hs') . ':94:5:Error:', \ ' Some other error', \ ]) @@ -87,6 +111,14 @@ Execute(The ghc handler should handle stack 1.5.1 output): \ 'col': 14, \ 'type': 'E', \ 'text': '• Expecting one fewer arguments to ‘Exp’ Expected kind ‘k0 -> *’, but ‘Exp’ has kind ‘*’ • In the type ‘Exp a’ | 160 | pattern F :: Exp a | ^^^^^', + \ 'detail': join([ + \ ' • Expecting one fewer arguments to ‘Exp’', + \ ' Expected kind ‘k0 -> *’, but ‘Exp’ has kind ‘*’', + \ ' • In the type ‘Exp a’', + \ ' |', + \ ' 160 | pattern F :: Exp a', + \ ' | ^^^^^', + \ ], "\n"), \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ From c07b3b9bfcc00fb8b6dd8b2e9627257df4c8ed4f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 18:47:30 +0000 Subject: [PATCH 216/390] Fix #1166 - Add an option for the rls toolchain --- ale_linters/rust/rls.vim | 5 ++++- doc/ale-rust.txt | 11 +++++++++++ test/command_callback/test_rust_rls_callbacks.vader | 11 ++++++++++- 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/ale_linters/rust/rls.vim b/ale_linters/rust/rls.vim index c49d268..832fe3e 100644 --- a/ale_linters/rust/rls.vim +++ b/ale_linters/rust/rls.vim @@ -2,6 +2,7 @@ " Description: A language server for Rust call ale#Set('rust_rls_executable', 'rls') +call ale#Set('rust_rls_toolchain', 'nightly') function! ale_linters#rust#rls#GetExecutable(buffer) abort return ale#Var(a:buffer, 'rust_rls_executable') @@ -9,8 +10,10 @@ endfunction function! ale_linters#rust#rls#GetCommand(buffer) abort let l:executable = ale_linters#rust#rls#GetExecutable(a:buffer) + let l:toolchain = ale#Var(a:buffer, 'rust_rls_toolchain') - return ale#Escape(l:executable) . ' +nightly' + return ale#Escape(l:executable) + \ . ' +' . ale#Escape(l:toolchain) endfunction function! ale_linters#rust#rls#GetLanguage(buffer) abort diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 15ffef0..a32c90b 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -70,6 +70,17 @@ g:ale_rust_rls_executable *g:ale_rust_rls_executable* This variable can be modified to change the executable path for `rls`. +g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain* + *b:ale_rust_rls_toolchain* + Type: |String| + Default: `'nightly'` + + This option can be set to change the toolchain used for `rls`. Possible + values include `'nightly'`, `'beta'`, and `'stable'`. + + The `rls` server will only be started once per executable. + + =============================================================================== rustc *ale-rust-rustc* diff --git a/test/command_callback/test_rust_rls_callbacks.vader b/test/command_callback/test_rust_rls_callbacks.vader index b01f8f0..e467fd9 100644 --- a/test/command_callback/test_rust_rls_callbacks.vader +++ b/test/command_callback/test_rust_rls_callbacks.vader @@ -1,7 +1,9 @@ Before: Save g:ale_rust_rls_executable + Save g:ale_rust_rls_toolchain unlet! g:ale_rust_rls_executable + unlet! g:ale_rust_rls_toolchain runtime ale_linters/rust/rls.vim @@ -16,7 +18,14 @@ After: Execute(The default executable path should be correct): AssertEqual 'rls', ale_linters#rust#rls#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape('rls') . ' +nightly', + \ ale#Escape('rls') . ' +' . ale#Escape('nightly'), + \ ale_linters#rust#rls#GetCommand(bufnr('')) + +Execute(The toolchain should be configurable): + let g:ale_rust_rls_toolchain = 'stable' + + AssertEqual + \ ale#Escape('rls') . ' +' . ale#Escape('stable'), \ ale_linters#rust#rls#GetCommand(bufnr('')) Execute(The language string should be correct): From 01318b6930c536cb63f09541bde11a9d48d4a12e Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 21:30:26 +0000 Subject: [PATCH 217/390] Compress one line --- autoload/ale/completion.vim | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/autoload/ale/completion.vim b/autoload/ale/completion.vim index 6a723a6..7ad7f9d 100644 --- a/autoload/ale/completion.vim +++ b/autoload/ale/completion.vim @@ -328,11 +328,7 @@ function! s:GetLSPCompletions(linter) abort else " Send a message saying the buffer has changed first, otherwise " completions won't know what text is nearby. - call ale#lsp#Send( - \ l:id, - \ ale#lsp#message#DidChange(l:buffer), - \ l:root - \) + call ale#lsp#Send(l:id, ale#lsp#message#DidChange(l:buffer), l:root) " For LSP completions, we need to clamp the column to the length of " the line. python-language-server and perhaps others do not implement From 21b460bb1dcb099786ebe57d8cd6ec4fd9618861 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 22:27:08 +0000 Subject: [PATCH 218/390] Implement go to defintion for LSP linters --- autoload/ale/definition.vim | 61 +++++++-- autoload/ale/lsp/message.vim | 9 ++ test/lsp/test_lsp_client_messages.vader | 14 +++ test/test_go_to_definition.vader | 161 ++++++++++++++++++++++-- 4 files changed, 227 insertions(+), 18 deletions(-) diff --git a/autoload/ale/definition.vim b/autoload/ale/definition.vim index 4b062b3..b20c01a 100644 --- a/autoload/ale/definition.vim +++ b/autoload/ale/definition.vim @@ -44,15 +44,40 @@ function! ale#definition#HandleTSServerResponse(conn_id, response) abort endif endfunction +function! ale#definition#HandleLSPResponse(conn_id, response) abort + if has_key(a:response, 'id') + \&& has_key(s:go_to_definition_map, a:response.id) + let l:options = remove(s:go_to_definition_map, a:response.id) + + " The result can be a Dictionary item, a List of the same, or null. + let l:result = get(a:response, 'result', v:null) + + if type(l:result) is type({}) + let l:result = [l:result] + elseif type(l:result) isnot type([]) + let l:result = [] + endif + + for l:item in l:result + let l:filename = ale#path#FromURI(l:item.uri) + let l:line = l:item.range.start.line + 1 + let l:column = l:item.range.start.character + + call ale#definition#Open(l:options, l:filename, l:line, l:column) + break + endfor + endif +endfunction + function! s:GoToLSPDefinition(linter, options) abort let l:buffer = bufnr('') let [l:line, l:column] = getcurpos()[1:2] - let l:lsp_details = ale#linter#StartLSP( - \ l:buffer, - \ a:linter, - \ function('ale#definition#HandleTSServerResponse'), - \) + let l:Callback = a:linter.lsp is# 'tsserver' + \ ? function('ale#definition#HandleTSServerResponse') + \ : function('ale#definition#HandleLSPResponse') + + let l:lsp_details = ale#linter#StartLSP(l:buffer, a:linter, l:Callback) if empty(l:lsp_details) return 0 @@ -61,11 +86,25 @@ function! s:GoToLSPDefinition(linter, options) abort let l:id = l:lsp_details.connection_id let l:root = l:lsp_details.project_root - let l:message = ale#lsp#tsserver_message#Definition( - \ l:buffer, - \ l:line, - \ l:column - \) + if a:linter.lsp is# 'tsserver' + let l:message = ale#lsp#tsserver_message#Definition( + \ l:buffer, + \ l:line, + \ l:column + \) + else + " Send a message saying the buffer has changed first, or the + " definition position probably won't make sense. + call ale#lsp#Send(l:id, ale#lsp#message#DidChange(l:buffer), l:root) + + let l:column = min([l:column, len(getline(l:line))]) + + " For LSP completions, we need to clamp the column to the length of + " the line. python-language-server and perhaps others do not implement + " this correctly. + let l:message = ale#lsp#message#Definition(l:buffer, l:line, l:column) + endif + let l:request_id = ale#lsp#Send(l:id, l:message, l:root) let s:go_to_definition_map[l:request_id] = { @@ -75,7 +114,7 @@ endfunction function! ale#definition#GoTo(options) abort for l:linter in ale#linter#Get(&filetype) - if l:linter.lsp is# 'tsserver' + if !empty(l:linter.lsp) call s:GoToLSPDefinition(l:linter, a:options) endif endfor diff --git a/autoload/ale/lsp/message.vim b/autoload/ale/lsp/message.vim index b3a039c..0b73cfc 100644 --- a/autoload/ale/lsp/message.vim +++ b/autoload/ale/lsp/message.vim @@ -107,3 +107,12 @@ function! ale#lsp#message#Completion(buffer, line, column, trigger_character) ab return l:message endfunction + +function! ale#lsp#message#Definition(buffer, line, column) abort + return [0, 'textDocument/definition', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('#' . a:buffer . ':p')), + \ }, + \ 'position': {'line': a:line - 1, 'character': a:column}, + \}] +endfunction diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index 346f79c..3abdd8a 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -129,6 +129,20 @@ Execute(ale#lsp#message#Completion() should return correct messages with a trigg \ } \ ], \ ale#lsp#message#Completion(bufnr(''), 12, 34, '.') + \ +Execute(ale#lsp#message#Definition() should return correct messages): + AssertEqual + \ [ + \ 0, + \ 'textDocument/definition', + \ { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(g:dir . '/foo/bar.ts'), + \ }, + \ 'position': {'line': 11, 'character': 34}, + \ } + \ ], + \ ale#lsp#message#Definition(bufnr(''), 12, 34) Execute(ale#lsp#tsserver_message#Open() should return correct messages): AssertEqual diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader index c6e8771..dd0e990 100644 --- a/test/test_go_to_definition.vader +++ b/test/test_go_to_definition.vader @@ -4,7 +4,7 @@ Before: let g:old_filename = expand('%:p') let g:Callback = 0 - let g:message = [] + let g:message_list = [] let g:expr_list = [] runtime autoload/ale/definition.vim @@ -21,7 +21,7 @@ Before: endfunction function! ale#lsp#Send(conn_id, message, root) abort - let g:message = a:message + call add(g:message_list, a:message) return 42 endfunction @@ -36,8 +36,9 @@ After: unlet! g:old_filename unlet! g:Callback - unlet! g:message + unlet! g:message_list unlet! g:expr_list + unlet! b:ale_linters runtime autoload/ale/definition.vim runtime autoload/ale/linter.vim @@ -119,8 +120,8 @@ Execute(tsserver completion requests should be sent): \ 'function(''ale#definition#HandleTSServerResponse'')', \ string(g:Callback) AssertEqual - \ [0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}], - \ g:message + \ [[0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}]], + \ g:message_list AssertEqual {'42': {'open_in_tab': 0}}, ale#definition#GetMap() Execute(tsserver tab completion requests should be sent): @@ -133,6 +134,152 @@ Execute(tsserver tab completion requests should be sent): \ 'function(''ale#definition#HandleTSServerResponse'')', \ string(g:Callback) AssertEqual - \ [0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}], - \ g:message + \ [[0, 'ts@definition', {'file': expand('%:p'), 'line': 2, 'offset': 5}]], + \ g:message_list + AssertEqual {'42': {'open_in_tab': 1}}, ale#definition#GetMap() + +Given python(Some Python file): + foo + somelongerline + bazxyzxyzxyz + +Execute(Other files should be jumped to for LSP definition responses): + call ale#definition#SetMap({3: {'open_in_tab': 0}}) + call ale#definition#HandleLSPResponse( + \ 1, + \ { + \ 'id': 3, + \ 'result': { + \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'range': { + \ 'start': {'line': 2, 'character': 7}, + \ }, + \ }, + \ } + \) + + AssertEqual + \ [ + \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ ], + \ g:expr_list + AssertEqual [3, 7], getpos('.')[1:2] + AssertEqual {}, ale#definition#GetMap() + +Execute(Other files should be jumped to in tabs for LSP definition responses): + call ale#definition#SetMap({3: {'open_in_tab': 1}}) + call ale#definition#HandleLSPResponse( + \ 1, + \ { + \ 'id': 3, + \ 'result': { + \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'range': { + \ 'start': {'line': 2, 'character': 7}, + \ }, + \ }, + \ } + \) + + AssertEqual + \ [ + \ 'tabedit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ ], + \ g:expr_list + AssertEqual [3, 7], getpos('.')[1:2] + AssertEqual {}, ale#definition#GetMap() + +Execute(Definition responses with lists should be handled): + call ale#definition#SetMap({3: {'open_in_tab': 0}}) + call ale#definition#HandleLSPResponse( + \ 1, + \ { + \ 'id': 3, + \ 'result': [ + \ { + \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'range': { + \ 'start': {'line': 2, 'character': 7}, + \ }, + \ }, + \ { + \ 'uri': ale#path#ToURI(g:dir . '/other_file'), + \ 'range': { + \ 'start': {'line': 20, 'character': 3}, + \ }, + \ }, + \ ], + \ } + \) + + AssertEqual + \ [ + \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ ], + \ g:expr_list + AssertEqual [3, 7], getpos('.')[1:2] + AssertEqual {}, ale#definition#GetMap() + +Execute(Definition responses with null response should be handled): + call ale#definition#SetMap({3: {'open_in_tab': 0}}) + call ale#definition#HandleLSPResponse(1, {'id': 3, 'result': v:null}) + + AssertEqual [], g:expr_list + +Execute(LSP completion requests should be sent): + runtime ale_linters/python/pyls.vim + let b:ale_linters = ['pyls'] + call setpos('.', [bufnr(''), 1, 5, 0]) + + ALEGoToDefinition + + AssertEqual + \ 'function(''ale#definition#HandleLSPResponse'')', + \ string(g:Callback) + + AssertEqual + \ [ + \ [1, 'textDocument/didChange', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ 'version': g:ale_lsp_next_version_id - 1, + \ }, + \ 'contentChanges': [{'text': join(getline(1, '$'), "\n") . "\n"}] + \ }], + \ [0, 'textDocument/definition', { + \ 'textDocument': {'uri': ale#path#ToURI(expand('%:p'))}, + \ 'position': {'line': 0, 'character': 3}, + \ }], + \ ], + \ g:message_list + + AssertEqual {'42': {'open_in_tab': 0}}, ale#definition#GetMap() + +Execute(LSP tab completion requests should be sent): + runtime ale_linters/python/pyls.vim + let b:ale_linters = ['pyls'] + call setpos('.', [bufnr(''), 1, 5, 0]) + + ALEGoToDefinitionInTab + + AssertEqual + \ 'function(''ale#definition#HandleLSPResponse'')', + \ string(g:Callback) + + AssertEqual + \ [ + \ [1, 'textDocument/didChange', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ 'version': g:ale_lsp_next_version_id - 1, + \ }, + \ 'contentChanges': [{'text': join(getline(1, '$'), "\n") . "\n"}] + \ }], + \ [0, 'textDocument/definition', { + \ 'textDocument': {'uri': ale#path#ToURI(expand('%:p'))}, + \ 'position': {'line': 0, 'character': 3}, + \ }], + \ ], + \ g:message_list + AssertEqual {'42': {'open_in_tab': 1}}, ale#definition#GetMap() From 17574e2fe1d66724fdece68102c0a660e93f58aa Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 23:02:51 +0000 Subject: [PATCH 219/390] Document go to definition support and put that and completion in an LSP section --- doc/ale.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 49 insertions(+), 7 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index 12a8b86..0b8a0c5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -10,7 +10,9 @@ CONTENTS *ale-contents* 2. Supported Languages & Tools..........|ale-support| 3. Linting..............................|ale-lint| 4. Fixing Problems......................|ale-fix| - 5. Completion...........................|ale-completion| + 5. Language Server Protocol Support.....|ale-lsp| + 5.1 Completion........................|ale-completion| + 5.2 Go To Definition..................|ale-go-to-definition| 6. Global Options.......................|ale-options| 6.1 Highlights........................|ale-highlights| 6.2 Options for write-good Linter.....|ale-write-good-options| @@ -545,17 +547,30 @@ by default. =============================================================================== -5. Completion *ale-completion* +5. Language Server Protocol Support *ale-lsp* -ALE offers some limited support for automatic completion of code while you -type. Completion is only supported via Language Server Protocol servers which -ALE can connect to for linting, which can offer good built-in support for -suggesting completion information. ALE will only suggest symbols for -completion for LSP linters that are enabled. +ALE offers some support for integrating with Language Server Protocol (LSP) +servers. LSP linters can be used in combination with any other linter, and +will automatically connect to LSP servers when needed. ALE also supports +`tsserver` for TypeScript, which uses a different but very similar protocol. + +ALE supports the following LSP/tsserver features. + +1. Diagnostics/linting - Enabled via selecting linters as usual. +2. Completion (Only for tsserver) +3. Go to definition + + +------------------------------------------------------------------------------- +5.1 Completion *ale-completion* NOTE: At the moment, only `tsserver` for TypeScript code is supported for completion. +ALE offers limited support for automatic completion of code while you type. +Completion is only supported while a least one LSP linter is enabled. ALE +will only suggest symbols provided by the LSP servers. + Suggestions will be made while you type after completion is enabled. Completion can be enabled by setting |g:ale_completion_enabled| to `1`. The delay for completion can be configured with |g:ale_completion_delay|. ALE will @@ -563,6 +578,17 @@ only suggest so many possible matches for completion. The maximum number of items can be controlled with |g:ale_completion_max_suggestions|. +------------------------------------------------------------------------------- +5.2 Go To Definition *ale-go-to-definition* + +ALE supports jumping to the files and locations where symbols are defined +through any enabled LSP linters. The locations ALE will jump to depend on the +information returned by LSP servers. The following commands are supported: + +|ALEGoToDefinition| - Open the definition of the symbol under the cursor. +|ALEGoToDefinitionInTab| - The same, but for opening the file in a new tab. + + =============================================================================== 6. Global Options *ale-options* @@ -1576,6 +1602,22 @@ ALEFixSuggest *ALEFixSuggest* See |ale-fix| for more information. +ALEGoToDefinition *ALEGoToDefinition* + + Jump to the definition of a symbol under the cursor using the enabled LSP + linters for the buffer. ALE will jump to a definition if an LSP server + provides a location to jump to. Otherwise, ALE will do nothing. + + A plug mapping `(ale_go_to_definition)` is defined for this command. + + +ALEGoToDefinitionInTab *ALEGoToDefinitionInTab* + + The same as |ALEGoToDefinition|, but opens results in a new tab. + + A plug mapping `(ale_go_to_definition_in_tab)` is defined for this + command. + *:ALELint* ALELint *ALELint* From 17f93b16ab74b5f05ed7922c8a5aebc598fcc199 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 23:08:38 +0000 Subject: [PATCH 220/390] Test go to definition tests on Windows --- test/test_go_to_definition.vader | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader index dd0e990..0b8afe3 100644 --- a/test/test_go_to_definition.vader +++ b/test/test_go_to_definition.vader @@ -79,7 +79,7 @@ Execute(Other files should be jumped to for definition responses): AssertEqual \ [ - \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -104,7 +104,7 @@ Execute(Other files should be jumped to for definition responses in tabs too): AssertEqual \ [ - \ 'tabedit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ 'tabedit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -160,7 +160,7 @@ Execute(Other files should be jumped to for LSP definition responses): AssertEqual \ [ - \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] From f311a46f794d303b25a71ab99299b78bd031b4dd Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 23:12:13 +0000 Subject: [PATCH 221/390] Add go to definition to the README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7382789..9715409 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,7 @@ back to a filesystem. In other words, this plugin allows you to lint while you type. In addition to linting support, ALE offers some support for fixing code with -formatting tools, and completion via Language Server Protocol servers, or -servers with similar enough protocols, like `tsserver`. +formatting tools, and some Language Server Protocol and `tsserver` features. ## Table of Contents @@ -27,6 +26,7 @@ servers with similar enough protocols, like `tsserver`. 1. [Linting](#usage-linting) 2. [Fixing](#usage-fixing) 3. [Completion](#usage-completion) + 4. [Go To Definition](#usage-go-to-definition) 3. [Installation](#installation) 1. [Installation with Vim package management](#standard-installation) 2. [Installation with Pathogen](#installation-with-pathogen) @@ -223,6 +223,15 @@ let g:ale_completion_enabled = 1 See `:help ale-completion` for more information. + + +### 2.iv Go To Definition + +ALE supports jumping to the definition of words under your cursor with the +`:ALEGoToDefinition` command using any enabled LSP linters and `tsserver`. + +See `:help ale-go-to-definition` for more information. + ## 3. Installation From d4ea0423a2c65a626daca89880811416a9d02040 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 26 Nov 2017 23:20:21 +0000 Subject: [PATCH 222/390] Fix go to definition tests on Windows --- test/test_go_to_definition.vader | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader index 0b8afe3..1e0380f 100644 --- a/test/test_go_to_definition.vader +++ b/test/test_go_to_definition.vader @@ -70,7 +70,7 @@ Execute(Other files should be jumped to for definition responses): \ 'success': v:true, \ 'body': [ \ { - \ 'file': g:dir . '/completion_dummy_file', + \ 'file': ale#path#Winify(g:dir . '/completion_dummy_file'), \ 'start': {'line': 3, 'offset': 7}, \ }, \ ], @@ -95,7 +95,7 @@ Execute(Other files should be jumped to for definition responses in tabs too): \ 'success': v:true, \ 'body': [ \ { - \ 'file': g:dir . '/completion_dummy_file', + \ 'file': ale#path#Winify(g:dir . '/completion_dummy_file'), \ 'start': {'line': 3, 'offset': 7}, \ }, \ ], @@ -150,7 +150,7 @@ Execute(Other files should be jumped to for LSP definition responses): \ { \ 'id': 3, \ 'result': { - \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, @@ -173,7 +173,7 @@ Execute(Other files should be jumped to in tabs for LSP definition responses): \ { \ 'id': 3, \ 'result': { - \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, @@ -183,7 +183,7 @@ Execute(Other files should be jumped to in tabs for LSP definition responses): AssertEqual \ [ - \ 'tabedit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ 'tabedit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -197,13 +197,13 @@ Execute(Definition responses with lists should be handled): \ 'id': 3, \ 'result': [ \ { - \ 'uri': ale#path#ToURI(g:dir . '/completion_dummy_file'), + \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, \ }, \ { - \ 'uri': ale#path#ToURI(g:dir . '/other_file'), + \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/other_file')), \ 'range': { \ 'start': {'line': 20, 'character': 3}, \ }, @@ -214,7 +214,7 @@ Execute(Definition responses with lists should be handled): AssertEqual \ [ - \ 'edit ' . fnameescape(g:dir . '/completion_dummy_file'), + \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] From e84ee4332f03844219da9c3f65e8ddc10be43ced Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Mon, 27 Nov 2017 14:22:05 +0000 Subject: [PATCH 223/390] Add support for linting GraphQL with ESLint --- README.md | 2 +- ale_linters/graphql/eslint.vim | 9 +++++++++ doc/ale-graphql.txt | 3 +++ doc/ale.txt | 3 ++- 4 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 ale_linters/graphql/eslint.vim diff --git a/README.md b/README.md index 9715409..c5f63f3 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ formatting. | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang) | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | -| GraphQL | [gqlint](https://github.com/happylinks/gqlint) | +| GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | | Haskell | [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | diff --git a/ale_linters/graphql/eslint.vim b/ale_linters/graphql/eslint.vim new file mode 100644 index 0000000..dfcbf9d --- /dev/null +++ b/ale_linters/graphql/eslint.vim @@ -0,0 +1,9 @@ +" Author: Benjie Gillam +" Description: eslint for GraphQL files + +call ale#linter#Define('graphql', { +\ 'name': 'eslint', +\ 'executable_callback': 'ale#handlers#eslint#GetExecutable', +\ 'command_callback': 'ale#handlers#eslint#GetCommand', +\ 'callback': 'ale#handlers#eslint#Handle', +\}) diff --git a/doc/ale-graphql.txt b/doc/ale-graphql.txt index 5ceb5ca..a3b9381 100644 --- a/doc/ale-graphql.txt +++ b/doc/ale-graphql.txt @@ -2,6 +2,9 @@ ALE GraphQL Integration *ale-graphql-options* +=============================================================================== +eslint *ale-graphql-eslint* + =============================================================================== gqlint *ale-graphql-gqlint* diff --git a/doc/ale.txt b/doc/ale.txt index 0b8a0c5..d1afb42 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -74,6 +74,7 @@ CONTENTS *ale-contents* gofmt...............................|ale-go-gofmt| gometalinter........................|ale-go-gometalinter| graphql...............................|ale-graphql-options| + eslint..............................|ale-graphql-eslint| gqlint..............................|ale-graphql-gqlint| handlebars............................|ale-handlebars-options| ember-template-lint.................|ale-handlebars-embertemplatelint| @@ -294,7 +295,7 @@ Notes: * FusionScript: `fusion-lint` * GLSL: glslang * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! -* GraphQL: `gqlint` +* GraphQL: `eslint`, `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` From 09f9c21f1b580077d27bb73858a10a64d2fa05e3 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Mon, 27 Nov 2017 15:55:57 +0000 Subject: [PATCH 224/390] Fix typo --- doc/ale-typescript.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt index d31ac71..d83a2df 100644 --- a/doc/ale-typescript.txt +++ b/doc/ale-typescript.txt @@ -5,7 +5,7 @@ ALE TypeScript Integration *ale-typescript-options* =============================================================================== eslint *ale-typescript-eslint* -Becauase of how TypeScript compiles code to JavaScript and how interrelated +Because of how TypeScript compiles code to JavaScript and how interrelated the two languages are, the `eslint` linter for TypeScript uses the JavaScript options for `eslint` too. See: |ale-javascript-eslint|. From b0114deabcb472b5cc7bde21ec9ccab98a618930 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Mon, 27 Nov 2017 15:57:17 +0000 Subject: [PATCH 225/390] Reference the JS ESLint options --- doc/ale-graphql.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/ale-graphql.txt b/doc/ale-graphql.txt index a3b9381..de41276 100644 --- a/doc/ale-graphql.txt +++ b/doc/ale-graphql.txt @@ -5,6 +5,11 @@ ALE GraphQL Integration *ale-graphql-options* =============================================================================== eslint *ale-graphql-eslint* +The `eslint` linter for GraphQL uses the JavaScript options for `eslint`; see: +|ale-javascript-eslint|. + +You will need the GraphQL ESLint plugin installed for this to work. + =============================================================================== gqlint *ale-graphql-gqlint* From 4e821e64c7292ba635e55c409a015023d7549374 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 28 Nov 2017 09:47:04 +0000 Subject: [PATCH 226/390] Fix #1168 - Make the ruby linter executable configurable --- ale_linters/ruby/ruby.vim | 16 ++++++++++-- doc/ale-ruby.txt | 17 ++++++++++--- doc/ale.txt | 1 + .../test_ruby_command_callback.vader | 25 +++++++++++++++++++ 4 files changed, 54 insertions(+), 5 deletions(-) create mode 100644 test/command_callback/test_ruby_command_callback.vader diff --git a/ale_linters/ruby/ruby.vim b/ale_linters/ruby/ruby.vim index a9f7b51..1aa8885 100644 --- a/ale_linters/ruby/ruby.vim +++ b/ale_linters/ruby/ruby.vim @@ -1,10 +1,22 @@ " Author: Brandon Roehl - https://github.com/BrandonRoehl " Description: Ruby MRI for Ruby files +call ale#Set('ruby_ruby_executable', 'ruby') + +function! ale_linters#ruby#ruby#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'ruby_ruby_executable') +endfunction + +function! ale_linters#ruby#ruby#GetCommand(buffer) abort + let l:executable = ale_linters#ruby#ruby#GetExecutable(a:buffer) + + return ale#Escape(l:executable) . ' -w -c -T1 %t' +endfunction + call ale#linter#Define('ruby', { \ 'name': 'ruby', -\ 'executable': 'ruby', +\ 'executable_callback': 'ale_linters#ruby#ruby#GetExecutable', +\ 'command_callback': 'ale_linters#ruby#ruby#GetCommand', \ 'output_stream': 'stderr', -\ 'command': 'ruby -w -c -T1 %t', \ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', \}) diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt index c710a26..94181ed 100644 --- a/doc/ale-ruby.txt +++ b/doc/ale-ruby.txt @@ -58,10 +58,10 @@ g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link* =============================================================================== rubocop *ale-ruby-rubocop* -g:ale_ruby_rubocop_executable g:ale_ruby_rubocop_executable - b:ale_ruby_rubocop_executable +g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable* + *b:ale_ruby_rubocop_executable* Type: String - Default: 'rubocop' + Default: `'rubocop'` Override the invoked rubocop binary. This is useful for running rubocop from binstubs or a bundle. @@ -75,5 +75,16 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options* This variable can be change to modify flags given to rubocop. +=============================================================================== +ruby *ale-ruby-ruby* + +g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable* + *b:ale_ruby_ruby_executable* + Type: String + Default: `'ruby'` + + This variable can be changed to use a different executable for ruby. + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index d1afb42..7d87077 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -170,6 +170,7 @@ CONTENTS *ale-contents* rails_best_practices................|ale-ruby-rails_best_practices| reek................................|ale-ruby-reek| rubocop.............................|ale-ruby-rubocop| + ruby................................|ale-ruby-ruby| rust..................................|ale-rust-options| cargo...............................|ale-rust-cargo| rls.................................|ale-rust-rls| diff --git a/test/command_callback/test_ruby_command_callback.vader b/test/command_callback/test_ruby_command_callback.vader new file mode 100644 index 0000000..3813d56 --- /dev/null +++ b/test/command_callback/test_ruby_command_callback.vader @@ -0,0 +1,25 @@ +Before: + Save g:ale_ruby_ruby_executable + + unlet! g:ale_ruby_ruby_executable + + runtime ale_linters/ruby/ruby.vim + +After: + Restore + + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual 'ruby', ale_linters#ruby#ruby#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('ruby') . ' -w -c -T1 %t', + \ ale_linters#ruby#ruby#GetCommand(bufnr('')) + +Execute(The executable should be configurable): + let g:ale_ruby_ruby_executable = 'foobar' + + AssertEqual 'foobar', ale_linters#ruby#ruby#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('foobar') . ' -w -c -T1 %t', + \ ale_linters#ruby#ruby#GetCommand(bufnr('')) From 0ab689db0a137f7f62a3856eeba7c0ad235a625a Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 28 Nov 2017 10:08:34 +0000 Subject: [PATCH 227/390] Allow warnings about trailing blank lines to be hidden for flake8 and pycodestyle --- ale_linters/python/flake8.vim | 6 ++++ ale_linters/python/pycodestyle.vim | 6 ++++ doc/ale.txt | 19 +++++++--- plugin/ale.vim | 5 +-- test/handler/test_flake8_handler.vader | 40 +++++++++++++++++++-- test/handler/test_pycodestyle_handler.vader | 34 ++++++++++++++++++ 6 files changed, 101 insertions(+), 9 deletions(-) diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim index 480e605..400e60f 100644 --- a/ale_linters/python/flake8.vim +++ b/ale_linters/python/flake8.vim @@ -91,6 +91,12 @@ function! ale_linters#python#flake8#Handle(buffer, lines) abort continue endif + if l:code is# 'W391' + \&& !ale#Var(a:buffer, 'warn_about_trailing_blank_lines') + " Skip warnings for trailing blank lines if the option is off + continue + endif + let l:item = { \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, diff --git a/ale_linters/python/pycodestyle.vim b/ale_linters/python/pycodestyle.vim index 0382e9d..1958f37 100644 --- a/ale_linters/python/pycodestyle.vim +++ b/ale_linters/python/pycodestyle.vim @@ -23,6 +23,12 @@ function! ale_linters#python#pycodestyle#Handle(buffer, lines) abort " lines are formatted as follows: " file.py:21:26: W291 trailing whitespace for l:match in ale#util#GetMatches(a:lines, l:pattern) + if l:match[4] is# 'W391' + \&& !ale#Var(a:buffer, 'warn_about_trailing_blank_lines') + " Skip warnings for trailing blank lines if the option is off + continue + endif + let l:item = { \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, diff --git a/doc/ale.txt b/doc/ale.txt index 7d87077..184912c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1387,6 +1387,18 @@ b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names* directory containing the Python file to find virtualenv paths. +g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines* +b:ale_warn_about_trailing_blank_lines *b:ale_warn_about_trailing_blank_lines* + + Type: |Number| + Default: `1` + + When this option is set to `1`, warnings about trailing blank lines will be + shown. + + This option behaves similarly to |g:ale_warn_about_trailing_whitespace|. + + g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace* b:ale_warn_about_trailing_whitespace *b:ale_warn_about_trailing_whitespace* @@ -1394,10 +1406,9 @@ b:ale_warn_about_trailing_whitespace *b:ale_warn_about_trailing_whitespace* Default: `1` When this option is set to `1`, warnings relating to trailing whitespace on - lines will be shown in signs, the loclist, and echo messages, etc. If these - errors are found to be too irritating while edits are being made, and you - have configured Vim to automatically remove trailing whitespace, then you - can disable these warnings for some linters by setting this option to `0`. + lines will be shown. If warnings are too irritating while editing buffers, + and you have configured Vim to automatically remove trailing whitespace, + you can disable these warnings by setting this option to `0`. Not all linters may respect this option. If a linter does not, please file a bug report, and it may be possible to add such support. diff --git a/plugin/ale.vim b/plugin/ale.vim index a8bce1b..8c97e39 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -175,8 +175,9 @@ let g:ale_statusline_format = get(g:, 'ale_statusline_format', \) " This flag can be set to 0 to disable warnings for trailing whitespace -let g:ale_warn_about_trailing_whitespace = -\ get(g:, 'ale_warn_about_trailing_whitespace', 1) +call ale#Set('warn_about_trailing_whitespace', 1) +" This flag can be set to 0 to disable warnings for trailing blank lines +call ale#Set('warn_about_trailing_blank_lines', 1) " A flag for controlling the maximum size of the command history to store. let g:ale_max_buffer_history_size = get(g:, 'ale_max_buffer_history_size', 20) diff --git a/test/handler/test_flake8_handler.vader b/test/handler/test_flake8_handler.vader index d8cb51b..655f02a 100644 --- a/test/handler/test_flake8_handler.vader +++ b/test/handler/test_flake8_handler.vader @@ -1,8 +1,16 @@ Before: - runtime ale_linters/python/flake8.vim + Save g:ale_warn_about_trailing_blank_lines + + let g:ale_warn_about_trailing_blank_lines = 1 + + runtime ale_linters/python/flake8.vim After: - call ale#linter#Reset() + Restore + + unlet! b:ale_warn_about_trailing_blank_lines + + call ale#linter#Reset() Execute(The flake8 handler should handle basic warnings and syntax errors): AssertEqual @@ -126,7 +134,7 @@ Execute(The flake8 handler should handle stack traces): \ 'ImportError: No module named parser', \ ]) -Execute (The flake8 handler should handle names with spaces): +Execute(The flake8 handler should handle names with spaces): AssertEqual \ [ \ { @@ -141,3 +149,29 @@ Execute (The flake8 handler should handle names with spaces): \ ale_linters#python#flake8#Handle(42, [ \ 'C:\something\with spaces.py:6:6: E111 indentation is not a multiple of four', \ ]) + +Execute(Warnings about trailing blank lines should be reported by default): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W391', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'blank line at end of file', + \ }, + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: W391 blank line at end of file', + \ ]) + +Execute(Disabling trailing blank line warnings should work): + let b:ale_warn_about_trailing_blank_lines = 0 + + AssertEqual + \ [ + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: W391 blank line at end of file', + \ ]) diff --git a/test/handler/test_pycodestyle_handler.vader b/test/handler/test_pycodestyle_handler.vader index 856f429..cb92eb3 100644 --- a/test/handler/test_pycodestyle_handler.vader +++ b/test/handler/test_pycodestyle_handler.vader @@ -1,7 +1,15 @@ Before: + Save g:ale_warn_about_trailing_blank_lines + + let g:ale_warn_about_trailing_blank_lines = 1 + runtime ale_linters/python/pycodestyle.vim After: + Restore + + unlet! b:ale_warn_about_trailing_blank_lines + call ale#linter#Reset() silent file something_else.py @@ -64,3 +72,29 @@ Execute(The pycodestyle handler should parse output): \ 'stdin:222:34: W602 deprecated form of raising exception', \ 'example.py:544:21: W601 .has_key() is deprecated, use ''in''', \ ]) + +Execute(Warnings about trailing blank lines should be reported by default): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W391', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'blank line at end of file', + \ }, + \ ], + \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'foo.py:6:1: W391 blank line at end of file', + \ ]) + +Execute(Disabling trailing blank line warnings should work): + let b:ale_warn_about_trailing_blank_lines = 0 + + AssertEqual + \ [ + \ ], + \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'foo.py:6:1: W391 blank line at end of file', + \ ]) From a43ada93e40b8286dde3cd62f10369876787ddc1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 28 Nov 2017 10:12:49 +0000 Subject: [PATCH 228/390] Allow warnings about trailing whitespace to be disabled for pycodestyle, and cover the flake8 code with tests --- ale_linters/python/pycodestyle.vim | 6 ++++ test/handler/test_flake8_handler.vader | 39 +++++++++++++++++++++ test/handler/test_pycodestyle_handler.vader | 39 +++++++++++++++++++++ 3 files changed, 84 insertions(+) diff --git a/ale_linters/python/pycodestyle.vim b/ale_linters/python/pycodestyle.vim index 1958f37..bbecdf0 100644 --- a/ale_linters/python/pycodestyle.vim +++ b/ale_linters/python/pycodestyle.vim @@ -23,6 +23,12 @@ function! ale_linters#python#pycodestyle#Handle(buffer, lines) abort " lines are formatted as follows: " file.py:21:26: W291 trailing whitespace for l:match in ale#util#GetMatches(a:lines, l:pattern) + if(l:match[4] is# 'W291' || l:match[4] is# 'W293') + \&& !ale#Var(a:buffer, 'warn_about_trailing_whitespace') + " Skip warnings for trailing whitespace if the option is off. + continue + endif + if l:match[4] is# 'W391' \&& !ale#Var(a:buffer, 'warn_about_trailing_blank_lines') " Skip warnings for trailing blank lines if the option is off diff --git a/test/handler/test_flake8_handler.vader b/test/handler/test_flake8_handler.vader index 655f02a..8b44039 100644 --- a/test/handler/test_flake8_handler.vader +++ b/test/handler/test_flake8_handler.vader @@ -1,7 +1,9 @@ Before: Save g:ale_warn_about_trailing_blank_lines + Save g:ale_warn_about_trailing_whitespace let g:ale_warn_about_trailing_blank_lines = 1 + let g:ale_warn_about_trailing_whitespace = 1 runtime ale_linters/python/flake8.vim @@ -9,6 +11,7 @@ After: Restore unlet! b:ale_warn_about_trailing_blank_lines + unlet! b:ale_warn_about_trailing_whitespace call ale#linter#Reset() @@ -150,6 +153,42 @@ Execute(The flake8 handler should handle names with spaces): \ 'C:\something\with spaces.py:6:6: E111 indentation is not a multiple of four', \ ]) +Execute(Warnings about trailing whitespace should be reported by default): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W291', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'who cares', + \ }, + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W293', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'who cares', + \ }, + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: W291 who cares', + \ 'foo.py:6:1: W293 who cares', + \ ]) + +Execute(Disabling trailing whitespace warnings should work): + let b:ale_warn_about_trailing_whitespace = 0 + + AssertEqual + \ [ + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: W291 who cares', + \ 'foo.py:6:1: W293 who cares', + \ ]) + Execute(Warnings about trailing blank lines should be reported by default): AssertEqual \ [ diff --git a/test/handler/test_pycodestyle_handler.vader b/test/handler/test_pycodestyle_handler.vader index cb92eb3..0fd885d 100644 --- a/test/handler/test_pycodestyle_handler.vader +++ b/test/handler/test_pycodestyle_handler.vader @@ -1,7 +1,9 @@ Before: Save g:ale_warn_about_trailing_blank_lines + Save g:ale_warn_about_trailing_whitespace let g:ale_warn_about_trailing_blank_lines = 1 + let g:ale_warn_about_trailing_whitespace = 1 runtime ale_linters/python/pycodestyle.vim @@ -9,6 +11,7 @@ After: Restore unlet! b:ale_warn_about_trailing_blank_lines + unlet! b:ale_warn_about_trailing_whitespace call ale#linter#Reset() silent file something_else.py @@ -73,6 +76,42 @@ Execute(The pycodestyle handler should parse output): \ 'example.py:544:21: W601 .has_key() is deprecated, use ''in''', \ ]) +Execute(Warnings about trailing whitespace should be reported by default): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W291', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'who cares', + \ }, + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'W293', + \ 'type': 'W', + \ 'sub_type': 'style', + \ 'text': 'who cares', + \ }, + \ ], + \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'foo.py:6:1: W291 who cares', + \ 'foo.py:6:1: W293 who cares', + \ ]) + +Execute(Disabling trailing whitespace warnings should work): + let b:ale_warn_about_trailing_whitespace = 0 + + AssertEqual + \ [ + \ ], + \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'foo.py:6:1: W291 who cares', + \ 'foo.py:6:1: W293 who cares', + \ ]) + Execute(Warnings about trailing blank lines should be reported by default): AssertEqual \ [ From edb3a0c5e4079708b915e6227541e4e1fae9f712 Mon Sep 17 00:00:00 2001 From: Evan Rutledge Borden Date: Tue, 28 Nov 2017 17:58:13 -0500 Subject: [PATCH 229/390] Add brittany for Haskell formatting `brittany` is one of the options for Haskell source formatting. This adds the necessary fixer files and documentation to support `brittany` in `ALE`. --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 ++++ autoload/ale/fixers/brittany.vim | 15 ++++++++++++ doc/ale-haskell.txt | 10 ++++++++ doc/ale.txt | 1 + .../fixers/test_brittany_fixer_callback.vader | 23 +++++++++++++++++++ 6 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 autoload/ale/fixers/brittany.vim create mode 100644 test/fixers/test_brittany_fixer_callback.vader diff --git a/README.md b/README.md index c5f63f3..c0589ee 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ formatting. | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | -| Haskell | [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | +| Haskell | [brittany](https://github.com/lspitzner/brittany), [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | | HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 4fb229b..dd63a80 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -134,6 +134,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['haskell'], \ 'description': 'Fix Haskell files with hfmt.', \ }, +\ 'brittany': { +\ 'function': 'ale#fixers#brittany#Fix', +\ 'suggested_filetypes': ['haskell'], +\ 'description': 'Fix Haskell files with brittany.', +\ }, \ 'refmt': { \ 'function': 'ale#fixers#refmt#Fix', \ 'suggested_filetypes': ['reason'], diff --git a/autoload/ale/fixers/brittany.vim b/autoload/ale/fixers/brittany.vim new file mode 100644 index 0000000..fed5eb8 --- /dev/null +++ b/autoload/ale/fixers/brittany.vim @@ -0,0 +1,15 @@ +" Author: eborden +" Description: Integration of brittany with ALE. + +call ale#Set('haskell_brittany_executable', 'brittany') + +function! ale#fixers#brittany#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'haskell_brittany_executable') + + return { + \ 'command': ale#Escape(l:executable) + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction + diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt index 4a490ef..0ea4037 100644 --- a/doc/ale-haskell.txt +++ b/doc/ale-haskell.txt @@ -2,6 +2,16 @@ ALE Haskell Integration *ale-haskell-options* +=============================================================================== +brittany *ale-haskell-brittany* + +g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable* + *b:ale_haskell_brittany_executable* + Type: |String| + Default: `'brittany'` + + This variable can be changed to use a different executable for brittany. + =============================================================================== hdevtools *ale-haskell-hdevtools* diff --git a/doc/ale.txt b/doc/ale.txt index 184912c..151351f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -79,6 +79,7 @@ CONTENTS *ale-contents* handlebars............................|ale-handlebars-options| ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| + brittany............................|ale-haskell-brittany| hdevtools...........................|ale-haskell-hdevtools| hfmt................................|ale-haskell-hfmt| stack-build.........................|ale-haskell-stack-build| diff --git a/test/fixers/test_brittany_fixer_callback.vader b/test/fixers/test_brittany_fixer_callback.vader new file mode 100644 index 0000000..a0182b5 --- /dev/null +++ b/test/fixers/test_brittany_fixer_callback.vader @@ -0,0 +1,23 @@ +Before: + Save g:ale_haskell_brittany_executable + + " Use an invalid global executable, so we don't match it. + let g:ale_haskell_brittany_executable = 'xxxinvalid' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The brittany callback should return the correct default values): + call ale#test#SetFilename('../haskell_files/testfile.hs') + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape('xxxinvalid') + \ . ' %t', + \ }, + \ ale#fixers#brittany#Fix(bufnr('')) From 6503b85d3d0f01d8fa74f8024fda8d6fe0d62274 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 29 Nov 2017 10:08:54 +0000 Subject: [PATCH 230/390] Fix #1178 - Don't use the output from eslint_d for fixing files when the output is an error message --- autoload/ale/fixers/eslint.vim | 12 ++++++++++++ test/fixers/test_eslint_fixer_callback.vader | 20 ++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/autoload/ale/fixers/eslint.vim b/autoload/ale/fixers/eslint.vim index 76615fb..36f4751 100644 --- a/autoload/ale/fixers/eslint.vim +++ b/autoload/ale/fixers/eslint.vim @@ -22,6 +22,17 @@ function! ale#fixers#eslint#ProcessFixDryRunOutput(buffer, output) abort return [] endfunction +function! ale#fixers#eslint#ProcessEslintDOutput(buffer, output) abort + " If the output is an error message, don't use it. + for l:line in a:output[:10] + if l:line =~# '^Error:' + return [] + endif + endfor + + return a:output +endfunction + function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort let l:executable = ale#handlers#eslint#GetExecutable(a:buffer) let l:version = ale#semver#GetVersion(l:executable, a:version_output) @@ -37,6 +48,7 @@ function! ale#fixers#eslint#ApplyFixForVersion(buffer, version_output) abort return { \ 'command': ale#node#Executable(a:buffer, l:executable) \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \ 'process_with': 'ale#fixers#eslint#ProcessEslintDOutput', \} endif diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index afb267a..aafc4e7 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -101,6 +101,7 @@ Execute(--fix-to-stdout should be used for eslint_d): \ 'command': \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \ 'process_with': 'ale#fixers#eslint#ProcessEslintDOutput', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['v3.19.0 (eslint_d v4.2.0)']) @@ -110,6 +111,7 @@ Execute(--fix-to-stdout should be used for eslint_d): \ 'command': \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', + \ 'process_with': 'ale#fixers#eslint#ProcessEslintDOutput', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['4.9.0']) @@ -150,3 +152,21 @@ Execute(The --fix-dry-run post-processor should handle JSON output correctly): AssertEqual \ ['foo', 'bar'], \ ale#fixers#eslint#ProcessFixDryRunOutput(bufnr(''), ['[{"output": "foo\nbar"}]']) + +Execute(The eslint_d post-processor should permit regular JavaScript content): + AssertEqual + \ [ + \ 'const x = ''Error: foo''', + \ 'const y = 3', + \ ], + \ ale#fixers#eslint#ProcessEslintDOutput(bufnr(''), [ + \ 'const x = ''Error: foo''', + \ 'const y = 3', + \ ]) + +Execute(The eslint_d post-processor should handle error messages correctly): + AssertEqual + \ [], + \ ale#fixers#eslint#ProcessEslintDOutput(bufnr(''), [ + \ 'Error: No ESLint configuration found.', + \ ]) From 5d65980c42da3eb2c7f1431e15c3e2bf7d340c61 Mon Sep 17 00:00:00 2001 From: Lukas Galke Date: Thu, 30 Nov 2017 00:33:13 +0100 Subject: [PATCH 231/390] fnameescape when searching nearest file --- autoload/ale/path.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index bca0fe8..5fd6cef 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -31,6 +31,7 @@ endfunction " through the paths relative to the given buffer. function! ale#path#FindNearestFile(buffer, filename) abort let l:buffer_filename = fnamemodify(bufname(a:buffer), ':p') + let l:buffer_filename = fnameescape(l:buffer_filename) let l:relative_path = findfile(a:filename, l:buffer_filename . ';') From fd261264d7020699d76ed2f6eecd9800ef5f5b9f Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 30 Nov 2017 10:25:32 +0000 Subject: [PATCH 232/390] Escape the filename for finddir --- autoload/ale/path.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index 5fd6cef..57e607a 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -46,6 +46,7 @@ endfunction " through the paths relative to the given buffer. function! ale#path#FindNearestDirectory(buffer, directory_name) abort let l:buffer_filename = fnamemodify(bufname(a:buffer), ':p') + let l:buffer_filename = fnameescape(l:buffer_filename) let l:relative_path = finddir(a:directory_name, l:buffer_filename . ';') From a990188e276aad9410bc6fd1b627153fb279ffac Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 30 Nov 2017 10:34:51 +0000 Subject: [PATCH 233/390] Fix #1176 - Add an option for caching failing executable checks --- autoload/ale/engine.vim | 18 +++++++++++------- doc/ale.txt | 13 +++++++++++++ plugin/ale.vim | 4 ++++ test/test_ale_info.vader | 29 +++++++++++++++++++++++++++++ 4 files changed, 57 insertions(+), 7 deletions(-) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 811b243..150b53c 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -32,16 +32,20 @@ function! ale#engine#IsExecutable(buffer, executable) abort return 0 endif - if has_key(s:executable_cache_map, a:executable) - return 1 + " Check for a cached executable() check. + let l:result = get(s:executable_cache_map, a:executable, v:null) + + if l:result isnot v:null + return l:result endif - let l:result = 0 + " Check if the file is executable, and convert -1 to 1. + let l:result = executable(a:executable) isnot 0 - if executable(a:executable) - let s:executable_cache_map[a:executable] = 1 - - let l:result = 1 + " Cache the executable check if we found it, or if the option to cache + " failing checks is on. + if l:result || g:ale_cache_executable_check_failures + let s:executable_cache_map[a:executable] = l:result endif if g:ale_history_enabled diff --git a/doc/ale.txt b/doc/ale.txt index 184912c..a4ec727 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -605,6 +605,19 @@ g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled* |airline#extensions#ale#warning_symbol|. +g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures* + + Type: |Number| + Default: `0` + + When set to `1`, ALE will cache failing executable checks for linters. By + default, only executable checks which succeed will be cached. + + When this option is set to `1`, Vim will have to be restarted after new + executables are installed for ALE to be able to run linters for those + executables. + + g:ale_change_sign_column_color *g:ale_change_sign_column_color* Type: |Number| diff --git a/plugin/ale.vim b/plugin/ale.vim index 8c97e39..a07915f 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -188,6 +188,10 @@ let g:ale_history_enabled = get(g:, 'ale_history_enabled', 1) " A flag for storing the full output of commands in the history. let g:ale_history_log_output = get(g:, 'ale_history_log_output', 1) +" A flag for caching failed executable checks. +" This is off by default, because it will cause problems. +call ale#Set('cache_executable_check_failures', 0) + " A dictionary mapping regular expression patterns to arbitrary buffer " variables to be set. Useful for configuration ALE based on filename " patterns. diff --git a/test/test_ale_info.vader b/test/test_ale_info.vader index 30237a3..2ca1834 100644 --- a/test/test_ale_info.vader +++ b/test/test_ale_info.vader @@ -2,9 +2,13 @@ Before: Save g:ale_warn_about_trailing_whitespace Save g:ale_linters Save g:ale_fixers + Save g:ale_lint_on_text_changed + Save g:ale_cache_executable_check_failures unlet! b:ale_history + let g:ale_lint_on_text_changed = 'always' + let g:ale_cache_executable_check_failures = 0 let g:ale_warn_about_trailing_whitespace = 1 let g:testlinter1 = {'name': 'testlinter1', 'executable': 'testlinter1', 'command': 'testlinter1', 'callback': 'testCB1', 'output_stream': 'stdout'} @@ -355,6 +359,31 @@ Execute (ALEInfo command history should print command output if logging is on): Execute (ALEInfo should include executable checks in the history): call ale#linter#Define('testft', g:testlinter1) call ale#engine#IsExecutable(bufnr(''), has('win32') ? 'cmd' : 'echo') + call ale#engine#IsExecutable(bufnr(''), has('win32') ? 'cmd' : 'echo') + call ale#engine#IsExecutable(bufnr(''), 'TheresNoWayThisIsExecutable') + call ale#engine#IsExecutable(bufnr(''), 'TheresNoWayThisIsExecutable') + + call CheckInfo([ + \ ' Current Filetype: testft.testft2', + \ 'Available Linters: [''testlinter1'']', + \ ' Enabled Linters: [''testlinter1'']', + \ ' Linter Variables:', + \ '', + \] + g:globals_lines + g:command_header + [ + \ '', + \ '(executable check - success) ' . (has('win32') ? 'cmd' : 'echo'), + \ '(executable check - failure) TheresNoWayThisIsExecutable', + \ '(executable check - failure) TheresNoWayThisIsExecutable', + \]) + +Execute (The option for caching failing executable checks should work): + let g:ale_cache_executable_check_failures = 1 + + call ale#linter#Define('testft', g:testlinter1) + + call ale#engine#IsExecutable(bufnr(''), has('win32') ? 'cmd' : 'echo') + call ale#engine#IsExecutable(bufnr(''), has('win32') ? 'cmd' : 'echo') + call ale#engine#IsExecutable(bufnr(''), 'TheresNoWayThisIsExecutable') call ale#engine#IsExecutable(bufnr(''), 'TheresNoWayThisIsExecutable') call CheckInfo([ From 0406af44846277f58bbbf3d1e4ba7fa6ab3ae0f6 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase Date: Fri, 1 Dec 2017 03:03:10 +0100 Subject: [PATCH 234/390] Delete unnecessary unlets I'm not even sure why these were here. --- test/command_callback/test_glslang_command_callback.vader | 2 -- 1 file changed, 2 deletions(-) diff --git a/test/command_callback/test_glslang_command_callback.vader b/test/command_callback/test_glslang_command_callback.vader index 9d40683..1b1722a 100644 --- a/test/command_callback/test_glslang_command_callback.vader +++ b/test/command_callback/test_glslang_command_callback.vader @@ -10,8 +10,6 @@ Before: After: Restore - unlet! g:ale_cuda_nvcc_executable - unlet! g:ale_cuda_nvcc_options call ale#linter#Reset() Execute(Executable should default to glslangValidator): From 6b3927820bd46cb25e8741d04c13dec15401f92f Mon Sep 17 00:00:00 2001 From: "E.J. Sexton" Date: Fri, 1 Dec 2017 14:55:34 +0100 Subject: [PATCH 235/390] Fixed command string for phpcbf fixer --- autoload/ale/fixers/phpcbf.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/fixers/phpcbf.vim b/autoload/ale/fixers/phpcbf.vim index 9bff741..649e17d 100644 --- a/autoload/ale/fixers/phpcbf.vim +++ b/autoload/ale/fixers/phpcbf.vim @@ -19,6 +19,6 @@ function! ale#fixers#phpcbf#Fix(buffer) abort \ ? '--standard=' . l:standard \ : '' return { - \ 'command': ale#Escape(l:executable) . ' --stdin-path=%s ' . l:standard_option + \ 'command': ale#Escape(l:executable) . ' --stdin-path=%s ' . l:standard_option . ' -' \} endfunction From daee4a4722ab2ddd9490a50de2c4c1f590325aa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Co=C3=AAlho?= Date: Fri, 1 Dec 2017 14:04:30 -0300 Subject: [PATCH 236/390] Add prospector for checking Python code (#1183) --- README.md | 2 +- ale_linters/python/prospector.vim | 82 +++++++++++ doc/ale-python.txt | 40 ++++++ doc/ale.txt | 3 +- test/handler/test_prospector_handler.vader | 158 +++++++++++++++++++++ 5 files changed, 283 insertions(+), 2 deletions(-) create mode 100644 ale_linters/python/prospector.vim create mode 100644 test/handler/test_prospector_handler.vader diff --git a/README.md b/README.md index c5f63f3..0cc5206 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,7 @@ formatting. | proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | -| Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | +| Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | diff --git a/ale_linters/python/prospector.vim b/ale_linters/python/prospector.vim new file mode 100644 index 0000000..66af598 --- /dev/null +++ b/ale_linters/python/prospector.vim @@ -0,0 +1,82 @@ +" Author: chocoelho +" Description: prospector linter python files + +let g:ale_python_prospector_executable = +\ get(g:, 'ale_python_prospector_executable', 'prospector') + +let g:ale_python_prospector_options = +\ get(g:, 'ale_python_prospector_options', '') + +let g:ale_python_prospector_use_global = get(g:, 'ale_python_prospector_use_global', 0) + +function! ale_linters#python#prospector#GetExecutable(buffer) abort + return ale#python#FindExecutable(a:buffer, 'python_prospector', ['prospector']) +endfunction + +function! ale_linters#python#prospector#GetCommand(buffer) abort + return ale#Escape(ale_linters#python#prospector#GetExecutable(a:buffer)) + \ . ' ' . ale#Var(a:buffer, 'python_prospector_options') + \ . ' --messages-only --absolute-paths --zero-exit --output-format json' + \ . ' %s' +endfunction + +function! ale_linters#python#prospector#Handle(buffer, lines) abort + let l:output = [] + + let l:prospector_error = json_decode(join(a:lines, '')) + + for l:error in l:prospector_error.messages + if (l:error.code is# 'W291' || l:error.code is# 'W293' || l:error.code is# 'trailing-whitespace') + \ && !ale#Var(a:buffer, 'warn_about_trailing_whitespace') + " Skip warnings for trailing whitespace if the option is off. + continue + endif + + if l:error.code is# 'W391' + \&& !ale#Var(a:buffer, 'warn_about_trailing_blank_lines') + " Skip warnings for trailing blank lines if the option is off + continue + endif + + if l:error.source =~# '\v\[%(dodgy|mccabe|pep8|pep257|pyroma)\]$' + let l:sub_type = 'style' + else + let l:sub_type = '' + endif + + if l:error.source =~# '\v\[pylint\]$' + let l:type = l:error.code =~? '\m^[CRW]' ? 'W' : 'E' + elseif l:error.source =~# '\v\[%(frosted|pep8)\]$' + let l:type = l:error.code =~? '\m^W' ? 'W' : 'E' + elseif l:error.source =~# '\v\[%(dodgy|pyroma|vulture)\]$' + let l:type = 'W' + else + let l:type = 'E' + endif + + let l:item = { + \ 'lnum': l:error.location.line, + \ 'col': l:error.location.character + 1, + \ 'text': l:error.message, + \ 'code': printf('(%s) %s', l:error.source, l:error.code), + \ 'type': l:type, + \ 'sub_type': l:sub_type, + \} + + if l:sub_type is# '' + unlet l:item.sub_type + endif + + call add(l:output, l:item) + endfor + + return l:output +endfunction + +call ale#linter#Define('python', { +\ 'name': 'prospector', +\ 'executable_callback': 'ale_linters#python#prospector#GetExecutable', +\ 'command_callback': 'ale_linters#python#prospector#GetCommand', +\ 'callback': 'ale_linters#python#prospector#Handle', +\ 'lint_file': 1, +\}) diff --git a/doc/ale-python.txt b/doc/ale-python.txt index a78cb5a..742a854 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -122,6 +122,46 @@ g:ale_python_mypy_use_global *g:ale_python_mypy_use_global* See |ale-integrations-local-executables| +=============================================================================== +prospector *ale-python-prospector* + +g:ale_python_prospector_executable *g:ale_python_prospector_executable* + *b:ale_python_prospector_executable* + Type: |String| + Default: `'prospector'` + + See |ale-integrations-local-executables| + + +g:ale_python_prospector_options *g:ale_python_prospector_options* + *b:ale_python_prospector_options* + Type: |String| + Default: `''` + + This variable can be changed to add command-line arguments to the prospector + invocation. + + For example, to dynamically switch between programs targeting Python 2 and + Python 3, you may want to set > + + let g:ale_python_prospector_executable = 'python3' + " or 'python' for Python 2 + let g:ale_python_prospector_options = '--rcfile /path/to/.prospector.yaml' + " The virtualenv detection needs to be disabled. + let g:ale_python_prospector_use_global = 0 + + after making sure it's installed for the appropriate Python versions (e.g. + `python3 -m pip install --user prospector`). + + +g:ale_python_prospector_use_global *g:ale_python_prospector_use_global* + *b:ale_python_prospector_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== pycodestyle *ale-python-pycodestyle* diff --git a/doc/ale.txt b/doc/ale.txt index a4ec727..d39a5c6 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -153,6 +153,7 @@ CONTENTS *ale-contents* flake8..............................|ale-python-flake8| isort...............................|ale-python-isort| mypy................................|ale-python-mypy| + prospector..........................|ale-python-prospector| pycodestyle.........................|ale-python-pycodestyle| pylint..............................|ale-python-pylint| pyls................................|ale-python-pyls| @@ -326,7 +327,7 @@ Notes: * proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` -* Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` +* Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` * reStructuredText: `proselint`, `rstcheck`, `write-good`, `redpen` diff --git a/test/handler/test_prospector_handler.vader b/test/handler/test_prospector_handler.vader new file mode 100644 index 0000000..7962f6c --- /dev/null +++ b/test/handler/test_prospector_handler.vader @@ -0,0 +1,158 @@ +Before: + Save g:ale_warn_about_trailing_whitespace + + let g:ale_warn_about_trailing_whitespace = 1 + + runtime ale_linters/python/prospector.vim + +After: + Restore + + call ale#linter#Reset() + + silent file something_else.py + +Execute(Basic prospector errors should be handle): + AssertEqual + \ [ + \ { + \ 'lnum': 20, + \ 'col': 1, + \ 'text': 'Trailing whitespace', + \ 'code': '(pylint) trailing-whitespace', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 1, + \ 'col': 1, + \ 'text': 'Missing module docstring', + \ 'code': '(pylint) missing-docstring', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 1, + \ 'text': 'Missing function docstring', + \ 'code': '(pylint) missing-docstring', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 3, + \ 'col': 5, + \ 'text': '''break'' not properly in loop', + \ 'code': '(pylint) not-in-loop', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 4, + \ 'col': 5, + \ 'text': 'Unreachable code', + \ 'code': '(pylint) unreachable', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 7, + \ 'col': 33, + \ 'text': 'No exception type(s) specified', + \ 'code': '(pylint) bare-except', + \ 'type': 'E', + \ }, + \ ], + \ ale_linters#python#prospector#Handle(bufnr(''), [ + \ '{', + \ ' "messages": [', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "trailing-whitespace",', + \ ' "message": "Trailing whitespace",', + \ ' "location": {', + \ ' "character": 0,', + \ ' "line": 20', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "missing-docstring",', + \ ' "message": "Missing module docstring",', + \ ' "location": {', + \ ' "character": 0,', + \ ' "line": 1', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "missing-docstring",', + \ ' "message": "Missing function docstring",', + \ ' "location": {', + \ ' "character": 0,', + \ ' "line": 2', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "not-in-loop",', + \ ' "message": "''break'' not properly in loop",', + \ ' "location": {', + \ ' "character": 4,', + \ ' "line": 3', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "unreachable",', + \ ' "message": "Unreachable code",', + \ ' "location": {', + \ ' "character": 4,', + \ ' "line": 4', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "bare-except",', + \ ' "message": "No exception type(s) specified",', + \ ' "location": {', + \ ' "character": 32,', + \ ' "line": 7', + \ ' }', + \ ' }', + \ ' ]', + \ '}', + \ ]) + +Execute(Ignoring trailing whitespace messages should work): + let g:ale_warn_about_trailing_whitespace = 0 + + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 1, + \ 'text': 'Missing module docstring', + \ 'code': '(pylint) missing-docstring', + \ 'type': 'E', + \ }, + \ ], + \ ale_linters#python#prospector#Handle(bufnr(''), [ + \ '{', + \ ' "messages": [', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "trailing-whitespace",', + \ ' "message": "Trailing whitespace",', + \ ' "location": {', + \ ' "character": 0,', + \ ' "line": 4', + \ ' }', + \ ' },', + \ ' {', + \ ' "source": "pylint",', + \ ' "code": "missing-docstring",', + \ ' "message": "Missing module docstring",', + \ ' "location": {', + \ ' "character": 0,', + \ ' "line": 1', + \ ' }', + \ ' }', + \ ' ]', + \ '}', + \ ]) From 6053f764bd6f7707af0be0f0520a691571de5705 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 1 Dec 2017 17:12:16 +0000 Subject: [PATCH 237/390] Make toggling work when pattern options are enabled --- autoload/ale/toggle.vim | 2 +- test/test_ale_toggle.vader | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/autoload/ale/toggle.vim b/autoload/ale/toggle.vim index dcca703..e9cc29b 100644 --- a/autoload/ale/toggle.vim +++ b/autoload/ale/toggle.vim @@ -79,7 +79,7 @@ endfunction function! s:EnablePreamble() abort " Set pattern options again, if enabled. if g:ale_pattern_options_enabled - call ale#pattern_options#SetOptions() + call ale#pattern_options#SetOptions(bufnr('')) endif " Lint immediately, including running linters against the file. diff --git a/test/test_ale_toggle.vader b/test/test_ale_toggle.vader index a57546f..d56f8c2 100644 --- a/test/test_ale_toggle.vader +++ b/test/test_ale_toggle.vader @@ -3,10 +3,14 @@ Before: Save g:ale_set_signs Save g:ale_set_lists_synchronously Save g:ale_run_synchronously + Save g:ale_pattern_options + Save g:ale_pattern_options_enabled let g:ale_set_signs = 1 let g:ale_set_lists_synchronously = 1 let g:ale_run_synchronously = 1 + let g:ale_pattern_options = {} + let g:ale_pattern_options_enabled = 1 unlet! b:ale_enabled From 51b127a4fd8e581ab0592874db584facb70e9f79 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase Date: Fri, 1 Dec 2017 18:36:44 +0100 Subject: [PATCH 238/390] Add glslls (#1179) * Add glslls-based LSP linter * Make logfile configureable --- README.md | 2 +- ale_linters/glsl/glslls.vim | 38 +++++++++++++++++++ doc/ale-glsl.txt | 20 ++++++++++ doc/ale.txt | 3 +- .../test_glslls_command_callback.vader | 37 ++++++++++++++++++ 5 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 ale_linters/glsl/glslls.vim create mode 100644 test/command_callback/test_glslls_command_callback.vader diff --git a/README.md b/README.md index 0cc5206..89bcc25 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ formatting. | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | -| GLSL | [glslang](https://github.com/KhronosGroup/glslang) | +| GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | diff --git a/ale_linters/glsl/glslls.vim b/ale_linters/glsl/glslls.vim new file mode 100644 index 0000000..67ea379 --- /dev/null +++ b/ale_linters/glsl/glslls.vim @@ -0,0 +1,38 @@ +" Author: Sven-Hendrik Haase +" Description: A language server for glsl + +call ale#Set('glsl_glslls_executable', 'glslls') +call ale#Set('glsl_glslls_logfile', '') + +function! ale_linters#glsl#glslls#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'glsl_glslls_executable') +endfunction + +function! ale_linters#glsl#glslls#GetCommand(buffer) abort + let l:executable = ale_linters#glsl#glslls#GetExecutable(a:buffer) + let l:logfile = ale#Var(a:buffer, 'glsl_glslls_logfile') + let l:logfile_args = '' + if l:logfile isnot# '' + let l:logfile_args = ' --verbose -l ' . l:logfile + endif + return ale#Escape(l:executable) . l:logfile_args . ' --stdin' +endfunction + +function! ale_linters#glsl#glslls#GetLanguage(buffer) abort + return 'glsl' +endfunction + +function! ale_linters#glsl#glslls#GetProjectRoot(buffer) abort + let l:project_root = ale#c#FindProjectRoot(a:buffer) + + return !empty(l:project_root) ? fnamemodify(l:project_root, ':h:h') : '' +endfunction + +call ale#linter#Define('glsl', { +\ 'name': 'glslls', +\ 'lsp': 'stdio', +\ 'executable_callback': 'ale_linters#glsl#glslls#GetExecutable', +\ 'command_callback': 'ale_linters#glsl#glslls#GetCommand', +\ 'language_callback': 'ale_linters#glsl#glslls#GetLanguage', +\ 'project_root_callback': 'ale_linters#glsl#glslls#GetProjectRoot', +\}) diff --git a/doc/ale-glsl.txt b/doc/ale-glsl.txt index fbadf03..257de75 100644 --- a/doc/ale-glsl.txt +++ b/doc/ale-glsl.txt @@ -32,5 +32,25 @@ g:ale_glsl_glslang_options *g:ale_glsl_glslang_options* This variable can be set to pass additional options to glslangValidator. +=============================================================================== +glslls *ale-glsl-glslls* + +g:ale_glsl_glslls_executable *g:ale_glsl_glslls_executable* + *b:ale_glsl_glslls_executable* + Type: |String| + Default: `'glslls'` + + This variable can be changed to change the path to glslls. + See |ale-integrations-local-executables| + +g:ale_glsl_glslls_logfile *g:ale_glsl_glslls_logfile* + *b:ale_glsl_glslls_logfile* + Type: |String| + Default: `''` + + Setting this variable to a writeable file path will enable logging to that + file. + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index d39a5c6..1106946 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -70,6 +70,7 @@ CONTENTS *ale-contents* fusion-lint.........................|ale-fuse-fusionlint| glsl..................................|ale-glsl-options| glslang.............................|ale-glsl-glslang| + glslls..............................|ale-glsl-glslls| go....................................|ale-go-options| gofmt...............................|ale-go-gofmt| gometalinter........................|ale-go-gometalinter| @@ -295,7 +296,7 @@ Notes: * Erlang: `erlc`, `SyntaxErl` * Fortran: `gcc` * FusionScript: `fusion-lint` -* GLSL: glslang +* GLSL: glslang, `glslls` * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `eslint`, `gqlint` * Haml: `haml-lint` diff --git a/test/command_callback/test_glslls_command_callback.vader b/test/command_callback/test_glslls_command_callback.vader new file mode 100644 index 0000000..e64c235 --- /dev/null +++ b/test/command_callback/test_glslls_command_callback.vader @@ -0,0 +1,37 @@ +Before: + Save g:ale_glsl_glslls_executable + Save g:ale_glsl_glslls_logfile + + unlet! g:ale_glsl_glslls_executable + unlet! g:ale_glsl_glslls_logfile + + runtime ale_linters/glsl/glslls.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + call ale#linter#Reset() + +Execute(Executable should default to 'glslls'): + AssertEqual + \ 'glslls', + \ ale_linters#glsl#glslls#GetExecutable(bufnr('')) + +Execute(Executable should be configurable): + let g:ale_glsl_glslls_executable = 'foobar' + AssertEqual + \ 'foobar', + \ ale_linters#glsl#glslls#GetExecutable(bufnr('')) + +Execute(Command should use executable): + let command1 = ale_linters#glsl#glslls#GetCommand(bufnr('')) + AssertEqual command1, ale#Escape('glslls') . ' --stdin' + + let g:ale_glsl_glslls_executable = 'foobar' + let command2 = ale_linters#glsl#glslls#GetCommand(bufnr('')) + AssertEqual command2, ale#Escape('foobar') . ' --stdin' + +Execute(Setting logfile should work): + let g:ale_glsl_glslls_logfile = '/tmp/test.log' + let command = ale_linters#glsl#glslls#GetCommand(bufnr('')) + AssertEqual command, ale#Escape('glslls') . ' --verbose -l /tmp/test.log --stdin' From 499c1542727c7e79302529f61ffb2bbaecb08b68 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 1 Dec 2017 17:50:19 +0000 Subject: [PATCH 239/390] Move the Bash code for running Vader tests to its own file --- run-tests | 146 +++++++----------------------------- test/script/run-vader-tests | 120 +++++++++++++++++++++++++++++ 2 files changed, 146 insertions(+), 120 deletions(-) create mode 100755 test/script/run-vader-tests diff --git a/run-tests b/run-tests index 07ff3a8..816dc0e 100755 --- a/run-tests +++ b/run-tests @@ -9,17 +9,15 @@ # --neovim-only Run tests only for NeoVim # --vim-only Run tests only for Vim -RED='\033[0;31m' -GREEN='\033[0;32m' -NC='\033[0m' -CURRENT_IMAGE_ID=d5a1b5915b09 -IMAGE=w0rp/ale -DOCKER_FLAGS=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$IMAGE") -EXIT=0 +current_image_id=d5a1b5915b09 +image=w0rp/ale +docker_flags=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$image") +exit_code=0 tests='test/*.vader test/*/*.vader test/*/*/*.vader test/*/*/*.vader' -verbose=0 -quiet=0 +# These flags are forwarded to the script for running Vader tests. +verbose_flag='' +quiet_flag='' run_neovim_tests=1 run_vim_tests=1 run_vint=1 @@ -28,11 +26,11 @@ run_custom_checks=1 while [ $# -ne 0 ]; do case $1 in -v) - verbose=1 + verbose_flag='-v' shift ;; -q) - quiet=1 + quiet_flag='-q' shift ;; --neovim-only) @@ -85,108 +83,16 @@ fi # Delete .swp files in the test directory, which cause Vim 8 to hang. find test -name '*.swp' -delete -docker images -q w0rp/ale | grep "^$CURRENT_IMAGE_ID" > /dev/null \ - || docker pull "$IMAGE" +docker images -q w0rp/ale | grep "^$current_image_id" > /dev/null \ + || docker pull "$image" -function filter-vader-output() { - # When verbose mode is off, suppress output until Vader starts. - local start_output="$verbose" - local filtered_data='' - - while read -r; do - if ((!start_output)); then - if [[ "$REPLY" = *'Starting Vader:'* ]]; then - start_output=1 - else - continue - fi - fi - - if ((quiet)); then - if [[ "$REPLY" = *'Starting Vader:'* ]]; then - filtered_data="$REPLY" - elif [[ "$REPLY" = *'Success/Total'* ]]; then - success="$(echo -n "$REPLY" | grep -o '[0-9]\+/' | head -n1 | cut -d/ -f1)" - total="$(echo -n "$REPLY" | grep -o '/[0-9]\+' | head -n1 | cut -d/ -f2)" - - if [ "$success" -lt "$total" ]; then - echo "$filtered_data" - echo "$REPLY" - fi - - filtered_data='' - else - filtered_data="$filtered_data"$'\n'"$REPLY" - fi - else - echo "$REPLY" - fi - done -} - -function color-vader-output() { - while read -r; do - if [[ "$REPLY" = *'[EXECUTE] (X)'* ]]; then - echo -en "$RED" - elif [[ "$REPLY" = *'[EXECUTE]'* ]] || [[ "$REPLY" = *'[ GIVEN]'* ]]; then - echo -en "$NC" - fi - - if [[ "$REPLY" = *'Success/Total'* ]]; then - success="$(echo -n "$REPLY" | grep -o '[0-9]\+/' | head -n1 | cut -d/ -f1)" - total="$(echo -n "$REPLY" | grep -o '/[0-9]\+' | head -n1 | cut -d/ -f2)" - - if [ "$success" -lt "$total" ]; then - echo -en "$RED" - else - echo -en "$GREEN" - fi - - echo "$REPLY" - echo -en "$NC" - else - echo "$REPLY" - fi - done - - echo -en "$NC" -} - -if ((run_neovim_tests)); then - for vim in $(docker run --rm "$IMAGE" ls /vim-build/bin | grep '^neovim' ); do - echo - echo '========================================' - echo "Running tests for $vim" - echo '========================================' - echo - - set -o pipefail - docker run -it -e VADER_OUTPUT_FILE=/dev/stderr "${DOCKER_FLAGS[@]}" \ - "/vim-build/bin/$vim" -u test/vimrc \ - --headless "+Vader! $tests" | filter-vader-output | color-vader-output || EXIT=$? - set +o pipefail - done - - echo -fi - -if ((run_vim_tests)); then - for vim in $(docker run --rm "$IMAGE" ls /vim-build/bin | grep '^vim' ); do - echo - echo '========================================' - echo "Running tests for $vim" - echo '========================================' - echo - - set -o pipefail - docker run -a stderr -e VADER_OUTPUT_FILE=/dev/stderr "${DOCKER_FLAGS[@]}" \ - "/vim-build/bin/$vim" -u test/vimrc \ - "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output || EXIT=$? - set +o pipefail - done - - echo -fi +for vim in $(docker run --rm "$image" ls /vim-build/bin | grep '^neovim\|^vim' ); do + if [[ $vim =~ ^neovim ]] && ((run_neovim_tests)); then + test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" + elif ((run_vim_tests)); then + test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" + fi +done if ((run_vint)); then echo '========================================' @@ -196,7 +102,7 @@ if ((run_vint)); then echo set -o pipefail - docker run -a stdout "${DOCKER_FLAGS[@]}" vint -s . || EXIT=$? + docker run -a stdout "${docker_flags[@]}" vint -s . || exit_code=$? set +o pipefail echo fi @@ -209,7 +115,7 @@ if ((run_custom_checks)); then echo set -o pipefail - docker run -a stdout "${DOCKER_FLAGS[@]}" test/script/custom-checks . || EXIT=$? + docker run -a stdout "${docker_flags[@]}" test/script/custom-checks . || exit_code=$? set +o pipefail echo @@ -219,7 +125,7 @@ if ((run_custom_checks)); then echo 'Duplicate tags follow:' echo - grep --exclude=tags -roh '\*.*\*$' doc | sort | uniq -d || EXIT=$? + grep --exclude=tags -roh '\*.*\*$' doc | sort | uniq -d || exit_code=$? echo '========================================' echo 'Checking for invalid tag references' @@ -234,7 +140,7 @@ if ((run_custom_checks)); then diff -u \ <(grep --exclude=tags -roh "\*$tag_regex\*" doc | sort -u | sed 's/*//g') \ <(grep --exclude=tags -roh "|$tag_regex|" doc | sort -u | sed 's/|//g') \ - | grep '^+[^+]' && EXIT=1 + | grep '^+[^+]' && exit_code=1 echo '========================================' echo 'diff README.md and doc/ale.txt tables' @@ -242,7 +148,7 @@ if ((run_custom_checks)); then echo 'Differences follow:' echo - test/script/check-supported-tools-tables || EXIT=$? + test/script/check-supported-tools-tables || exit_code=$? echo '========================================' echo 'Look for badly aligned doc tags' @@ -254,14 +160,14 @@ if ((run_custom_checks)); then # tags which aren't at the right margin. grep ' \*[^*]\+\*$' doc/ -r \ | awk '{ sep = index($0, ":"); if (length(substr($0, sep + 1 )) < 79) { print } }' \ - | grep . && EXIT=1 + | grep . && exit_code=1 echo '========================================' echo 'Look for table of contents issues' echo '========================================' echo - test/script/check-toc || EXIT=$? + test/script/check-toc || exit_code=$? fi -exit $EXIT +exit $exit_code diff --git a/test/script/run-vader-tests b/test/script/run-vader-tests new file mode 100755 index 0000000..d28e198 --- /dev/null +++ b/test/script/run-vader-tests @@ -0,0 +1,120 @@ +#!/bin/bash -eu + +image=w0rp/ale +docker_flags=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$image") +red='\033[0;31m' +green='\033[0;32m' +nc='\033[0m' +verbose=0 +quiet=0 + +while [ $# -ne 0 ]; do + case $1 in + -v) + verbose=1 + shift + ;; + -q) + quiet=1 + shift + ;; + --) + shift + break + ;; + -?*) + echo "Invalid argument: $1" 1>&2 + exit 1 + ;; + *) + break + ;; + esac +done + +vim="$1" +tests="$2" + +function filter-vader-output() { + # When verbose mode is off, suppress output until Vader starts. + local start_output="$verbose" + local filtered_data='' + + while read -r; do + if ((!start_output)); then + if [[ "$REPLY" = *'Starting Vader:'* ]]; then + start_output=1 + else + continue + fi + fi + + if ((quiet)); then + if [[ "$REPLY" = *'Starting Vader:'* ]]; then + filtered_data="$REPLY" + elif [[ "$REPLY" = *'Success/Total'* ]]; then + success="$(echo -n "$REPLY" | grep -o '[0-9]\+/' | head -n1 | cut -d/ -f1)" + total="$(echo -n "$REPLY" | grep -o '/[0-9]\+' | head -n1 | cut -d/ -f2)" + + if [ "$success" -lt "$total" ]; then + echo "$filtered_data" + echo "$REPLY" + fi + + filtered_data='' + else + filtered_data="$filtered_data"$'\n'"$REPLY" + fi + else + echo "$REPLY" + fi + done +} + +function color-vader-output() { + while read -r; do + if [[ "$REPLY" = *'[EXECUTE] (X)'* ]]; then + echo -en "$red" + elif [[ "$REPLY" = *'[EXECUTE]'* ]] || [[ "$REPLY" = *'[ GIVEN]'* ]]; then + echo -en "$nc" + fi + + if [[ "$REPLY" = *'Success/Total'* ]]; then + success="$(echo -n "$REPLY" | grep -o '[0-9]\+/' | head -n1 | cut -d/ -f1)" + total="$(echo -n "$REPLY" | grep -o '/[0-9]\+' | head -n1 | cut -d/ -f2)" + + if [ "$success" -lt "$total" ]; then + echo -en "$red" + else + echo -en "$green" + fi + + echo "$REPLY" + echo -en "$nc" + else + echo "$REPLY" + fi + done + + echo -en "$nc" +} + +echo +echo '========================================' +echo "Running tests for $vim" +echo '========================================' +echo + +if [[ $vim =~ ^neovim ]]; then + set -o pipefail + docker run -it -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ + "/vim-build/bin/$vim" -u test/vimrc \ + --headless "+Vader! $tests" | filter-vader-output | color-vader-output + set +o pipefail +else + set -o pipefail + docker run -a stderr -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ + "/vim-build/bin/$vim" -u test/vimrc \ + "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output + set +o pipefail +fi From 6650c9a901ae35e76754a389ee1ae67b6dfb754f Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 1 Dec 2017 18:06:09 +0000 Subject: [PATCH 240/390] Break up the rest of the test script code into smaller files --- run-tests | 83 +++---------------- test/script/custom-checks | 137 +++++++++++++------------------ test/script/custom-linting-rules | 95 +++++++++++++++++++++ test/script/run-vader-tests | 7 +- test/script/run-vint | 18 ++++ 5 files changed, 183 insertions(+), 157 deletions(-) create mode 100755 test/script/custom-linting-rules create mode 100755 test/script/run-vint diff --git a/run-tests b/run-tests index 816dc0e..4c2c45f 100755 --- a/run-tests +++ b/run-tests @@ -11,7 +11,6 @@ current_image_id=d5a1b5915b09 image=w0rp/ale -docker_flags=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$image") exit_code=0 tests='test/*.vader test/*/*.vader test/*/*/*.vader test/*/*/*.vader' @@ -49,6 +48,12 @@ while [ $# -ne 0 ]; do run_vint=0 shift ;; + --vint-only) + run_vim_tests=0 + run_neovim_tests=0 + run_custom_checks=0 + shift + ;; --no-custom-checks) run_custom_checks=0 shift @@ -88,86 +93,18 @@ docker images -q w0rp/ale | grep "^$current_image_id" > /dev/null \ for vim in $(docker run --rm "$image" ls /vim-build/bin | grep '^neovim\|^vim' ); do if [[ $vim =~ ^neovim ]] && ((run_neovim_tests)); then - test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" + test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" || exit_code=$? elif ((run_vim_tests)); then - test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" + test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" || exit_code=$? fi done if ((run_vint)); then - echo '========================================' - echo 'Running Vint to lint our code' - echo '========================================' - echo 'Vint warnings/errors follow:' - echo - - set -o pipefail - docker run -a stdout "${docker_flags[@]}" vint -s . || exit_code=$? - set +o pipefail - echo + test/script/run-vint || exit_code=$? fi if ((run_custom_checks)); then - echo '========================================' - echo 'Running custom checks' - echo '========================================' - echo 'Custom warnings/errors follow:' - echo - - set -o pipefail - docker run -a stdout "${docker_flags[@]}" test/script/custom-checks . || exit_code=$? - set +o pipefail - echo - - echo '========================================' - echo 'Checking for duplicate tags' - echo '========================================' - echo 'Duplicate tags follow:' - echo - - grep --exclude=tags -roh '\*.*\*$' doc | sort | uniq -d || exit_code=$? - - echo '========================================' - echo 'Checking for invalid tag references' - echo '========================================' - echo 'Invalid tag references tags follow:' - echo - - tag_regex='[gb]\?:\?\(ale\|ALE\)[a-zA-Z_\-]\+' - - # Grep for tags and references, and complain if we find a reference without - # a tag for the reference. Only our tags will be included. - diff -u \ - <(grep --exclude=tags -roh "\*$tag_regex\*" doc | sort -u | sed 's/*//g') \ - <(grep --exclude=tags -roh "|$tag_regex|" doc | sort -u | sed 's/|//g') \ - | grep '^+[^+]' && exit_code=1 - - echo '========================================' - echo 'diff README.md and doc/ale.txt tables' - echo '========================================' - echo 'Differences follow:' - echo - - test/script/check-supported-tools-tables || exit_code=$? - - echo '========================================' - echo 'Look for badly aligned doc tags' - echo '========================================' - echo 'Badly aligned tags follow:' - echo - - # Documentation tags need to be aligned to the right margin, so look for - # tags which aren't at the right margin. - grep ' \*[^*]\+\*$' doc/ -r \ - | awk '{ sep = index($0, ":"); if (length(substr($0, sep + 1 )) < 79) { print } }' \ - | grep . && exit_code=1 - - echo '========================================' - echo 'Look for table of contents issues' - echo '========================================' - echo - - test/script/check-toc || exit_code=$? + test/script/custom-checks || exit_code=$? fi exit $exit_code diff --git a/test/script/custom-checks b/test/script/custom-checks index e2c906b..791053d 100755 --- a/test/script/custom-checks +++ b/test/script/custom-checks @@ -1,95 +1,68 @@ #!/bin/bash -eu -# This Bash script implements custom sanity checks for scripts beyond what -# Vint covers, which are easy to check with regex. +exit_code=0 +image=w0rp/ale +docker_flags=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$image") -# A flag for automatically fixing some errors. -FIX_ERRORS=0 -RETURN_CODE=0 +echo '========================================' +echo 'Running custom linting rules' +echo '========================================' +echo 'Custom warnings/errors follow:' +echo -function print_help() { - echo "Usage: ./custom-checks [--fix] [DIRECTORY]" 1>&2 - echo 1>&2 - echo " -h, --help Print this help text" 1>&2 - echo " --fix Automatically fix some errors" 1>&2 - exit 1 -} +set -o pipefail +docker run -a stdout "${docker_flags[@]}" test/script/custom-linting-rules . || exit_code=$? +set +o pipefail +echo -while [ $# -ne 0 ]; do - case $1 in - -h) ;& --help) - print_help - ;; - --fix) - FIX_ERRORS=1 - shift - ;; - --) - shift - break - ;; - -?*) - echo "Invalid argument: $1" 1>&2 - exit 1 - ;; - *) - break - ;; - esac -done +echo '========================================' +echo 'Checking for duplicate tags' +echo '========================================' +echo 'Duplicate tags follow:' +echo -if [ $# -eq 0 ] || [ -z "$1" ]; then - print_help -fi +grep --exclude=tags -roh '\*.*\*$' doc | sort | uniq -d || exit_code=$? -shopt -s globstar +echo '========================================' +echo 'Checking for invalid tag references' +echo '========================================' +echo 'Invalid tag references tags follow:' +echo -directories=("$@") +tag_regex='[gb]\?:\?\(ale\|ALE\)[a-zA-Z_\-]\+' -check_errors() { - regex="$1" - message="$2" +# Grep for tags and references, and complain if we find a reference without +# a tag for the reference. Only our tags will be included. +diff -u \ + <(grep --exclude=tags -roh "\*$tag_regex\*" doc | sort -u | sed 's/*//g') \ + <(grep --exclude=tags -roh "|$tag_regex|" doc | sort -u | sed 's/|//g') \ + | grep '^+[^+]' && exit_code=1 - for directory in "${directories[@]}"; do - while IFS= read -r match; do - RETURN_CODE=1 - echo "$match $message" - done < <(grep -n "$regex" "$directory"/**/*.vim \ - | grep -v 'no-custom-checks' \ - | grep -o '^[^:]\+:[0-9]\+' \ - | sed 's:^\./::') - done -} +echo '========================================' +echo 'diff README.md and doc/ale.txt tables' +echo '========================================' +echo 'Differences follow:' +echo -if (( FIX_ERRORS )); then - for directory in "${directories[@]}"; do - sed -i "s/^\(function.*)\) *$/\1 abort/" "$directory"/**/*.vim - sed -i "s/shellescape(/ale#Escape(/" "$directory"/**/*.vim - sed -i 's/==#/is#/g' "$directory"/**/*.vim - sed -i 's/==?/is?/g' "$directory"/**/*.vim - sed -i 's/!=#/isnot#/g' "$directory"/**/*.vim - sed -i 's/!=?/isnot?/g' "$directory"/**/*.vim - done -fi +test/script/check-supported-tools-tables || exit_code=$? -check_errors \ - '^function.*) *$' \ - 'Function without abort keyword (See :help except-compat)' -check_errors '^function[^!]' 'function without !' -check_errors ' \+$' 'Trailing whitespace' -check_errors '^ * end\?i\? *$' 'Write endif, not en, end, or endi' -check_errors '^ [^ ]' 'Use four spaces, not two spaces' -check_errors $'\t' 'Use four spaces, not tabs' -# This check should prevent people from using a particular inconsistent name. -check_errors 'let g:ale_\w\+_\w\+_args =' 'Name your option g:ale___options instead' -check_errors 'shellescape(' 'Use ale#Escape instead of shellescape' -check_errors 'simplify(' 'Use ale#path#Simplify instead of simplify' -check_errors "expand(['\"]%" "Use expand('#' . a:buffer . '...') instead. You might get a filename for the wrong buffer." -check_errors 'getcwd()' "Do not use getcwd(), as it could run from the wrong buffer. Use expand('#' . a:buffer . ':p:h') instead." -check_errors '==#' "Use 'is#' instead of '==#'. 0 ==# 'foobar' is true" -check_errors '==?' "Use 'is?' instead of '==?'. 0 ==? 'foobar' is true" -check_errors '!=#' "Use 'isnot#' instead of '!=#'. 0 !=# 'foobar' is false" -check_errors '!=?' "Use 'isnot?' instead of '!=?'. 0 !=? 'foobar' is false" -check_errors '^ *:\?echo' "Stray echo line. Use \`execute echo\` if you want to echo something" +echo '========================================' +echo 'Look for badly aligned doc tags' +echo '========================================' +echo 'Badly aligned tags follow:' +echo -exit $RETURN_CODE +# Documentation tags need to be aligned to the right margin, so look for +# tags which aren't at the right margin. +grep ' \*[^*]\+\*$' doc/ -r \ + | awk '{ sep = index($0, ":"); if (length(substr($0, sep + 1 )) < 79) { print } }' \ + | grep . && exit_code=1 + +echo '========================================' +echo 'Look for table of contents issues' +echo '========================================' +echo + +test/script/check-toc || exit_code=$? + +exit $exit_code diff --git a/test/script/custom-linting-rules b/test/script/custom-linting-rules new file mode 100755 index 0000000..ef6d792 --- /dev/null +++ b/test/script/custom-linting-rules @@ -0,0 +1,95 @@ +#!/bin/bash -eu + +# This Bash script implements custom sanity checks for scripts beyond what +# Vint covers, which are easy to check with regex. + +# A flag for automatically fixing some errors. +FIX_ERRORS=0 +RETURN_CODE=0 + +function print_help() { + echo "Usage: test/script/custom-linting-rules [--fix] [DIRECTORY]" 1>&2 + echo 1>&2 + echo " -h, --help Print this help text" 1>&2 + echo " --fix Automatically fix some errors" 1>&2 + exit 1 +} + +while [ $# -ne 0 ]; do + case $1 in + -h) ;& --help) + print_help + ;; + --fix) + FIX_ERRORS=1 + shift + ;; + --) + shift + break + ;; + -?*) + echo "Invalid argument: $1" 1>&2 + exit 1 + ;; + *) + break + ;; + esac +done + +if [ $# -eq 0 ] || [ -z "$1" ]; then + print_help +fi + +shopt -s globstar + +directories=("$@") + +check_errors() { + regex="$1" + message="$2" + + for directory in "${directories[@]}"; do + while IFS= read -r match; do + RETURN_CODE=1 + echo "$match $message" + done < <(grep -n "$regex" "$directory"/**/*.vim \ + | grep -v 'no-custom-checks' \ + | grep -o '^[^:]\+:[0-9]\+' \ + | sed 's:^\./::') + done +} + +if (( FIX_ERRORS )); then + for directory in "${directories[@]}"; do + sed -i "s/^\(function.*)\) *$/\1 abort/" "$directory"/**/*.vim + sed -i "s/shellescape(/ale#Escape(/" "$directory"/**/*.vim + sed -i 's/==#/is#/g' "$directory"/**/*.vim + sed -i 's/==?/is?/g' "$directory"/**/*.vim + sed -i 's/!=#/isnot#/g' "$directory"/**/*.vim + sed -i 's/!=?/isnot?/g' "$directory"/**/*.vim + done +fi + +check_errors \ + '^function.*) *$' \ + 'Function without abort keyword (See :help except-compat)' +check_errors '^function[^!]' 'function without !' +check_errors ' \+$' 'Trailing whitespace' +check_errors '^ * end\?i\? *$' 'Write endif, not en, end, or endi' +check_errors '^ [^ ]' 'Use four spaces, not two spaces' +check_errors $'\t' 'Use four spaces, not tabs' +# This check should prevent people from using a particular inconsistent name. +check_errors 'let g:ale_\w\+_\w\+_args =' 'Name your option g:ale___options instead' +check_errors 'shellescape(' 'Use ale#Escape instead of shellescape' +check_errors 'simplify(' 'Use ale#path#Simplify instead of simplify' +check_errors "expand(['\"]%" "Use expand('#' . a:buffer . '...') instead. You might get a filename for the wrong buffer." +check_errors 'getcwd()' "Do not use getcwd(), as it could run from the wrong buffer. Use expand('#' . a:buffer . ':p:h') instead." +check_errors '==#' "Use 'is#' instead of '==#'. 0 ==# 'foobar' is true" +check_errors '==?' "Use 'is?' instead of '==?'. 0 ==? 'foobar' is true" +check_errors '!=#' "Use 'isnot#' instead of '!=#'. 0 !=# 'foobar' is false" +check_errors '!=?' "Use 'isnot?' instead of '!=?'. 0 !=? 'foobar' is false" +check_errors '^ *:\?echo' "Stray echo line. Use \`execute echo\` if you want to echo something" + +exit $RETURN_CODE diff --git a/test/script/run-vader-tests b/test/script/run-vader-tests index d28e198..d5daec2 100755 --- a/test/script/run-vader-tests +++ b/test/script/run-vader-tests @@ -7,6 +7,7 @@ green='\033[0;32m' nc='\033[0m' verbose=0 quiet=0 +exit_code=0 while [ $# -ne 0 ]; do case $1 in @@ -109,12 +110,14 @@ if [[ $vim =~ ^neovim ]]; then set -o pipefail docker run -it -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ "/vim-build/bin/$vim" -u test/vimrc \ - --headless "+Vader! $tests" | filter-vader-output | color-vader-output + --headless "+Vader! $tests" | filter-vader-output | color-vader-output || exit_code=$? set +o pipefail else set -o pipefail docker run -a stderr -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ "/vim-build/bin/$vim" -u test/vimrc \ - "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output + "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output || exit_code=$? set +o pipefail fi + +exit "$exit_code" diff --git a/test/script/run-vint b/test/script/run-vint new file mode 100755 index 0000000..e114030 --- /dev/null +++ b/test/script/run-vint @@ -0,0 +1,18 @@ +#!/bin/bash -eu + +exit_code=0 +image=w0rp/ale +docker_flags=(--rm -v "$PWD:/testplugin" -v "$PWD/test:/home" -w /testplugin "$image") + +echo '========================================' +echo 'Running Vint to lint our code' +echo '========================================' +echo 'Vint warnings/errors follow:' +echo + +set -o pipefail +docker run -a stdout "${docker_flags[@]}" vint -s . || exit_code=$? +set +o pipefail +echo + +exit $exit_code From 122fdfd329eaaf16dd473094aad1e94281aee88b Mon Sep 17 00:00:00 2001 From: "E.J. Sexton" Date: Sat, 2 Dec 2017 09:27:18 +0100 Subject: [PATCH 241/390] Fixed command string for phpcbf fixer --- test/fixers/test_phpcbf_fixer_callback.vader | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/test/fixers/test_phpcbf_fixer_callback.vader b/test/fixers/test_phpcbf_fixer_callback.vader index cf02a0b..b5c72f2 100644 --- a/test/fixers/test_phpcbf_fixer_callback.vader +++ b/test/fixers/test_phpcbf_fixer_callback.vader @@ -43,7 +43,7 @@ Execute(The phpcbf callback should return the correct default values): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' }, + \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, \ ale#fixers#phpcbf#Fix(bufnr('')) Execute(The phpcbf callback should include the phpcbf_standard option): @@ -51,7 +51,7 @@ Execute(The phpcbf callback should include the phpcbf_standard option): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml'}, + \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, \ ale#fixers#phpcbf#Fix(bufnr('')) Before: @@ -99,7 +99,7 @@ Execute(The phpcbf callback should return the correct default values): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' }, + \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, \ ale#fixers#phpcbf#Fix(bufnr('')) Execute(The phpcbf callback should include the phpcbf_standard option): @@ -107,6 +107,6 @@ Execute(The phpcbf callback should include the phpcbf_standard option): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml'}, + \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, \ ale#fixers#phpcbf#Fix(bufnr('')) From f5fc746d00a8b8e0aaac1904ce97ad7eb52e1b24 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 2 Dec 2017 12:26:30 +0000 Subject: [PATCH 242/390] Fix #1186 - Use -w by default for Perl, which does not execute code --- ale_linters/perl/perl.vim | 9 ++--- doc/ale-perl.txt | 6 ++- .../test_perl_command_callback.vader | 37 +++++++++++++++++++ 3 files changed, 45 insertions(+), 7 deletions(-) create mode 100644 test/command_callback/test_perl_command_callback.vader diff --git a/ale_linters/perl/perl.vim b/ale_linters/perl/perl.vim index 3328806..6421d4f 100644 --- a/ale_linters/perl/perl.vim +++ b/ale_linters/perl/perl.vim @@ -1,18 +1,15 @@ " Author: Vincent Lequertier " Description: This file adds support for checking perl syntax -let g:ale_perl_perl_executable = -\ get(g:, 'ale_perl_perl_executable', 'perl') - -let g:ale_perl_perl_options = -\ get(g:, 'ale_perl_perl_options', '-c -Mwarnings -Ilib') +call ale#Set('perl_perl_executable', 'perl') +call ale#Set('perl_perl_options', '-w -Mwarnings -Ilib') function! ale_linters#perl#perl#GetExecutable(buffer) abort return ale#Var(a:buffer, 'perl_perl_executable') endfunction function! ale_linters#perl#perl#GetCommand(buffer) abort - return ale_linters#perl#perl#GetExecutable(a:buffer) + return ale#Escape(ale_linters#perl#perl#GetExecutable(a:buffer)) \ . ' ' . ale#Var(a:buffer, 'perl_perl_options') \ . ' %t' endfunction diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt index 7611d30..7142d24 100644 --- a/doc/ale-perl.txt +++ b/doc/ale-perl.txt @@ -16,11 +16,15 @@ g:ale_perl_perl_executable *g:ale_perl_perl_executable* g:ale_perl_perl_options *g:ale_perl_perl_options* *b:ale_perl_perl_options* Type: |String| - Default: `'-c -Mwarnings -Ilib'` + Default: `'-w -Mwarnings -Ilib'` This variable can be changed to alter the command-line arguments to the perl invocation. + Perl code is checked with `-w` by default, because `-c` can execute + malicious code. You can use the `-c` option at your own risk. See + |g:ale_pattern_options| for changing the option only for specific files. + =============================================================================== perlcritic *ale-perl-perlcritic* diff --git a/test/command_callback/test_perl_command_callback.vader b/test/command_callback/test_perl_command_callback.vader new file mode 100644 index 0000000..e82f227 --- /dev/null +++ b/test/command_callback/test_perl_command_callback.vader @@ -0,0 +1,37 @@ +Before: + Save g:ale_perl_perl_executable + Save g:ale_perl_perl_options + + unlet! g:ale_perl_perl_executable + unlet! g:ale_perl_perl_options + + runtime ale_linters/perl/perl.vim + +After: + Restore + + unlet! b:ale_perl_perl_executable + unlet! b:ale_perl_perl_options + + call ale#linter#Reset() + +Execute(The default Perl command callback should be correct): + AssertEqual + \ 'perl', + \ ale_linters#perl#perl#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('perl') . ' -w -Mwarnings -Ilib %t', + \ ale_linters#perl#perl#GetCommand(bufnr('')) + +Execute(Overriding the executable and command should work): + let b:ale_perl_perl_executable = 'foobar' + let b:ale_perl_perl_options = '-c' + + AssertEqual + \ 'foobar', + \ ale_linters#perl#perl#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('foobar') . ' -c %t', + \ ale_linters#perl#perl#GetCommand(bufnr('')) From 2bd966c5cc33b8b19570a7978845c2786da62363 Mon Sep 17 00:00:00 2001 From: Dave Wongillies Date: Sat, 2 Dec 2017 04:29:17 -0800 Subject: [PATCH 243/390] Puppet: allow for when parser doesn't supply column for errors (#1182) * puppet: add test for puppet parser validate * puppet: handle where parser validate doesn't supply the column * puppet: add test for when parser validate doesn't supply column * Fix puppet regex to handle Windows paths --- ale_linters/puppet/puppet.vim | 3 +- test/handler/test_puppet_handler.vader | 45 ++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 test/handler/test_puppet_handler.vader diff --git a/ale_linters/puppet/puppet.vim b/ale_linters/puppet/puppet.vim index 47e89d3..8beeb61 100644 --- a/ale_linters/puppet/puppet.vim +++ b/ale_linters/puppet/puppet.vim @@ -3,8 +3,9 @@ function! ale_linters#puppet#puppet#Handle(buffer, lines) abort " Matches patterns like the following: " Error: Could not parse for environment production: Syntax error at ':' at /root/puppetcode/modules/nginx/manifests/init.pp:43:12 + " Error: Could not parse for environment production: Syntax error at '='; expected '}' at /root/puppetcode/modules/pancakes/manifests/init.pp:5" - let l:pattern = '^Error: .*: \(.\+\) at .\+:\(\d\+\):\(\d\+\)$' + let l:pattern = '^Error: .*: \(.\+\) at .\+\.pp:\(\d\+\):\=\(\d*\)' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) diff --git a/test/handler/test_puppet_handler.vader b/test/handler/test_puppet_handler.vader new file mode 100644 index 0000000..0d274fd --- /dev/null +++ b/test/handler/test_puppet_handler.vader @@ -0,0 +1,45 @@ +Before: + runtime ale_linters/puppet/puppet.vim + +After: + call ale#linter#Reset() + +Execute(The puppet handler should parse lines correctly when no column is supplied): + " Line Error + AssertEqual + \ [ + \ { + \ 'lnum': 5, + \ 'col': 0, + \ 'text': "Syntax error at '='; expected '}'" + \ }, + \ { + \ 'lnum': 3, + \ 'col': 0, + \ 'text': "Syntax error at '='; expected '}'" + \ }, + \ ], + \ ale_linters#puppet#puppet#Handle(255, [ + \ "Error: Could not parse for environment production: Syntax error at '='; expected '}' at /root/puppetcode/modules/pancakes/manifests/init.pp:5", + \ "Error: Could not parse for environment production: Syntax error at '='; expected '}' at C:/puppet/modules/pancakes/manifests/init.pp:3", + \ ]) + +Execute(The puppet handler should parse lines and column correctly): + " Line Error + AssertEqual + \ [ + \ { + \ 'lnum': 43, + \ 'col': 12, + \ 'text': "Syntax error at ':'" + \ }, + \ { + \ 'lnum': 54, + \ 'col': 9, + \ 'text': "Syntax error at ':'" + \ } + \ ], + \ ale_linters#puppet#puppet#Handle(255, [ + \ "Error: Could not parse for environment production: Syntax error at ':' at /root/puppetcode/modules/nginx/manifests/init.pp:43:12", + \ "Error: Could not parse for environment production: Syntax error at ':' at C:/puppet/modules/nginx/manifests/init.pp:54:9", + \ ]) From acd12603395f8541c4ee13d9b16e2595c9219343 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 2 Dec 2017 20:38:28 +0000 Subject: [PATCH 244/390] Revert "Fix #1186 - Use -w by default for Perl, which does not execute code" This reverts commit f5fc746d00a8b8e0aaac1904ce97ad7eb52e1b24. --- ale_linters/perl/perl.vim | 9 +++-- doc/ale-perl.txt | 6 +-- .../test_perl_command_callback.vader | 37 ------------------- 3 files changed, 7 insertions(+), 45 deletions(-) delete mode 100644 test/command_callback/test_perl_command_callback.vader diff --git a/ale_linters/perl/perl.vim b/ale_linters/perl/perl.vim index 6421d4f..3328806 100644 --- a/ale_linters/perl/perl.vim +++ b/ale_linters/perl/perl.vim @@ -1,15 +1,18 @@ " Author: Vincent Lequertier " Description: This file adds support for checking perl syntax -call ale#Set('perl_perl_executable', 'perl') -call ale#Set('perl_perl_options', '-w -Mwarnings -Ilib') +let g:ale_perl_perl_executable = +\ get(g:, 'ale_perl_perl_executable', 'perl') + +let g:ale_perl_perl_options = +\ get(g:, 'ale_perl_perl_options', '-c -Mwarnings -Ilib') function! ale_linters#perl#perl#GetExecutable(buffer) abort return ale#Var(a:buffer, 'perl_perl_executable') endfunction function! ale_linters#perl#perl#GetCommand(buffer) abort - return ale#Escape(ale_linters#perl#perl#GetExecutable(a:buffer)) + return ale_linters#perl#perl#GetExecutable(a:buffer) \ . ' ' . ale#Var(a:buffer, 'perl_perl_options') \ . ' %t' endfunction diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt index 7142d24..7611d30 100644 --- a/doc/ale-perl.txt +++ b/doc/ale-perl.txt @@ -16,15 +16,11 @@ g:ale_perl_perl_executable *g:ale_perl_perl_executable* g:ale_perl_perl_options *g:ale_perl_perl_options* *b:ale_perl_perl_options* Type: |String| - Default: `'-w -Mwarnings -Ilib'` + Default: `'-c -Mwarnings -Ilib'` This variable can be changed to alter the command-line arguments to the perl invocation. - Perl code is checked with `-w` by default, because `-c` can execute - malicious code. You can use the `-c` option at your own risk. See - |g:ale_pattern_options| for changing the option only for specific files. - =============================================================================== perlcritic *ale-perl-perlcritic* diff --git a/test/command_callback/test_perl_command_callback.vader b/test/command_callback/test_perl_command_callback.vader deleted file mode 100644 index e82f227..0000000 --- a/test/command_callback/test_perl_command_callback.vader +++ /dev/null @@ -1,37 +0,0 @@ -Before: - Save g:ale_perl_perl_executable - Save g:ale_perl_perl_options - - unlet! g:ale_perl_perl_executable - unlet! g:ale_perl_perl_options - - runtime ale_linters/perl/perl.vim - -After: - Restore - - unlet! b:ale_perl_perl_executable - unlet! b:ale_perl_perl_options - - call ale#linter#Reset() - -Execute(The default Perl command callback should be correct): - AssertEqual - \ 'perl', - \ ale_linters#perl#perl#GetExecutable(bufnr('')) - - AssertEqual - \ ale#Escape('perl') . ' -w -Mwarnings -Ilib %t', - \ ale_linters#perl#perl#GetCommand(bufnr('')) - -Execute(Overriding the executable and command should work): - let b:ale_perl_perl_executable = 'foobar' - let b:ale_perl_perl_options = '-c' - - AssertEqual - \ 'foobar', - \ ale_linters#perl#perl#GetExecutable(bufnr('')) - - AssertEqual - \ ale#Escape('foobar') . ' -c %t', - \ ale_linters#perl#perl#GetCommand(bufnr('')) From a4f8506227ae0842adb74035eef51eba71c079e1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 2 Dec 2017 20:43:47 +0000 Subject: [PATCH 245/390] Fix #1186 - Disable checking code with perl by default --- autoload/ale/linter.vim | 1 + doc/ale-perl.txt | 5 +++++ doc/ale.txt | 1 + 3 files changed, 7 insertions(+) diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index e8f30ff..f4fa0c4 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -27,6 +27,7 @@ let s:default_ale_linters = { \ 'csh': ['shell'], \ 'go': ['gofmt', 'golint', 'go vet'], \ 'help': [], +\ 'perl': ['perlcritic'], \ 'python': ['flake8', 'mypy', 'pylint'], \ 'rust': ['cargo'], \ 'spec': [], diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt index 7611d30..414856b 100644 --- a/doc/ale-perl.txt +++ b/doc/ale-perl.txt @@ -1,6 +1,11 @@ =============================================================================== ALE Perl Integration *ale-perl-options* +ALE offers a few ways to check Perl code. Checking code with `perl` is +disabled by default, as `perl` code cannot be checked without executing it. + +See |g:ale_linters|. + =============================================================================== perl *ale-perl-perl* diff --git a/doc/ale.txt b/doc/ale.txt index 1106946..3f90223 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1031,6 +1031,7 @@ g:ale_linters *g:ale_linters* \ 'csh': ['shell'], \ 'go': ['gofmt', 'golint', 'go vet'], \ 'help': [], + \ 'perl': ['perlcritic'], \ 'python': ['flake8', 'mypy', 'pylint'], \ 'rust': ['cargo'], \ 'spec': [], From 2f9869de44cf4b9542fc79a4c4566aa268910b23 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 2 Dec 2017 20:47:01 +0000 Subject: [PATCH 246/390] Escape the perl executable, and cover the callbacks with tests --- ale_linters/perl/perl.vim | 2 +- .../test_perl_command_callback.vader | 37 +++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 test/command_callback/test_perl_command_callback.vader diff --git a/ale_linters/perl/perl.vim b/ale_linters/perl/perl.vim index 3328806..fcc88f3 100644 --- a/ale_linters/perl/perl.vim +++ b/ale_linters/perl/perl.vim @@ -12,7 +12,7 @@ function! ale_linters#perl#perl#GetExecutable(buffer) abort endfunction function! ale_linters#perl#perl#GetCommand(buffer) abort - return ale_linters#perl#perl#GetExecutable(a:buffer) + return ale#Escape(ale_linters#perl#perl#GetExecutable(a:buffer)) \ . ' ' . ale#Var(a:buffer, 'perl_perl_options') \ . ' %t' endfunction diff --git a/test/command_callback/test_perl_command_callback.vader b/test/command_callback/test_perl_command_callback.vader new file mode 100644 index 0000000..ba85e53 --- /dev/null +++ b/test/command_callback/test_perl_command_callback.vader @@ -0,0 +1,37 @@ +Before: + Save g:ale_perl_perl_executable + Save g:ale_perl_perl_options + + unlet! g:ale_perl_perl_executable + unlet! g:ale_perl_perl_options + + runtime ale_linters/perl/perl.vim + +After: + Restore + + unlet! b:ale_perl_perl_executable + unlet! b:ale_perl_perl_options + + call ale#linter#Reset() + +Execute(The default Perl command callback should be correct): + AssertEqual + \ 'perl', + \ ale_linters#perl#perl#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('perl') . ' -c -Mwarnings -Ilib %t', + \ ale_linters#perl#perl#GetCommand(bufnr('')) + +Execute(Overriding the executable and command should work): + let b:ale_perl_perl_executable = 'foobar' + let b:ale_perl_perl_options = '-w' + + AssertEqual + \ 'foobar', + \ ale_linters#perl#perl#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape('foobar') . ' -w %t', + \ ale_linters#perl#perl#GetCommand(bufnr('')) From fba3c57872de0ebf77586399405a25552298ad1b Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Tue, 5 Dec 2017 00:29:44 +0900 Subject: [PATCH 247/390] added importjs fixer - added tests for fixer functions - added docs --- autoload/ale/fix/registry.vim | 5 +++ autoload/ale/fixers/importjs.vim | 24 +++++++++++++ doc/ale-javascript.txt | 9 +++++ doc/ale.txt | 1 + .../fixers/test_importjs_fixer_callback.vader | 35 +++++++++++++++++++ test/javascript_files/test.js | 0 6 files changed, 74 insertions(+) create mode 100644 autoload/ale/fixers/importjs.vim create mode 100644 test/fixers/test_importjs_fixer_callback.vader create mode 100644 test/javascript_files/test.js diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 4fb229b..5c09e78 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -54,6 +54,11 @@ let s:default_registry = { \ 'description': 'Apply prettier-eslint to a file.', \ 'aliases': ['prettier-eslint'], \ }, +\ 'importjs': { +\ 'function': 'ale#fixers#importjs#Fix', +\ 'suggested_filetypes': ['javascript'], +\ 'description': 'automatic imports for javascript', +\ }, \ 'puppetlint': { \ 'function': 'ale#fixers#puppetlint#Fix', \ 'suggested_filetypes': ['puppet'], diff --git a/autoload/ale/fixers/importjs.vim b/autoload/ale/fixers/importjs.vim new file mode 100644 index 0000000..e8eedb1 --- /dev/null +++ b/autoload/ale/fixers/importjs.vim @@ -0,0 +1,24 @@ +" Author: Jeff Willette +" Description: Integration of importjs with ALE. + +call ale#Set('js_importjs_executable', 'importjs') + +function! ale#fixers#importjs#ProcessOutput(buffer, output) abort + let l:result = ale#util#FuzzyJSONDecode(a:output, []) + return split(get(l:result, 'fileContent', ''), "\n") +endfunction + +function! ale#fixers#importjs#Fix(buffer) abort + let l:executable = ale#Var(a:buffer, 'js_importjs_executable') + + if !executable(l:executable) + return 0 + endif + + return { + \ 'command': ale#Escape(l:executable) + \ . ' fix' + \ . ' %s', + \ 'process_with': 'ale#fixers#importjs#ProcessOutput', + \} +endfunction diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 3934dfb..f625fd7 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -103,6 +103,15 @@ g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global* See |ale-integrations-local-executables| +=============================================================================== +importjs *ale-javascript-importjs* + +g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable* + *b:ale_javascript_importjs_executable* + Type: |String| + Default: `'importjs'` + + =============================================================================== jscs *ale-javascript-jscs* diff --git a/doc/ale.txt b/doc/ale.txt index 3f90223..8e8f5f4 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -95,6 +95,7 @@ CONTENTS *ale-contents* javascript............................|ale-javascript-options| eslint..............................|ale-javascript-eslint| flow................................|ale-javascript-flow| + importjs............................|ale-javascript-importjs| jscs................................|ale-javascript-jscs| jshint..............................|ale-javascript-jshint| prettier............................|ale-javascript-prettier| diff --git a/test/fixers/test_importjs_fixer_callback.vader b/test/fixers/test_importjs_fixer_callback.vader new file mode 100644 index 0000000..c3e57f8 --- /dev/null +++ b/test/fixers/test_importjs_fixer_callback.vader @@ -0,0 +1,35 @@ +Before: + Save g:ale_js_importjs_executable + + " Use an invalid global executable, so we don't match it. + let g:ale_js_importjs_executable = 'xxxinvalid' + + call ale#test#SetDirectory('/testplugin/test/fixers') + call ale#test#SetFilename('../javascript_files/test.js') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The importjs callback should return 0 when the executable isn't executable): + AssertEqual + \ 0, + \ ale#fixers#importjs#Fix(bufnr('')) + +Execute(The importjs callback should run the command when the executable test passes): + let g:ale_js_importjs_executable = has('win32') ? 'cmd' : 'echo' + + AssertEqual + \ { + \ 'process_with': 'ale#fixers#importjs#ProcessOutput', + \ 'command': ale#Escape(g:ale_js_importjs_executable) . ' fix %s' + \ }, + \ ale#fixers#importjs#Fix(bufnr('')) + +Execute(The ProcessOutput callback should return the expected output): + let g:testOutput = '{"messages":[],"fileContent":"one\ntwo","unresolvedImports":{}}' + + AssertEqual + \ ['one', 'two'], + \ ale#fixers#importjs#ProcessOutput(bufnr(''), g:testOutput) diff --git a/test/javascript_files/test.js b/test/javascript_files/test.js new file mode 100644 index 0000000..e69de29 From 0d627d46134a756860beaf825a618313e4133de3 Mon Sep 17 00:00:00 2001 From: Franco Victorio Date: Mon, 4 Dec 2017 13:28:52 -0300 Subject: [PATCH 248/390] Add solhint support --- ale_linters/solidity/solhint.vim | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 ale_linters/solidity/solhint.vim diff --git a/ale_linters/solidity/solhint.vim b/ale_linters/solidity/solhint.vim new file mode 100644 index 0000000..cab2c18 --- /dev/null +++ b/ale_linters/solidity/solhint.vim @@ -0,0 +1,29 @@ +" Author: Franco Victorio - https://github.com/fvictorio +" Description: Report errors in Solidity code with solhint + +function! ale_linters#solidity#solhint#Handle(buffer, lines) abort + " Matches patterns like the following: + " /path/to/file/file.sol: line 1, col 10, Error - 'addOne' is defined but never used. (no-unused-vars) + + let l:pattern = '\v^[^:]+: line (\d+), col (\d+), (Error|Warning) - (.*)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:isError = l:match[3] is? 'error' + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'col': l:match[2] + 0, + \ 'text': l:match[4], + \ 'type': l:isError ? 'E' : 'W' + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('solidity', { +\ 'name': 'solhint', +\ 'executable': 'solhint', +\ 'command': 'solhint --formatter compact %t', +\ 'callback': 'ale_linters#solidity#solhint#Handle', +\}) From 3e1bd8d922c2be22fdaa24ce2d11bafa636375a7 Mon Sep 17 00:00:00 2001 From: Franco Victorio Date: Mon, 4 Dec 2017 14:23:34 -0300 Subject: [PATCH 249/390] Update documentation --- README.md | 2 +- doc/ale-solidity.txt | 8 ++++++++ doc/ale.txt | 3 ++- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 25fb72b..9408348 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,7 @@ formatting. | Scala | [scalac](http://scala-lang.org), [scalastyle](http://www.scalastyle.org) | | Slim | [slim-lint](https://github.com/sds/slim-lint) | | SML | [smlnj](http://www.smlnj.org/) | -| Solidity | [solium](https://github.com/duaraghav8/Solium) | +| Solidity | [solhint](https://github.com/protofire/solhint), [solium](https://github.com/duaraghav8/Solium) | | Stylus | [stylelint](https://github.com/stylelint/stylelint) | | SQL | [sqlint](https://github.com/purcell/sqlint) | | Swift | [swiftlint](https://github.com/realm/SwiftLint), [swiftformat](https://github.com/nicklockwood/SwiftFormat) | diff --git a/doc/ale-solidity.txt b/doc/ale-solidity.txt index 3dea123..4b74a27 100644 --- a/doc/ale-solidity.txt +++ b/doc/ale-solidity.txt @@ -2,6 +2,14 @@ ALE Solidity Integration *ale-solidity-options* +=============================================================================== +solhint *ale-solidity-solhint* + + Solhint should work out-of-the-box. You can further configure it using a + `.solihint.json` file. See https://github.com/protofire/solhint for more + information. + + =============================================================================== solium *ale-solidity-solium* diff --git a/doc/ale.txt b/doc/ale.txt index 04f187d..e44ff24 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -186,6 +186,7 @@ CONTENTS *ale-contents* sml...................................|ale-sml-options| smlnj...............................|ale-sml-smlnj| solidity..............................|ale-solidity-options| + solhint.............................|ale-solidity-solhint| solium..............................|ale-solidity-solium| spec..................................|ale-spec-options| rpmlint.............................|ale-spec-rpmlint| @@ -334,7 +335,7 @@ Notes: * Scala: `scalac`, `scalastyle` * Slim: `slim-lint` * SML: `smlnj` -* Solidity: `solium` +* Solidity: `solhint, solium` * Stylus: `stylelint` * SQL: `sqlint` * Swift: `swiftlint`, `swiftformat` From 57e1b03435c94cd93748a87ee9fbd285452d91ca Mon Sep 17 00:00:00 2001 From: Franco Victorio Date: Mon, 4 Dec 2017 14:23:46 -0300 Subject: [PATCH 250/390] Add test for solhint handler --- test/handler/test_solhint_handler.vader | 54 +++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 test/handler/test_solhint_handler.vader diff --git a/test/handler/test_solhint_handler.vader b/test/handler/test_solhint_handler.vader new file mode 100644 index 0000000..43e3505 --- /dev/null +++ b/test/handler/test_solhint_handler.vader @@ -0,0 +1,54 @@ +Before: + runtime ale_linters/solidity/solhint.vim + +After: + call ale#linter#Reset() + +Execute(The vint handler should parse error messages correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 17, + \ 'text': 'Compiler version must be fixed (compiler-fixed)', + \ 'type': 'W', + \ }, + \ { + \ 'lnum': 4, + \ 'col': 8, + \ 'text': 'Use double quotes for string literals (quotes)', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 5, + \ 'col': 8, + \ 'text': 'Use double quotes for string literals (quotes)', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 13, + \ 'col': 3, + \ 'text': 'Expected indentation of 4 spaces but found 2 (indent)', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 14, + \ 'col': 3, + \ 'text': 'Expected indentation of 4 spaces but found 2 (indent)', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 47, + \ 'col': 3, + \ 'text': 'Function order is incorrect, public function can not go after internal function. (func-order)', + \ 'type': 'E', + \ }, + \ ], + \ ale_linters#solidity#solhint#Handle(bufnr(''), [ + \ 'contracts/Bounty.sol: line 1, col 17, Warning - Compiler version must be fixed (compiler-fixed)', + \ 'contracts/Bounty.sol: line 4, col 8, Error - Use double quotes for string literals (quotes)', + \ 'contracts/Bounty.sol: line 5, col 8, Error - Use double quotes for string literals (quotes)', + \ 'contracts/Bounty.sol: line 13, col 3, Error - Expected indentation of 4 spaces but found 2 (indent)', + \ 'contracts/Bounty.sol: line 14, col 3, Error - Expected indentation of 4 spaces but found 2 (indent)', + \ 'contracts/Bounty.sol: line 47, col 3, Error - Function order is incorrect, public function can not go after internal function. (func-order)', + \ ]) From e2a8f759d870ed7a1f0ee4698a73b65e9f36e54d Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Tue, 5 Dec 2017 03:42:36 +0900 Subject: [PATCH 251/390] Added option for `gometalinter` to lint package (#1156) * Added option for `gometalinter` to lint package * added tests for the `gometalinter` command * changed gometalinter commands to use BufferCdString --- ale_linters/go/gometalinter.vim | 25 +++++++++++---- .../test_gometalinter_command_callback.vader | 32 +++++++++++++------ test/handler/test_gometalinter_handler.vader | 12 ++++--- 3 files changed, 49 insertions(+), 20 deletions(-) diff --git a/ale_linters/go/gometalinter.vim b/ale_linters/go/gometalinter.vim index f1abfc8..375a8b0 100644 --- a/ale_linters/go/gometalinter.vim +++ b/ale_linters/go/gometalinter.vim @@ -1,8 +1,9 @@ -" Author: Ben Reedy +" Author: Ben Reedy , Jeff Willette " Description: Adds support for the gometalinter suite for Go files call ale#Set('go_gometalinter_options', '') call ale#Set('go_gometalinter_executable', 'gometalinter') +call ale#Set('go_gometalinter_lint_package', 0) function! ale_linters#go#gometalinter#GetExecutable(buffer) abort return ale#Var(a:buffer, 'go_gometalinter_executable') @@ -10,13 +11,22 @@ endfunction function! ale_linters#go#gometalinter#GetCommand(buffer) abort let l:executable = ale_linters#go#gometalinter#GetExecutable(a:buffer) - let l:filename = expand('#' . a:buffer) + let l:filename = expand('#' . a:buffer . ':t') let l:options = ale#Var(a:buffer, 'go_gometalinter_options') + let l:lint_package = ale#Var(a:buffer, 'go_gometalinter_lint_package') - return ale#Escape(l:executable) - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(l:filename)) - \ . (!empty(l:options) ? ' ' . l:options : '') - \ . ' ' . ale#Escape(fnamemodify(l:filename, ':h')) + " BufferCdString is used so that we can be sure the paths output from gometalinter can + " be calculated to absolute paths in the Handler + if l:lint_package + return ale#path#BufferCdString(a:buffer) + \ . ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') . ' .' + endif + + return ale#path#BufferCdString(a:buffer) + \ . ale#Escape(l:executable) + \ . ' --include=' . ale#Escape(ale#util#EscapePCRE(l:filename)) + \ . (!empty(l:options) ? ' ' . l:options : '') . ' .' endfunction function! ale_linters#go#gometalinter#GetMatches(lines) abort @@ -26,10 +36,13 @@ function! ale_linters#go#gometalinter#GetMatches(lines) abort endfunction function! ale_linters#go#gometalinter#Handler(buffer, lines) abort + let l:dir = expand('#' . a:buffer . ':p:h') let l:output = [] for l:match in ale_linters#go#gometalinter#GetMatches(a:lines) + " l:match[1] will already be an absolute path, output from gometalinter call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'type': tolower(l:match[4]) is# 'warning' ? 'W' : 'E', diff --git a/test/command_callback/test_gometalinter_command_callback.vader b/test/command_callback/test_gometalinter_command_callback.vader index 912396c..93a541c 100644 --- a/test/command_callback/test_gometalinter_command_callback.vader +++ b/test/command_callback/test_gometalinter_command_callback.vader @@ -1,9 +1,11 @@ Before: Save b:ale_go_gometalinter_executable Save b:ale_go_gometalinter_options + Save b:ale_go_gometalinter_lint_package let b:ale_go_gometalinter_executable = 'gometalinter' let b:ale_go_gometalinter_options = '' + let b:ale_go_gometalinter_lint_package = 0 runtime ale_linters/go/gometalinter.vim @@ -21,9 +23,10 @@ Execute(The gometalinter callback should return the right defaults): \ 'gometalinter', \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape('gometalinter') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) - \ . ' ' . ale#Escape(getcwd()), + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('gometalinter') + \ . ' --include=' . ale#Escape(ale#util#EscapePCRE(expand('%' . ':t'))) + \ . ' .', \ ale_linters#go#gometalinter#GetCommand(bufnr('')) Execute(The gometalinter callback should use a configured executable): @@ -33,17 +36,26 @@ Execute(The gometalinter callback should use a configured executable): \ 'something else', \ ale_linters#go#gometalinter#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape('something else') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) - \ . ' ' . ale#Escape(getcwd()), + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('something else') + \ . ' --include=' . ale#Escape(ale#util#EscapePCRE(expand('%' . ':t'))) + \ . ' .', \ ale_linters#go#gometalinter#GetCommand(bufnr('')) Execute(The gometalinter callback should use configured options): let b:ale_go_gometalinter_options = '--foobar' AssertEqual - \ ale#Escape('gometalinter') - \ . ' --include=' . ale#Escape('^' . ale#util#EscapePCRE(expand('%'))) - \ . ' --foobar' - \ . ' ' . ale#Escape(getcwd()), + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('gometalinter') + \ . ' --include=' . ale#Escape(ale#util#EscapePCRE(expand('%' . ':t'))) + \ . ' --foobar' . ' .', + \ ale_linters#go#gometalinter#GetCommand(bufnr('')) + +Execute(The gometalinter `lint_package` option should use the correct command): + let b:ale_go_gometalinter_lint_package = 1 + + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ale#Escape('gometalinter') . ' .', \ ale_linters#go#gometalinter#GetCommand(bufnr('')) diff --git a/test/handler/test_gometalinter_handler.vader b/test/handler/test_gometalinter_handler.vader index 603ba22..703040e 100644 --- a/test/handler/test_gometalinter_handler.vader +++ b/test/handler/test_gometalinter_handler.vader @@ -29,8 +29,10 @@ Execute (The gometalinter handler should handle names with spaces): \ 'C:\something\file with spaces.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', \ ]), 'v:val[1:5]') -Execute (The gometalinter handler should handle relative paths correctly): - silent file /foo/bar/baz.go +Execute (The gometalinter handler should handle paths correctly): + call ale#test#SetFilename('app/test.go') + + let file = ale#path#GetAbsPath(expand('%:p:h'), 'test.go') AssertEqual \ [ @@ -39,15 +41,17 @@ Execute (The gometalinter handler should handle relative paths correctly): \ 'col': 3, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (staticcheck)', \ 'type': 'W', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ { \ 'lnum': 37, \ 'col': 5, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (golint)', \ 'type': 'E', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gometalinter#Handler(bufnr(''), [ - \ 'baz.go:12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', - \ 'baz.go:37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', + \ file . ':12:3:warning: expected ''package'', found ''IDENT'' gibberish (staticcheck)', + \ file . ':37:5:error: expected ''package'', found ''IDENT'' gibberish (golint)', \ ]) From 85e0bd33141a05216848e525b3e86b6698aa38cd Mon Sep 17 00:00:00 2001 From: Franco Victorio Date: Tue, 5 Dec 2017 16:02:15 -0300 Subject: [PATCH 252/390] Extract error code from message --- ale_linters/solidity/solhint.vim | 5 +++-- test/handler/test_solhint_handler.vader | 18 ++++++++++++------ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/ale_linters/solidity/solhint.vim b/ale_linters/solidity/solhint.vim index cab2c18..519fd49 100644 --- a/ale_linters/solidity/solhint.vim +++ b/ale_linters/solidity/solhint.vim @@ -5,7 +5,7 @@ function! ale_linters#solidity#solhint#Handle(buffer, lines) abort " Matches patterns like the following: " /path/to/file/file.sol: line 1, col 10, Error - 'addOne' is defined but never used. (no-unused-vars) - let l:pattern = '\v^[^:]+: line (\d+), col (\d+), (Error|Warning) - (.*)$' + let l:pattern = '\v^[^:]+: line (\d+), col (\d+), (Error|Warning) - (.*) \((.*)\)$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) @@ -14,7 +14,8 @@ function! ale_linters#solidity#solhint#Handle(buffer, lines) abort \ 'lnum': l:match[1] + 0, \ 'col': l:match[2] + 0, \ 'text': l:match[4], - \ 'type': l:isError ? 'E' : 'W' + \ 'code': l:match[5], + \ 'type': l:isError ? 'E' : 'W', \}) endfor diff --git a/test/handler/test_solhint_handler.vader b/test/handler/test_solhint_handler.vader index 43e3505..a3ed5d5 100644 --- a/test/handler/test_solhint_handler.vader +++ b/test/handler/test_solhint_handler.vader @@ -10,37 +10,43 @@ Execute(The vint handler should parse error messages correctly): \ { \ 'lnum': 1, \ 'col': 17, - \ 'text': 'Compiler version must be fixed (compiler-fixed)', + \ 'text': 'Compiler version must be fixed', + \ 'code': 'compiler-fixed', \ 'type': 'W', \ }, \ { \ 'lnum': 4, \ 'col': 8, - \ 'text': 'Use double quotes for string literals (quotes)', + \ 'text': 'Use double quotes for string literals', + \ 'code': 'quotes', \ 'type': 'E', \ }, \ { \ 'lnum': 5, \ 'col': 8, - \ 'text': 'Use double quotes for string literals (quotes)', + \ 'text': 'Use double quotes for string literals', + \ 'code': 'quotes', \ 'type': 'E', \ }, \ { \ 'lnum': 13, \ 'col': 3, - \ 'text': 'Expected indentation of 4 spaces but found 2 (indent)', + \ 'text': 'Expected indentation of 4 spaces but found 2', + \ 'code': 'indent', \ 'type': 'E', \ }, \ { \ 'lnum': 14, \ 'col': 3, - \ 'text': 'Expected indentation of 4 spaces but found 2 (indent)', + \ 'text': 'Expected indentation of 4 spaces but found 2', + \ 'code': 'indent', \ 'type': 'E', \ }, \ { \ 'lnum': 47, \ 'col': 3, - \ 'text': 'Function order is incorrect, public function can not go after internal function. (func-order)', + \ 'text': 'Function order is incorrect, public function can not go after internal function.', + \ 'code': 'func-order', \ 'type': 'E', \ }, \ ], From f66837818a161551dadff0a54eddfa3f639d61d8 Mon Sep 17 00:00:00 2001 From: Evan Rutledge Borden Date: Tue, 5 Dec 2017 15:04:02 -0500 Subject: [PATCH 253/390] Update doc/ale.txt to include brittany. --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 151351f..28d0f9a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -300,7 +300,7 @@ Notes: * GraphQL: `eslint`, `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` -* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` +* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `brittany`, `hfmt` * HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` From 440ef30b79aee2529e70c3633af6289b0abc8046 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 13:23:17 +0000 Subject: [PATCH 254/390] Update the issue template --- ISSUE_TEMPLATE.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 45d5350..093e086 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,8 +1,24 @@ + +## Information + +VIM version: PASTE JUST THE FIRST LINE OF `:version` HERE. + +### :ALEInfo + +PASTE OUTPUT OF `:ALEInfo` HERE. YOU CAN TRY `:ALEInfoToClipboard`. + +## What went wrong + +WRITE WHAT WENT WRONG HERE. + +## Reproducing the bug + +Steps for repeating the bug: + +1. Write a list of steps. +2. Otherwise nobody will fix the bug. From 0e57ca3df3af3f13dc4cad6ade6428b9896466c1 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 13:24:23 +0000 Subject: [PATCH 255/390] Include the operating system in the issue template --- ISSUE_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 093e086..613fcfb 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -7,6 +7,7 @@ ## Information VIM version: PASTE JUST THE FIRST LINE OF `:version` HERE. +Operating System: WHAT OS WERE YOU USING? ### :ALEInfo From d6bf13502ad7a018a739b82bc068d299aacc5d26 Mon Sep 17 00:00:00 2001 From: Martin Tournoij Date: Thu, 7 Dec 2017 15:26:20 +0000 Subject: [PATCH 256/390] Add ALEStartLint autocmd This grew out of my work in #1193; to ensure the statusline was being updated I had to add: fun! s:redraw(timer) redrawstatus endfun augroup ALEProgress autocmd! autocmd BufWritePost * call timer_start(100, function('s:redraw')) autocmd User ALELint redrawstatus augroup end Which kind of works, but is ugly. With this, I can replace the `BufWritePost` with: autocmd User ALEStartLint redrawstatus Which is much better, IMHO. Actually, this patch actually replaces adding a function, since you can do: augroup ALEProgress autocmd! autocmd User ALEStartLint hi Statusline ctermfg=darkgrey autocmd User ALELint hi Statusline ctermfg=NONE augroup end or: let s:ale_running = 0 let l:stl .= '%{s:ale_running ? "[linting]" : ""}' augroup ALEProgress autocmd! autocmd User ALEStartLint let s:ale_running = 1 | redrawstatus autocmd User ALELint let s:ale_running = 0 | redrawstatus augroup end Both seem to work very well in my testing. No need to `ale#Statusline#IsRunning()` anymore, I think? --- README.md | 10 ++++++---- autoload/ale/engine.vim | 2 ++ doc/ale.txt | 6 ++++++ test/test_alelint_autocmd.vader | 25 ++++++++++++++++++++++++- 4 files changed, 38 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 89bcc25..0292d52 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ formatting tools, and some Language Server Protocol and `tsserver` features. 5. [How can I show errors or warnings in my statusline?](#faq-statusline) 6. [How can I show errors or warnings in my lightline?](#faq-lightline) 7. [How can I change the format for echo messages?](#faq-echo-format) - 8. [How can I execute some code when ALE stops linting?](#faq-autocmd) + 8. [How can I execute some code when ALE starts or stops linting?](#faq-autocmd) 9. [How can I navigate between errors quickly?](#faq-navigation) 10. [How can I run linters only when I save files?](#faq-lint-on-save) 11. [How can I use the quickfix list instead of the loclist?](#faq-quickfix) @@ -493,15 +493,17 @@ Will give you: -### 5.viii. How can I execute some code when ALE stops linting? +### 5.viii. How can I execute some code when ALE starts or stops linting? ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html) -event whenever has a linter has been successfully executed and processed. This -autocmd event can be used to call arbitrary functions after ALE stops linting. +events whenever has a linter is started and has been successfully executed and +processed. This autocmd event can be used to call arbitrary functions before and +after ALE stops linting. ```vim augroup YourGroup autocmd! + autocmd User ALEStartLint call YourFunction() autocmd User ALELint call YourFunction() augroup END ``` diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 150b53c..895544f 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -556,6 +556,8 @@ function! s:RunJob(options) abort \ 'output': [], \ 'next_chain_index': l:next_chain_index, \} + + silent doautocmd User ALEStartLint endif if g:ale_history_enabled diff --git a/doc/ale.txt b/doc/ale.txt index 8e8f5f4..e45cfa9 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2196,6 +2196,12 @@ ALELint *ALELint-autocmd* The autocmd commands are run with |:silent|, so |:unsilent| is required for echoing messges. + +ALEStartLint *ALEStartLint-autocmd* + + This |User| autocommand is triggered by ALE right after it started a new + linting job. + =============================================================================== 10. Special Thanks *ale-special-thanks* diff --git a/test/test_alelint_autocmd.vader b/test/test_alelint_autocmd.vader index 4503005..bf96abf 100644 --- a/test/test_alelint_autocmd.vader +++ b/test/test_alelint_autocmd.vader @@ -1,18 +1,41 @@ Before: + let g:start = 0 let g:success = 0 let g:ale_run_synchronously = 1 + function! TestCallback(buffer, output) + return [{ + \ 'lnum': 1, + \ 'col': 3, + \ 'text': 'baz boz', + \}] + endfunction + + call ale#linter#Define('foobar', { + \ 'name': 'testlinter', + \ 'callback': 'TestCallback', + \ 'executable': has('win32') ? 'cmd' : 'true', + \ 'command': has('win32') ? 'echo' : 'true', + \}) + "let g:ale_linters = {'foobar': ['lint_file_linter']} + After: let g:ale_run_synchronously = 0 let g:ale_buffer_info = {} + let g:ale_linters = {} + call ale#linter#Reset() + delfunction TestCallback augroup! VaderTest Execute (Run a lint cycle, and check that a variable is set in the autocmd): + set filetype=foobar augroup VaderTest autocmd! - autocmd User ALELint let g:success = 1 + autocmd User ALEStartLint let g:start = 1 + autocmd User ALELint let g:success = 1 augroup end call ale#Lint() + AssertEqual g:start, 1 AssertEqual g:success, 1 From 63ecc8341d308c63781e4f7f81347858777d8c89 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 18:47:01 +0000 Subject: [PATCH 257/390] Fix #1202 - Do not use --all-targets by default, because it doesn't work some of the time. --- ale_linters/rust/cargo.vim | 2 +- doc/ale-rust.txt | 2 +- .../test_cargo_command_callbacks.vader | 34 +++++++++---------- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index ae26fab..a0e123a 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -2,7 +2,7 @@ " Description: rustc invoked by cargo for rust files call ale#Set('rust_cargo_use_check', 1) -call ale#Set('rust_cargo_check_all_targets', 1) +call ale#Set('rust_cargo_check_all_targets', 0) function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# '' diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index a32c90b..64d5293 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -53,7 +53,7 @@ g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check* g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets* *b:ale_rust_cargo_check_all_targets* Type: |Number| - Default: `1` + Default: `0` When set to `1`, ALE will set the `--all-targets` option when `cargo check` is used. See |g:ale_rust_cargo_use_check|, diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader index 1053551..65ea5a8 100644 --- a/test/command_callback/test_cargo_command_callbacks.vader +++ b/test/command_callback/test_cargo_command_callbacks.vader @@ -85,23 +85,7 @@ Execute(`cargo build` should be used when g:ale_rust_cargo_use_check is set to 0 AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) -Execute(`cargo check --all-targets` should be used when the version is new enough): - AssertEqual - \ 'cargo check --all-targets' . g:suffix, - \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ - \ 'cargo 0.22.0 (3423351a5 2017-10-06)', - \ ]) - - " We should cache the version check - AssertEqual - \ 'cargo check --all-targets' . g:suffix, - \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) - - AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) - -Execute(--all-targets should not be used when g:ale_rust_cargo_check_all_targets is set to 0): - let g:ale_rust_cargo_check_all_targets = 0 - +Execute(`cargo check` should be used when the version is new enough): AssertEqual \ 'cargo check' . g:suffix, \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ @@ -114,3 +98,19 @@ Execute(--all-targets should not be used when g:ale_rust_cargo_check_all_targets \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(--all-targets should be used when g:ale_rust_cargo_check_all_targets is set to 1): + let g:ale_rust_cargo_check_all_targets = 1 + + AssertEqual + \ 'cargo check --all-targets' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + + " We should cache the version check + AssertEqual + \ 'cargo check --all-targets' . g:suffix, + \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) + + AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) From fbc8ac95539b6b1672e824a2df0422fdeb32f5c6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 19:01:13 +0000 Subject: [PATCH 258/390] Update ale.txt --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 28d0f9a..5d5bd28 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -300,7 +300,7 @@ Notes: * GraphQL: `eslint`, `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` -* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `brittany`, `hfmt` +* Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` * HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` From b6efb5649ebac9faeb1c8326482b654ef2931531 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 20:07:45 +0000 Subject: [PATCH 259/390] Run tests in parallel --- run-tests | 45 ++++++++++++++++++++++++++++++------- test/script/run-vader-tests | 18 +++++---------- 2 files changed, 42 insertions(+), 21 deletions(-) diff --git a/run-tests b/run-tests index 4c2c45f..6004911 100755 --- a/run-tests +++ b/run-tests @@ -11,7 +11,6 @@ current_image_id=d5a1b5915b09 image=w0rp/ale -exit_code=0 tests='test/*.vader test/*/*.vader test/*/*/*.vader test/*/*/*.vader' # These flags are forwarded to the script for running Vader tests. @@ -91,20 +90,50 @@ find test -name '*.swp' -delete docker images -q w0rp/ale | grep "^$current_image_id" > /dev/null \ || docker pull "$image" +output_dir=$(mktemp -d 2>/dev/null || mktemp -d -t 'mytmpdir') + +trap '{ rm -rf "$output_dir"; }' EXIT + +file_number=0 +pid_list='' + for vim in $(docker run --rm "$image" ls /vim-build/bin | grep '^neovim\|^vim' ); do - if [[ $vim =~ ^neovim ]] && ((run_neovim_tests)); then - test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" || exit_code=$? - elif ((run_vim_tests)); then - test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" || exit_code=$? + if ((run_vim_tests)) || [[ $vim =~ ^neovim ]] && ((run_neovim_tests)); then + echo "Starting Vim: $vim..." + file_number=$((file_number+1)) + test/script/run-vader-tests $quiet_flag $verbose_flag "$vim" "$tests" \ + > "$output_dir/$file_number" 2>&1 & + pid_list="$pid_list $!" fi done if ((run_vint)); then - test/script/run-vint || exit_code=$? + echo "Starting Vint..." + file_number=$((file_number+1)) + test/script/run-vint > "$output_dir/$file_number" 2>&1 & + pid_list="$pid_list $!" fi if ((run_custom_checks)); then - test/script/custom-checks || exit_code=$? + echo "Starting Custom checks..." + file_number=$((file_number+1)) + test/script/custom-checks &> "$output_dir/$file_number" 2>&1 & + pid_list="$pid_list $!" fi -exit $exit_code +echo + +failed=0 +index=0 + +for pid in $pid_list; do + index=$((index+1)) + + if ! wait "$pid"; then + failed=1 + fi + + cat "$output_dir/$index" +done + +exit $failed diff --git a/test/script/run-vader-tests b/test/script/run-vader-tests index d5daec2..a10b8ba 100755 --- a/test/script/run-vader-tests +++ b/test/script/run-vader-tests @@ -106,18 +106,10 @@ echo "Running tests for $vim" echo '========================================' echo -if [[ $vim =~ ^neovim ]]; then - set -o pipefail - docker run -it -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ - "/vim-build/bin/$vim" -u test/vimrc \ - --headless "+Vader! $tests" | filter-vader-output | color-vader-output || exit_code=$? - set +o pipefail -else - set -o pipefail - docker run -a stderr -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ - "/vim-build/bin/$vim" -u test/vimrc \ - "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output || exit_code=$? - set +o pipefail -fi +set -o pipefail +docker run -a stderr -e VADER_OUTPUT_FILE=/dev/stderr "${docker_flags[@]}" \ + "/vim-build/bin/$vim" -u test/vimrc \ + "+Vader! $tests" 2>&1 | filter-vader-output | color-vader-output || exit_code=$? +set +o pipefail exit "$exit_code" From 7d932a239c0d4db4d19a39b410283fdfc72b7f3e Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 7 Dec 2017 23:25:17 +0000 Subject: [PATCH 260/390] Fix #1205 Do not add line highlights if the groups do not exist --- autoload/ale/highlight.vim | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/autoload/ale/highlight.vim b/autoload/ale/highlight.vim index e3c749f..ae1f3e7 100644 --- a/autoload/ale/highlight.vim +++ b/autoload/ale/highlight.vim @@ -95,6 +95,12 @@ function! ale#highlight#UpdateHighlights() abort " If highlights are enabled and signs are not enabled, we should still " offer line highlights by adding a separate set of highlights. if !g:ale_set_signs + let l:available_groups = { + \ 'ALEWarningLine': hlexists('ALEWarningLine'), + \ 'ALEInfoLine': hlexists('ALEInfoLine'), + \ 'ALEErrorLine': hlexists('ALEErrorLine'), + \} + for l:item in l:item_list if l:item.type is# 'W' let l:group = 'ALEWarningLine' @@ -104,7 +110,9 @@ function! ale#highlight#UpdateHighlights() abort let l:group = 'ALEErrorLine' endif - call matchaddpos(l:group, [l:item.lnum]) + if l:available_groups[l:group] + call matchaddpos(l:group, [l:item.lnum]) + endif endfor endif endfunction From 92f20b0e516526294fb933bd5640a1f5f1c0671a Mon Sep 17 00:00:00 2001 From: Martin Tournoij Date: Wed, 6 Dec 2017 13:04:31 +0000 Subject: [PATCH 261/390] goimports fixer doesn't work for vendored libraries In Go you can "vendor" packages by putting them in the `vendor/` directory for a project. Adding the `-srcdir` argument makes `goimports` pick up these packages, in addition to what you have in GOPATH. Without this, `goimports` is not very useful, since most projects vendor their packages. --- autoload/ale/fixers/goimports.vim | 2 +- test/fixers/test_goimports_fixer_callback.vader | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/autoload/ale/fixers/goimports.vim b/autoload/ale/fixers/goimports.vim index f569513..783d020 100644 --- a/autoload/ale/fixers/goimports.vim +++ b/autoload/ale/fixers/goimports.vim @@ -14,7 +14,7 @@ function! ale#fixers#goimports#Fix(buffer) abort return { \ 'command': ale#Escape(l:executable) - \ . ' -l -w' + \ . ' -l -w -srcdir %s' \ . (empty(l:options) ? '' : ' ' . l:options) \ . ' %t', \ 'read_temporary_file': 1, diff --git a/test/fixers/test_goimports_fixer_callback.vader b/test/fixers/test_goimports_fixer_callback.vader index 1d2763c..cec0635 100644 --- a/test/fixers/test_goimports_fixer_callback.vader +++ b/test/fixers/test_goimports_fixer_callback.vader @@ -25,7 +25,7 @@ Execute(The goimports callback should the command when the executable test passe AssertEqual \ { \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w %t' + \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w -srcdir %s %t' \ }, \ ale#fixers#goimports#Fix(bufnr('')) @@ -36,6 +36,6 @@ Execute(The goimports callback should include extra options): AssertEqual \ { \ 'read_temporary_file': 1, - \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w --xxx %t' + \ 'command': ale#Escape(g:ale_go_goimports_executable) . ' -l -w -srcdir %s --xxx %t' \ }, \ ale#fixers#goimports#Fix(bufnr('')) From 2d3d6d3a10bc4ff16624466cdc4189f22a5ac5f0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 8 Dec 2017 13:07:32 +0000 Subject: [PATCH 262/390] Ask for the first two lines for :version in the issue template --- ISSUE_TEMPLATE.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 613fcfb..0276a65 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -6,7 +6,10 @@ ## Information -VIM version: PASTE JUST THE FIRST LINE OF `:version` HERE. +**VIM version** + +PASTE JUST THE FIRST TWO LINES OF `:version` HERE. + Operating System: WHAT OS WERE YOU USING? ### :ALEInfo From 0700c2d90071883f1003b51e3f6d126f69d7f6f5 Mon Sep 17 00:00:00 2001 From: butlerx Date: Sat, 9 Dec 2017 13:52:15 +0000 Subject: [PATCH 263/390] add google-java-format fixer --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 ++++ autoload/ale/fixers/google_java_format.vim | 23 ++++++++++++++++ doc/ale-java.txt | 19 +++++++++++++ doc/ale.txt | 1 + ...st_goofle_java_format_fixer_callback.vader | 27 +++++++++++++++++++ 6 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 autoload/ale/fixers/google_java_format.vim create mode 100644 test/fixers/test_goofle_java_format_fixer_callback.vader diff --git a/README.md b/README.md index b978c16..d2c4c5e 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ formatting. | Haskell | [brittany](https://github.com/lspitzner/brittany), [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | | HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | -| Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | +| Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html), [google-java-format](https://github.com/google/google-java-format) | | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index b4e18c4..53df7cc 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -154,6 +154,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['sh'], \ 'description': 'Fix sh files with shfmt.', \ }, +\ 'google_java_format': { +\ 'function': 'ale#fixers#google_java_format#Fix', +\ 'suggested_filetypes': ['java'], +\ 'description': 'Fix Java files with google-java-format.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/google_java_format.vim b/autoload/ale/fixers/google_java_format.vim new file mode 100644 index 0000000..92632e8 --- /dev/null +++ b/autoload/ale/fixers/google_java_format.vim @@ -0,0 +1,23 @@ +" Author: butlerx +" Description: Integration of Google-java-format with ALE. + +call ale#Set('google_java_format_executable', 'google-java-format') +call ale#Set('google_java_format_use_global', 0) +call ale#Set('google_java_format_options', '') + +function! ale#fixers#google_java_format#Fix(buffer) abort + let l:options = ale#Var(a:buffer, 'google_java_format_options') + let l:executable = ale#Var(a:buffer, 'google_java_format_executable') + + if !executable(l:executable) + return 0 + endif + + return { + \ 'command': ale#Escape(l:executable) + \ . ' ' . (empty(l:options) ? '' : ' ' . l:options) + \ . ' --replace' + \ . ' %t', + \ 'read_temporary_file': 1, + \} +endfunction diff --git a/doc/ale-java.txt b/doc/ale-java.txt index 13decb4..ce47542 100644 --- a/doc/ale-java.txt +++ b/doc/ale-java.txt @@ -33,5 +33,24 @@ g:ale_java_javac_options *g:ale_java_javac_options* This variable can be set to pass additional options to javac. +=============================================================================== +google-java-format *ale-java-google-java-format* + + +g:ale_java_google_java_format_executable *g:ale_java_google_java_format_executable* + *b:ale_java_google_java_format_executable* + Type: |String| + Default: `'google-java-format'` + + See |ale-integrations-local-executables| + + +g:ale_java_google_java_format_options *g:ale_java_google_java_format_options* + *b:ale_java_google_java_format_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index db725c0..f527b61 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -93,6 +93,7 @@ CONTENTS *ale-contents* java..................................|ale-java-options| checkstyle..........................|ale-java-checkstyle| javac...............................|ale-java-javac| + google-java-format..................|ale-java-google-java-format| javascript............................|ale-javascript-options| eslint..............................|ale-javascript-eslint| flow................................|ale-javascript-flow| diff --git a/test/fixers/test_goofle_java_format_fixer_callback.vader b/test/fixers/test_goofle_java_format_fixer_callback.vader new file mode 100644 index 0000000..d64e278 --- /dev/null +++ b/test/fixers/test_goofle_java_format_fixer_callback.vader @@ -0,0 +1,27 @@ +Before: + Save g:ale_google_java_format_executable + + " Use an invalid global executable, so we don't match it. + let g:ale_google_java_format_executable = 'xxxinvalid' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + + call ale#test#RestoreDirectory() + +Execute(The google-java-format callback should return 0 when the executable isn't executable): + AssertEqual + \ 0, + \ ale#fixers#google_java_format#Fix(bufnr('')) + +Execute(The google-java-format callback should run the command when the executable test passes): + let g:ale_google_java_format_executable = has('win32') ? 'cmd' : 'echo' + + AssertEqual + \ { + \ 'read_temporary_file': 1, + \ 'command': ale#Escape(ale_google_java_format_executable) . ' --replace %t' + \ }, + \ ale#fixers#google_java_format#Fix(bufnr('')) From cebe7c39183b565b393d52fe9dadbf138c830b59 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 10 Dec 2017 09:58:33 +0000 Subject: [PATCH 264/390] Fix #1210 - Do not report this file as a temporary file in the quickfix list for TSLint --- ale_linters/typescript/tslint.vim | 8 +++++++- test/handler/test_tslint_handler.vader | 28 +++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/ale_linters/typescript/tslint.vim b/ale_linters/typescript/tslint.vim index a1bfbb7..f4b4816 100644 --- a/ale_linters/typescript/tslint.vim +++ b/ale_linters/typescript/tslint.vim @@ -29,7 +29,6 @@ function! ale_linters#typescript#tslint#Handle(buffer, lines) abort endif let l:item = { - \ 'filename': ale#path#GetAbsPath(l:dir, l:error.name), \ 'type': (get(l:error, 'ruleSeverity', '') is# 'WARNING' ? 'W' : 'E'), \ 'text': l:error.failure, \ 'lnum': l:error.startPosition.line + 1, @@ -38,6 +37,13 @@ function! ale_linters#typescript#tslint#Handle(buffer, lines) abort \ 'end_col': l:error.endPosition.character + 1, \} + let l:filename = ale#path#GetAbsPath(l:dir, l:error.name) + + " Assume temporary files are this file. + if !ale#path#IsTempName(l:filename) + let l:item.filename = l:filename + endif + if has_key(l:error, 'ruleName') let l:item.code = l:error.ruleName endif diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index d6ed353..78a2417 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -278,5 +278,31 @@ Execute(The tslint handler should not report no-implicit-dependencies errors): \ 'character': 0, \ 'line': 1, \ 'position': 1 - \ } + \ }, \ }])]) + +Execute(The tslint handler should set filename keys for temporary files): + " The temporay filename below is hacked into being a relative path so we can + " test that we resolve the temporary filename first. + AssertEqual + \ [ + \ {'lnum': 47, 'col': 1, 'code': 'curly', 'end_lnum': 47, 'type': 'E', 'end_col': 26, 'text': 'if statements must be braced'}, + \ ], + \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ + \ { + \ 'endPosition': { + \ 'character':25, + \ 'line':46, + \ 'position':1383, + \ }, + \ 'failure': 'if statements must be braced', + \ 'name': substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), + \ 'ruleName': 'curly', + \ 'ruleSeverity':'ERROR', + \ 'startPosition': { + \ 'character':0, + \ 'line':46, + \ 'position':1358, + \ } + \ }, + \ ])]) From 9152effa9fe4dc9e71d1ff846ba9fdf77eeeebf9 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 10 Dec 2017 10:07:04 +0000 Subject: [PATCH 265/390] Get the new test to pass on Windows --- test/handler/test_tslint_handler.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index 78a2417..287baa0 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -296,7 +296,7 @@ Execute(The tslint handler should set filename keys for temporary files): \ 'position':1383, \ }, \ 'failure': 'if statements must be braced', - \ 'name': substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), + \ 'name': substitute(substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), '\([A-Z]:\\\)[A-Z]:', '\1', ''), \ 'ruleName': 'curly', \ 'ruleSeverity':'ERROR', \ 'startPosition': { From 7a88a3605c9bc270bcbc00fbf11aaf2a825d7bae Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 10 Dec 2017 10:12:26 +0000 Subject: [PATCH 266/390] Disable a test on Windows for now, because Windows is stupid --- test/handler/test_tslint_handler.vader | 50 +++++++++++++------------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index 287baa0..4c551dc 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -282,27 +282,29 @@ Execute(The tslint handler should not report no-implicit-dependencies errors): \ }])]) Execute(The tslint handler should set filename keys for temporary files): - " The temporay filename below is hacked into being a relative path so we can - " test that we resolve the temporary filename first. - AssertEqual - \ [ - \ {'lnum': 47, 'col': 1, 'code': 'curly', 'end_lnum': 47, 'type': 'E', 'end_col': 26, 'text': 'if statements must be braced'}, - \ ], - \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ - \ { - \ 'endPosition': { - \ 'character':25, - \ 'line':46, - \ 'position':1383, - \ }, - \ 'failure': 'if statements must be braced', - \ 'name': substitute(substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), '\([A-Z]:\\\)[A-Z]:', '\1', ''), - \ 'ruleName': 'curly', - \ 'ruleSeverity':'ERROR', - \ 'startPosition': { - \ 'character':0, - \ 'line':46, - \ 'position':1358, - \ } - \ }, - \ ])]) + if !has('win32') + " The temporay filename below is hacked into being a relative path so we can + " test that we resolve the temporary filename first. + AssertEqual + \ [ + \ {'lnum': 47, 'col': 1, 'code': 'curly', 'end_lnum': 47, 'type': 'E', 'end_col': 26, 'text': 'if statements must be braced'}, + \ ], + \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ + \ { + \ 'endPosition': { + \ 'character':25, + \ 'line':46, + \ 'position':1383, + \ }, + \ 'failure': 'if statements must be braced', + \ 'name': substitute(substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), '\([A-Z]:\\\)[A-Z]:', '\1', ''), + \ 'ruleName': 'curly', + \ 'ruleSeverity':'ERROR', + \ 'startPosition': { + \ 'character':0, + \ 'line':46, + \ 'position':1358, + \ } + \ }, + \ ])]) + endif From 4825cce1cc9ec729ea59ae90eb819f67239d335b Mon Sep 17 00:00:00 2001 From: Martin Tournoij Date: Sun, 10 Dec 2017 13:03:03 +0000 Subject: [PATCH 267/390] Run before lint cycle, rename autocmds --- README.md | 8 +++---- autoload/ale/engine.vim | 6 +++-- doc/ale.txt | 40 +++++++++++++++++++-------------- test/test_alelint_autocmd.vader | 32 +++++--------------------- 4 files changed, 37 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 0292d52..fd919c0 100644 --- a/README.md +++ b/README.md @@ -497,14 +497,14 @@ Will give you: ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html) events whenever has a linter is started and has been successfully executed and -processed. This autocmd event can be used to call arbitrary functions before and -after ALE stops linting. +processed. These events can be used to call arbitrary functions before and after +ALE stops linting. ```vim augroup YourGroup autocmd! - autocmd User ALEStartLint call YourFunction() - autocmd User ALELint call YourFunction() + autocmd User ALELintPre call YourFunction() + autocmd User ALELintPost call YourFunction() augroup END ``` diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 895544f..65e663a 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -321,6 +321,8 @@ function! ale#engine#SetResults(buffer, loclist) abort call ale#engine#RemoveManagedFiles(a:buffer) " Call user autocommands. This allows users to hook into ALE's lint cycle. + silent doautocmd User ALELintPost + " Old DEPRECATED name; call it for backwards compatibility. silent doautocmd User ALELint endif endfunction @@ -556,8 +558,6 @@ function! s:RunJob(options) abort \ 'output': [], \ 'next_chain_index': l:next_chain_index, \} - - silent doautocmd User ALEStartLint endif if g:ale_history_enabled @@ -787,6 +787,8 @@ function! ale#engine#RunLinters(buffer, linters, should_lint_file) abort " We can only clear the results if we aren't checking the buffer. let l:can_clear_results = !ale#engine#IsCheckingBuffer(a:buffer) + silent doautocmd User ALELintPre + for l:linter in a:linters " Only run lint_file linters if we should. if !l:linter.lint_file || a:should_lint_file diff --git a/doc/ale.txt b/doc/ale.txt index e45cfa9..79101c6 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2048,7 +2048,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* the file on disk, including |g:ale_lint_on_enter| and |g:ale_lint_on_save|. Linters with this option set to `1` will also be run when linters are run - manually, per |ALELint-autocmd|. + manually, per |ALELintPost-autocmd|. When this option is set to `1`, `read_buffer` will be set automatically to `0`. The two options cannot @@ -2182,26 +2182,32 @@ ale#statusline#Count(buffer) *ale#statusline#Count()* `total` -> The total number of problems. -ALELint *ALELint-autocmd* +ALELintPre ALELintPost *ALELintPre-autocmd* *ALELintPost-autocmd* - This |User| autocommand is triggered by ALE every time it completes a lint - cycle. It can be used to update statuslines, send notifications, or - complete any other operation that needs to be done after linting has been - performed. - - For example, you can echo a message when linting is complete like so: - > - autocmd User ALELint unsilent echom 'ALE run!' -< + These |User| autocommands are triggered before and after every lint cycle. + It can be used to update statuslines, send notifications, etc. The autocmd commands are run with |:silent|, so |:unsilent| is required for echoing messges. - -ALEStartLint *ALEStartLint-autocmd* - - This |User| autocommand is triggered by ALE right after it started a new - linting job. - + For example to change the color of the statusline while the linter is + running: +> + augroup ALEProgress + autocmd! + autocmd User ALELintPre hi Statusline ctermfg=darkgrey + autocmd User ALELintPOST hi Statusline ctermfg=NONE + augroup end +< + Or to display the progress in the statusline: +> + let s:ale_running = 0 + let l:stl .= '%{s:ale_running ? "[linting]" : ""}' + augroup ALEProgress + autocmd! + autocmd User ALELintPre let s:ale_running = 1 | redrawstatus + autocmd User ALELintPost let s:ale_running = 0 | redrawstatus + augroup end +< =============================================================================== 10. Special Thanks *ale-special-thanks* diff --git a/test/test_alelint_autocmd.vader b/test/test_alelint_autocmd.vader index bf96abf..b19e6b4 100644 --- a/test/test_alelint_autocmd.vader +++ b/test/test_alelint_autocmd.vader @@ -1,41 +1,21 @@ Before: - let g:start = 0 - let g:success = 0 + let g:pre_success = 0 + let g:post_success = 0 let g:ale_run_synchronously = 1 - function! TestCallback(buffer, output) - return [{ - \ 'lnum': 1, - \ 'col': 3, - \ 'text': 'baz boz', - \}] - endfunction - - call ale#linter#Define('foobar', { - \ 'name': 'testlinter', - \ 'callback': 'TestCallback', - \ 'executable': has('win32') ? 'cmd' : 'true', - \ 'command': has('win32') ? 'echo' : 'true', - \}) - "let g:ale_linters = {'foobar': ['lint_file_linter']} - After: let g:ale_run_synchronously = 0 let g:ale_buffer_info = {} - let g:ale_linters = {} - call ale#linter#Reset() - delfunction TestCallback augroup! VaderTest Execute (Run a lint cycle, and check that a variable is set in the autocmd): - set filetype=foobar augroup VaderTest autocmd! - autocmd User ALEStartLint let g:start = 1 - autocmd User ALELint let g:success = 1 + autocmd User ALELintPre let g:pre_success = 1 + autocmd User ALELintPost let g:post_success = 1 augroup end call ale#Lint() - AssertEqual g:start, 1 - AssertEqual g:success, 1 + AssertEqual g:pre_success, 1 + AssertEqual g:post_success, 1 From d2a6d9a9152476ed89fcb10291c95d4fc3716423 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 13 Dec 2017 11:14:31 +0000 Subject: [PATCH 268/390] Fix #1216 - Suppress trailing whitespace warings for ansible-lint when the option is set --- ale_linters/ansible/ansible_lint.vim | 2 +- test/handler/test_ansible_lint_handler.vader | 20 +++++++++++++++++--- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/ale_linters/ansible/ansible_lint.vim b/ale_linters/ansible/ansible_lint.vim index 27c9632..0b3b39c 100644 --- a/ale_linters/ansible/ansible_lint.vim +++ b/ale_linters/ansible/ansible_lint.vim @@ -21,7 +21,7 @@ function! ale_linters#ansible#ansible_lint#Handle(buffer, lines) abort for l:match in ale#util#GetMatches(a:lines, l:pattern) let l:code = l:match[4] - if l:code is# 'EANSIBLE002' + if l:code is# 'EANSIBLE0002' \&& !ale#Var(a:buffer, 'warn_about_trailing_whitespace') " Skip warnings for trailing whitespace if the option is off. continue diff --git a/test/handler/test_ansible_lint_handler.vader b/test/handler/test_ansible_lint_handler.vader index cd6e513..796277e 100644 --- a/test/handler/test_ansible_lint_handler.vader +++ b/test/handler/test_ansible_lint_handler.vader @@ -1,9 +1,13 @@ Before: - runtime ale_linters/ansible/ansible_lint.vim - call ale#test#SetFilename('main.yml') + runtime ale_linters/ansible/ansible_lint.vim + call ale#test#SetFilename('main.yml') + + let b:ale_warn_about_trailing_whitespace = 1 After: - call ale#linter#Reset() + unlet! b:ale_warn_about_trailing_whitespace + + call ale#linter#Reset() Execute(The ansible-lint handler should handle basic errors): AssertEqual @@ -20,6 +24,16 @@ Execute(The ansible-lint handler should handle basic errors): \ fnamemodify(tempname(), ':h') . '/main.yml:35: [EANSIBLE0002] Trailing whitespace', \ ]) +Execute(The ansible-lint handler should supress trailing whitespace output when the option is used): + let b:ale_warn_about_trailing_whitespace = 0 + + AssertEqual + \ [ + \ ], + \ ale_linters#ansible#ansible_lint#Handle(bufnr(''), [ + \ fnamemodify(tempname(), ':h') . '/main.yml:35: [EANSIBLE0002] Trailing whitespace', + \ ]) + Execute (The ansible-lint handler should handle names with spaces): AssertEqual \ [ From 55ca96bd8310737da5e2f7d21587dcdbe6c9f011 Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Wed, 13 Dec 2017 14:19:56 +0100 Subject: [PATCH 269/390] Add a linter for alex https://github.com/wooorm/alex Enabled for text-like file formats and documented in README and doc. --- README.md | 24 ++++++++++++------------ ale_linters/asciidoc/alex.vim | 10 ++++++++++ ale_linters/help/alex.vim | 10 ++++++++++ ale_linters/html/alex.vim | 10 ++++++++++ ale_linters/mail/alex.vim | 10 ++++++++++ ale_linters/markdown/alex.vim | 10 ++++++++++ ale_linters/nroff/alex.vim | 10 ++++++++++ ale_linters/pod/alex.vim | 10 ++++++++++ ale_linters/rst/alex.vim | 10 ++++++++++ ale_linters/tex/alex.vim | 10 ++++++++++ ale_linters/texinfo/alex.vim | 10 ++++++++++ ale_linters/text/alex.vim | 10 ++++++++++ ale_linters/xhtml/alex.vim | 10 ++++++++++ autoload/ale/handlers/alex.vim | 22 ++++++++++++++++++++++ doc/ale.txt | 24 ++++++++++++------------ 15 files changed, 166 insertions(+), 24 deletions(-) create mode 100644 ale_linters/asciidoc/alex.vim create mode 100644 ale_linters/help/alex.vim create mode 100644 ale_linters/html/alex.vim create mode 100644 ale_linters/mail/alex.vim create mode 100644 ale_linters/markdown/alex.vim create mode 100644 ale_linters/nroff/alex.vim create mode 100644 ale_linters/pod/alex.vim create mode 100644 ale_linters/rst/alex.vim create mode 100644 ale_linters/tex/alex.vim create mode 100644 ale_linters/texinfo/alex.vim create mode 100644 ale_linters/text/alex.vim create mode 100644 ale_linters/xhtml/alex.vim create mode 100644 autoload/ale/handlers/alex.vim diff --git a/README.md b/README.md index b978c16..d91d41c 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ formatting. | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | | API Blueprint | [drafter](https://github.com/apiaryio/drafter) | -| AsciiDoc | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/)| +| AsciiDoc | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/)| | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | @@ -106,36 +106,36 @@ formatting. | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | | Haskell | [brittany](https://github.com/lspitzner/brittany), [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | -| HTML | [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | +| HTML | [alex](https://github.com/wooorm/alex), [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html) | | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | -| LaTeX | [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| LaTeX | [alex](https://github.com/wooorm/alex), [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | -| Mail | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | +| Mail | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| Markdown | [alex](https://github.com/wooorm/alex), [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | -| nroff | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| nroff | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Objective-C | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | -| Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Pod | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| reStructuredText | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Re:VIEW | [redpen](http://redpen.cc/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | @@ -151,14 +151,14 @@ formatting. | Swift | [swiftlint](https://github.com/realm/SwiftLint), [swiftformat](https://github.com/nicklockwood/SwiftFormat) | | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | | Terraform | [tflint](https://github.com/wata727/tflint) | -| Texinfo | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| -| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| Texinfo | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| Text^ | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Thrift | [thrift](http://thrift.apache.org/) | | TypeScript | [eslint](http://eslint.org/), [prettier](https://github.com/prettier/prettier), [tslint](https://github.com/palantir/tslint), tsserver, typecheck | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | | Vim | [vint](https://github.com/Kuniwak/vint) | -| Vim help^ | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | -| XHTML | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Vim help^ | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| XHTML | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | XML | [xmllint](http://xmlsoft.org/xmllint.html) | | YAML | [swaglint](https://github.com/byCedric/swaglint), [yamllint](https://yamllint.readthedocs.io/) | diff --git a/ale_linters/asciidoc/alex.vim b/ale_linters/asciidoc/alex.vim new file mode 100644 index 0000000..a1e50de --- /dev/null +++ b/ale_linters/asciidoc/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for asciidoc files + +call ale#linter#Define('asciidoc', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/help/alex.vim b/ale_linters/help/alex.vim new file mode 100644 index 0000000..9b3e4ee --- /dev/null +++ b/ale_linters/help/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for help files + +call ale#linter#Define('help', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/html/alex.vim b/ale_linters/html/alex.vim new file mode 100644 index 0000000..85dc4fd --- /dev/null +++ b/ale_linters/html/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for HTML files + +call ale#linter#Define('html', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/mail/alex.vim b/ale_linters/mail/alex.vim new file mode 100644 index 0000000..047e6cf --- /dev/null +++ b/ale_linters/mail/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for HTML files + +call ale#linter#Define('mail', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/markdown/alex.vim b/ale_linters/markdown/alex.vim new file mode 100644 index 0000000..1e3e368 --- /dev/null +++ b/ale_linters/markdown/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for markdown files + +call ale#linter#Define('markdown', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/nroff/alex.vim b/ale_linters/nroff/alex.vim new file mode 100644 index 0000000..911ac41 --- /dev/null +++ b/ale_linters/nroff/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for nroff files + +call ale#linter#Define('nroff', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/pod/alex.vim b/ale_linters/pod/alex.vim new file mode 100644 index 0000000..8bc205d --- /dev/null +++ b/ale_linters/pod/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for pod files + +call ale#linter#Define('pod', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/rst/alex.vim b/ale_linters/rst/alex.vim new file mode 100644 index 0000000..1fed723 --- /dev/null +++ b/ale_linters/rst/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for rst files + +call ale#linter#Define('rst', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/tex/alex.vim b/ale_linters/tex/alex.vim new file mode 100644 index 0000000..da82856 --- /dev/null +++ b/ale_linters/tex/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for TeX files + +call ale#linter#Define('tex', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/texinfo/alex.vim b/ale_linters/texinfo/alex.vim new file mode 100644 index 0000000..41969fd --- /dev/null +++ b/ale_linters/texinfo/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for texinfo files + +call ale#linter#Define('texinfo', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/text/alex.vim b/ale_linters/text/alex.vim new file mode 100644 index 0000000..32d8ce2 --- /dev/null +++ b/ale_linters/text/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for text files + +call ale#linter#Define('text', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/ale_linters/xhtml/alex.vim b/ale_linters/xhtml/alex.vim new file mode 100644 index 0000000..cf073cb --- /dev/null +++ b/ale_linters/xhtml/alex.vim @@ -0,0 +1,10 @@ +" Author: Johannes Wienke +" Description: alex for XHTML files + +call ale#linter#Define('xhtml', { +\ 'name': 'alex', +\ 'executable': 'alex', +\ 'command': 'alex %t -t', +\ 'output_stream': 'stderr', +\ 'callback': 'ale#handlers#alex#Handle', +\}) diff --git a/autoload/ale/handlers/alex.vim b/autoload/ale/handlers/alex.vim new file mode 100644 index 0000000..853d313 --- /dev/null +++ b/autoload/ale/handlers/alex.vim @@ -0,0 +1,22 @@ +" Author: Johannes Wienke +" Description: Error handling for errors in alex output format + +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:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'col': l:match[2] + 0, + \ 'end_lnum': l:match[3] + 0, + \ 'end_col': l:match[4] - 1, + \ 'text': l:match[5] . ' (' . (l:match[7]) . ')', + \ 'type': 'W', + \}) + endfor + + return l:output +endfunction diff --git a/doc/ale.txt b/doc/ale.txt index db725c0..f7111aa 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -274,7 +274,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` * API Blueprint: `drafter` -* AsciiDoc: `proselint`, `write-good`, `redpen` +* AsciiDoc: `alex`, `proselint`, `write-good`, `redpen` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` * Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` @@ -305,36 +305,36 @@ Notes: * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` -* HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` +* HTML: `alex`, `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good`, `redpen` +* LaTeX (tex): `alex`, `chktex`, `lacheck`, `proselint`, `write-good`, `redpen` * Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` * Lua: `luacheck` -* Mail: `proselint`, `vale` +* Mail: `alex`, `proselint`, `vale` * Make: `checkmake` -* Markdown: `mdl`, `proselint`, `vale`, `remark-lint`, `write-good`, `redpen` +* Markdown: `alex`, `mdl`, `proselint`, `vale`, `remark-lint`, `write-good`, `redpen` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` -* nroff: `proselint`, `write-good` +* nroff: `alex`, `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` -* Pod: `proselint`, `write-good` +* Pod: `alex`, `proselint`, `write-good` * proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` -* reStructuredText: `proselint`, `rstcheck`, `write-good`, `redpen` +* reStructuredText: `alex`, `proselint`, `rstcheck`, `write-good`, `redpen` * Re:VIEW: `redpen` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` @@ -350,14 +350,14 @@ Notes: * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! * Terraform: `tflint` -* Texinfo: `proselint`, `write-good` -* Text^: `proselint`, `vale`, `write-good`, `redpen` +* Texinfo: `alex`, `proselint`, `write-good` +* Text^: `alex`, `proselint`, `vale`, `write-good`, `redpen` * Thrift: `thrift` * TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck` * Verilog: `iverilog`, `verilator` * Vim: `vint` -* Vim help^: `proselint`, `write-good` -* XHTML: `proselint`, `write-good` +* Vim help^: `alex`, `proselint`, `write-good` +* XHTML: `alex`, `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` From 0d046f5f013b9cf9620ef6f0a593f733051fc708 Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Wed, 13 Dec 2017 14:37:49 +0100 Subject: [PATCH 270/390] Add a vader test for the message handler --- test/handler/test_alex_handler.vader | 54 ++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 test/handler/test_alex_handler.vader diff --git a/test/handler/test_alex_handler.vader b/test/handler/test_alex_handler.vader new file mode 100644 index 0000000..eb241f8 --- /dev/null +++ b/test/handler/test_alex_handler.vader @@ -0,0 +1,54 @@ +Execute(The alex handler should handle the example from the alex README): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'col': 5, + \ 'end_lnum': 1, + \ 'end_col': 13, + \ 'type': 'W', + \ 'text': '`boogeyman` may be insensitive, use `boogey` instead (retext-equality)', + \ }, + \ { + \ 'lnum': 1, + \ 'col': 42, + \ 'end_lnum': 1, + \ 'end_col': 47, + \ 'type': 'W', + \ 'text': '`master` / `slaves` may be insensitive, use `primary` / `replica` instead (retext-equality)', + \ }, + \ { + \ 'lnum': 1, + \ 'col': 69, + \ 'end_lnum': 1, + \ 'end_col': 74, + \ 'type': 'W', + \ 'text': 'Don’t use “slaves”, it’s profane (retext-profanities)', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 52, + \ 'end_lnum': 2, + \ 'end_col': 53, + \ 'type': 'W', + \ 'text': '`he` may be insensitive, use `they`, `it` instead (retext-equality)', + \ }, + \ { + \ 'lnum': 2, + \ 'col': 61, + \ 'end_lnum': 2, + \ 'end_col': 67, + \ 'type': 'W', + \ 'text': '`cripple` may be insensitive, use `person with a limp` instead (retext-equality)', + \ }, + \ ], + \ ale#handlers#alex#Handle(bufnr(''), [ + \ 'example.md', + \ ' 1:5-1:14 warning `boogeyman` may be insensitive, use `boogey` instead boogeyman-boogeywoman retext-equality', + \ ' 1:42-1:48 warning `master` / `slaves` may be insensitive, use `primary` / `replica` instead master-slave retext-equality', + \ ' 1:69-1:75 warning Don’t use “slaves”, it’s profane slaves retext-profanities', + \ ' 2:52-2:54 warning `he` may be insensitive, use `they`, `it` instead he-she retext-equality', + \ ' 2:61-2:68 warning `cripple` may be insensitive, use `person with a limp` instead cripple retext-equality', + \ '', + \ '⚠ 5 warnings', + \ ]) From e7eb27271496ad5e2cb6ea6a145d86ef63501c99 Mon Sep 17 00:00:00 2001 From: Jelte Fennema Date: Wed, 13 Dec 2017 14:59:59 +0100 Subject: [PATCH 271/390] Fix erb linter for puppet style erb scripts --- ale_linters/eruby/erb.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ale_linters/eruby/erb.vim b/ale_linters/eruby/erb.vim index 65de18e..61d9703 100644 --- a/ale_linters/eruby/erb.vim +++ b/ale_linters/eruby/erb.vim @@ -5,7 +5,7 @@ function! ale_linters#eruby#erb#GetCommand(buffer) abort let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) if empty(l:rails_root) - return 'erb -P -x %t | ruby -c' + return 'erb -P -T - -x %t | ruby -c' endif " Rails-flavored eRuby does not comply with the standard as understood by From 78d1f5f5dfdc3a362b3ecb304ffb07e9bb10a65c Mon Sep 17 00:00:00 2001 From: Stephen Rathbone Date: Wed, 13 Dec 2017 21:23:18 +0000 Subject: [PATCH 272/390] Fix PHP linter to support PHP 7.2 lint output --- ale_linters/php/php.vim | 6 ++++-- test/handler/test_php_handler.vader | 12 ++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/ale_linters/php/php.vim b/ale_linters/php/php.vim index b263c5f..6470383 100644 --- a/ale_linters/php/php.vim +++ b/ale_linters/php/php.vim @@ -4,12 +4,14 @@ function! ale_linters#php#php#Handle(buffer, lines) abort " Matches patterns like the following: " - " Parse error: syntax error, unexpected ';', expecting ']' in - on line 15 - let l:pattern = '\v^%(Fatal|Parse) error:\s+(.+unexpected ''(.+)%(expecting.+)@= - Parse error: syntax error, unexpected ';', expecting ']' in Standard input code on line 15 + let l:pattern = '\v^%(Fatal|Parse) error:\s+(.+unexpected ''(.+)%(expecting.+)@ Date: Sun, 17 Dec 2017 11:58:05 +0000 Subject: [PATCH 273/390] Update ale.txt --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index f527b61..fc4a984 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -308,7 +308,7 @@ Notes: * Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` * HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` -* Java: `checkstyle`, `javac` +* Java: `checkstyle`, `javac`, `google-java-format` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` From 7284270120e1a9f9b697d388a4999654f0fc7db5 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 17 Dec 2017 12:10:07 +0000 Subject: [PATCH 274/390] Fix some right margin alignment --- doc/ale-java.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/ale-java.txt b/doc/ale-java.txt index ce47542..0d2011f 100644 --- a/doc/ale-java.txt +++ b/doc/ale-java.txt @@ -34,19 +34,20 @@ g:ale_java_javac_options *g:ale_java_javac_options* =============================================================================== -google-java-format *ale-java-google-java-format* +google-java-format *ale-java-google-java-format* -g:ale_java_google_java_format_executable *g:ale_java_google_java_format_executable* - *b:ale_java_google_java_format_executable* +g:ale_java_google_java_format_executable + *g:ale_java_google_java_format_executable* + *b:ale_java_google_java_format_executable* Type: |String| Default: `'google-java-format'` See |ale-integrations-local-executables| -g:ale_java_google_java_format_options *g:ale_java_google_java_format_options* - *b:ale_java_google_java_format_options* +g:ale_java_google_java_format_options *g:ale_java_google_java_format_options* + *b:ale_java_google_java_format_options* Type: |String| Default: `''` From 09d3ecc49bf6bdbfacf04855f22d32c5aad411c9 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 17 Dec 2017 12:11:30 +0000 Subject: [PATCH 275/390] Clean up some doc formatting --- doc/ale.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index b818f87..3f4ff58 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2185,10 +2185,11 @@ ale#statusline#Count(buffer) *ale#statusline#Count()* `total` -> The total number of problems. -ALELintPre ALELintPost *ALELintPre-autocmd* *ALELintPost-autocmd* +ALELintPre *ALELintPre-autocmd* +ALELintPost *ALELintPost-autocmd* These |User| autocommands are triggered before and after every lint cycle. - It can be used to update statuslines, send notifications, etc. + They can be used to update statuslines, send notifications, etc. The autocmd commands are run with |:silent|, so |:unsilent| is required for echoing messges. @@ -2211,6 +2212,7 @@ ALELintPre ALELintPost *ALELintPre-autocmd* *ALELintPost-autocmd autocmd User ALELintPost let s:ale_running = 0 | redrawstatus augroup end < + =============================================================================== 10. Special Thanks *ale-special-thanks* From 7e793c9d71c93e03d38fcf952b926069473c2705 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 17 Dec 2017 12:36:07 +0000 Subject: [PATCH 276/390] Fix a typo --- autoload/ale/python.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index 90721ef..7a294e4 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -31,7 +31,7 @@ endfunction " The root directory is defined as the first directory found while searching " upwards through paths, including the current directory, until a path " containing an init file (one from MANIFEST.in, setup.cfg, pytest.ini, -" tox.ini) is found. If it is not possible to find the project root directorty +" tox.ini) is found. If it is not possible to find the project root directory " via init file, then it will be defined as the first directory found " searching upwards through paths, including the current directory, until no " __init__.py files is found. From 55e09a4a2da8f14d03e69d78351089540b898528 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 17 Dec 2017 12:38:46 +0000 Subject: [PATCH 277/390] Look for mypy.ini to find Python project roots too --- autoload/ale/python.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index 7a294e4..117b0ef 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -18,6 +18,7 @@ function! ale#python#FindProjectRootIni(buffer) abort \|| filereadable(l:path . '/setup.cfg') \|| filereadable(l:path . '/pytest.ini') \|| filereadable(l:path . '/tox.ini') + \|| filereadable(l:path . '/mypy.ini') \|| filereadable(l:path . '/pycodestyle.cfg') \|| filereadable(l:path . '/flake8.cfg') return l:path From 96b90b45db5070c964adb14f1a0ac67c61571648 Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Sun, 17 Dec 2017 16:49:57 +0100 Subject: [PATCH 278/390] Use JSON output with vale Switches all vale instances to JSON output and provides an appropriate handler for that. Without JSON, no end_col is provided and text highlighting only catches the first character of every result. --- ale_linters/mail/vale.vim | 4 +- ale_linters/markdown/vale.vim | 4 +- ale_linters/text/vale.vim | 4 +- autoload/ale/handlers/vale.vim | 36 +++++++++++++++ test/handler/test_vale_handler.vader | 67 ++++++++++++++++++++++++++++ 5 files changed, 109 insertions(+), 6 deletions(-) create mode 100644 autoload/ale/handlers/vale.vim create mode 100644 test/handler/test_vale_handler.vader diff --git a/ale_linters/mail/vale.vim b/ale_linters/mail/vale.vim index 9b30bf6..e6dfd2e 100644 --- a/ale_linters/mail/vale.vim +++ b/ale_linters/mail/vale.vim @@ -4,6 +4,6 @@ call ale#linter#Define('mail', { \ 'name': 'vale', \ 'executable': 'vale', -\ 'command': 'vale --output=line %t', -\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\ 'command': 'vale --output=JSON %t', +\ 'callback': 'ale#handlers#vale#Handle', \}) diff --git a/ale_linters/markdown/vale.vim b/ale_linters/markdown/vale.vim index 43b3d34..838c4db 100644 --- a/ale_linters/markdown/vale.vim +++ b/ale_linters/markdown/vale.vim @@ -4,6 +4,6 @@ call ale#linter#Define('markdown', { \ 'name': 'vale', \ 'executable': 'vale', -\ 'command': 'vale --output=line %t', -\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\ 'command': 'vale --output=JSON %t', +\ 'callback': 'ale#handlers#vale#Handle', \}) diff --git a/ale_linters/text/vale.vim b/ale_linters/text/vale.vim index 60bd799..cf37c2f 100644 --- a/ale_linters/text/vale.vim +++ b/ale_linters/text/vale.vim @@ -4,6 +4,6 @@ call ale#linter#Define('text', { \ 'name': 'vale', \ 'executable': 'vale', -\ 'command': 'vale --output=line %t', -\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\ 'command': 'vale --output=JSON %t', +\ 'callback': 'ale#handlers#vale#Handle', \}) diff --git a/autoload/ale/handlers/vale.vim b/autoload/ale/handlers/vale.vim new file mode 100644 index 0000000..c842057 --- /dev/null +++ b/autoload/ale/handlers/vale.vim @@ -0,0 +1,36 @@ +" Author: Johannes Wienke +" Description: output handler for the vale JSON format + +function! ale#handlers#vale#GetType(severity) abort + if a:severity is? 'warning' + return 'W' + endif + + return 'E' +endfunction + +function! ale#handlers#vale#Handle(buffer, lines) abort + try + let l:errors = json_decode(join(a:lines, '')) + catch + return [] + endtry + + if empty(l:errors) + return [] + endif + + let l:output = [] + for l:error in l:errors[keys(l:errors)[0]] + call add(l:output, { + \ 'lnum': l:error['Line'], + \ 'col': l:error['Span'][0], + \ 'end_col': l:error['Span'][1], + \ 'code': l:error['Check'], + \ 'text': l:error['Message'], + \ 'type': ale#handlers#vale#GetType(l:error['Severity']), + \}) + endfor + + return l:output +endfunction diff --git a/test/handler/test_vale_handler.vader b/test/handler/test_vale_handler.vader new file mode 100644 index 0000000..afc32db --- /dev/null +++ b/test/handler/test_vale_handler.vader @@ -0,0 +1,67 @@ +Execute(The vale handler should handle broken JSON): + AssertEqual + \ [], + \ ale#handlers#vale#Handle(bufnr(''), ["{asdf"]) + +Execute(The vale handler should handle am empty string response): + AssertEqual + \ [], + \ ale#handlers#vale#Handle(bufnr(''), []) + +Execute(The vale handler should handle an empty result): + AssertEqual + \ [], + \ ale#handlers#vale#Handle(bufnr(''), ["{}"]) + +Execute(The vale handler should handle a normal example): + AssertEqual + \ [ + \ { + \ 'lnum': 5, + \ 'col': 195, + \ 'end_col': 201, + \ 'type': 'W', + \ 'text': "Consider removing 'usually'", + \ 'code': 'vale.Hedging', + \ }, + \ { + \ 'lnum': 7, + \ 'col': 1, + \ 'end_col': 27, + \ 'type': 'E', + \ 'text': "'Documentation' is repeated!", + \ 'code': 'vale.Repetition', + \ }, + \ ], + \ ale#handlers#vale#Handle(bufnr(''), [ + \ '{', + \ ' "/home/languitar/src/autosuspend/README.md": [', + \ ' {', + \ ' "Check": "vale.Hedging",', + \ ' "Description": "",', + \ ' "Line": 5,', + \ ' "Link": "",', + \ " \"Message\": \"Consider removing 'usually'\",", + \ ' "Severity": "warning",', + \ ' "Span": [', + \ ' 195,', + \ ' 201', + \ ' ],', + \ ' "Hide": false', + \ ' },', + \ ' {', + \ ' "Check": "vale.Repetition",', + \ ' "Description": "",', + \ ' "Line": 7,', + \ ' "Link": "",', + \ " \"Message\": \"'Documentation' is repeated!\",", + \ ' "Severity": "error",', + \ ' "Span": [', + \ ' 1,', + \ ' 27', + \ ' ],', + \ ' "Hide": false', + \ ' }', + \ ' ]', + \ '}', + \ ]) From ad1aee0b890a3609cede4cc11eb02f798e63fbf5 Mon Sep 17 00:00:00 2001 From: Nick Diego Yamane Date: Sun, 17 Dec 2017 16:45:57 -0400 Subject: [PATCH 279/390] Fix typos in flake8 test messages Signed-off-by: Nick Diego Yamane --- test/command_callback/test_flake8_command_callback.vader | 2 +- test/handler/test_flake8_handler.vader | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/command_callback/test_flake8_command_callback.vader b/test/command_callback/test_flake8_command_callback.vader index 47d5c0f..8cb4ded 100644 --- a/test/command_callback/test_flake8_command_callback.vader +++ b/test/command_callback/test_flake8_command_callback.vader @@ -158,7 +158,7 @@ Execute(Using `python -m flake8` should be supported for running flake8): \ ale#Escape('python') . ' -m flake8 --some-option --format=default -', \ ale_linters#python#flake8#GetCommand(bufnr(''), ['2.9.9']) -Execute(Using `python2 -m flake8` should be use with the old args option): +Execute(Using `python2 -m flake8` should be supported with the old args option): let g:ale_python_flake8_executable = 'python2' let g:ale_python_flake8_args = '-m flake8' let g:ale_python_flake8_use_global = 0 diff --git a/test/handler/test_flake8_handler.vader b/test/handler/test_flake8_handler.vader index 8b44039..492941c 100644 --- a/test/handler/test_flake8_handler.vader +++ b/test/handler/test_flake8_handler.vader @@ -48,7 +48,7 @@ Execute(The flake8 handler should handle basic warnings and syntax errors): \ 'stdin:8:3: E999 SyntaxError: invalid syntax', \ ]) -Execute(The flake8 handler should set end column indexes should be set for certain errors): +Execute(The flake8 handler should set end column indexes for certain errors): AssertEqual \ [ \ { From d3cf02ecda8a5abe51cf74d17ff3e0414194f937 Mon Sep 17 00:00:00 2001 From: Daniel Parker Date: Mon, 18 Dec 2017 09:33:11 +0000 Subject: [PATCH 280/390] Add support for Vritual Env folder called venv --- autoload/ale/python.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim index 117b0ef..82dd9d7 100644 --- a/autoload/ale/python.vim +++ b/autoload/ale/python.vim @@ -10,6 +10,7 @@ let g:ale_virtualenv_dir_names = get(g:, 'ale_virtualenv_dir_names', [ \ 've-py3', \ 've', \ 'virtualenv', +\ 'venv', \]) function! ale#python#FindProjectRootIni(buffer) abort From 938c150880fa1e9b71e90145fc158152ba11ac8e Mon Sep 17 00:00:00 2001 From: Daniel Parker Date: Mon, 18 Dec 2017 09:44:02 +0000 Subject: [PATCH 281/390] Update docs --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 33f9fdf..f16858e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1397,7 +1397,7 @@ g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names* b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names* Type: |List| - Default: `['.env', 'env', 've-py3', 've', 'virtualenv']` + Default: `['.env', 'env', 've-py3', 've', 'virtualenv', 'venv']` A list of directory names to be used when searching upwards from Python files to discover virtulenv directories with. From 1626fce1c933d96f891f2a1caaf30c489f6c3e1c Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Mon, 18 Dec 2017 11:15:00 +0100 Subject: [PATCH 282/390] Enable the vale linter also for further markup languages (#1230) * Enable the vale linter also for LaTeX * Enable the vale linter for rst files --- ale_linters/rst/vale.vim | 9 +++++++++ ale_linters/tex/vale.vim | 9 +++++++++ 2 files changed, 18 insertions(+) create mode 100644 ale_linters/rst/vale.vim create mode 100644 ale_linters/tex/vale.vim diff --git a/ale_linters/rst/vale.vim b/ale_linters/rst/vale.vim new file mode 100644 index 0000000..2e654dc --- /dev/null +++ b/ale_linters/rst/vale.vim @@ -0,0 +1,9 @@ +" Author: chew-z https://github.com/chew-z +" Description: vale for RST files + +call ale#linter#Define('rst', { +\ 'name': 'vale', +\ 'executable': 'vale', +\ 'command': 'vale --output=JSON %t', +\ 'callback': 'ale#handlers#vale#Handle', +\}) diff --git a/ale_linters/tex/vale.vim b/ale_linters/tex/vale.vim new file mode 100644 index 0000000..f64e72a --- /dev/null +++ b/ale_linters/tex/vale.vim @@ -0,0 +1,9 @@ +" Author: chew-z https://github.com/chew-z +" Description: vale for LaTeX files + +call ale#linter#Define('tex', { +\ 'name': 'vale', +\ 'executable': 'vale', +\ 'command': 'vale --output=JSON %t', +\ 'callback': 'ale#handlers#vale#Handle', +\}) From af7eb2b9793e0d8e3b211d1239a74b4c9ef36995 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 10:28:49 +0000 Subject: [PATCH 283/390] Sort the list of supported tools and add vale to more languages --- README.md | 10 +++++----- doc/ale.txt | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9850420..35bb29e 100644 --- a/README.md +++ b/README.md @@ -75,12 +75,12 @@ formatting. | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | | API Blueprint | [drafter](https://github.com/apiaryio/drafter) | -| AsciiDoc | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/)| +| AsciiDoc | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [write-good](https://github.com/btford/write-good) | | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | C | [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/), [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html)| -| C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangcheck](http://clang.llvm.org/docs/ClangCheck.html) !!, [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) !!, [gcc](https://gcc.gnu.org/), [clang-format](https://clang.llvm.org/docs/ClangFormat.html)| +| C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangcheck](http://clang.llvm.org/docs/ClangCheck.html) !!, [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html), [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) !!, [gcc](https://gcc.gnu.org/) | | CUDA | [nvcc](http://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/index.html) | | C# | [mcs](http://www.mono-project.com/docs/about-mono/languages/csharp/) see:`help ale-cs-mcs` for details, [mcsc](http://www.mono-project.com/docs/about-mono/languages/csharp/) !! see:`help ale-cs-mcsc` for details and configuration| | Chef | [foodcritic](http://www.foodcritic.io/) | @@ -112,13 +112,13 @@ formatting. | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | -| LaTeX | [alex](https://github.com/wooorm/alex), [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| LaTeX | [alex](https://github.com/wooorm/alex), [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [alex](https://github.com/wooorm/alex), [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [remark-lint](https://github.com/wooorm/remark-lint) !!, [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| Markdown | [alex](https://github.com/wooorm/alex), [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | @@ -135,7 +135,7 @@ formatting. | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| reStructuredText | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [rstcheck](https://github.com/myint/rstcheck), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Re:VIEW | [redpen](http://redpen.cc/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | diff --git a/doc/ale.txt b/doc/ale.txt index f16858e..1fe5895 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -275,12 +275,12 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` * API Blueprint: `drafter` -* AsciiDoc: `alex`, `proselint`, `write-good`, `redpen` +* AsciiDoc: `alex`, `proselint`, `redpen`, `write-good` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` * Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` * C: `cppcheck`, `cpplint`!!, `gcc`, `clang`, `clangtidy`!!, `clang-format` -* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `cppcheck`, `cpplint`!!, `gcc`, `clang-format` +* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `gcc` * CUDA: `nvcc`!! * C#: `mcs`, `mcsc`!! * Chef: `foodcritic` @@ -312,13 +312,13 @@ Notes: * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `alex`, `chktex`, `lacheck`, `proselint`, `write-good`, `redpen` +* LaTeX (tex): `alex`, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` * Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` * Lua: `luacheck` * Mail: `alex`, `proselint`, `vale` * Make: `checkmake` -* Markdown: `alex`, `mdl`, `proselint`, `vale`, `remark-lint`, `write-good`, `redpen` +* Markdown: `alex`, `mdl`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` @@ -335,7 +335,7 @@ Notes: * Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` -* reStructuredText: `alex`, `proselint`, `rstcheck`, `write-good`, `redpen` +* reStructuredText: `alex`, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good` * Re:VIEW: `redpen` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` From e4821c7f2f6f562368e13937876e1b109e912a74 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 10:37:21 +0000 Subject: [PATCH 284/390] Indicate that 4.2.0 is no longer strictly required for prettier-eslint, and add links for prettier-eslint and prettier-standard --- README.md | 2 +- doc/ale.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 35bb29e..ec8788a 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ formatting. | HTML | [alex](https://github.com/wooorm/alex), [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html), [google-java-format](https://github.com/google/google-java-format) | -| JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), prettier-eslint >= 4.2.0, prettier-standard, [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) +| JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), [prettier-eslint](https://github.com/prettier/prettier-eslint), [prettier-standard](https://github.com/sheerun/prettier-standard), [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [alex](https://github.com/wooorm/alex), [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | diff --git a/doc/ale.txt b/doc/ale.txt index 1fe5895..b7f14f8 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -309,7 +309,7 @@ Notes: * HTML: `alex`, `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac`, `google-java-format` -* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` +* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `alex`, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` From 8afd9a70a602a877f09f39ab34fbd1feb81ebc87 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 11:14:10 +0000 Subject: [PATCH 285/390] #1212 Fix some echo cursor flashing by only echoing once all linters are finished. --- autoload/ale/engine.vim | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 65e663a..8441ad1 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -306,13 +306,13 @@ function! ale#engine#SetResults(buffer, loclist) abort call ale#highlight#SetHighlights(a:buffer, a:loclist) endif - if g:ale_echo_cursor - " Try and echo the warning now. - " This will only do something meaningful if we're in normal mode. - call ale#cursor#EchoCursorWarning() - endif - if l:linting_is_done + if g:ale_echo_cursor + " Try and echo the warning now. + " This will only do something meaningful if we're in normal mode. + call ale#cursor#EchoCursorWarning() + endif + " Reset the save event marker, used for opening windows, etc. call setbufvar(a:buffer, 'ale_save_event_fired', 0) From e0c3cbd16f2e29464667d7bf56936312f712185a Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 11:22:24 +0000 Subject: [PATCH 286/390] Remove some now redundant echo code --- autoload/ale/cursor.vim | 38 ++++++++++++-------------------------- 1 file changed, 12 insertions(+), 26 deletions(-) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index abe3c5a..68dab75 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -4,37 +4,23 @@ let s:cursor_timer = -1 let s:last_pos = [0, 0, 0] -function! s:EchoWithShortMess(setting, message) abort - " We need to remember the setting for shormess and reset it again. - let l:shortmess_options = getbufvar('%', '&shortmess') - - try - " Turn shortmess on or off. - if a:setting is# 'on' - setlocal shortmess+=T - " echomsg is needed for the message to get truncated and appear in - " the message history. - exec "norm! :echomsg a:message\n" - elseif a:setting is# 'off' - setlocal shortmess-=T - " Regular echo is needed for printing newline characters. - execute 'echo a:message' - else - throw 'Invalid setting: ' . string(a:setting) - endif - finally - call setbufvar('%', '&shortmess', l:shortmess_options) - endtry -endfunction - -function! ale#cursor#TruncatedEcho(message) abort - let l:message = a:message +function! ale#cursor#TruncatedEcho(original_message) abort + let l:message = a:original_message " Change tabs to spaces. let l:message = substitute(l:message, "\t", ' ', 'g') " Remove any newlines in the message. let l:message = substitute(l:message, "\n", '', 'g') - call s:EchoWithShortMess('on', l:message) + " We need to remember the setting for shortmess and reset it again. + let l:shortmess_options = &l:shortmess + + try + " The message is truncated and saved to the history. + setlocal shortmess+=T + exec "norm! :echomsg l:message\n" + finally + let &l:shortmess = l:shortmess_options + endtry endfunction function! s:FindItemAtCursor() abort From 31241e9ed89ddad6c015d0f9ca9bb8a4de80332e Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 12:01:05 +0000 Subject: [PATCH 287/390] Get the TSLint tempname test running on Windows --- test/handler/test_tslint_handler.vader | 57 ++++++++++++++------------ 1 file changed, 31 insertions(+), 26 deletions(-) diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index 4c551dc..bbaef83 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -12,6 +12,9 @@ After: Restore unlet! b:ale_typescript_tslint_ignore_empty_files + unlet! b:relative_to_root + unlet! b:tempname_suffix + unlet! b:relative_tempname call ale#test#RestoreDirectory() call ale#linter#Reset() @@ -282,29 +285,31 @@ Execute(The tslint handler should not report no-implicit-dependencies errors): \ }])]) Execute(The tslint handler should set filename keys for temporary files): - if !has('win32') - " The temporay filename below is hacked into being a relative path so we can - " test that we resolve the temporary filename first. - AssertEqual - \ [ - \ {'lnum': 47, 'col': 1, 'code': 'curly', 'end_lnum': 47, 'type': 'E', 'end_col': 26, 'text': 'if statements must be braced'}, - \ ], - \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ - \ { - \ 'endPosition': { - \ 'character':25, - \ 'line':46, - \ 'position':1383, - \ }, - \ 'failure': 'if statements must be braced', - \ 'name': substitute(substitute(substitute(expand('%:p'), '[^/\\]', '', 'g'), '.', '../', 'g') . tempname(), '\([A-Z]:\\\)[A-Z]:', '\1', ''), - \ 'ruleName': 'curly', - \ 'ruleSeverity':'ERROR', - \ 'startPosition': { - \ 'character':0, - \ 'line':46, - \ 'position':1358, - \ } - \ }, - \ ])]) - endif + " The temporay filename below is hacked into being a relative path so we can + " test that we resolve the temporary filename first. + let b:relative_to_root = substitute(expand('%:p'), '\v[^/\\]*([/\\])[^/\\]*', has('win32') ? '..\' : '../', 'g') + let b:tempname_suffix = substitute(tempname(), '^\v([A-Z]:)?[/\\]', '', '') + let b:relative_tempname = b:relative_to_root . b:tempname_suffix + + AssertEqual + \ [ + \ {'lnum': 47, 'col': 1, 'code': 'curly', 'end_lnum': 47, 'type': 'E', 'end_col': 26, 'text': 'if statements must be braced'}, + \ ], + \ ale_linters#typescript#tslint#Handle(bufnr(''), [json_encode([ + \ { + \ 'endPosition': { + \ 'character':25, + \ 'line':46, + \ 'position':1383, + \ }, + \ 'failure': 'if statements must be braced', + \ 'name': b:relative_tempname, + \ 'ruleName': 'curly', + \ 'ruleSeverity':'ERROR', + \ 'startPosition': { + \ 'character':0, + \ 'line':46, + \ 'position':1358, + \ } + \ }, + \ ])]) From fdaac9bd781baf85d04d6b3138a2b80cd7b3a25d Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 18 Dec 2017 13:27:59 +0000 Subject: [PATCH 288/390] Fix #1210 - Fix a Windows path issue which broke TSLint --- autoload/ale/c.vim | 6 +- autoload/ale/path.vim | 31 +++++--- test/handler/test_javac_handler.vader | 10 +-- test/handler/test_tslint_handler.vader | 4 +- test/test_c_import_paths.vader | 18 ++--- test/test_get_abspath.vader | 22 ++++-- test/test_path_upwards.vader | 98 ++++++++++++-------------- 7 files changed, 106 insertions(+), 83 deletions(-) diff --git a/autoload/ale/c.vim b/autoload/ale/c.vim index b9f9439..f6ad7de 100644 --- a/autoload/ale/c.vim +++ b/autoload/ale/c.vim @@ -1,6 +1,8 @@ " Author: gagbo , w0rp " Description: Functions for integrating with C-family linters. +let s:sep = has('win32') ? '\' : '/' + function! ale#c#FindProjectRoot(buffer) abort for l:project_filename in ['.git/HEAD', 'configure', 'Makefile', 'CMakeLists.txt'] let l:full_path = ale#path#FindNearestFile(a:buffer, l:project_filename) @@ -47,7 +49,7 @@ function! ale#c#FindLocalHeaderPaths(buffer) abort " If we find an 'include' directory in the project root, then use that. if isdirectory(l:project_root . '/include') - return [ale#path#Simplify(l:project_root . '/include')] + return [ale#path#Simplify(l:project_root . s:sep . 'include')] endif return [] @@ -79,7 +81,7 @@ let g:ale_c_build_dir_names = get(g:, 'ale_c_build_dir_names', [ function! ale#c#FindCompileCommands(buffer) abort for l:path in ale#path#Upwards(expand('#' . a:buffer . ':p:h')) for l:dirname in ale#Var(a:buffer, 'c_build_dir_names') - let l:c_build_dir = l:path . '/' . l:dirname + let l:c_build_dir = l:path . s:sep . l:dirname if filereadable(l:c_build_dir . '/compile_commands.json') return l:c_build_dir diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index 57e607a..b0f4dca 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -1,14 +1,23 @@ " Author: w0rp " Description: Functions for working with paths in the filesystem. +" simplify a path, and fix annoying issues with paths on Windows. +" +" Forward slashes are changed to back slashes so path equality works better. +" +" Paths starting with more than one forward slash are changed to only one +" forward slash, to prevent the paths being treated as special MSYS paths. function! ale#path#Simplify(path) abort - " //foo is turned into /foo to stop Windows doing stupid things with - " search paths. - return substitute(simplify(a:path), '^//\+', '/', 'g') " no-custom-checks + if has('unix') + return substitute(simplify(a:path), '^//\+', '/', 'g') " no-custom-checks + endif + + let l:win_path = substitute(a:path, '/', '\\', 'g') + + return substitute(simplify(l:win_path), '^\\\+', '\', 'g') " no-custom-checks endfunction " This function is mainly used for testing. -" Simplify() a path, and change forward slashes to back slashes on Windows. " " If an additional 'add_drive' argument is given, the current drive letter " will be prefixed to any absolute paths on Windows. @@ -16,8 +25,6 @@ function! ale#path#Winify(path, ...) abort let l:new_path = ale#path#Simplify(a:path) if has('win32') - let l:new_path = substitute(l:new_path, '/', '\\', 'g') - " Add a drive letter to \foo\bar paths, if needed. if a:0 && a:1 is# 'add_drive' && l:new_path[:0] is# '\' let l:new_path = fnamemodify('.', ':p')[:1] . l:new_path @@ -86,6 +93,10 @@ endfunction " Return 1 if a path is an absolute path. function! ale#path#IsAbsolute(filename) abort + if has('win32') && a:filename[:0] is# '\' + return 1 + endif + " Check for /foo and C:\foo, etc. return a:filename[:0] is# '/' || a:filename[1:2] is# ':\' endfunction @@ -103,7 +114,7 @@ endfunction " directory, return the absolute path to the file. function! ale#path#GetAbsPath(base_directory, filename) abort if ale#path#IsAbsolute(a:filename) - return a:filename + return ale#path#Simplify(a:filename) endif let l:sep = has('win32') ? '\' : '/' @@ -145,8 +156,8 @@ endfunction " Given a path, return every component of the path, moving upwards. function! ale#path#Upwards(path) abort - let l:pattern = ale#Has('win32') ? '\v/+|\\+' : '\v/+' - let l:sep = ale#Has('win32') ? '\' : '/' + let l:pattern = has('win32') ? '\v/+|\\+' : '\v/+' + let l:sep = has('win32') ? '\' : '/' let l:parts = split(ale#path#Simplify(a:path), l:pattern) let l:path_list = [] @@ -155,7 +166,7 @@ function! ale#path#Upwards(path) abort let l:parts = l:parts[:-2] endwhile - if ale#Has('win32') && a:path =~# '^[a-zA-z]:\' + if has('win32') && a:path =~# '^[a-zA-z]:\' " Add \ to C: for C:\, etc. let l:path_list[-1] .= '\' elseif a:path[0] is# '/' diff --git a/test/handler/test_javac_handler.vader b/test/handler/test_javac_handler.vader index 3997b42..6189e6e 100644 --- a/test/handler/test_javac_handler.vader +++ b/test/handler/test_javac_handler.vader @@ -12,33 +12,33 @@ Execute(The javac handler should handle cannot find symbol errors): AssertEqual \ [ \ { - \ 'filename': '/tmp/vLPr4Q5/33/foo.java', + \ 'filename': ale#path#Simplify('/tmp/vLPr4Q5/33/foo.java'), \ 'lnum': 1, \ 'text': 'error: some error', \ 'type': 'E', \ }, \ { - \ 'filename': '/tmp/vLPr4Q5/33/foo.java', + \ 'filename': ale#path#Simplify('/tmp/vLPr4Q5/33/foo.java'), \ 'lnum': 2, \ 'col': 5, \ 'text': 'error: cannot find symbol: BadName', \ 'type': 'E', \ }, \ { - \ 'filename': '/tmp/vLPr4Q5/33/foo.java', + \ 'filename': ale#path#Simplify('/tmp/vLPr4Q5/33/foo.java'), \ 'lnum': 34, \ 'col': 5, \ 'text': 'error: cannot find symbol: BadName2', \ 'type': 'E', \ }, \ { - \ 'filename': '/tmp/vLPr4Q5/33/foo.java', + \ 'filename': ale#path#Simplify('/tmp/vLPr4Q5/33/foo.java'), \ 'lnum': 37, \ 'text': 'warning: some warning', \ 'type': 'W', \ }, \ { - \ 'filename': '/tmp/vLPr4Q5/33/foo.java', + \ 'filename': ale#path#Simplify('/tmp/vLPr4Q5/33/foo.java'), \ 'lnum': 42, \ 'col': 11, \ 'text': 'error: cannot find symbol: bar()', diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index bbaef83..8d263ef 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -287,9 +287,9 @@ Execute(The tslint handler should not report no-implicit-dependencies errors): Execute(The tslint handler should set filename keys for temporary files): " The temporay filename below is hacked into being a relative path so we can " test that we resolve the temporary filename first. - let b:relative_to_root = substitute(expand('%:p'), '\v[^/\\]*([/\\])[^/\\]*', has('win32') ? '..\' : '../', 'g') + let b:relative_to_root = substitute(expand('%:p'), '\v[^/\\]*([/\\])[^/\\]*', '../', 'g') let b:tempname_suffix = substitute(tempname(), '^\v([A-Z]:)?[/\\]', '', '') - let b:relative_tempname = b:relative_to_root . b:tempname_suffix + let b:relative_tempname = substitute(b:relative_to_root . b:tempname_suffix, '\\', '/', 'g') AssertEqual \ [ diff --git a/test/test_c_import_paths.vader b/test/test_c_import_paths.vader index af185ea..21e49a3 100644 --- a/test/test_c_import_paths.vader +++ b/test/test_c_import_paths.vader @@ -40,7 +40,7 @@ Execute(The C GCC handler should include 'include' directories for projects with \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -53,7 +53,7 @@ Execute(The C GCC handler should include 'include' directories for projects with \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -92,7 +92,7 @@ Execute(The C Clang handler should include 'include' directories for projects wi \ ale#Escape('clang') \ . ' -S -x c -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#c#clang#GetCommand(bufnr('')) @@ -144,7 +144,7 @@ Execute(The C++ GCC handler should include 'include' directories for projects wi \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -157,7 +157,7 @@ Execute(The C++ GCC handler should include 'include' directories for projects wi \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -196,7 +196,7 @@ Execute(The C++ Clang handler should include 'include' directories for projects \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -209,7 +209,7 @@ Execute(The C++ Clang handler should include 'include' directories for projects \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -256,7 +256,7 @@ Execute(The C++ Clang handler shoud use the include directory based on the .git \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/git_and_nested_makefiles/src')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/git_and_nested_makefiles') . '/include') . ' ' + \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/git_and_nested_makefiles/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -268,7 +268,7 @@ Execute(The C++ ClangTidy handler should include json folders for projects with AssertEqual \ ale#Escape('clang-tidy') \ . ' -checks=' . ale#Escape('*') . ' %s ' - \ . '-p ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/json_project') . '/build') + \ . '-p ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/json_project/build')) \ , ale_linters#cpp#clangtidy#GetCommand(bufnr('')) Execute(Move .git/HEAD back): diff --git a/test/test_get_abspath.vader b/test/test_get_abspath.vader index 5f81380..7e1b593 100644 --- a/test/test_get_abspath.vader +++ b/test/test_get_abspath.vader @@ -1,15 +1,29 @@ Execute(Relative paths should be resolved correctly): AssertEqual - \ '/foo/bar/baz/whatever.txt', + \ has('win32') ? '\foo\bar\baz\whatever.txt' : '/foo/bar/baz/whatever.txt', \ ale#path#GetAbsPath('/foo/bar/xyz', '../baz/whatever.txt') AssertEqual - \ has('win32') ? '/foo/bar/xyz\whatever.txt' : '/foo/bar/xyz/whatever.txt', + \ has('win32') ? '\foo\bar\xyz\whatever.txt' : '/foo/bar/xyz/whatever.txt', \ ale#path#GetAbsPath('/foo/bar/xyz', './whatever.txt') AssertEqual - \ has('win32') ? '/foo/bar/xyz\whatever.txt' : '/foo/bar/xyz/whatever.txt', + \ has('win32') ? '\foo\bar\xyz\whatever.txt' : '/foo/bar/xyz/whatever.txt', \ ale#path#GetAbsPath('/foo/bar/xyz', 'whatever.txt') + if has('win32') + AssertEqual + \ 'C:\foo\bar\baz\whatever.txt', + \ ale#path#GetAbsPath('C:\foo\bar\baz\xyz', '../whatever.txt') + endif + Execute(Absolute paths should be resolved correctly): AssertEqual - \ '/ding/dong', + \ has('win32') ? '\ding\dong' : '/ding/dong', \ ale#path#GetAbsPath('/foo/bar/xyz', '/ding/dong') + + AssertEqual + \ has('win32') ? '\ding\dong' : '/ding/dong', + \ ale#path#GetAbsPath('/foo/bar/xyz', '//ding/dong') + + if has('win32') + AssertEqual '\ding', ale#path#GetAbsPath('/foo/bar/xyz', '\\ding') + endif diff --git a/test/test_path_upwards.vader b/test/test_path_upwards.vader index 8b81a10..cd461a2 100644 --- a/test/test_path_upwards.vader +++ b/test/test_path_upwards.vader @@ -1,52 +1,48 @@ -After: - let g:ale_has_override = {} +Execute(ale#path#Upwards should return the correct path components): + if has('unix') + " Absolute paths should include / on the end. + AssertEqual + \ ['/foo/bar/baz', '/foo/bar', '/foo', '/'], + \ ale#path#Upwards('/foo/bar/baz') + AssertEqual + \ ['/foo/bar/baz', '/foo/bar', '/foo', '/'], + \ ale#path#Upwards('/foo/bar/baz///') + " Relative paths do not. + AssertEqual + \ ['foo/bar/baz', 'foo/bar', 'foo'], + \ ale#path#Upwards('foo/bar/baz') + AssertEqual + \ ['foo2/bar', 'foo2'], + \ ale#path#Upwards('foo//..////foo2////bar') + " Expect an empty List for empty strings. + AssertEqual [], ale#path#Upwards('') + endif -Execute(ale#path#Upwards should return the correct path components for Unix): - let g:ale_has_override = {'win32': 0} - - " Absolute paths should include / on the end. - AssertEqual - \ ['/foo/bar/baz', '/foo/bar', '/foo', '/'], - \ ale#path#Upwards('/foo/bar/baz') - AssertEqual - \ ['/foo/bar/baz', '/foo/bar', '/foo', '/'], - \ ale#path#Upwards('/foo/bar/baz///') - " Relative paths do not. - AssertEqual - \ ['foo/bar/baz', 'foo/bar', 'foo'], - \ ale#path#Upwards('foo/bar/baz') - AssertEqual - \ ['foo2/bar', 'foo2'], - \ ale#path#Upwards('foo//..////foo2////bar') - " Expect an empty List for empty strings. - AssertEqual [], ale#path#Upwards('') - -Execute(ale#path#Upwards should return the correct path components for Windows): - let g:ale_has_override = {'win32': 1} - - AssertEqual - \ ['C:\foo\bar\baz', 'C:\foo\bar', 'C:\foo', 'C:\'], - \ ale#path#Upwards('C:\foo\bar\baz') - AssertEqual - \ ['C:\foo\bar\baz', 'C:\foo\bar', 'C:\foo', 'C:\'], - \ ale#path#Upwards('C:\foo\bar\baz\\\') - AssertEqual - \ ['/foo\bar\baz', '/foo\bar', '/foo', '/'], - \ ale#path#Upwards('/foo/bar/baz') - AssertEqual - \ ['foo\bar\baz', 'foo\bar', 'foo'], - \ ale#path#Upwards('foo/bar/baz') - AssertEqual - \ ['foo\bar\baz', 'foo\bar', 'foo'], - \ ale#path#Upwards('foo\bar\baz') - " simplify() is used internally, and should sort out \ paths when actually - " running Windows, which we can't test here. - AssertEqual - \ ['foo2\bar', 'foo2'], - \ ale#path#Upwards('foo//..///foo2////bar') - " Expect an empty List for empty strings. - AssertEqual [], ale#path#Upwards('') - " Paths starting with // return / - AssertEqual - \ ['/foo2\bar', '/foo2', '/'], - \ ale#path#Upwards('//foo//..///foo2////bar') + if has('win32') + AssertEqual + \ ['C:\foo\bar\baz', 'C:\foo\bar', 'C:\foo', 'C:\'], + \ ale#path#Upwards('C:\foo\bar\baz') + AssertEqual + \ ['C:\foo\bar\baz', 'C:\foo\bar', 'C:\foo', 'C:\'], + \ ale#path#Upwards('C:\foo\bar\baz\\\') + AssertEqual + \ ['/foo\bar\baz', '/foo\bar', '/foo', '/'], + \ ale#path#Upwards('/foo/bar/baz') + AssertEqual + \ ['foo\bar\baz', 'foo\bar', 'foo'], + \ ale#path#Upwards('foo/bar/baz') + AssertEqual + \ ['foo\bar\baz', 'foo\bar', 'foo'], + \ ale#path#Upwards('foo\bar\baz') + " simplify() is used internally, and should sort out \ paths when actually + " running Windows, which we can't test here. + AssertEqual + \ ['foo2\bar', 'foo2'], + \ ale#path#Upwards('foo//..///foo2////bar') + " Expect an empty List for empty strings. + AssertEqual [], ale#path#Upwards('') + " Paths starting with // return / + AssertEqual + \ ['/foo2\bar', '/foo2', '/'], + \ ale#path#Upwards('//foo//..///foo2////bar') + endif From 1e574ed5f7c9d3b6b0b3b4d209984102eba079b2 Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Mon, 18 Dec 2017 15:26:52 +0100 Subject: [PATCH 289/390] Make alex a file linter alex does not find its configuration file when using temporary files for input. --- README.md | 24 ++++++++++++------------ ale_linters/asciidoc/alex.vim | 5 +++-- ale_linters/help/alex.vim | 3 ++- ale_linters/html/alex.vim | 3 ++- ale_linters/mail/alex.vim | 3 ++- ale_linters/markdown/alex.vim | 3 ++- ale_linters/nroff/alex.vim | 3 ++- ale_linters/pod/alex.vim | 3 ++- ale_linters/rst/alex.vim | 3 ++- ale_linters/tex/alex.vim | 3 ++- ale_linters/texinfo/alex.vim | 3 ++- ale_linters/text/alex.vim | 3 ++- ale_linters/xhtml/alex.vim | 3 ++- doc/ale.txt | 24 ++++++++++++------------ 14 files changed, 49 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index ec8788a..e939e6f 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ formatting. | ASM | [gcc](https://gcc.gnu.org) | | Ansible | [ansible-lint](https://github.com/willthames/ansible-lint) | | API Blueprint | [drafter](https://github.com/apiaryio/drafter) | -| AsciiDoc | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [write-good](https://github.com/btford/write-good) | +| AsciiDoc | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [write-good](https://github.com/btford/write-good) | | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | @@ -106,36 +106,36 @@ formatting. | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | | Haskell | [brittany](https://github.com/lspitzner/brittany), [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | -| HTML | [alex](https://github.com/wooorm/alex), [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | +| HTML | [alex](https://github.com/wooorm/alex) !!, [HTMLHint](http://htmlhint.com/), [proselint](http://proselint.com/), [tidy](http://www.html-tidy.org/), [write-good](https://github.com/btford/write-good) | | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html), [google-java-format](https://github.com/google/google-java-format) | | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), [prettier-eslint](https://github.com/prettier/prettier-eslint), [prettier-standard](https://github.com/sheerun/prettier-standard), [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) | JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | -| LaTeX | [alex](https://github.com/wooorm/alex), [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | +| LaTeX | [alex](https://github.com/wooorm/alex) !!, [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | | Lua | [luacheck](https://github.com/mpeterv/luacheck) | -| Mail | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | +| Mail | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [alex](https://github.com/wooorm/alex), [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | +| Markdown | [alex](https://github.com/wooorm/alex) !!, [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | -| nroff | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| nroff | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| | Objective-C | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | -| Pod | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Pod | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | | ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | -| reStructuredText | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [rstcheck](https://github.com/myint/rstcheck), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | +| reStructuredText | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [rstcheck](https://github.com/myint/rstcheck), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Re:VIEW | [redpen](http://redpen.cc/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) | @@ -151,14 +151,14 @@ formatting. | Swift | [swiftlint](https://github.com/realm/SwiftLint), [swiftformat](https://github.com/nicklockwood/SwiftFormat) | | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | | Terraform | [tflint](https://github.com/wata727/tflint) | -| Texinfo | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| -| Text^ | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | +| Texinfo | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)| +| Text^ | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) | | Thrift | [thrift](http://thrift.apache.org/) | | TypeScript | [eslint](http://eslint.org/), [prettier](https://github.com/prettier/prettier), [tslint](https://github.com/palantir/tslint), tsserver, typecheck | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | | Vim | [vint](https://github.com/Kuniwak/vint) | -| Vim help^ | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | -| XHTML | [alex](https://github.com/wooorm/alex), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Vim help^ | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| XHTML | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | XML | [xmllint](http://xmlsoft.org/xmllint.html) | | YAML | [swaglint](https://github.com/byCedric/swaglint), [yamllint](https://yamllint.readthedocs.io/) | diff --git a/ale_linters/asciidoc/alex.vim b/ale_linters/asciidoc/alex.vim index a1e50de..79b04fc 100644 --- a/ale_linters/asciidoc/alex.vim +++ b/ale_linters/asciidoc/alex.vim @@ -1,10 +1,11 @@ " Author: Johannes Wienke " Description: alex for asciidoc files -call ale#linter#Define('asciidoc', { +call ale#linter#Define('help', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/help/alex.vim b/ale_linters/help/alex.vim index 9b3e4ee..21b23b4 100644 --- a/ale_linters/help/alex.vim +++ b/ale_linters/help/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('help', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/html/alex.vim b/ale_linters/html/alex.vim index 85dc4fd..5a1f61e 100644 --- a/ale_linters/html/alex.vim +++ b/ale_linters/html/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('html', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/mail/alex.vim b/ale_linters/mail/alex.vim index 047e6cf..b0651cc 100644 --- a/ale_linters/mail/alex.vim +++ b/ale_linters/mail/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('mail', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/markdown/alex.vim b/ale_linters/markdown/alex.vim index 1e3e368..2930614 100644 --- a/ale_linters/markdown/alex.vim +++ b/ale_linters/markdown/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('markdown', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/nroff/alex.vim b/ale_linters/nroff/alex.vim index 911ac41..a10db2d 100644 --- a/ale_linters/nroff/alex.vim +++ b/ale_linters/nroff/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('nroff', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/pod/alex.vim b/ale_linters/pod/alex.vim index 8bc205d..5c09bef 100644 --- a/ale_linters/pod/alex.vim +++ b/ale_linters/pod/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('pod', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/rst/alex.vim b/ale_linters/rst/alex.vim index 1fed723..e637eae 100644 --- a/ale_linters/rst/alex.vim +++ b/ale_linters/rst/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('rst', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/tex/alex.vim b/ale_linters/tex/alex.vim index da82856..78c530f 100644 --- a/ale_linters/tex/alex.vim +++ b/ale_linters/tex/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('tex', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/texinfo/alex.vim b/ale_linters/texinfo/alex.vim index 41969fd..4a88457 100644 --- a/ale_linters/texinfo/alex.vim +++ b/ale_linters/texinfo/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('texinfo', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/text/alex.vim b/ale_linters/text/alex.vim index 32d8ce2..c696367 100644 --- a/ale_linters/text/alex.vim +++ b/ale_linters/text/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('text', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/ale_linters/xhtml/alex.vim b/ale_linters/xhtml/alex.vim index cf073cb..60a9a7c 100644 --- a/ale_linters/xhtml/alex.vim +++ b/ale_linters/xhtml/alex.vim @@ -4,7 +4,8 @@ call ale#linter#Define('xhtml', { \ 'name': 'alex', \ 'executable': 'alex', -\ 'command': 'alex %t -t', +\ 'command': 'alex %s -t', \ 'output_stream': 'stderr', \ 'callback': 'ale#handlers#alex#Handle', +\ 'lint_file': 1, \}) diff --git a/doc/ale.txt b/doc/ale.txt index b7f14f8..bdcb39f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -275,7 +275,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` * API Blueprint: `drafter` -* AsciiDoc: `alex`, `proselint`, `redpen`, `write-good` +* AsciiDoc: `alex`!!, `proselint`, `redpen`, `write-good` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` * Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` @@ -306,36 +306,36 @@ Notes: * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` -* HTML: `alex`, `HTMLHint`, `proselint`, `tidy`, `write-good` +* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac`, `google-java-format` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `alex`, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` +* LaTeX (tex): `alex`!!, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` * Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` * Lua: `luacheck` -* Mail: `alex`, `proselint`, `vale` +* Mail: `alex`!!, `proselint`, `vale` * Make: `checkmake` -* Markdown: `alex`, `mdl`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` +* Markdown: `alex`!!, `mdl`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` -* nroff: `alex`, `proselint`, `write-good` +* nroff: `alex`!!, `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` -* Pod: `alex`, `proselint`, `write-good` +* Pod: `alex`!!, `proselint`, `write-good` * proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin`, `ols`, `refmt` -* reStructuredText: `alex`, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good` +* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good` * Re:VIEW: `redpen` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` @@ -351,14 +351,14 @@ Notes: * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! * Terraform: `tflint` -* Texinfo: `alex`, `proselint`, `write-good` -* Text^: `alex`, `proselint`, `vale`, `write-good`, `redpen` +* Texinfo: `alex`!!, `proselint`, `write-good` +* Text^: `alex`!!, `proselint`, `vale`, `write-good`, `redpen` * Thrift: `thrift` * TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck` * Verilog: `iverilog`, `verilator` * Vim: `vint` -* Vim help^: `alex`, `proselint`, `write-good` -* XHTML: `alex`, `proselint`, `write-good` +* Vim help^: `alex`!!, `proselint`, `write-good` +* XHTML: `alex`!!, `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` From 79aaec5a99c2fa4455758d4b0483b13fe4e0db78 Mon Sep 17 00:00:00 2001 From: Johannes Wienke Date: Mon, 18 Dec 2017 17:10:57 +0100 Subject: [PATCH 290/390] Missing warning level 'suggestion' for vale Vale can also, optionally, raise suggestions. These weren't covered yet. --- autoload/ale/handlers/vale.vim | 2 ++ test/handler/test_vale_handler.vader | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/autoload/ale/handlers/vale.vim b/autoload/ale/handlers/vale.vim index c842057..9dc0872 100644 --- a/autoload/ale/handlers/vale.vim +++ b/autoload/ale/handlers/vale.vim @@ -4,6 +4,8 @@ function! ale#handlers#vale#GetType(severity) abort if a:severity is? 'warning' return 'W' + elseif a:severity is? 'suggestion' + return 'I' endif return 'E' diff --git a/test/handler/test_vale_handler.vader b/test/handler/test_vale_handler.vader index afc32db..37badb4 100644 --- a/test/handler/test_vale_handler.vader +++ b/test/handler/test_vale_handler.vader @@ -32,6 +32,14 @@ Execute(The vale handler should handle a normal example): \ 'text': "'Documentation' is repeated!", \ 'code': 'vale.Repetition', \ }, + \ { + \ 'lnum': 7, + \ 'col': 1, + \ 'end_col': 27, + \ 'type': 'I', + \ 'text': "'Documentation' is repeated!", + \ 'code': 'vale.Repetition', + \ }, \ ], \ ale#handlers#vale#Handle(bufnr(''), [ \ '{', @@ -61,6 +69,19 @@ Execute(The vale handler should handle a normal example): \ ' 27', \ ' ],', \ ' "Hide": false', + \ ' },', + \ ' {', + \ ' "Check": "vale.Repetition",', + \ ' "Description": "",', + \ ' "Line": 7,', + \ ' "Link": "",', + \ " \"Message\": \"'Documentation' is repeated!\",", + \ ' "Severity": "suggestion",', + \ ' "Span": [', + \ ' 1,', + \ ' 27', + \ ' ],', + \ ' "Hide": false', \ ' }', \ ' ]', \ '}', From 2cacba5758614beadee38e493df957206aae8dde Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 12:06:08 +0000 Subject: [PATCH 291/390] Fix #1228 - Reset the cursor if echoing a message moves it --- autoload/ale/cursor.vim | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 68dab75..25e91e7 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -15,9 +15,18 @@ function! ale#cursor#TruncatedEcho(original_message) abort let l:shortmess_options = &l:shortmess try + let l:cursor_position = getcurpos() + " The message is truncated and saved to the history. setlocal shortmess+=T exec "norm! :echomsg l:message\n" + + " Reset the cursor position if we moved off the end of the line. + " Using :norm and :echomsg can move the cursor off the end of the + " line. + if l:cursor_position != getcurpos() + call setpos('.', l:cursor_position) + endif finally let &l:shortmess = l:shortmess_options endtry From 532594839c2ee435e9f240bb699694b991fac56e Mon Sep 17 00:00:00 2001 From: Jelte Fennema Date: Tue, 19 Dec 2017 13:21:30 +0100 Subject: [PATCH 292/390] erb: fix tests --- test/command_callback/test_erb_command_callback.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/command_callback/test_erb_command_callback.vader b/test/command_callback/test_erb_command_callback.vader index 9b1d223..481f64f 100644 --- a/test/command_callback/test_erb_command_callback.vader +++ b/test/command_callback/test_erb_command_callback.vader @@ -10,7 +10,7 @@ Execute(Executable should not contain any filter code by default): call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb') AssertEqual - \ 'erb -P -x %t | ruby -c', + \ 'erb -P -T - -x %t | ruby -c', \ ale_linters#eruby#erb#GetCommand(bufnr('')) Execute(Executable should filter invalid eRuby when inside a Rails project): From d2bea5c3101e9f198492efb8ca294e63e62415a4 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 14:43:18 +0000 Subject: [PATCH 293/390] Allow the cursor messages to be disabled while Vim is running --- autoload/ale/cursor.vim | 8 ++++++++ test/test_cursor_warnings.vader | 11 +++++++++++ 2 files changed, 19 insertions(+) diff --git a/autoload/ale/cursor.vim b/autoload/ale/cursor.vim index 25e91e7..50b1fb5 100644 --- a/autoload/ale/cursor.vim +++ b/autoload/ale/cursor.vim @@ -55,6 +55,10 @@ function! ale#cursor#EchoCursorWarning(...) abort endfunction function! s:EchoImpl() abort + if !g:ale_echo_cursor + return + endif + " Only echo the warnings in normal mode, otherwise we will get problems. if mode() isnot# 'n' return @@ -81,6 +85,10 @@ function! s:EchoImpl() abort endfunction function! ale#cursor#EchoCursorWarningWithDelay() abort + if !g:ale_echo_cursor + return + endif + " Only echo the warnings in normal mode, otherwise we will get problems. if mode() isnot# 'n' return diff --git a/test/test_cursor_warnings.vader b/test/test_cursor_warnings.vader index f112d8d..1959221 100644 --- a/test/test_cursor_warnings.vader +++ b/test/test_cursor_warnings.vader @@ -1,5 +1,6 @@ Before: Save g:ale_echo_msg_format + Save g:ale_echo_cursor let g:ale_buffer_info = { \ bufnr('%'): { @@ -66,6 +67,7 @@ Before: let g:ale_set_loclist = 0 let g:ale_set_signs = 0 let g:ale_set_highlights = 0 + let g:ale_echo_cursor = 1 function GetLastMessage() redir => l:output @@ -222,3 +224,12 @@ Execute(The buffer message format option should take precedence): call ale#cursor#EchoCursorWarning() AssertEqual 'FOO Some information', GetLastMessage() + +Execute(The cursor message shouldn't be echoed if the option is off): + let g:ale_echo_cursor = 0 + echom 'foo' + + call cursor(1, 1) + call ale#cursor#EchoCursorWarning() + + AssertEqual 'foo', GetLastMessage() From f74e22b938798a6bd64e6fa55754c3e7e28285dd Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 15:35:57 +0000 Subject: [PATCH 294/390] Clean up ALE linter buffer data when buffers are deleted, not unloaded --- plugin/ale.vim | 2 +- test/test_autocmd_commands.vader | 2 +- test/test_cleanup.vader | 25 ++++++++++++------------- 3 files changed, 14 insertions(+), 15 deletions(-) diff --git a/plugin/ale.vim b/plugin/ale.vim index a07915f..2f613b5 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -285,7 +285,7 @@ call ale#toggle#InitAuGroups() augroup ALECleanupGroup autocmd! " Clean up buffers automatically when they are unloaded. - autocmd BufUnload * call ale#engine#Cleanup(str2nr(expand(''))) + autocmd BufDelete * call ale#engine#Cleanup(str2nr(expand(''))) autocmd QuitPre * call ale#events#QuitEvent(str2nr(expand(''))) augroup END diff --git a/test/test_autocmd_commands.vader b/test/test_autocmd_commands.vader index e7e9e86..c03e8fb 100644 --- a/test/test_autocmd_commands.vader +++ b/test/test_autocmd_commands.vader @@ -191,7 +191,7 @@ Execute (g:ale_echo_cursor = 1 should bind cursor events): Execute (ALECleanupGroup should include the right commands): AssertEqual [ - \ 'BufUnload * call ale#engine#Cleanup(str2nr(expand('''')))', + \ 'BufDelete * call ale#engine#Cleanup(str2nr(expand('''')))', \ 'QuitPre * call ale#events#QuitEvent(str2nr(expand('''')))', \], CheckAutocmd('ALECleanupGroup') diff --git a/test/test_cleanup.vader b/test/test_cleanup.vader index 23e5bcf..232874a 100644 --- a/test/test_cleanup.vader +++ b/test/test_cleanup.vader @@ -1,15 +1,14 @@ -Before: - let g:buffer = bufnr('%') - - let g:ale_buffer_info = { - \ g:buffer : {'temporary_file_list': [], 'temporary_directory_list': []}, - \ 10347: {'temporary_file_list': [], 'temporary_directory_list': []}, - \} - After: - unlet! g:buffer - let g:ale_buffer_info = {} + unlet! g:buffer + let g:ale_buffer_info = {} -Execute('ALE globals should be cleared when the buffer is closed.'): - :q! - AssertEqual {10347: {'temporary_file_list': [], 'temporary_directory_list': []}}, g:ale_buffer_info +Execute('ALE globals should be cleared when the buffer is deleted): + new + + let g:ale_buffer_info = { + \ bufnr(''): {'temporary_file_list': [], 'temporary_directory_list': []}, + \ 10347: {'temporary_file_list': [], 'temporary_directory_list': []}, + \} + + bdelete + AssertEqual {10347: {'temporary_file_list': [], 'temporary_directory_list': []}}, g:ale_buffer_info From 647c798eb79849d67c71825faf610136a4fc1a27 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 16:54:46 +0000 Subject: [PATCH 295/390] Fix #1226 - Update the mcsc documentation to make it clearer how to use it --- doc/ale-cs.txt | 72 ++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index eeb1abd..38ee23e 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -5,9 +5,9 @@ ALE C# Integration *ale-cs-options* =============================================================================== mcs *ale-cs-mcs* - The mcs linter checks the syntax of the '*.cs' file loaded in the current - buffer only. It uses the --parse option of the mcs compiler and implicitly - sets the -unsafe flag. + The `mcs` linter looks only for syntax errors while you type. See |ale-cs-mcsc| + for the separately configured linter for checking for semantic errors. + g:ale_cs_mcs_options *g:ale_cs_mcs_options* *b:ale_cs_mcs_options* @@ -17,7 +17,7 @@ g:ale_cs_mcs_options *g:ale_cs_mcs_options* This variable can be changed to pass additional flags given to mcs. - NOTE: The -unsafe flag is selected implicitly and thus does not need to be + NOTE: The -unsafe flag is selected implicitly and thus does not need to be explicitly included in the |g:ale_cs_mcs_options| or |b:ale_cs_mcs_options| parameter. @@ -25,49 +25,37 @@ g:ale_cs_mcs_options *g:ale_cs_mcs_options* =============================================================================== mcsc *ale-cs-mcsc* + The mcsc linter checks for semantic errors when files are opened or saved + See |ale-lint-file-linters| for more information on linters which do not + check for problems while you type. + The mcsc linter uses the mono mcs compiler to generate a temporary module target file (-t:module). The module includes including all '*.cs' files - contained in the directory tree rooted at the path defined by the + contained in the directory tree rooted at the path defined by the |g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable. - variable and all sub directories. + variable and all sub directories. - The paths to search for additional assembly ('*.dll') files can be - specified using the |g:ale_cs_mcsc_assembly_path| or - |b:ale_cs_mcsc_assembly_path| variable. The additional assembly files ('*.dll') - can be included through the |g:ale_cs_mcsc_assemblies| or - |b:ale_cs_mcsc_assemblies| parameter. + The paths to search for additional assembly files can be specified using the + |g:ale_cs_mcsc_assembly_path| or |b:ale_cs_mcsc_assembly_path| variables. + + NOTE: ALE will not any errors in files apart from syntax errors if any one + of the source files contains a syntax error. Syntax errors must be fixed + first before other errors will be shown. - NOTE: mcs compiles sources in multiple phases. It stops compilation after - finding errors during the current phase. - For example assume a file named 'FileWithTypeError.cs' is edited and saved - which contains a Type error. In the same directory tree a file named - 'FileWithSyntaxError.cs' exists which contains a syntax error - (eg.: a missing '{'). - In that case mcs and thus mcsc linter will stop after the syntax check phase is - finished and report the syntax error in the file 'FileWithSyntaxError.cs'. The - Type error in the file 'FileWithTypeError.cs is not seen jet. - The only possibility to find the error in in 'FileWithTypeError.cs' is to fix - the syntax error in 'FileWithSyntaxError.cs' first. After saving mcs will - successfully pass the syntax check phase and advance to the next compilation - phase at which the Type error hidden in 'FileWithTypeError.cs' is found and - now can be indicated by ale. g:ale_cs_mcsc_options *g:ale_cs_mcsc_options* *b:ale_cs_mcsc_options* Type: |String| Default: `''` - This parameter can be used to define additional flags and parameters independent - of the source tree to be linted. The specified string is directly passed to - mcs compiler without any further change. + This option can be set to pass additional arguments to the `mcs` compiler. - For example, to add the dotnet package which is not added per default + For example, to add the dotnet package which is not added per default: > let g:ale_cs_mcs_options = '-pkg:dotnet' +< + NOTE: the `-unsafe` option is always passed to `mcs`. - NOTE: The mcs -unsafe option is included implicitly per default. Therefore it - is not necessary to specify it explicitly through the |g:ale_cs_mcsc_options| - or |b:ale_cs_mcsc_options| parameter. g:ale_cs_mcsc_source *g:ale_cs_mcsc_source* *b:ale_cs_mcsc_source* @@ -80,23 +68,33 @@ g:ale_cs_mcsc_source *g:ale_cs_mcsc_source* NOTE: Currently it is not possible to specify sub directories and directory sub trees which shall not be searched for *.cs files. + g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path* *b:ale_cs_mcsc_assembly_path* Type: |List| Default: `[]` This variable defines a list of path strings to be searched for external - assembly ('*.dll') files. The list is passed to the mcs compiler using the - '-lib:' flag. + assembly files. The list is passed to the mcs compiler using the `-lib:` + flag. + g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies* *b:ale_cs_mcsc_assemblies* Type: |List| Default: `[]` - This variable defines a list of external assembly (*.dll) files required - by the mono mcs compiler to generate a valid module target. The list is - passed the mcs compiler using the '-r:' flag. + This variable defines a list of external assembly (*.dll) files required + by the mono mcs compiler to generate a valid module target. The list is + passed the mcs compiler using the `-r:` flag. + + For example: > + + " Compile C# programs with the Unity engine DLL file on Mac. + let g:ale_cs_mcss_assemblies = [ + \ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll', + \] +< =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: From 0ad254799781ba1e00b13b26dfbee5c6fed9684f Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 17:34:34 +0000 Subject: [PATCH 296/390] Fix mcsc paths and escaping for Windows --- ale_linters/cs/mcsc.vim | 69 +++++++++---------- doc/ale-cs.txt | 3 +- .../test_cs_mcsc_command_callbacks.vader | 32 ++++++--- test/handler/test_mcsc_handler.vader | 19 ++++- 4 files changed, 74 insertions(+), 49 deletions(-) diff --git a/ale_linters/cs/mcsc.vim b/ale_linters/cs/mcsc.vim index 6e51ef3..f16e4b4 100644 --- a/ale_linters/cs/mcsc.vim +++ b/ale_linters/cs/mcsc.vim @@ -1,55 +1,47 @@ -" general mcs options which are likely to stay constant across -" source trees like -pkg:dotnet -let g:ale_cs_mcsc_options = get(g:, 'ale_cs_mcsc_options', '') +call ale#Set('cs_mcsc_options', '') +call ale#Set('cs_mcsc_source', '') +call ale#Set('cs_mcsc_assembly_path', []) +call ale#Set('cs_mcsc_assemblies', []) -" path string pointing the linter to the base path of the -" source tree to check -let g:ale_cs_mcsc_source = get(g:, 'ale_cs_mcsc_source','.') +function! s:GetWorkingDirectory(buffer) abort + let l:working_directory = ale#Var(a:buffer, 'cs_mcsc_source') -" list of search paths for additional assemblies to consider -let g:ale_cs_mcsc_assembly_path = get(g:, 'ale_cs_mcsc_assembly_path',[]) + if !empty(l:working_directory) + return l:working_directory + endif + + return fnamemodify(bufname(a:buffer), ':p:h') +endfunction -" list of assemblies to consider -let g:ale_cs_mcsc_assemblies = get(g:, 'ale_cs_mcsc_assemblies',[]) function! ale_linters#cs#mcsc#GetCommand(buffer) abort + " Pass assembly paths via the -lib: parameter. + let l:path_list = ale#Var(a:buffer, 'cs_mcsc_assembly_path') - " if list of assembly search paths is not empty convert it to - " appropriate -lib: parameter of mcs - let l:path = ale#Var(a:buffer, 'cs_mcsc_assembly_path') + let l:lib_option = !empty(l:path_list) + \ ? '-lib:' . join(map(copy(l:path_list), 'ale#Escape(v:val)'), ',') + \ : '' - if !empty(l:path) - let l:path = '-lib:"' . join(l:path, '","') .'"' - else - let l:path ='' - endif + " Pass paths to DLL files via the -r: parameter. + let l:assembly_list = ale#Var(a:buffer, 'cs_mcsc_assemblies') - " if list of assemblies to link is not empty convert it to the - " appropriate -r: parameter of mcs - let l:assemblies = ale#Var(a:buffer, 'cs_mcsc_assemblies') - - if !empty(l:assemblies) - let l:assemblies = '-r:"' . join(l:assemblies, '","') . '"' - else - let l:assemblies ='' - endif + let l:r_option = !empty(l:assembly_list) + \ ? '-r:' . join(map(copy(l:assembly_list), 'ale#Escape(v:val)'), ',') + \ : '' " register temporary module target file with ale let l:out = tempname() call ale#engine#ManageFile(a:buffer, l:out) - " assemble linter command string to be executed by ale - " implicitly set -unsafe mcs flag set compilation - " target to module (-t:module), direct mcs output to - " temporary file (-out) - " - return 'cd "' . ale#Var(a:buffer, 'cs_mcsc_source') . '";' + " The code is compiled as a module and the output is redirected to a + " temporary file. + return ale#path#CdString(s:GetWorkingDirectory(a:buffer)) \ . 'mcs -unsafe' \ . ' ' . ale#Var(a:buffer, 'cs_mcsc_options') - \ . ' ' . l:path - \ . ' ' . l:assemblies + \ . ' ' . l:lib_option + \ . ' ' . l:r_option \ . ' -out:' . l:out \ . ' -t:module' - \ . ' -recurse:"*.cs"' + \ . ' -recurse:' . ale#Escape('*.cs') endfunction function! ale_linters#cs#mcsc#Handle(buffer, lines) abort @@ -62,11 +54,12 @@ function! ale_linters#cs#mcsc#Handle(buffer, lines) abort " path and not just the file loaded in the buffer let l:pattern = '^\v(.+\.cs)\((\d+),(\d+)\)\: ([^ ]+) ([^ ]+): (.+)$' let l:output = [] - let l:source = ale#Var(a:buffer, 'cs_mcsc_source') + + let l:dir = s:GetWorkingDirectory(a:buffer) for l:match in ale#util#GetMatches(a:lines, l:pattern) call add(l:output, { - \ 'filename': fnamemodify(l:source . '/' . l:match[1], ':p'), + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, \ 'col': l:match[3] + 0, \ 'type': l:match[4] is# 'error' ? 'E' : 'W', diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index 38ee23e..ad8b2bb 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -63,7 +63,8 @@ g:ale_cs_mcsc_source *g:ale_cs_mcsc_source* Default: `''` This variable defines the root path of the directory tree searched for the - '*.cs' files to be linted. If empty the current working directory is used. + '*.cs' files to be linted. If this option is empty, the source file's + directory will be used. NOTE: Currently it is not possible to specify sub directories and directory sub trees which shall not be searched for *.cs files. diff --git a/test/command_callback/test_cs_mcsc_command_callbacks.vader b/test/command_callback/test_cs_mcsc_command_callbacks.vader index 441cef5..cb52c96 100644 --- a/test/command_callback/test_cs_mcsc_command_callbacks.vader +++ b/test/command_callback/test_cs_mcsc_command_callbacks.vader @@ -12,6 +12,8 @@ Before: unlet! g:ale_cs_mcsc_assembly_path unlet! g:ale_cs_mcsc_assemblies + let g:prefix = ' -out:TEMP -t:module -recurse:' . ale#Escape('*.cs') + function! GetCommand() let l:command = ale_linters#cs#mcsc#GetCommand(bufnr('')) let l:command = join(split(l:command)) @@ -28,52 +30,64 @@ After: unlet! g:ale_cs_mcsc_source unlet! g:ale_cs_mcsc_assembly_path unlet! g:ale_cs_mcsc_assemblies + unlet! g:ale_prefix delfunction GetCommand call ale#linter#Reset() -Execute(Check for proper default command): +Execute(The mcsc linter should return the correct default command): AssertEqual - \ 'cd ".";mcs -unsafe -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe' . g:prefix, \ GetCommand() Execute(The options should be be used in the command): let g:ale_cs_mcsc_options = '-pkg:dotnet' AssertEqual - \ 'cd ".";mcs -unsafe ' . g:ale_cs_mcsc_options . ' -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe -pkg:dotnet' . g:prefix, \ GetCommand() Execute(The souce path should be be used in the command): - let g:ale_cs_mcsc_source='../foo/bar' + let g:ale_cs_mcsc_source = '../foo/bar' AssertEqual - \ 'cd "' . g:ale_cs_mcsc_source . '";mcs -unsafe -out:TEMP -t:module -recurse:"*.cs"', + \ 'cd ' . ale#Escape('../foo/bar') . ' && ' + \ . 'mcs -unsafe' . g:prefix, \ GetCommand() Execute(The list of search pathes for assemblies should be be used in the command if not empty): let g:ale_cs_mcsc_assembly_path = ['/usr/lib/mono', '../foo/bar'] AssertEqual - \ 'cd ".";mcs -unsafe -lib:"' . join(g:ale_cs_mcsc_assembly_path,'","') . '" -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe' + \ . ' -lib:' . ale#Escape('/usr/lib/mono') . ',' . ale#Escape('../foo/bar') + \ . g:prefix, \ GetCommand() let g:ale_cs_mcsc_assembly_path = [] AssertEqual - \ 'cd ".";mcs -unsafe -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe' . g:prefix, \ GetCommand() Execute(The list of assemblies should be be used in the command if not empty): let g:ale_cs_mcsc_assemblies = ['foo.dll', 'bar.dll'] AssertEqual - \ 'cd ".";mcs -unsafe -r:"' . join(g:ale_cs_mcsc_assemblies,'","') . '" -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe' + \ . ' -r:' . ale#Escape('foo.dll') . ',' . ale#Escape('bar.dll') + \ . g:prefix, \ GetCommand() let g:ale_cs_mcsc_assemblies = [] AssertEqual - \ 'cd ".";mcs -unsafe -out:TEMP -t:module -recurse:"*.cs"', + \ ale#path#BufferCdString(bufnr('')) + \ . 'mcs -unsafe' . g:prefix, \ GetCommand() diff --git a/test/handler/test_mcsc_handler.vader b/test/handler/test_mcsc_handler.vader index a000792..d97a2ed 100644 --- a/test/handler/test_mcsc_handler.vader +++ b/test/handler/test_mcsc_handler.vader @@ -9,8 +9,25 @@ After: unlet! g:ale_cs_mcsc_source call ale#linter#Reset() +Execute(The mcs handler should work with the default of the buffer's directory): + AssertEqual + \ [ + \ { + \ 'lnum': 12, + \ 'col' : 29, + \ 'text': '; expected', + \ 'code': 'CS1001', + \ 'type': 'E', + \ 'filename': ale#path#Winify(expand('%:p:h') . '/Test.cs', 'add_drive'), + \ }, + \ ], + \ ale_linters#cs#mcsc#Handle(347, [ + \ 'Test.cs(12,29): error CS1001: ; expected', + \ 'Compilation failed: 2 error(s), 1 warnings', + \ ]) + Execute(The mcs handler should handle cannot find symbol errors): - let g:ale_cs_mcsc_source='/home/foo/project/bar' + let g:ale_cs_mcsc_source = '/home/foo/project/bar' AssertEqual \ [ From cc8e5502c8fd9d0d2ba405214e05f90b4152e2b2 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 17:42:51 +0000 Subject: [PATCH 297/390] Fix #1240 - Parse line and column numbers for fatal embertemplatelint errors --- ale_linters/handlebars/embertemplatelint.vim | 6 ++---- test/handler/test_embertemplatelint_handler.vader | 11 ++++------- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/ale_linters/handlebars/embertemplatelint.vim b/ale_linters/handlebars/embertemplatelint.vim index 963ab56..68ea715 100644 --- a/ale_linters/handlebars/embertemplatelint.vim +++ b/ale_linters/handlebars/embertemplatelint.vim @@ -22,15 +22,13 @@ function! ale_linters#handlebars#embertemplatelint#Handle(buffer, lines) abort for l:error in get(values(l:json), 0, []) if has_key(l:error, 'fatal') call add(l:output, { - \ 'bufnr': a:buffer, - \ 'lnum': 1, - \ 'col': 1, + \ 'lnum': get(l:error, 'line', 1), + \ 'col': get(l:error, 'column', 1), \ 'text': l:error.message, \ 'type': l:error.severity == 1 ? 'W' : 'E', \}) else call add(l:output, { - \ 'bufnr': a:buffer, \ 'lnum': l:error.line, \ 'col': l:error.column, \ 'text': l:error.rule . ': ' . l:error.message, diff --git a/test/handler/test_embertemplatelint_handler.vader b/test/handler/test_embertemplatelint_handler.vader index ea5313c..97ca439 100644 --- a/test/handler/test_embertemplatelint_handler.vader +++ b/test/handler/test_embertemplatelint_handler.vader @@ -32,14 +32,12 @@ Execute(The ember-template-lint handler should parse lines correctly): AssertEqual \ [ \ { - \ 'bufnr': 347, \ 'lnum': 1, \ 'col': 10, \ 'text': 'bare-strings: Non-translated string used', \ 'type': 'E', \ }, \ { - \ 'bufnr': 347, \ 'lnum': 3, \ 'col': 6, \ 'text': 'invalid-interactive: Interaction added to non-interactive element', @@ -55,8 +53,8 @@ Execute(The ember-template-lint handler should handle template parsing error cor \ "fatal": true, \ "moduleId": "app/templates/application", \ "message": "Parse error on line 5 ...", - \ "line": 1, - \ "column": 1, + \ "line": 5, + \ "column": 3, \ "source": "Error: Parse error on line 5 ...", \ "severity": 2 \ } @@ -66,9 +64,8 @@ Execute(The ember-template-lint handler should handle template parsing error cor AssertEqual \ [ \ { - \ 'bufnr': 347, - \ 'lnum': 1, - \ 'col': 1, + \ 'lnum': 5, + \ 'col': 3, \ 'text': 'Parse error on line 5 ...', \ 'type': 'E', \ }, From 73f61514c9039e7e863da3544f251d3f8d7d1956 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 18:10:29 +0000 Subject: [PATCH 298/390] Fix #1031 - Make the rust flags configurable --- ale_linters/rust/rustc.vim | 18 ++++++--- doc/ale-rust.txt | 13 +++++++ .../test_rustc_command_callback.vader | 37 +++++++++++++++++++ 3 files changed, 62 insertions(+), 6 deletions(-) create mode 100644 test/command_callback/test_rustc_command_callback.vader diff --git a/ale_linters/rust/rustc.vim b/ale_linters/rust/rustc.vim index e792faa..3cd401b 100644 --- a/ale_linters/rust/rustc.vim +++ b/ale_linters/rust/rustc.vim @@ -1,21 +1,27 @@ " Author: Daniel Schemala " Description: rustc for rust files -function! ale_linters#rust#rustc#RustcCommand(buffer_number) abort +call ale#Set('rust_rustc_options', '-Z no-trans') + +function! ale_linters#rust#rustc#RustcCommand(buffer) abort " Try to guess the library search path. If the project is managed by cargo, " it's usually /target/debug/deps/ or " /target/release/deps/ - let l:cargo_file = ale#path#FindNearestFile(a:buffer_number, 'Cargo.toml') + let l:cargo_file = ale#path#FindNearestFile(a:buffer, 'Cargo.toml') if l:cargo_file isnot# '' - let l:project_root = fnamemodify(l:cargo_file, ':h') - let l:dependencies = '-L ' . l:project_root . '/target/debug/deps -L ' . - \ l:project_root . '/target/release/deps' + let l:root = fnamemodify(l:cargo_file, ':h') + let l:dependencies = ' -L ' . ale#Escape(ale#path#GetAbsPath(l:root, 'target/debug/deps')) + \ . ' -L ' . ale#Escape(ale#path#GetAbsPath(l:root, 'target/release/deps')) else let l:dependencies = '' endif - return 'rustc --error-format=json -Z no-trans ' . l:dependencies . ' -' + let l:options = ale#Var(a:buffer, 'rust_rustc_options') + + return 'rustc --error-format=json' + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . l:dependencies . ' -' endfunction call ale#linter#Define('rust', { diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 64d5293..535f21d 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -84,6 +84,19 @@ g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain* =============================================================================== rustc *ale-rust-rustc* + +g:ale_rust_rustc_options *g:ale_rust_rustc_options* + *b:ale_rust_rustc_options* + Type: |String| + Default: `'-Z no-trans'` + + The variable can be used to change the options passed to `rustc`. + + `-Z no-trans` should only work with nightly builds of Rust. Be careful when + setting the options, as running `rustc` could execute code or generate + binary files. + + g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes* *b:ale_rust_ignore_error_codes* Type: |List| of |String|s diff --git a/test/command_callback/test_rustc_command_callback.vader b/test/command_callback/test_rustc_command_callback.vader new file mode 100644 index 0000000..fe46c9a --- /dev/null +++ b/test/command_callback/test_rustc_command_callback.vader @@ -0,0 +1,37 @@ +Before: + Save g:ale_rust_rustc_options + + unlet! g:ale_rust_rustc_options + + runtime ale_linters/rust/rustc.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + unlet! b:ale_rust_rustc_options + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual + \ 'rustc --error-format=json -Z no-trans -', + \ ale_linters#rust#rustc#RustcCommand(bufnr('')) + +Execute(The options should be configurable): + let b:ale_rust_rustc_options = '--foo' + + AssertEqual + \ 'rustc --error-format=json --foo -', + \ ale_linters#rust#rustc#RustcCommand(bufnr('')) + +Execute(Some default paths should be included when the project is a Cargo project): + call ale#test#SetFilename('cargo_paths/test.rs') + + AssertEqual + \ 'rustc --error-format=json -Z no-trans' + \ . ' -L ' . ale#Escape(ale#path#GetAbsPath(g:dir, 'cargo_paths/target/debug/deps')) + \ . ' -L ' . ale#Escape(ale#path#GetAbsPath(g:dir, 'cargo_paths/target/release/deps')) + \ . ' -', + \ ale_linters#rust#rustc#RustcCommand(bufnr('')) From 1568bf81281507aaaa8c71af85e244e94bd2924c Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 19 Dec 2017 18:23:09 +0000 Subject: [PATCH 299/390] Fix the mscs tests on Windows, and use the improved Simplify for all tests instead. --- autoload/ale/path.vim | 17 ----- autoload/ale/test.vim | 2 +- .../test_brakeman_command_callback.vader | 4 +- .../test_c_cppcheck_command_callbacks.vader | 2 +- .../test_cpp_cppcheck_command_callbacks.vader | 2 +- .../test_dartanalyzer_command_callback.vader | 2 +- .../test_flake8_command_callback.vader | 12 ++-- .../test_haml_hamllint_command_callback.vader | 8 +-- .../test_javac_command_callback.vader | 12 ++-- ...test_less_stylelint_command_callback.vader | 2 +- .../test_lessc_command_callback.vader | 8 +-- .../test_mypy_command_callback.vader | 8 +-- .../test_ocaml_ols_callbacks.vader | 4 +- .../test_perlcritic_command_callback.vader | 2 +- .../test_php_langserver_callbacks.vader | 4 +- .../test_puglint_command_callback.vader | 20 +++--- .../test_pyflakes_command_callback.vader | 2 +- .../test_pylint_command_callback.vader | 2 +- .../test_pyls_command_callback.vader | 2 +- ...ails_best_practices_command_callback.vader | 2 +- .../test_reason_ols_callbacks.vader | 4 +- .../test_rubocop_command_callback.vader | 6 +- .../test_rust_rls_callbacks.vader | 2 +- .../test_shellcheck_command_callback.vader | 2 +- .../test_slimlint_command_callback.vader | 2 +- .../test_standard_command_callback.vader | 4 +- .../test_swaglint_command_callback.vader | 4 +- .../test_write_good_command_callback.vader | 8 +-- test/fix/test_ale_fix.vader | 2 +- .../fixers/test_autopep8_fixer_callback.vader | 4 +- .../test_elm_format_fixer_callback.vader | 6 +- test/fixers/test_eslint_fixer_callback.vader | 30 ++++---- test/fixers/test_isort_fixer_callback.vader | 2 +- test/fixers/test_phpcbf_fixer_callback.vader | 12 ++-- .../test_prettier_eslint_fixer.callback.vader | 4 +- test/fixers/test_rubocop_fixer_callback.vader | 4 +- .../fixers/test_standard_fixer_callback.vader | 2 +- .../test_stylelint_fixer_callback.vader | 2 +- test/fixers/test_yapf_fixer_callback.vader | 6 +- test/handler/test_brakeman_handler.vader | 4 +- test/handler/test_ghc_handler.vader | 12 ++-- test/handler/test_gobuild_handler.vader | 2 +- test/handler/test_gometalinter_handler.vader | 4 +- test/handler/test_javac_handler.vader | 4 +- test/handler/test_lessc_handler.vader | 6 +- test/handler/test_mcsc_handler.vader | 8 +-- test/handler/test_mypy_handler.vader | 10 +-- test/handler/test_perl_handler.vader | 6 +- test/handler/test_rstcheck_lint_handler.vader | 6 +- test/handler/test_rust_handler.vader | 10 +-- test/handler/test_tslint_handler.vader | 12 ++-- test/lsp/test_lsp_client_messages.vader | 14 ++-- test/test_c_import_paths.vader | 70 +++++++++---------- test/test_csslint_config_detection.vader | 2 +- test/test_elm_executable_detection.vader | 2 +- test/test_eslint_executable_detection.vader | 8 +-- test/test_find_nearest_directory.vader | 2 +- test/test_go_to_definition.vader | 22 +++--- .../test_gradle_build_classpath_command.vader | 10 +-- test/test_gradle_find_executable.vader | 4 +- test/test_gradle_find_project_root.vader | 6 +- test/test_list_titles.vader | 4 +- test/test_nearest_file_search.vader | 2 +- test/test_path_equality.vader | 2 +- test/test_phpcs_executable_detection.vader | 2 +- test/test_resolve_local_path.vader | 2 +- test/test_sml_command.vader | 4 +- test/test_tflint_config_detection.vader | 2 +- 68 files changed, 224 insertions(+), 241 deletions(-) diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index b0f4dca..16dabf2 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -17,23 +17,6 @@ function! ale#path#Simplify(path) abort return substitute(simplify(l:win_path), '^\\\+', '\', 'g') " no-custom-checks endfunction -" This function is mainly used for testing. -" -" If an additional 'add_drive' argument is given, the current drive letter -" will be prefixed to any absolute paths on Windows. -function! ale#path#Winify(path, ...) abort - let l:new_path = ale#path#Simplify(a:path) - - if has('win32') - " Add a drive letter to \foo\bar paths, if needed. - if a:0 && a:1 is# 'add_drive' && l:new_path[:0] is# '\' - let l:new_path = fnamemodify('.', ':p')[:1] . l:new_path - endif - endif - - return l:new_path -endfunction - " Given a buffer and a filename, find the nearest file by searching upwards " through the paths relative to the given buffer. function! ale#path#FindNearestFile(buffer, filename) abort diff --git a/autoload/ale/test.vim b/autoload/ale/test.vim index 8fc4fe4..bea10c5 100644 --- a/autoload/ale/test.vim +++ b/autoload/ale/test.vim @@ -50,5 +50,5 @@ function! ale#test#SetFilename(path) abort \ ? a:path \ : l:dir . '/' . a:path - silent! noautocmd execute 'file ' . fnameescape(ale#path#Winify(l:full_path)) + silent! noautocmd execute 'file ' . fnameescape(ale#path#Simplify(l:full_path)) endfunction diff --git a/test/command_callback/test_brakeman_command_callback.vader b/test/command_callback/test_brakeman_command_callback.vader index f98801b..1772c9d 100644 --- a/test/command_callback/test_brakeman_command_callback.vader +++ b/test/command_callback/test_brakeman_command_callback.vader @@ -25,7 +25,7 @@ Execute(The brakeman command callback should find a valid Rails app root): AssertEqual \ 'brakeman -f json -q -p ' - \ . ale#Escape(ale#path#Winify(g:dir . '/../ruby_fixtures/valid_rails_app')), + \ . ale#Escape(ale#path#Simplify(g:dir . '/../ruby_fixtures/valid_rails_app')), \ ale_linters#ruby#brakeman#GetCommand(bufnr('')) Execute(The brakeman command callback should include configured options): @@ -35,5 +35,5 @@ Execute(The brakeman command callback should include configured options): AssertEqual \ 'brakeman -f json -q --combobulate -p ' - \ . ale#Escape(ale#path#Winify(g:dir . '/../ruby_fixtures/valid_rails_app')), + \ . ale#Escape(ale#path#Simplify(g:dir . '/../ruby_fixtures/valid_rails_app')), \ ale_linters#ruby#brakeman#GetCommand(bufnr('')) diff --git a/test/command_callback/test_c_cppcheck_command_callbacks.vader b/test/command_callback/test_c_cppcheck_command_callbacks.vader index e6fe1b7..1643e3e 100644 --- a/test/command_callback/test_c_cppcheck_command_callbacks.vader +++ b/test/command_callback/test_c_cppcheck_command_callbacks.vader @@ -43,7 +43,7 @@ Execute(cppcheck for C++ should detect compile_commands.json files): call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/cppcheck_paths/one')) . ' && ' + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/cppcheck_paths/one')) . ' && ' \ . ale#Escape('cppcheck') \ . ' -q --language=c --project=compile_commands.json --enable=style %t', \ ale_linters#c#cppcheck#GetCommand(bufnr('')) diff --git a/test/command_callback/test_cpp_cppcheck_command_callbacks.vader b/test/command_callback/test_cpp_cppcheck_command_callbacks.vader index f7b37d4..2c9d729 100644 --- a/test/command_callback/test_cpp_cppcheck_command_callbacks.vader +++ b/test/command_callback/test_cpp_cppcheck_command_callbacks.vader @@ -43,7 +43,7 @@ Execute(cppcheck for C++ should detect compile_commands.json files): call ale#test#SetFilename('cppcheck_paths/one/foo.cpp') AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/cppcheck_paths/one')) . ' && ' + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/cppcheck_paths/one')) . ' && ' \ . ale#Escape('cppcheck') \ . ' -q --language=c++ --project=compile_commands.json --enable=style %t', \ ale_linters#cpp#cppcheck#GetCommand(bufnr('')) diff --git a/test/command_callback/test_dartanalyzer_command_callback.vader b/test/command_callback/test_dartanalyzer_command_callback.vader index 6685ab4..c7b5139 100644 --- a/test/command_callback/test_dartanalyzer_command_callback.vader +++ b/test/command_callback/test_dartanalyzer_command_callback.vader @@ -35,6 +35,6 @@ Execute(The .packages file should be set if detected): AssertEqual \ ale#Escape('dartanalyzer') - \ . ' --packages ' . ale#Escape(ale#path#Winify(g:dir . '/dart_paths/.packages')) + \ . ' --packages ' . ale#Escape(ale#path#Simplify(g:dir . '/dart_paths/.packages')) \ . ' %s', \ ale_linters#dart#dartanalyzer#GetCommand(bufnr('')) diff --git a/test/command_callback/test_flake8_command_callback.vader b/test/command_callback/test_flake8_command_callback.vader index 8cb4ded..1784b81 100644 --- a/test/command_callback/test_flake8_command_callback.vader +++ b/test/command_callback/test_flake8_command_callback.vader @@ -76,7 +76,7 @@ Execute(You should be able to set a custom executable and it should be escaped): Execute(The flake8 callbacks should detect virtualenv directories): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/flake8' \) @@ -95,35 +95,35 @@ Execute(The FindProjectRoot should detect the project root directory for namespa silent execute 'file ' . fnameescape(g:dir . '/python_paths/namespace_package_manifest/namespace/foo/bar.py') AssertEqual - \ ale#path#Winify(g:dir . '/python_paths/namespace_package_manifest'), + \ ale#path#Simplify(g:dir . '/python_paths/namespace_package_manifest'), \ ale#python#FindProjectRoot(bufnr('')) Execute(The FindProjectRoot should detect the project root directory for namespace package via setup.cf): silent execute 'file ' . fnameescape(g:dir . '/python_paths/namespace_package_setup/namespace/foo/bar.py') AssertEqual - \ ale#path#Winify(g:dir . '/python_paths/namespace_package_setup'), + \ ale#path#Simplify(g:dir . '/python_paths/namespace_package_setup'), \ ale#python#FindProjectRoot(bufnr('')) Execute(The FindProjectRoot should detect the project root directory for namespace package via pytest.ini): silent execute 'file ' . fnameescape(g:dir . '/python_paths/namespace_package_pytest/namespace/foo/bar.py') AssertEqual - \ ale#path#Winify(g:dir . '/python_paths/namespace_package_pytest'), + \ ale#path#Simplify(g:dir . '/python_paths/namespace_package_pytest'), \ ale#python#FindProjectRoot(bufnr('')) Execute(The FindProjectRoot should detect the project root directory for namespace package via tox.ini): silent execute 'file ' . fnameescape(g:dir . '/python_paths/namespace_package_tox/namespace/foo/bar.py') AssertEqual - \ ale#path#Winify(g:dir . '/python_paths/namespace_package_tox'), + \ ale#path#Simplify(g:dir . '/python_paths/namespace_package_tox'), \ ale#python#FindProjectRoot(bufnr('')) Execute(The FindProjectRoot should detect the project root directory for non-namespace package): silent execute 'file ' . fnameescape(g:dir . '/python_paths/no_virtualenv/subdir/foo/bar.py') AssertEqual - \ ale#path#Winify(g:dir . '/python_paths/no_virtualenv/subdir'), + \ ale#path#Simplify(g:dir . '/python_paths/no_virtualenv/subdir'), \ ale#python#FindProjectRoot(bufnr('')) " Some users currently run flake8 this way, so we should support it. diff --git a/test/command_callback/test_haml_hamllint_command_callback.vader b/test/command_callback/test_haml_hamllint_command_callback.vader index 68aa1e6..0d9b1e0 100644 --- a/test/command_callback/test_haml_hamllint_command_callback.vader +++ b/test/command_callback/test_haml_hamllint_command_callback.vader @@ -18,7 +18,7 @@ Execute(The default command should be correct): Execute(The command should have the .rubocop.yml prepended as an env var if one exists): call ale#test#SetFilename('../hamllint-test-files/rubocop-yml/subdir/file.haml') - let b:conf = ale#path#Winify(g:dir . '/../hamllint-test-files/rubocop-yml/.rubocop.yml') + let b:conf = ale#path#Simplify(g:dir . '/../hamllint-test-files/rubocop-yml/.rubocop.yml') if has('win32') " Windows uses 'set var=... && command' @@ -38,7 +38,7 @@ Execute(The command should have the .rubocop.yml prepended as an env var if one Execute(The command should have the nearest .haml-lint.yml set as --config if it exists): call ale#test#SetFilename('../hamllint-test-files/haml-lint-yml/subdir/file.haml') - let b:conf = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-yml/.haml-lint.yml') + let b:conf = ale#path#Simplify(g:dir . '/../hamllint-test-files/haml-lint-yml/.haml-lint.yml') AssertEqual \ 'haml-lint --config ' @@ -48,8 +48,8 @@ Execute(The command should have the nearest .haml-lint.yml set as --config if it Execute(The command should include a .rubocop.yml and a .haml-lint if both are found): call ale#test#SetFilename('../hamllint-test-files/haml-lint-and-rubocop/subdir/file.haml') - let b:conf_hamllint = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml') - let b:conf_rubocop = ale#path#Winify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml') + let b:conf_hamllint = ale#path#Simplify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.haml-lint.yml') + let b:conf_rubocop = ale#path#Simplify(g:dir . '/../hamllint-test-files/haml-lint-and-rubocop/.rubocop.yml') if has('win32') " Windows uses 'set var=... && command' diff --git a/test/command_callback/test_javac_command_callback.vader b/test/command_callback/test_javac_command_callback.vader index fe54530..7823d03 100644 --- a/test/command_callback/test_javac_command_callback.vader +++ b/test/command_callback/test_javac_command_callback.vader @@ -122,7 +122,7 @@ Execute(The javac callback should detect source directories): AssertEqual \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -sourcepath ' . ale#Escape( - \ ale#path#Winify(g:dir . '/java_paths/src/main/java/') + \ ale#path#Simplify(g:dir . '/java_paths/src/main/java/') \ ) \ . ' -d TEMP %t', \ GetCommand([]) @@ -136,7 +136,7 @@ Execute(The javac callback should combine detected source directories and classp \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -cp ' . ale#Escape(join(['/foo/bar.jar', '/xyz/abc.jar'], g:cp_sep)) \ . ' -sourcepath ' . ale#Escape( - \ ale#path#Winify(g:dir . '/java_paths/src/main/java/') + \ ale#path#Simplify(g:dir . '/java_paths/src/main/java/') \ ) \ . ' -d TEMP %t', \ GetCommand([ @@ -166,8 +166,8 @@ Execute(The javac callback should include src/test/java for test paths): AssertEqual \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -sourcepath ' . ale#Escape(join([ - \ ale#path#Winify(g:dir . '/java_paths/src/main/java/'), - \ ale#path#Winify(g:dir . '/java_paths/src/test/java/'), + \ ale#path#Simplify(g:dir . '/java_paths/src/main/java/'), + \ ale#path#Simplify(g:dir . '/java_paths/src/test/java/'), \ ], g:cp_sep)) \ . ' -d TEMP %t', \ GetCommand([]) @@ -180,8 +180,8 @@ Execute(The javac callback should include src/main/jaxb when available): AssertEqual \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && javac -Xlint' \ . ' -sourcepath ' . ale#Escape(join([ - \ ale#path#Winify(g:dir . '/java_paths_with_jaxb/src/main/java/'), - \ ale#path#Winify(g:dir . '/java_paths_with_jaxb/src/main/jaxb/'), + \ ale#path#Simplify(g:dir . '/java_paths_with_jaxb/src/main/java/'), + \ ale#path#Simplify(g:dir . '/java_paths_with_jaxb/src/main/jaxb/'), \ ], g:cp_sep)) \ . ' -d TEMP %t', \ GetCommand([]) diff --git a/test/command_callback/test_less_stylelint_command_callback.vader b/test/command_callback/test_less_stylelint_command_callback.vader index d5aa3b9..a5912ec 100644 --- a/test/command_callback/test_less_stylelint_command_callback.vader +++ b/test/command_callback/test_less_stylelint_command_callback.vader @@ -30,7 +30,7 @@ After: Execute(node_modules directories should be discovered): call ale#test#SetFilename('stylelint_paths/nested/testfile.less') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir \ . '/stylelint_paths/node_modules/.bin/stylelint' \) diff --git a/test/command_callback/test_lessc_command_callback.vader b/test/command_callback/test_lessc_command_callback.vader index 785c38c..ec2899d 100644 --- a/test/command_callback/test_lessc_command_callback.vader +++ b/test/command_callback/test_lessc_command_callback.vader @@ -30,7 +30,7 @@ After: Execute(node_modules directories should be discovered): call ale#test#SetFilename('lessc_paths/nested/testfile.less') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir \ . '/lessc_paths/node_modules/.bin/lessc' \) @@ -43,7 +43,7 @@ Execute(node_modules directories should be discovered): \ ale#Escape(b:executable) \ . ' --no-color --lint' \ . ' --include-path=' - \ . ale#Escape(ale#path#Winify(g:dir . '/lessc_paths/nested')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/lessc_paths/nested')) \ . ' -', \ ale_linters#less#lessc#GetCommand(bufnr('')) @@ -61,7 +61,7 @@ Execute(The global override should work): \ ale#Escape('foobar') \ . ' --no-color --lint' \ . ' --include-path=' - \ . ale#Escape(ale#path#Winify(g:dir . '/lessc_paths/nested')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/lessc_paths/nested')) \ . ' -', \ ale_linters#less#lessc#GetCommand(bufnr('')) @@ -76,7 +76,7 @@ Execute(Extra options should be configurable): \ ale#Escape('lessc') \ . ' --no-color --lint' \ . ' --include-path=' - \ . ale#Escape(ale#path#Winify(g:dir)) + \ . ale#Escape(ale#path#Simplify(g:dir)) \ . ' --whatever' \ . ' -', \ ale_linters#less#lessc#GetCommand(bufnr('')) diff --git a/test/command_callback/test_mypy_command_callback.vader b/test/command_callback/test_mypy_command_callback.vader index 4ccc008..6a0add5 100644 --- a/test/command_callback/test_mypy_command_callback.vader +++ b/test/command_callback/test_mypy_command_callback.vader @@ -61,7 +61,7 @@ Execute(The mypy command should switch directories to the detected project root) \ 'mypy', \ ale_linters#python#mypy#GetExecutable(bufnr('')) AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/python_paths/no_virtualenv/subdir')) + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/no_virtualenv/subdir')) \ . ' && ' . ale#Escape('mypy') \ . ' --show-column-numbers ' \ . '--shadow-file %s %t %s', @@ -70,13 +70,13 @@ Execute(The mypy command should switch directories to the detected project root) Execute(The mypy callbacks should detect virtualenv directories and switch to the project root): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') - let b:executable = ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/mypy') + let b:executable = ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/mypy') AssertEqual \ b:executable, \ ale_linters#python#mypy#GetExecutable(bufnr('')) AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/subdir')) + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/subdir')) \ . ' && ' . ale#Escape(b:executable) \ . ' --show-column-numbers ' \ . '--shadow-file %s %t %s', @@ -90,7 +90,7 @@ Execute(You should able able to use the global mypy instead): \ 'mypy', \ ale_linters#python#mypy#GetExecutable(bufnr('')) AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/subdir')) + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/subdir')) \ . ' && ' . ale#Escape('mypy') \ . ' --show-column-numbers ' \ . '--shadow-file %s %t %s', diff --git a/test/command_callback/test_ocaml_ols_callbacks.vader b/test/command_callback/test_ocaml_ols_callbacks.vader index 2c44dbc..d10898f 100644 --- a/test/command_callback/test_ocaml_ols_callbacks.vader +++ b/test/command_callback/test_ocaml_ols_callbacks.vader @@ -32,14 +32,14 @@ Execute(The project root should be detected correctly): call ale#test#SetFilename('ols_paths/file.ml') AssertEqual - \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#path#Simplify(g:dir . '/ols_paths'), \ ale#handlers#ols#GetProjectRoot(bufnr('')) Execute(The local executable should be used when available): call ale#test#SetFilename('ols_paths/file.ml') AssertEqual - \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#path#Simplify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), \ ale#handlers#ols#GetExecutable(bufnr('')) Execute(The gloabl executable should always be used when use_global is set): diff --git a/test/command_callback/test_perlcritic_command_callback.vader b/test/command_callback/test_perlcritic_command_callback.vader index 8f339d3..6507868 100644 --- a/test/command_callback/test_perlcritic_command_callback.vader +++ b/test/command_callback/test_perlcritic_command_callback.vader @@ -43,7 +43,7 @@ Execute(The command should be correct with g:ale_perl_perlcritic_showrules on): Execute(The command search for the profile file when set): let b:ale_perl_perlcritic_profile = 'README.md' - let b:readme_path = ale#path#Winify(expand('%:p:h:h:h') . '/README.md') + let b:readme_path = ale#path#Simplify(expand('%:p:h:h:h') . '/README.md') AssertEqual \ ale#Escape('perlcritic') . ' --verbose ''%l:%c %m\n'' --nocolor' diff --git a/test/command_callback/test_php_langserver_callbacks.vader b/test/command_callback/test_php_langserver_callbacks.vader index 0c7e69e..0dc3063 100644 --- a/test/command_callback/test_php_langserver_callbacks.vader +++ b/test/command_callback/test_php_langserver_callbacks.vader @@ -33,10 +33,10 @@ Execute(Vendor executables should be detected): call ale#test#SetFilename('php-langserver-project/test.php') AssertEqual - \ ale#path#Winify(g:dir . '/php-langserver-project/vendor/bin/php-language-server.php'), + \ ale#path#Simplify(g:dir . '/php-langserver-project/vendor/bin/php-language-server.php'), \ ale_linters#php#langserver#GetExecutable(bufnr('')) AssertEqual - \ 'php ' . ale#Escape(ale#path#Winify( + \ 'php ' . ale#Escape(ale#path#Simplify( \ g:dir \ . '/php-langserver-project/vendor/bin/php-language-server.php' \ )), diff --git a/test/command_callback/test_puglint_command_callback.vader b/test/command_callback/test_puglint_command_callback.vader index 1194658..f9b4a85 100644 --- a/test/command_callback/test_puglint_command_callback.vader +++ b/test/command_callback/test_puglint_command_callback.vader @@ -21,12 +21,12 @@ Execute(puglint should detect local executables and package.json): call ale#test#SetFilename('puglint_project/test.pug') AssertEqual - \ ale#path#Winify(g:dir . '/puglint_project/node_modules/.bin/pug-lint'), + \ ale#path#Simplify(g:dir . '/puglint_project/node_modules/.bin/pug-lint'), \ ale_linters#pug#puglint#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape(ale#path#Winify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/puglint_project/package.json')) + \ ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/package.json')) \ . ' -r inline %t', \ ale_linters#pug#puglint#GetCommand(bufnr('')) @@ -39,7 +39,7 @@ Execute(puglint should use global executables if configured): AssertEqual \ ale#Escape('pug-lint') - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/puglint_project/package.json')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/package.json')) \ . ' -r inline %t', \ ale_linters#pug#puglint#GetCommand(bufnr('')) @@ -47,8 +47,8 @@ Execute(puglint should detect .pug-lintrc): call ale#test#SetFilename('puglint_project/puglint_rc_dir/subdir/test.pug') AssertEqual - \ ale#Escape(ale#path#Winify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/puglint_project/puglint_rc_dir/.pug-lintrc')) + \ ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/puglint_rc_dir/.pug-lintrc')) \ . ' -r inline %t', \ ale_linters#pug#puglint#GetCommand(bufnr('')) @@ -56,8 +56,8 @@ Execute(puglint should detect .pug-lintrc.js): call ale#test#SetFilename('puglint_project/puglint_rc_js_dir/subdir/test.pug') AssertEqual - \ ale#Escape(ale#path#Winify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/puglint_project/puglint_rc_js_dir/.pug-lintrc.js')) + \ ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/puglint_rc_js_dir/.pug-lintrc.js')) \ . ' -r inline %t', \ ale_linters#pug#puglint#GetCommand(bufnr('')) @@ -65,7 +65,7 @@ Execute(puglint should detect .pug-lintrc.json): call ale#test#SetFilename('puglint_project/puglint_rc_json_dir/subdir/test.pug') AssertEqual - \ ale#Escape(ale#path#Winify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/puglint_project/puglint_rc_json_dir/.pug-lintrc.json')) + \ ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/node_modules/.bin/pug-lint')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/puglint_project/puglint_rc_json_dir/.pug-lintrc.json')) \ . ' -r inline %t', \ ale_linters#pug#puglint#GetCommand(bufnr('')) diff --git a/test/command_callback/test_pyflakes_command_callback.vader b/test/command_callback/test_pyflakes_command_callback.vader index 30a106c..e8486ca 100644 --- a/test/command_callback/test_pyflakes_command_callback.vader +++ b/test/command_callback/test_pyflakes_command_callback.vader @@ -33,7 +33,7 @@ Execute(The pyflakes executable should be configurable): Execute(The pyflakes executable should be run from the virtualenv path): call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/pyflakes' \) diff --git a/test/command_callback/test_pylint_command_callback.vader b/test/command_callback/test_pylint_command_callback.vader index 447409b..1ff8e35 100644 --- a/test/command_callback/test_pylint_command_callback.vader +++ b/test/command_callback/test_pylint_command_callback.vader @@ -61,7 +61,7 @@ Execute(The pylint callbacks shouldn't detect virtualenv directories where they Execute(The pylint callbacks should detect virtualenv directories): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/pylint' \) diff --git a/test/command_callback/test_pyls_command_callback.vader b/test/command_callback/test_pyls_command_callback.vader index 9f9703d..06ea718 100644 --- a/test/command_callback/test_pyls_command_callback.vader +++ b/test/command_callback/test_pyls_command_callback.vader @@ -33,7 +33,7 @@ Execute(The pyls executable should be configurable): Execute(The pyls executable should be run from the virtualenv path): call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/pyls' \) diff --git a/test/command_callback/test_rails_best_practices_command_callback.vader b/test/command_callback/test_rails_best_practices_command_callback.vader index 7305f4a..b4d2e82 100644 --- a/test/command_callback/test_rails_best_practices_command_callback.vader +++ b/test/command_callback/test_rails_best_practices_command_callback.vader @@ -9,7 +9,7 @@ Before: let b:args = '--silent -f json' \ . ' --output-file ' . (has('win32') ? '%t' : '/dev/stdout') - let b:app_path = ale#path#Winify(g:dir . '/../ruby_fixtures/valid_rails_app') + let b:app_path = ale#path#Simplify(g:dir . '/../ruby_fixtures/valid_rails_app') let b:suffix = has('win32') ? '; type %t' : '' After: diff --git a/test/command_callback/test_reason_ols_callbacks.vader b/test/command_callback/test_reason_ols_callbacks.vader index ffe403f..5fb39af 100644 --- a/test/command_callback/test_reason_ols_callbacks.vader +++ b/test/command_callback/test_reason_ols_callbacks.vader @@ -32,14 +32,14 @@ Execute(The project root should be detected correctly): call ale#test#SetFilename('ols_paths/file.re') AssertEqual - \ ale#path#Winify(g:dir . '/ols_paths'), + \ ale#path#Simplify(g:dir . '/ols_paths'), \ ale#handlers#ols#GetProjectRoot(bufnr('')) Execute(The local executable should be used when available): call ale#test#SetFilename('ols_paths/file.re') AssertEqual - \ ale#path#Winify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), + \ ale#path#Simplify(g:dir . '/ols_paths/node_modules/.bin/ocaml-language-server'), \ ale#handlers#ols#GetExecutable(bufnr('')) Execute(The gloabl executable should always be used when use_global is set): diff --git a/test/command_callback/test_rubocop_command_callback.vader b/test/command_callback/test_rubocop_command_callback.vader index fddf714..f0aa194 100644 --- a/test/command_callback/test_rubocop_command_callback.vader +++ b/test/command_callback/test_rubocop_command_callback.vader @@ -17,7 +17,7 @@ Execute(Executable should default to rubocop): AssertEqual \ ale#Escape('rubocop') \ . ' --format json --force-exclusion --stdin ' - \ . ale#Escape(ale#path#Winify(g:dir . '/dummy.rb')), + \ . ale#Escape(ale#path#Simplify(g:dir . '/dummy.rb')), \ ale_linters#ruby#rubocop#GetCommand(bufnr('')) Execute(Should be able to set a custom executable): @@ -26,7 +26,7 @@ Execute(Should be able to set a custom executable): AssertEqual \ ale#Escape('bin/rubocop') \ . ' --format json --force-exclusion --stdin ' - \ . ale#Escape(ale#path#Winify(g:dir . '/dummy.rb')), + \ . ale#Escape(ale#path#Simplify(g:dir . '/dummy.rb')), \ ale_linters#ruby#rubocop#GetCommand(bufnr('')) Execute(Setting bundle appends 'exec rubocop'): @@ -35,5 +35,5 @@ Execute(Setting bundle appends 'exec rubocop'): AssertEqual \ ale#Escape('path to/bundle') . ' exec rubocop' \ . ' --format json --force-exclusion --stdin ' - \ . ale#Escape(ale#path#Winify(g:dir . '/dummy.rb')), + \ . ale#Escape(ale#path#Simplify(g:dir . '/dummy.rb')), \ ale_linters#ruby#rubocop#GetCommand(bufnr('')) diff --git a/test/command_callback/test_rust_rls_callbacks.vader b/test/command_callback/test_rust_rls_callbacks.vader index e467fd9..693d6e9 100644 --- a/test/command_callback/test_rust_rls_callbacks.vader +++ b/test/command_callback/test_rust_rls_callbacks.vader @@ -37,5 +37,5 @@ Execute(The project root should be detected correctly): call ale#test#SetFilename('rust-rls-project/test.rs') AssertEqual - \ ale#path#Winify(g:dir . '/rust-rls-project'), + \ ale#path#Simplify(g:dir . '/rust-rls-project'), \ ale_linters#rust#rls#GetProjectRoot(bufnr('')) diff --git a/test/command_callback/test_shellcheck_command_callback.vader b/test/command_callback/test_shellcheck_command_callback.vader index bf422b2..68694b6 100644 --- a/test/command_callback/test_shellcheck_command_callback.vader +++ b/test/command_callback/test_shellcheck_command_callback.vader @@ -12,7 +12,7 @@ Before: call ale#test#SetDirectory('/testplugin/test/command_callback') call ale#test#SetFilename('test.sh') - let b:prefix = 'cd ' . ale#Escape(ale#path#Winify(g:dir)) . ' && ' + let b:prefix = 'cd ' . ale#Escape(ale#path#Simplify(g:dir)) . ' && ' let b:suffix = ' -f gcc -' After: diff --git a/test/command_callback/test_slimlint_command_callback.vader b/test/command_callback/test_slimlint_command_callback.vader index d4dad4c..38588a1 100644 --- a/test/command_callback/test_slimlint_command_callback.vader +++ b/test/command_callback/test_slimlint_command_callback.vader @@ -20,7 +20,7 @@ Execute(The default command should be correct): Execute(The command should have the .rubocop.yml prepended as an env var if one exists): call ale#test#SetFilename('../slimlint-test-files/subdir/file.slim') - let b:conf = ale#path#Winify(g:dir . '/../slimlint-test-files/.rubocop.yml') + let b:conf = ale#path#Simplify(g:dir . '/../slimlint-test-files/.rubocop.yml') if has('win32') " Windows uses 'set var=... && command' diff --git a/test/command_callback/test_standard_command_callback.vader b/test/command_callback/test_standard_command_callback.vader index 279109e..3dee285 100644 --- a/test/command_callback/test_standard_command_callback.vader +++ b/test/command_callback/test_standard_command_callback.vader @@ -27,7 +27,7 @@ After: Execute(bin/cmd.js paths should be preferred): call ale#test#SetFilename('standard-test-files/with-cmd/testfile.js') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir \ . '/standard-test-files/with-cmd/node_modules/standard/bin/cmd.js' \) @@ -45,7 +45,7 @@ Execute(bin/cmd.js paths should be preferred): Execute(.bin directories should be used too): call ale#test#SetFilename('standard-test-files/with-bin/testfile.js') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir \ . '/standard-test-files/with-bin/node_modules/.bin/standard' \) diff --git a/test/command_callback/test_swaglint_command_callback.vader b/test/command_callback/test_swaglint_command_callback.vader index 0f1d870..51a1009 100644 --- a/test/command_callback/test_swaglint_command_callback.vader +++ b/test/command_callback/test_swaglint_command_callback.vader @@ -34,10 +34,10 @@ Execute(The yaml swaglint command callback should allow a local installation to call ale#test#SetFilename('swaglint_paths/docs/swagger.yaml') AssertEqual - \ ale#path#Winify(g:dir . '/swaglint_paths/node_modules/.bin/swaglint'), + \ ale#path#Simplify(g:dir . '/swaglint_paths/node_modules/.bin/swaglint'), \ ale_linters#yaml#swaglint#GetExecutable(bufnr('')) AssertEqual - \ ale#path#Winify(g:dir . '/swaglint_paths/node_modules/.bin/swaglint') + \ ale#path#Simplify(g:dir . '/swaglint_paths/node_modules/.bin/swaglint') \ . ' -r compact --stdin', \ ale_linters#yaml#swaglint#GetCommand(bufnr('')) diff --git a/test/command_callback/test_write_good_command_callback.vader b/test/command_callback/test_write_good_command_callback.vader index d9f0049..8d9e9a0 100644 --- a/test/command_callback/test_write_good_command_callback.vader +++ b/test/command_callback/test_write_good_command_callback.vader @@ -34,10 +34,10 @@ Execute(Should use the node_modules/.bin executable, if available): call ale#test#SetFilename('write-good-node-modules/test.txt') AssertEqual - \ ale#path#Winify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good'), + \ ale#path#Simplify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good'), \ ale#handlers#writegood#GetExecutable(bufnr('')) AssertEqual - \ ale#Escape(ale#path#Winify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good')) + \ ale#Escape(ale#path#Simplify(g:dir . '/write-good-node-modules/node_modules/.bin/write-good')) \ . ' %t', \ ale#handlers#writegood#GetCommand(bufnr('')) @@ -45,11 +45,11 @@ Execute(Should use the node_modules/write-good executable, if available): call ale#test#SetFilename('write-good-node-modules-2/test.txt') AssertEqual - \ ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js'), + \ ale#path#Simplify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js'), \ ale#handlers#writegood#GetExecutable(bufnr('')) AssertEqual \ (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/write-good-node-modules-2/node_modules/write-good/bin/write-good.js')) \ . ' %t', \ ale#handlers#writegood#GetCommand(bufnr('')) diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index 2a3e62c..fa1101e 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -515,7 +515,7 @@ Execute(ale#fix#InitBufferData() should set up the correct data): \ bufnr(''): { \ 'temporary_directory_list': [], \ 'vars': b:, - \ 'filename': ale#path#Winify(getcwd() . '/fix_test_file'), + \ 'filename': ale#path#Simplify(getcwd() . '/fix_test_file'), \ 'done': 0, \ 'lines_before': ['a', 'b', 'c'], \ 'should_save': 1, diff --git a/test/fixers/test_autopep8_fixer_callback.vader b/test/fixers/test_autopep8_fixer_callback.vader index 600fb19..5678aaf 100644 --- a/test/fixers/test_autopep8_fixer_callback.vader +++ b/test/fixers/test_autopep8_fixer_callback.vader @@ -27,7 +27,7 @@ Execute(The autopep8 callback should return the correct default values): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autopep8')) . ' -'}, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autopep8')) . ' -'}, \ ale#fixers#autopep8#Fix(bufnr('')) Execute(The autopep8 callback should include options): @@ -35,5 +35,5 @@ Execute(The autopep8 callback should include options): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autopep8')) . ' --some-option -' }, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autopep8')) . ' --some-option -' }, \ ale#fixers#autopep8#Fix(bufnr('')) diff --git a/test/fixers/test_elm_format_fixer_callback.vader b/test/fixers/test_elm_format_fixer_callback.vader index 8552c5d..d613aa8 100644 --- a/test/fixers/test_elm_format_fixer_callback.vader +++ b/test/fixers/test_elm_format_fixer_callback.vader @@ -15,7 +15,7 @@ Execute(The elm-format command should have default params): \ { \ 'read_temporary_file': 1, \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) \ . ' %t --yes', \ }, \ ale#fixers#format#Fix(bufnr('')) @@ -55,7 +55,7 @@ Execute(The elm-format command should manage empty options): \ { \ 'read_temporary_file': 1, \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) \ . ' %t', \ }, \ ale#fixers#format#Fix(bufnr('')) @@ -68,7 +68,7 @@ Execute(The elm-format command should manage custom options): \ { \ 'read_temporary_file': 1, \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../elm-test-files/node_modules/.bin/elm-format')) \ . ' %t --param1 --param2', \ }, \ ale#fixers#format#Fix(bufnr('')) diff --git a/test/fixers/test_eslint_fixer_callback.vader b/test/fixers/test_eslint_fixer_callback.vader index aafc4e7..be33825 100644 --- a/test/fixers/test_eslint_fixer_callback.vader +++ b/test/fixers/test_eslint_fixer_callback.vader @@ -13,8 +13,8 @@ Execute(The executable path should be correct): \ { \ 'read_temporary_file': 1, \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) \ . ' --fix %t', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['v4.4.1 (eslint_d v5.1.0)']) @@ -26,8 +26,8 @@ Execute(The lower priority configuration file in a nested directory should be pr \ { \ 'read_temporary_file': 1, \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/subdir-with-config/.eslintrc')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/subdir-with-config/.eslintrc')) \ . ' --fix %t', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) @@ -39,8 +39,8 @@ Execute(package.json should be used as a last resort): \ { \ 'read_temporary_file': 1, \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/.eslintrc.js')) \ . ' --fix %t', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) @@ -51,8 +51,8 @@ Execute(package.json should be used as a last resort): \ { \ 'read_temporary_file': 1, \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/node_modules/.bin/eslint')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/package.json')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/node_modules/.bin/eslint')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/package.json')) \ . ' --fix %t', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), []) @@ -64,7 +64,7 @@ Execute(The version check should be correct): \ { \ 'chain_with': 'ale#fixers#eslint#ApplyFixForVersion', \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) \ . ' --version' \ }, \ ale#fixers#eslint#Fix(bufnr('')) @@ -75,7 +75,7 @@ Execute(--fix-dry-run should be used for 4.9.0 and up): AssertEqual \ { \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) \ . ' --stdin-filename %s --stdin --fix-dry-run --format=json', \ 'process_with': 'ale#fixers#eslint#ProcessFixDryRunOutput', \ }, @@ -88,8 +88,8 @@ Execute(--fix-to-stdout should be used for eslint_d): \ { \ 'read_temporary_file': 1, \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) - \ . ' -c ' . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/package.json')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ . ' -c ' . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/package.json')) \ . ' --fix %t', \ }, \ ale#fixers#eslint#ApplyFixForVersion(bufnr(''), ['']) @@ -99,7 +99,7 @@ Execute(--fix-to-stdout should be used for eslint_d): AssertEqual \ { \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', \ 'process_with': 'ale#fixers#eslint#ProcessEslintDOutput', \ }, @@ -109,7 +109,7 @@ Execute(--fix-to-stdout should be used for eslint_d): AssertEqual \ { \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) + \ ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d')) \ . ' --stdin-filename %s --stdin --fix-to-stdout', \ 'process_with': 'ale#fixers#eslint#ProcessEslintDOutput', \ }, @@ -133,7 +133,7 @@ Execute(The version number should be cached): AssertEqual \ { \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) \ . ' --stdin-filename %s --stdin --fix-dry-run --format=json', \ 'process_with': 'ale#fixers#eslint#ProcessFixDryRunOutput', \ }, diff --git a/test/fixers/test_isort_fixer_callback.vader b/test/fixers/test_isort_fixer_callback.vader index ea4426d..503057b 100644 --- a/test/fixers/test_isort_fixer_callback.vader +++ b/test/fixers/test_isort_fixer_callback.vader @@ -25,5 +25,5 @@ Execute(The isort callback should return the correct default values): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/isort')) . ' -' }, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/isort')) . ' -' }, \ ale#fixers#isort#Fix(bufnr('')) diff --git a/test/fixers/test_phpcbf_fixer_callback.vader b/test/fixers/test_phpcbf_fixer_callback.vader index b5c72f2..1663c89 100644 --- a/test/fixers/test_phpcbf_fixer_callback.vader +++ b/test/fixers/test_phpcbf_fixer_callback.vader @@ -21,7 +21,7 @@ Execute(project with phpcbf should use local by default): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf'), + \ ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf'), \ ale#fixers#phpcbf#GetExecutable(bufnr('')) Execute(use-global should override local detection): @@ -43,7 +43,7 @@ Execute(The phpcbf callback should return the correct default values): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, \ ale#fixers#phpcbf#Fix(bufnr('')) Execute(The phpcbf callback should include the phpcbf_standard option): @@ -51,7 +51,7 @@ Execute(The phpcbf callback should include the phpcbf_standard option): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, \ ale#fixers#phpcbf#Fix(bufnr('')) Before: @@ -77,7 +77,7 @@ Execute(project with phpcbf should use local by default): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf'), + \ ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf'), \ ale#fixers#phpcbf#GetExecutable(bufnr('')) Execute(use-global should override local detection): @@ -99,7 +99,7 @@ Execute(The phpcbf callback should return the correct default values): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s -' }, \ ale#fixers#phpcbf#Fix(bufnr('')) Execute(The phpcbf callback should include the phpcbf_standard option): @@ -107,6 +107,6 @@ Execute(The phpcbf callback should include the phpcbf_standard option): call ale#test#SetFilename('php_paths/project-with-phpcbf/foo/test.php') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/php_paths/project-with-phpcbf/vendor/bin/phpcbf')) . ' --stdin-path=%s ' . '--standard=phpcbf_ruleset.xml' . ' -'}, \ ale#fixers#phpcbf#Fix(bufnr('')) diff --git a/test/fixers/test_prettier_eslint_fixer.callback.vader b/test/fixers/test_prettier_eslint_fixer.callback.vader index 1ff11fe..ef0b35d 100644 --- a/test/fixers/test_prettier_eslint_fixer.callback.vader +++ b/test/fixers/test_prettier_eslint_fixer.callback.vader @@ -54,7 +54,7 @@ Execute(--eslint-config-path should be set for 4.2.0 and up): \ 'command': \ ale#Escape('prettier-eslint') \ . ' %t' - \ . ' --eslint-config-path ' . ale#Escape(ale#path#Winify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) + \ . ' --eslint-config-path ' . ale#Escape(ale#path#Simplify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) \ . ' --write' \ }, \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), ['4.2.0']) @@ -87,7 +87,7 @@ Execute(The new --stdin-filepath option should be used when the version is new e \ { \ 'command': 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' \ . ale#Escape('prettier-eslint') - \ . ' --eslint-config-path ' . ale#Escape(ale#path#Winify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) + \ . ' --eslint-config-path ' . ale#Escape(ale#path#Simplify(g:dir . '/eslint-test-files/react-app/.eslintrc.js')) \ . ' --stdin-filepath %s --stdin', \ }, \ ale#fixers#prettier_eslint#ApplyFixForVersion(bufnr(''), ['4.4.0']) diff --git a/test/fixers/test_rubocop_fixer_callback.vader b/test/fixers/test_rubocop_fixer_callback.vader index ff2ca96..045256f 100644 --- a/test/fixers/test_rubocop_fixer_callback.vader +++ b/test/fixers/test_rubocop_fixer_callback.vader @@ -34,7 +34,7 @@ Execute(The rubocop callback should include configuration files): \ { \ 'read_temporary_file': 1, \ 'command': ale#Escape(g:ale_ruby_rubocop_executable) - \ . ' --config ' . ale#Escape(ale#path#Winify(g:dir . '/ruby_paths/with_config/.rubocop.yml')) + \ . ' --config ' . ale#Escape(ale#path#Simplify(g:dir . '/ruby_paths/with_config/.rubocop.yml')) \ . ' --auto-correct %t', \ }, \ ale#fixers#rubocop#Fix(bufnr('')) @@ -47,7 +47,7 @@ Execute(The rubocop callback should include custom rubocop options): \ { \ 'read_temporary_file': 1, \ 'command': ale#Escape(g:ale_ruby_rubocop_executable) - \ . ' --config ' . ale#Escape(ale#path#Winify(g:dir . '/ruby_paths/with_config/.rubocop.yml')) + \ . ' --config ' . ale#Escape(ale#path#Simplify(g:dir . '/ruby_paths/with_config/.rubocop.yml')) \ . ' --except Lint/Debugger' \ . ' --auto-correct %t', \ }, diff --git a/test/fixers/test_standard_fixer_callback.vader b/test/fixers/test_standard_fixer_callback.vader index 34c752d..38f2d54 100644 --- a/test/fixers/test_standard_fixer_callback.vader +++ b/test/fixers/test_standard_fixer_callback.vader @@ -11,7 +11,7 @@ Execute(The executable path should be correct): \ { \ 'read_temporary_file': 1, \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/standard/bin/cmd.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/standard/bin/cmd.js')) \ . ' --fix %t', \ }, \ ale#fixers#standard#Fix(bufnr('')) diff --git a/test/fixers/test_stylelint_fixer_callback.vader b/test/fixers/test_stylelint_fixer_callback.vader index a0fc6ff..90a9dc1 100644 --- a/test/fixers/test_stylelint_fixer_callback.vader +++ b/test/fixers/test_stylelint_fixer_callback.vader @@ -11,7 +11,7 @@ Execute(The executable path should be correct): \ { \ 'read_temporary_file': 1, \ 'command': (has('win32') ? 'node.exe ' : '') - \ . ale#Escape(ale#path#Winify(g:dir . '/../eslint-test-files/react-app/node_modules/stylelint/bin/stylelint.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/../eslint-test-files/react-app/node_modules/stylelint/bin/stylelint.js')) \ . ' --fix %t', \ }, \ ale#fixers#stylelint#Fix(bufnr('')) diff --git a/test/fixers/test_yapf_fixer_callback.vader b/test/fixers/test_yapf_fixer_callback.vader index e607556..cfc508c 100644 --- a/test/fixers/test_yapf_fixer_callback.vader +++ b/test/fixers/test_yapf_fixer_callback.vader @@ -26,7 +26,7 @@ Execute(The yapf callback should return the correct default values): call ale#test#SetFilename('python_paths/with_virtualenv/subdir/foo/bar.py') AssertEqual - \ {'command': ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yapf'))}, + \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yapf'))}, \ ale#fixers#yapf#Fix(bufnr('')) \ Execute(The yapf should include the .style.yapf file if present): @@ -35,8 +35,8 @@ Execute(The yapf should include the .style.yapf file if present): AssertEqual \ { \ 'command': - \ ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yapf')) + \ ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yapf')) \ . ' --no-local-style' - \ . ' --style ' . ale#Escape(ale#path#Winify(g:dir . '/python_paths/with_virtualenv/dir_with_yapf_config/.style.yapf')), + \ . ' --style ' . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/dir_with_yapf_config/.style.yapf')), \ }, \ ale#fixers#yapf#Fix(bufnr('')) diff --git a/test/handler/test_brakeman_handler.vader b/test/handler/test_brakeman_handler.vader index 5a39879..02eb31b 100644 --- a/test/handler/test_brakeman_handler.vader +++ b/test/handler/test_brakeman_handler.vader @@ -34,7 +34,7 @@ Execute(The brakeman handler should parse JSON correctly): \ '"fingerprint": "1234",', \ '"check_name": "SQL",', \ '"message": "Possible SQL injection",', - \ '"file": "' . substitute(ale#path#Winify('app/models/thing.rb'), '\\', '\\\\', 'g') . '",', + \ '"file": "' . substitute(ale#path#Simplify('app/models/thing.rb'), '\\', '\\\\', 'g') . '",', \ '"line": 84,', \ '"link": "http://brakemanscanner.org/docs/warning_types/sql_injection/",', \ '"code": "Thing.connection.execute(params[:data])",', @@ -53,7 +53,7 @@ Execute(The brakeman handler should parse JSON correctly): \ '"fingerprint": "1235",', \ '"check_name": "ModelAttrAccessible",', \ '"message": "Potentially dangerous attribute available for mass assignment",', - \ '"file": "' . substitute(ale#path#Winify('app/models/thing.rb'), '\\', '\\\\', 'g') . '",', + \ '"file": "' . substitute(ale#path#Simplify('app/models/thing.rb'), '\\', '\\\\', 'g') . '",', \ '"line": null,', \ '"link": "http://brakemanscanner.org/docs/warning_types/mass_assignment/",', \ '"code": ":name",', diff --git a/test/handler/test_ghc_handler.vader b/test/handler/test_ghc_handler.vader index 2a26f86..b040a23 100644 --- a/test/handler/test_ghc_handler.vader +++ b/test/handler/test_ghc_handler.vader @@ -48,11 +48,11 @@ Execute(The ghc handler should handle ghc 8 output): \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ \ '', - \ ale#path#Winify('src/Appoint/Lib.hs') . ':6:1: error:', + \ ale#path#Simplify('src/Appoint/Lib.hs') . ':6:1: error:', \ ' Failed to load interface for ‘GitHub.Data’', \ ' Use -v to see a list of the files searched for.', \ '', - \ ale#path#Winify('src/Appoint/Lib.hs') . ':7:1: warning:', + \ ale#path#Simplify('src/Appoint/Lib.hs') . ':7:1: warning:', \ ' Failed to load interface for ‘GitHub.Endpoints.PullRequests’', \ ' Use -v to see a list of the files searched for.', \ ]) @@ -92,12 +92,12 @@ Execute(The ghc handler should handle ghc 7 output): \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ - \ ale#path#Winify('src/Main.hs') . ':168:1:', + \ ale#path#Simplify('src/Main.hs') . ':168:1:', \ ' parse error (possibly incorrect indentation or mismatched brackets)', - \ ale#path#Winify('src/Main.hs') . ':84:1:Warning:', + \ ale#path#Simplify('src/Main.hs') . ':84:1:Warning:', \ ' Top-level binding with no type signature:', \ ' myLayout :: Choose Tall (Choose (Mirror Tall) Full) a', - \ ale#path#Winify('src/Main.hs') . ':94:5:Error:', + \ ale#path#Simplify('src/Main.hs') . ':94:5:Error:', \ ' Some other error', \ ]) @@ -122,7 +122,7 @@ Execute(The ghc handler should handle stack 1.5.1 output): \ }, \ ], \ ale#handlers#haskell#HandleGHCFormat(bufnr(''), [ - \ ' ' . ale#path#Winify('src/Main.hs') . ':160:14: error:', + \ ' ' . ale#path#Simplify('src/Main.hs') . ':160:14: error:', \ ' • Expecting one fewer arguments to ‘Exp’', \ ' Expected kind ‘k0 -> *’, but ‘Exp’ has kind ‘*’', \ ' • In the type ‘Exp a’', diff --git a/test/handler/test_gobuild_handler.vader b/test/handler/test_gobuild_handler.vader index ec77f9c..17608c3 100644 --- a/test/handler/test_gobuild_handler.vader +++ b/test/handler/test_gobuild_handler.vader @@ -37,7 +37,7 @@ Execute (The gobuild handler should handle relative paths correctly): \ 'col': 0, \ 'text': 'missing argument for Printf("%s"): format reads arg 2, have only 1 args', \ 'type': 'E', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gobuild#Handler(bufnr(''), [ diff --git a/test/handler/test_gometalinter_handler.vader b/test/handler/test_gometalinter_handler.vader index 703040e..1aade8a 100644 --- a/test/handler/test_gometalinter_handler.vader +++ b/test/handler/test_gometalinter_handler.vader @@ -41,14 +41,14 @@ Execute (The gometalinter handler should handle paths correctly): \ 'col': 3, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (staticcheck)', \ 'type': 'W', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.go'), \ }, \ { \ 'lnum': 37, \ 'col': 5, \ 'text': 'expected ''package'', found ''IDENT'' gibberish (golint)', \ 'type': 'E', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.go'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.go'), \ }, \ ], \ ale_linters#go#gometalinter#Handler(bufnr(''), [ diff --git a/test/handler/test_javac_handler.vader b/test/handler/test_javac_handler.vader index 6189e6e..ff4e163 100644 --- a/test/handler/test_javac_handler.vader +++ b/test/handler/test_javac_handler.vader @@ -69,13 +69,13 @@ Execute(The javac handler should resolve files from different directories): AssertEqual \ [ \ { - \ 'filename': ale#path#Winify(g:dir . '/Foo.java'), + \ 'filename': ale#path#Simplify(g:dir . '/Foo.java'), \ 'lnum': 1, \ 'text': 'error: some error', \ 'type': 'E', \ }, \ { - \ 'filename': ale#path#Winify(g:dir . '/Bar.java'), + \ 'filename': ale#path#Simplify(g:dir . '/Bar.java'), \ 'lnum': 1, \ 'text': 'error: some error', \ 'type': 'E', diff --git a/test/handler/test_lessc_handler.vader b/test/handler/test_lessc_handler.vader index 530c582..31de559 100644 --- a/test/handler/test_lessc_handler.vader +++ b/test/handler/test_lessc_handler.vader @@ -32,14 +32,14 @@ Execute(The lessc handler should handle errors for other files in the same direc \ 'col': 1, \ 'type': 'E', \ 'text': 'Unrecognised input. Possibly missing something', - \ 'filename': ale#path#Winify(g:dir . '/imported.less') + \ 'filename': ale#path#Simplify(g:dir . '/imported.less') \ }, \ { \ 'lnum': 2, \ 'col': 1, \ 'type': 'E', \ 'text': 'Unrecognised input. Possibly missing something', - \ 'filename': ale#path#Winify(g:dir . '/imported.less') + \ 'filename': ale#path#Simplify(g:dir . '/imported.less') \ }, \ ], \ ale_linters#less#lessc#Handle(bufnr(''), [ @@ -59,7 +59,7 @@ Execute(The lessc handler should handle errors for files in directories above co \ 'col': 1, \ 'type': 'E', \ 'text': 'Unrecognised input. Possibly missing something', - \ 'filename': ale#path#Winify(g:dir . '/../imported2.less') + \ 'filename': ale#path#Simplify(g:dir . '/../imported2.less') \ }, \ ], \ ale_linters#less#lessc#Handle(bufnr(''), [ diff --git a/test/handler/test_mcsc_handler.vader b/test/handler/test_mcsc_handler.vader index d97a2ed..ac55ee8 100644 --- a/test/handler/test_mcsc_handler.vader +++ b/test/handler/test_mcsc_handler.vader @@ -18,7 +18,7 @@ Execute(The mcs handler should work with the default of the buffer's directory): \ 'text': '; expected', \ 'code': 'CS1001', \ 'type': 'E', - \ 'filename': ale#path#Winify(expand('%:p:h') . '/Test.cs', 'add_drive'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/Test.cs'), \ }, \ ], \ ale_linters#cs#mcsc#Handle(347, [ @@ -37,7 +37,7 @@ Execute(The mcs handler should handle cannot find symbol errors): \ 'text': '; expected', \ 'code': 'CS1001', \ 'type': 'E', - \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), + \ 'filename': ale#path#Simplify('/home/foo/project/bar/Test.cs'), \ }, \ { \ 'lnum': 101, @@ -45,7 +45,7 @@ Execute(The mcs handler should handle cannot find symbol errors): \ 'text': 'Unexpected processor directive (no #if for this #endif)', \ 'code': 'CS1028', \ 'type': 'E', - \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), + \ 'filename': ale#path#Simplify('/home/foo/project/bar/Test.cs'), \ }, \ { \ 'lnum': 10, @@ -53,7 +53,7 @@ Execute(The mcs handler should handle cannot find symbol errors): \ 'text': 'some warning', \ 'code': 'CS0123', \ 'type': 'W', - \ 'filename': ale#path#Winify('/home/foo/project/bar/Test.cs', 'add_drive'), + \ 'filename': ale#path#Simplify('/home/foo/project/bar/Test.cs'), \ }, \ ], \ ale_linters#cs#mcsc#Handle(347, [ diff --git a/test/handler/test_mypy_handler.vader b/test/handler/test_mypy_handler.vader index a3e224f..abb8504 100644 --- a/test/handler/test_mypy_handler.vader +++ b/test/handler/test_mypy_handler.vader @@ -15,35 +15,35 @@ Execute(The mypy handler should parse lines correctly): \ { \ 'lnum': 768, \ 'col': 38, - \ 'filename': ale#path#Winify(g:dir . '/baz.py'), + \ 'filename': ale#path#Simplify(g:dir . '/baz.py'), \ 'type': 'E', \ 'text': 'Cannot determine type of ''SOME_SYMBOL''', \ }, \ { \ 'lnum': 821, \ 'col': 38, - \ 'filename': ale#path#Winify(g:dir . '/baz.py'), + \ 'filename': ale#path#Simplify(g:dir . '/baz.py'), \ 'type': 'E', \ 'text': 'Cannot determine type of ''SOME_SYMBOL''', \ }, \ { \ 'lnum': 38, \ 'col': 44, - \ 'filename': ale#path#Winify(g:dir . '/other.py'), + \ 'filename': ale#path#Simplify(g:dir . '/other.py'), \ 'type': 'E', \ 'text': 'Cannot determine type of ''ANOTHER_SYMBOL''', \ }, \ { \ 'lnum': 15, \ 'col': 3, - \ 'filename': ale#path#Winify(g:dir . '/__init__.py'), + \ 'filename': ale#path#Simplify(g:dir . '/__init__.py'), \ 'type': 'E', \ 'text': 'Argument 1 to "somefunc" has incompatible type "int"; expected "str"' \ }, \ { \ 'lnum': 72, \ 'col': 1, - \ 'filename': ale#path#Winify(g:dir . '/__init__.py'), + \ 'filename': ale#path#Simplify(g:dir . '/__init__.py'), \ 'type': 'W', \ 'text': 'Some warning', \ }, diff --git a/test/handler/test_perl_handler.vader b/test/handler/test_perl_handler.vader index 9e1c520..75e8f22 100644 --- a/test/handler/test_perl_handler.vader +++ b/test/handler/test_perl_handler.vader @@ -15,9 +15,9 @@ Execute(The Perl linter should ignore errors from other files): \ {'lnum': '2', 'type': 'E', 'text': 'Compilation failed in require'}, \ ], \ ale_linters#perl#perl#Handle(bufnr(''), [ - \ 'syntax error at ' . ale#path#Winify(g:dir . '/foo.pm') . ' line 4, near "aklsdfjmy "', - \ 'Compilation failed in require at ' . ale#path#Winify(g:dir . '/bar.pl') . ' line 2.', - \ 'BEGIN failed--compilation aborted at ' . ale#path#Winify(g:dir . '/bar.pl') . ' line 2.', + \ 'syntax error at ' . ale#path#Simplify(g:dir . '/foo.pm') . ' line 4, near "aklsdfjmy "', + \ 'Compilation failed in require at ' . ale#path#Simplify(g:dir . '/bar.pl') . ' line 2.', + \ 'BEGIN failed--compilation aborted at ' . ale#path#Simplify(g:dir . '/bar.pl') . ' line 2.', \ ]) Execute(The Perl linter should complain about failing to locate modules): diff --git a/test/handler/test_rstcheck_lint_handler.vader b/test/handler/test_rstcheck_lint_handler.vader index 928c599..3b4ac03 100644 --- a/test/handler/test_rstcheck_lint_handler.vader +++ b/test/handler/test_rstcheck_lint_handler.vader @@ -8,21 +8,21 @@ Execute(Warning and error messages should be handled correctly): AssertEqual \ [ \ { - \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_python.rst'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/bad_python.rst'), \ 'lnum': 7, \ 'col': 0, \ 'type': 'W', \ 'text': '(python) unexpected EOF while parsing', \ }, \ { - \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_cpp.rst'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/bad_cpp.rst'), \ 'lnum': 9, \ 'col': 0, \ 'type': 'W', \ 'text': '(cpp) error: ''x'' was not declared in this scope', \ }, \ { - \ 'filename': ale#path#Winify(expand('%:p:h') . '/bad_rst.rst'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/bad_rst.rst'), \ 'lnum': 1, \ 'col': 0, \ 'type': 'E', diff --git a/test/handler/test_rust_handler.vader b/test/handler/test_rust_handler.vader index a148103..05bd1e9 100644 --- a/test/handler/test_rust_handler.vader +++ b/test/handler/test_rust_handler.vader @@ -110,7 +110,7 @@ Execute(The Rust handler should handle cargo output): \ 'byte_start': 11505, \ 'column_end': 8, \ 'column_start': 5, - \ 'file_name': ale#path#Winify('src/playpen.rs'), + \ 'file_name': ale#path#Simplify('src/playpen.rs'), \ 'is_primary': v:true, \ 'label': v:null, \ 'line_end': 15, @@ -130,7 +130,7 @@ Execute(The Rust handler should handle cargo output): \ 'byte_start': 11494, \ 'column_end': 10, \ 'column_start': 7, - \ 'file_name': ale#path#Winify('src/playpen.rs'), + \ 'file_name': ale#path#Simplify('src/playpen.rs'), \ 'is_primary': v:true, \ 'label': v:null, \ 'line_end': 13, @@ -174,7 +174,7 @@ Execute(The Rust handler should should errors from expansion spans): \ 'byte_start': 1, \ 'column_end': 1, \ 'column_start': 1, - \ 'file_name': ale#path#Winify('src/other.rs'), + \ 'file_name': ale#path#Simplify('src/other.rs'), \ 'is_primary': v:true, \ 'label': 'some other error', \ 'line_end': 4, @@ -185,7 +185,7 @@ Execute(The Rust handler should should errors from expansion spans): \ 'byte_start': 52, \ 'column_end': 23, \ 'column_start': 21, - \ 'file_name': ale#path#Winify('src/playpen.rs'), + \ 'file_name': ale#path#Simplify('src/playpen.rs'), \ 'is_primary': v:true, \ 'label': 'expected bool, found integral variable', \ 'line_end': 4, @@ -227,7 +227,7 @@ Execute(The Rust handler should show detailed errors): \ 'column_end': 23, \ 'column_start': 21, \ 'expansion': v:null, - \ 'file_name': ale#path#Winify('src/playpen.rs'), + \ 'file_name': ale#path#Simplify('src/playpen.rs'), \ 'is_primary': v:true, \ 'label': 'expected bool, found integral variable', \ 'line_end': 4, diff --git a/test/handler/test_tslint_handler.vader b/test/handler/test_tslint_handler.vader index 8d263ef..32036ed 100644 --- a/test/handler/test_tslint_handler.vader +++ b/test/handler/test_tslint_handler.vader @@ -27,7 +27,7 @@ Execute(The tslint handler should parse lines correctly): \ { \ 'lnum': 1, \ 'col': 15, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.ts'), \ 'end_lnum': 1, \ 'type': 'E', \ 'end_col': 15, @@ -37,7 +37,7 @@ Execute(The tslint handler should parse lines correctly): \ { \ 'lnum': 2, \ 'col': 8, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.ts'), \ 'end_lnum': 3, \ 'type': 'W', \ 'end_col': 12, @@ -46,7 +46,7 @@ Execute(The tslint handler should parse lines correctly): \ { \ 'lnum': 2, \ 'col': 8, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/something-else.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/something-else.ts'), \ 'end_lnum': 3, \ 'type': 'W', \ 'end_col': 12, @@ -56,7 +56,7 @@ Execute(The tslint handler should parse lines correctly): \ { \ 'lnum': 31, \ 'col': 9, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.ts'), \ 'end_lnum': 31, \ 'type': 'E', \ 'end_col': 20, @@ -157,7 +157,7 @@ Execute(The tslint handler report errors for empty files by default): \ { \ 'lnum': 2, \ 'col': 1, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.ts'), \ 'end_lnum': 2, \ 'type': 'E', \ 'end_col': 1, @@ -231,7 +231,7 @@ Execute(The tslint handler should report errors when the ignore option is on, bu \ { \ 'lnum': 2, \ 'col': 1, - \ 'filename': ale#path#Winify(expand('%:p:h') . '/test.ts'), + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.ts'), \ 'end_lnum': 2, \ 'type': 'E', \ 'end_col': 1, diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index 3abdd8a..053da80 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -150,7 +150,7 @@ Execute(ale#lsp#tsserver_message#Open() should return correct messages): \ 1, \ 'ts@open', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ } \ ], \ ale#lsp#tsserver_message#Open(bufnr('')) @@ -161,7 +161,7 @@ Execute(ale#lsp#tsserver_message#Close() should return correct messages): \ 1, \ 'ts@close', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ } \ ], \ ale#lsp#tsserver_message#Close(bufnr('')) @@ -172,7 +172,7 @@ Execute(ale#lsp#tsserver_message#Change() should return correct messages): \ 1, \ 'ts@change', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ 'line': 1, \ 'offset': 1, \ 'endLine': 1073741824, @@ -188,7 +188,7 @@ Execute(ale#lsp#tsserver_message#Geterr() should return correct messages): \ 1, \ 'ts@geterr', \ { - \ 'files': [ale#path#Winify(g:dir . '/foo/bar.ts')], + \ 'files': [ale#path#Simplify(g:dir . '/foo/bar.ts')], \ } \ ], \ ale#lsp#tsserver_message#Geterr(bufnr('')) @@ -199,7 +199,7 @@ Execute(ale#lsp#tsserver_message#Completions() should return correct messages): \ 0, \ 'ts@completions', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ 'line': 347, \ 'offset': 12, \ 'prefix': 'abc', @@ -213,7 +213,7 @@ Execute(ale#lsp#tsserver_message#CompletionEntryDetails() should return correct \ 0, \ 'ts@completionEntryDetails', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ 'line': 347, \ 'offset': 12, \ 'entryNames': ['foo', 'bar'], @@ -227,7 +227,7 @@ Execute(ale#lsp#tsserver_message#Definition() should return correct messages): \ 0, \ 'ts@definition', \ { - \ 'file': ale#path#Winify(g:dir . '/foo/bar.ts'), + \ 'file': ale#path#Simplify(g:dir . '/foo/bar.ts'), \ 'line': 347, \ 'offset': 12, \ } diff --git a/test/test_c_import_paths.vader b/test/test_c_import_paths.vader index 21e49a3..6080779 100644 --- a/test/test_c_import_paths.vader +++ b/test/test_c_import_paths.vader @@ -39,8 +39,8 @@ Execute(The C GCC handler should include 'include' directories for projects with AssertEqual \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -52,8 +52,8 @@ Execute(The C GCC handler should include 'include' directories for projects with AssertEqual \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -65,8 +65,8 @@ Execute(The C GCC handler should include root directories for projects with .h f AssertEqual \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -78,8 +78,8 @@ Execute(The C GCC handler should include root directories for projects with .hpp AssertEqual \ ale#Escape('gcc') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' \ . ' -' \ , ale_linters#c#gcc#GetCommand(bufnr('')) @@ -91,8 +91,8 @@ Execute(The C Clang handler should include 'include' directories for projects wi AssertEqual \ ale#Escape('clang') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#c#clang#GetCommand(bufnr('')) @@ -104,8 +104,8 @@ Execute(The C Clang handler should include 'include' directories for projects wi AssertEqual \ ale#Escape('clang') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project')) . ' ' \ . ' -' \ , ale_linters#c#clang#GetCommand(bufnr('')) @@ -117,8 +117,8 @@ Execute(The C Clang handler should include root directories for projects with .h AssertEqual \ ale#Escape('clang') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project')) . ' ' \ . ' -' \ , ale_linters#c#clang#GetCommand(bufnr('')) @@ -130,8 +130,8 @@ Execute(The C Clang handler should include root directories for projects with .h AssertEqual \ ale#Escape('clang') \ . ' -S -x c -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' \ . ' -' \ , ale_linters#c#clang#GetCommand(bufnr('')) @@ -143,8 +143,8 @@ Execute(The C++ GCC handler should include 'include' directories for projects wi AssertEqual \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -156,8 +156,8 @@ Execute(The C++ GCC handler should include 'include' directories for projects wi AssertEqual \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -169,8 +169,8 @@ Execute(The C++ GCC handler should include root directories for projects with .h AssertEqual \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -182,8 +182,8 @@ Execute(The C++ GCC handler should include root directories for projects with .h AssertEqual \ ale#Escape('gcc') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' \ . ' -' \ , ale_linters#cpp#gcc#GetCommand(bufnr('')) @@ -195,8 +195,8 @@ Execute(The C++ Clang handler should include 'include' directories for projects AssertEqual \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/makefile_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -208,8 +208,8 @@ Execute(The C++ Clang handler should include 'include' directories for projects AssertEqual \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/configure_project/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/configure_project/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -221,8 +221,8 @@ Execute(The C++ Clang handler should include root directories for projects with AssertEqual \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/h_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/h_file_project')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -234,8 +234,8 @@ Execute(The C++ Clang handler should include root directories for projects with AssertEqual \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project/subdir')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/hpp_file_project')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -255,8 +255,8 @@ Execute(The C++ Clang handler shoud use the include directory based on the .git AssertEqual \ ale#Escape('clang++') \ . ' -S -x c++ -fsyntax-only ' - \ . '-iquote ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/git_and_nested_makefiles/src')) . ' ' - \ . ' -I' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/git_and_nested_makefiles/include')) . ' ' + \ . '-iquote ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/git_and_nested_makefiles/src')) . ' ' + \ . ' -I' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/git_and_nested_makefiles/include')) . ' ' \ . ' -' \ , ale_linters#cpp#clang#GetCommand(bufnr('')) @@ -268,7 +268,7 @@ Execute(The C++ ClangTidy handler should include json folders for projects with AssertEqual \ ale#Escape('clang-tidy') \ . ' -checks=' . ale#Escape('*') . ' %s ' - \ . '-p ' . ale#Escape(ale#path#Winify(g:dir . '/test_c_projects/json_project/build')) + \ . '-p ' . ale#Escape(ale#path#Simplify(g:dir . '/test_c_projects/json_project/build')) \ , ale_linters#cpp#clangtidy#GetCommand(bufnr('')) Execute(Move .git/HEAD back): diff --git a/test/test_csslint_config_detection.vader b/test/test_csslint_config_detection.vader index d84a00f..47e80d0 100644 --- a/test/test_csslint_config_detection.vader +++ b/test/test_csslint_config_detection.vader @@ -13,7 +13,7 @@ Execute(--config should be set when the .csslintrc file is found): AssertEqual \ ( \ 'csslint --format=compact ' - \ . '--config=' . ale#Escape(ale#path#Winify(g:dir . '/csslint-test-files/some-app/.csslintrc')) + \ . '--config=' . ale#Escape(ale#path#Simplify(g:dir . '/csslint-test-files/some-app/.csslintrc')) \ . ' %t' \ ), \ ale_linters#css#csslint#GetCommand(bufnr('')) diff --git a/test/test_elm_executable_detection.vader b/test/test_elm_executable_detection.vader index cca8a6e..4227cbf 100644 --- a/test/test_elm_executable_detection.vader +++ b/test/test_elm_executable_detection.vader @@ -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#Winify(g:dir . '/elm-test-files/app/node_modules/.bin/elm-make'), + \ ale#path#Simplify(g:dir . '/elm-test-files/app/node_modules/.bin/elm-make'), \ ale_linters#elm#make#GetExecutable(bufnr('')) Execute(should get valid executable with 'use_global' params): diff --git a/test/test_eslint_executable_detection.vader b/test/test_eslint_executable_detection.vader index ee79242..c1438ed 100644 --- a/test/test_eslint_executable_detection.vader +++ b/test/test_eslint_executable_detection.vader @@ -17,7 +17,7 @@ Execute(create-react-app directories should be detected correctly): call ale#test#SetFilename('eslint-test-files/react-app/subdir/testfile.js') AssertEqual - \ ale#path#Winify(g:dir . '/eslint-test-files/react-app/node_modules/eslint/bin/eslint.js'), + \ ale#path#Simplify(g:dir . '/eslint-test-files/react-app/node_modules/eslint/bin/eslint.js'), \ ale#handlers#eslint#GetExecutable(bufnr('')) Execute(use-global should override create-react-app detection): @@ -33,7 +33,7 @@ Execute(other app directories should be detected correctly): call ale#test#SetFilename('eslint-test-files/other-app/subdir/testfile.js') AssertEqual - \ ale#path#Winify(g:dir . '/eslint-test-files/node_modules/.bin/eslint'), + \ ale#path#Simplify(g:dir . '/eslint-test-files/node_modules/.bin/eslint'), \ ale#handlers#eslint#GetExecutable(bufnr('')) Execute(use-global should override other app directories): @@ -49,7 +49,7 @@ Execute(eslint_d should be detected correctly): call ale#test#SetFilename('eslint-test-files/app-with-eslint-d/testfile.js') AssertEqual - \ ale#path#Winify(g:dir . '/eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d'), + \ ale#path#Simplify(g:dir . '/eslint-test-files/app-with-eslint-d/node_modules/.bin/eslint_d'), \ ale#handlers#eslint#GetExecutable(bufnr('')) Execute(eslint.js executables should be run with node on Windows): @@ -59,6 +59,6 @@ Execute(eslint.js executables should be run with node on Windows): " We have to execute the file with node. AssertEqual \ ale#Escape('node.exe') . ' ' - \ . ale#Escape(ale#path#Winify(g:dir . '/eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/eslint-test-files/react-app/node_modules/eslint/bin/eslint.js')) \ . ' -f unix --stdin --stdin-filename %s', \ ale#handlers#eslint#GetCommand(bufnr('')) diff --git a/test/test_find_nearest_directory.vader b/test/test_find_nearest_directory.vader index 1442c8f..2529950 100644 --- a/test/test_find_nearest_directory.vader +++ b/test/test_find_nearest_directory.vader @@ -8,7 +8,7 @@ Execute(We should be able to find a directory some directory down): call ale#test#SetFilename('top/middle/bottom/dummy.txt') AssertEqual - \ ale#path#Winify(expand('%:p:h:h:h:h') . '/top/ale-special-directory-name-dont-use-this-please/'), + \ ale#path#Simplify(expand('%:p:h:h:h:h') . '/top/ale-special-directory-name-dont-use-this-please/'), \ ale#path#FindNearestDirectory(bufnr('%'), 'ale-special-directory-name-dont-use-this-please') Execute(We shouldn't find anything for files which don't match): diff --git a/test/test_go_to_definition.vader b/test/test_go_to_definition.vader index 1e0380f..b77a75a 100644 --- a/test/test_go_to_definition.vader +++ b/test/test_go_to_definition.vader @@ -70,7 +70,7 @@ Execute(Other files should be jumped to for definition responses): \ 'success': v:true, \ 'body': [ \ { - \ 'file': ale#path#Winify(g:dir . '/completion_dummy_file'), + \ 'file': ale#path#Simplify(g:dir . '/completion_dummy_file'), \ 'start': {'line': 3, 'offset': 7}, \ }, \ ], @@ -79,7 +79,7 @@ Execute(Other files should be jumped to for definition responses): AssertEqual \ [ - \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'edit ' . fnameescape(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -95,7 +95,7 @@ Execute(Other files should be jumped to for definition responses in tabs too): \ 'success': v:true, \ 'body': [ \ { - \ 'file': ale#path#Winify(g:dir . '/completion_dummy_file'), + \ 'file': ale#path#Simplify(g:dir . '/completion_dummy_file'), \ 'start': {'line': 3, 'offset': 7}, \ }, \ ], @@ -104,7 +104,7 @@ Execute(Other files should be jumped to for definition responses in tabs too): AssertEqual \ [ - \ 'tabedit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'tabedit ' . fnameescape(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -150,7 +150,7 @@ Execute(Other files should be jumped to for LSP definition responses): \ { \ 'id': 3, \ 'result': { - \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, @@ -160,7 +160,7 @@ Execute(Other files should be jumped to for LSP definition responses): AssertEqual \ [ - \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'edit ' . fnameescape(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -173,7 +173,7 @@ Execute(Other files should be jumped to in tabs for LSP definition responses): \ { \ 'id': 3, \ 'result': { - \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, @@ -183,7 +183,7 @@ Execute(Other files should be jumped to in tabs for LSP definition responses): AssertEqual \ [ - \ 'tabedit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'tabedit ' . fnameescape(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] @@ -197,13 +197,13 @@ Execute(Definition responses with lists should be handled): \ 'id': 3, \ 'result': [ \ { - \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ 'range': { \ 'start': {'line': 2, 'character': 7}, \ }, \ }, \ { - \ 'uri': ale#path#ToURI(ale#path#Winify(g:dir . '/other_file')), + \ 'uri': ale#path#ToURI(ale#path#Simplify(g:dir . '/other_file')), \ 'range': { \ 'start': {'line': 20, 'character': 3}, \ }, @@ -214,7 +214,7 @@ Execute(Definition responses with lists should be handled): AssertEqual \ [ - \ 'edit ' . fnameescape(ale#path#Winify(g:dir . '/completion_dummy_file')), + \ 'edit ' . fnameescape(ale#path#Simplify(g:dir . '/completion_dummy_file')), \ ], \ g:expr_list AssertEqual [3, 7], getpos('.')[1:2] diff --git a/test/test_gradle_build_classpath_command.vader b/test/test_gradle_build_classpath_command.vader index c31dc69..3c1eceb 100644 --- a/test/test_gradle_build_classpath_command.vader +++ b/test/test_gradle_build_classpath_command.vader @@ -10,7 +10,7 @@ Before: let g:command_tail = ' -I ' . ale#Escape(ale#gradle#GetInitPath()) \ . ' -q printClasspath' - let g:gradle_init_path = ale#path#Winify(g:dir . '../../autoload/ale/gradle/init.gradle') + let g:gradle_init_path = ale#path#Simplify(g:dir . '../../autoload/ale/gradle/init.gradle') After: Restore @@ -25,18 +25,18 @@ Execute(Should return 'gradlew' command if project includes gradle wapper): call ale#test#SetFilename('gradle-test-files/wrapped-project/src/main/kotlin/dummy.kt') AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/gradle-test-files/wrapped-project')) - \ . ' && ' . ale#Escape(ale#path#Winify(g:dir . '/gradle-test-files/wrapped-project/gradlew')) + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/gradle-test-files/wrapped-project')) + \ . ' && ' . ale#Escape(ale#path#Simplify(g:dir . '/gradle-test-files/wrapped-project/gradlew')) \ . g:command_tail, \ ale#gradle#BuildClasspathCommand(bufnr('')) Execute(Should return 'gradle' command if project does not include gradle wapper): call ale#test#SetFilename('gradle-test-files/unwrapped-project/src/main/kotlin/dummy.kt') let $PATH .= (has('win32') ? ';' : ':') - \ . ale#path#Winify(g:dir . '/gradle-test-files') + \ . ale#path#Simplify(g:dir . '/gradle-test-files') AssertEqual - \ 'cd ' . ale#Escape(ale#path#Winify(g:dir . '/gradle-test-files/unwrapped-project')) + \ 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/gradle-test-files/unwrapped-project')) \ . ' && ' . ale#Escape('gradle') \ . g:command_tail, \ ale#gradle#BuildClasspathCommand(bufnr('')) diff --git a/test/test_gradle_find_executable.vader b/test/test_gradle_find_executable.vader index 054c21a..5daa490 100644 --- a/test/test_gradle_find_executable.vader +++ b/test/test_gradle_find_executable.vader @@ -18,12 +18,12 @@ Execute(Should return 'gradlew' if found in parent directory): call ale#test#SetFilename('gradle-test-files/wrapped-project/src/main/kotlin/dummy.kt') AssertEqual - \ ale#path#Winify(g:dir . '/gradle-test-files/wrapped-project/gradlew'), + \ ale#path#Simplify(g:dir . '/gradle-test-files/wrapped-project/gradlew'), \ ale#gradle#FindExecutable(bufnr('')) Execute(Should return 'gradle' if 'gradlew' not found in parent directory): call ale#test#SetFilename('gradle-test-files/unwrapped-project/src/main/kotlin/dummy.kt') - let $PATH .= (has('win32') ? ';': ':') . ale#path#Winify(g:dir . '/gradle-test-files') + let $PATH .= (has('win32') ? ';': ':') . ale#path#Simplify(g:dir . '/gradle-test-files') AssertEqual \ 'gradle', diff --git a/test/test_gradle_find_project_root.vader b/test/test_gradle_find_project_root.vader index 87af110..8305bba 100644 --- a/test/test_gradle_find_project_root.vader +++ b/test/test_gradle_find_project_root.vader @@ -10,21 +10,21 @@ Execute(Should return directory for 'gradlew' if found in parent directory): call ale#test#SetFilename('gradle-test-files/wrapped-project/src/main/kotlin/dummy.kt') AssertEqual - \ ale#path#Winify(g:dir . '/gradle-test-files/wrapped-project'), + \ ale#path#Simplify(g:dir . '/gradle-test-files/wrapped-project'), \ ale#gradle#FindProjectRoot(bufnr('')) Execute(Should return directory for 'settings.gradle' if found in parent directory): call ale#test#SetFilename('gradle-test-files/settings-gradle-project/src/main/kotlin/dummy.kt') AssertEqual - \ ale#path#Winify(g:dir . '/gradle-test-files/settings-gradle-project'), + \ ale#path#Simplify(g:dir . '/gradle-test-files/settings-gradle-project'), \ ale#gradle#FindProjectRoot(bufnr('')) Execute(Should return directory for 'build.gradle' if found in parent directory): call ale#test#SetFilename('gradle-test-files/build-gradle-project/src/main/kotlin/dummy.kt') AssertEqual - \ ale#path#Winify(g:dir . '/gradle-test-files/build-gradle-project'), + \ ale#path#Simplify(g:dir . '/gradle-test-files/build-gradle-project'), \ ale#gradle#FindProjectRoot(bufnr('')) Execute(Should return empty string if gradle files are not found in parent directory): diff --git a/test/test_list_titles.vader b/test/test_list_titles.vader index e729541..d521906 100644 --- a/test/test_list_titles.vader +++ b/test/test_list_titles.vader @@ -42,7 +42,7 @@ Execute(The loclist titles should be set appropriately): if !has('nvim') AssertEqual - \ {'title': ale#path#Winify(getcwd() . '/foo')}, + \ {'title': ale#path#Simplify(getcwd() . '/foo')}, \ getloclist(0, {'title': ''}) endif @@ -72,6 +72,6 @@ Execute(The quickfix titles should be set appropriately): if !has('nvim') AssertEqual - \ {'title': ale#path#Winify(getcwd() . '/foo')}, + \ {'title': ale#path#Simplify(getcwd() . '/foo')}, \ getqflist({'title': ''}) endif diff --git a/test/test_nearest_file_search.vader b/test/test_nearest_file_search.vader index 63e82da..10d2cb3 100644 --- a/test/test_nearest_file_search.vader +++ b/test/test_nearest_file_search.vader @@ -8,7 +8,7 @@ Execute(We should be able to find a configuration file further up): call ale#test#SetFilename('top/middle/bottom/dummy.txt') AssertEqual - \ ale#path#Winify(expand('%:p:h:h:h:h') . '/top/example.ini'), + \ ale#path#Simplify(expand('%:p:h:h:h:h') . '/top/example.ini'), \ ale#path#FindNearestFile(bufnr('%'), 'example.ini') Execute(We shouldn't find anything for files which don't match): diff --git a/test/test_path_equality.vader b/test/test_path_equality.vader index 314a2d9..4ec9bd6 100644 --- a/test/test_path_equality.vader +++ b/test/test_path_equality.vader @@ -1,6 +1,6 @@ Before: function! CheckPath(path) abort - return ale#path#IsBufferPath(bufnr(''), ale#path#Winify(a:path)) + return ale#path#IsBufferPath(bufnr(''), ale#path#Simplify(a:path)) endfunction After: diff --git a/test/test_phpcs_executable_detection.vader b/test/test_phpcs_executable_detection.vader index f51ba9f..020bfac 100644 --- a/test/test_phpcs_executable_detection.vader +++ b/test/test_phpcs_executable_detection.vader @@ -19,7 +19,7 @@ Execute(project with phpcs should use local by default): call ale#test#SetFilename('phpcs-test-files/project-with-phpcs/foo/test.php') AssertEqual - \ ale#path#Winify(g:dir . '/phpcs-test-files/project-with-phpcs/vendor/bin/phpcs'), + \ ale#path#Simplify(g:dir . '/phpcs-test-files/project-with-phpcs/vendor/bin/phpcs'), \ ale_linters#php#phpcs#GetExecutable(bufnr('')) Execute(use-global should override local detection): diff --git a/test/test_resolve_local_path.vader b/test/test_resolve_local_path.vader index 125ae2f..3f0fb20 100644 --- a/test/test_resolve_local_path.vader +++ b/test/test_resolve_local_path.vader @@ -8,7 +8,7 @@ Execute(We should be able to find the local version of a file): call ale#test#SetFilename('top/middle/bottom/dummy.txt') AssertEqual - \ ale#path#Winify(expand('%:p:h:h:h:h') . '/top/example.ini'), + \ ale#path#Simplify(expand('%:p:h:h:h:h') . '/top/example.ini'), \ ale#path#ResolveLocalPath(bufnr('%'), 'example.ini', '/global/config.ini') Execute(We shouldn't find anything for files which don't match): diff --git a/test/test_sml_command.vader b/test/test_sml_command.vader index 2db2552..d26f650 100644 --- a/test/test_sml_command.vader +++ b/test/test_sml_command.vader @@ -9,14 +9,14 @@ Execute(smlnj finds CM file if it exists): call ale#test#SetFilename('smlnj/cm/foo.sml') AssertEqual - \ ale#path#Winify(g:dir . '/smlnj/cm/sources.cm'), + \ ale#path#Simplify(g:dir . '/smlnj/cm/sources.cm'), \ ale#handlers#sml#GetCmFile(bufnr('%')) Execute(smlnj finds CM file by searching upwards): call ale#test#SetFilename('smlnj/cm/path/to/bar.sml') AssertEqual - \ ale#path#Winify(g:dir . '/smlnj/cm/sources.cm'), + \ ale#path#Simplify(g:dir . '/smlnj/cm/sources.cm'), \ ale#handlers#sml#GetCmFile(bufnr('%')) Execute(smlnj returns '' when no CM file found): diff --git a/test/test_tflint_config_detection.vader b/test/test_tflint_config_detection.vader index 65c364e..3500869 100644 --- a/test/test_tflint_config_detection.vader +++ b/test/test_tflint_config_detection.vader @@ -12,7 +12,7 @@ Execute(adjacent config file should be found): \ ( \ ale#Escape('tflint') \ . ' --config ' - \ . ale#Escape(ale#path#Winify(g:dir . '/tflint-test-files/foo/.tflint.hcl')) + \ . ale#Escape(ale#path#Simplify(g:dir . '/tflint-test-files/foo/.tflint.hcl')) \ . ' -f json %t' \ ), \ ale_linters#terraform#tflint#GetCommand(bufnr('')) From 4b56b91ac859e18a632343ed8692696c70b34e46 Mon Sep 17 00:00:00 2001 From: Jansen Mitchell Date: Tue, 19 Dec 2017 20:27:12 -0600 Subject: [PATCH 300/390] Add support for Fountain with proselint. --- ale_linters/fountain/proselint.vim | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 ale_linters/fountain/proselint.vim diff --git a/ale_linters/fountain/proselint.vim b/ale_linters/fountain/proselint.vim new file mode 100644 index 0000000..5761adc --- /dev/null +++ b/ale_linters/fountain/proselint.vim @@ -0,0 +1,9 @@ +" Author: Jansen Mitchell https://github.com/JansenMitchell +" Description: proselint for Fountain files + +call ale#linter#Define('fountain', { +\ 'name': 'proselint', +\ 'executable': 'proselint', +\ 'command': 'proselint %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\}) From 537d162ee7f083faed817ba069fafc6c10c4ad5f Mon Sep 17 00:00:00 2001 From: Jansen Mitchell Date: Tue, 19 Dec 2017 21:57:25 -0600 Subject: [PATCH 301/390] Add Fountain and linter support information to README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e939e6f..f769e6e 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,7 @@ formatting. | Erb | [erb](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | | Fortran | [gcc](https://gcc.gnu.org/) | +| Fountain | [proselint](http://proselint.com/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | From d4b43d23f4a9f277a482fdad4ea3a3e951d80eab Mon Sep 17 00:00:00 2001 From: Nick Diego Yamane Date: Wed, 20 Dec 2017 06:10:07 -0400 Subject: [PATCH 302/390] Add support for linting git commit message files (#1233) --- README.md | 1 + ale_linters/gitcommit/gitlint.vim | 51 +++++++++++ doc/ale-gitcommit.txt | 42 ++++++++++ doc/ale.txt | 3 + .../no_virtualenv/subdir/foo/COMMIT_EDITMSG | 0 .../with_virtualenv/env/Scripts/gitlint.exe | 0 .../with_virtualenv/env/bin/gitlint | 0 .../with_virtualenv/subdir/foo/COMMIT_EDITMSG | 0 .../test_gitlint_command_callback.vader | 84 +++++++++++++++++++ test/handler/test_gitlint_handler.vader | 37 ++++++++ 10 files changed, 218 insertions(+) create mode 100644 ale_linters/gitcommit/gitlint.vim create mode 100644 doc/ale-gitcommit.txt create mode 100644 test/command_callback/python_paths/no_virtualenv/subdir/foo/COMMIT_EDITMSG create mode 100755 test/command_callback/python_paths/with_virtualenv/env/Scripts/gitlint.exe create mode 100755 test/command_callback/python_paths/with_virtualenv/env/bin/gitlint create mode 100644 test/command_callback/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG create mode 100644 test/command_callback/test_gitlint_command_callback.vader create mode 100644 test/handler/test_gitlint_handler.vader diff --git a/README.md b/README.md index e939e6f..129033c 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,7 @@ formatting. | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | +| Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | diff --git a/ale_linters/gitcommit/gitlint.vim b/ale_linters/gitcommit/gitlint.vim new file mode 100644 index 0000000..991d5a1 --- /dev/null +++ b/ale_linters/gitcommit/gitlint.vim @@ -0,0 +1,51 @@ +" Author: Nick Yamane +" Description: gitlint for git commit message files + +let g:ale_gitcommit_gitlint_executable = +\ get(g:, 'ale_gitcommit_gitlint_executable', 'gitlint') +let g:ale_gitcommit_gitlint_options = get(g:, 'ale_gitcommit_gitlint_options', '') +let g:ale_gitcommit_gitlint_use_global = get(g:, 'ale_gitcommit_gitlint_use_global', 0) + + +function! ale_linters#gitcommit#gitlint#GetExecutable(buffer) abort + return ale#python#FindExecutable(a:buffer, 'gitcommit_gitlint', ['gitlint']) +endfunction + +function! ale_linters#gitcommit#gitlint#GetCommand(buffer) abort + let l:options = ale#Var(a:buffer, 'gitcommit_gitlint_options') + let l:executable = ale_linters#gitcommit#gitlint#GetExecutable(a:buffer) + return ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' lint' +endfunction + + +function! ale_linters#gitcommit#gitlint#Handle(buffer, lines) abort + " Matches patterns line the following: + let l:pattern = '\v^(\d+): (\w+) (.*)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:code = l:match[2] + + let l:item = { + \ 'lnum': l:match[1] + 0, + \ 'text': l:code . ': ' . l:match[3], + \ 'type': 'E', + \} + + call add(l:output, l:item) + endfor + + return l:output +endfunction + + +call ale#linter#Define('gitcommit', { +\ 'name': 'gitlint', +\ 'output_stream': 'stderr', +\ 'executable_callback': 'ale_linters#gitcommit#gitlint#GetExecutable', +\ 'command_callback': 'ale_linters#gitcommit#gitlint#GetCommand', +\ 'callback': 'ale_linters#gitcommit#gitlint#Handle', +\}) + diff --git a/doc/ale-gitcommit.txt b/doc/ale-gitcommit.txt new file mode 100644 index 0000000..71813dd --- /dev/null +++ b/doc/ale-gitcommit.txt @@ -0,0 +1,42 @@ +=============================================================================== +ALE Git Commit Integration *ale-gitcommit-options* + + +=============================================================================== +gitlint *ale-gitcommit-gitlint* + +g:ale_gitcommit_gitlint_executable *g:ale_gitcommit_gitlint_executable* + *b:ale_gitcommit_gitlint_executable* + Type: |String| + Default: `'gitlint'` + + This variable can be changed to modify the executable used for gitlint. + + +g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options* + *b:ale_gitcommit_gitlint_options* + Type: |String| + Default: `''` + + This variable can be changed to add command-line arguments to the gitlint + invocation. + + For example, to dinamically set the gitlint configuration file path, you + may want to set > + + let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini' +< + +g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global* + *b:ale_gitcommit_gitlint_use_global* + Type: |Number| + Default: `0` + + This variable controls whether or not ALE will search for gitlint in a + virtualenv directory first. If this variable is set to `1`, then ALE will + always use |g:ale_gitcommit_gitlint_executable| for the executable path. + + Both variables can be set with `b:` buffer variables instead. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index bdcb39f..7cc6b22 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -68,6 +68,8 @@ CONTENTS *ale-contents* gcc.................................|ale-fortran-gcc| fusionscript..........................|ale-fuse-options| fusion-lint.........................|ale-fuse-fusionlint| + git commit............................|ale-gitcommit-options| + gitlint.............................|ale-gitcommit-gitlint| glsl..................................|ale-glsl-options| glslang.............................|ale-glsl-glslang| glslls..............................|ale-glsl-glslls| @@ -300,6 +302,7 @@ Notes: * Erlang: `erlc`, `SyntaxErl` * Fortran: `gcc` * FusionScript: `fusion-lint` +* Git Commit Messages: `gitlint` * GLSL: glslang, `glslls` * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `eslint`, `gqlint` diff --git a/test/command_callback/python_paths/no_virtualenv/subdir/foo/COMMIT_EDITMSG b/test/command_callback/python_paths/no_virtualenv/subdir/foo/COMMIT_EDITMSG new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/python_paths/with_virtualenv/env/Scripts/gitlint.exe b/test/command_callback/python_paths/with_virtualenv/env/Scripts/gitlint.exe new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/python_paths/with_virtualenv/env/bin/gitlint b/test/command_callback/python_paths/with_virtualenv/env/bin/gitlint new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG b/test/command_callback/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_gitlint_command_callback.vader b/test/command_callback/test_gitlint_command_callback.vader new file mode 100644 index 0000000..1a40ea7 --- /dev/null +++ b/test/command_callback/test_gitlint_command_callback.vader @@ -0,0 +1,84 @@ +Before: + Save g:ale_gitcommit_gitlint_executable + Save g:ale_gitcommit_gitlint_options + Save g:ale_gitcommit_gitlint_use_global + + unlet! g:ale_gitcommit_gitlint_executable + unlet! g:ale_gitcommit_gitlint_options + unlet! g:ale_gitcommit_gitlint_use_global + + runtime ale_linters/gitcommit/gitlint.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + + let b:bin_dir = has('win32') ? 'Scripts' : 'bin' + let b:command_tail = ' lint' + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + + unlet! b:bin_dir + unlet! b:executable + +Execute(The gitlint callbacks should return the correct default values): + AssertEqual + \ 'gitlint', + \ ale_linters#gitcommit#gitlint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('gitlint') . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) + +Execute(The gitlint executable should be configurable, and escaped properly): + let g:ale_gitcommit_gitlint_executable = 'executable with spaces' + + AssertEqual + \ 'executable with spaces', + \ ale_linters#gitcommit#gitlint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('executable with spaces') . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) + +Execute(The gitlint command callback should let you set options): + let g:ale_gitcommit_gitlint_options = '--some-option' + + AssertEqual + \ ale#Escape('gitlint') . ' --some-option' . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) + +Execute(The gitlint callbacks shouldn't detect virtualenv directories where they don't exist): + silent execute 'file ' . fnameescape(g:dir . '/python_paths/no_virtualenv/subdir/foo/COMMIT_EDITMSG') + + AssertEqual + \ 'gitlint', + \ ale_linters#gitcommit#gitlint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('gitlint') . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) + +Execute(The gitlint callbacks should detect virtualenv directories): + silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG') + + let b:executable = ale#path#Winify( + \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/gitlint' + \) + + AssertEqual + \ b:executable, + \ ale_linters#gitcommit#gitlint#GetExecutable(bufnr('')) + + AssertEqual + \ ale#Escape(b:executable) . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) + +Execute(You should able able to use the global gitlint instead): + silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG') + let g:ale_gitcommit_gitlint_use_global = 1 + + AssertEqual + \ 'gitlint', + \ ale_linters#gitcommit#gitlint#GetExecutable(bufnr('')) + AssertEqual + \ ale#Escape('gitlint') . b:command_tail, + \ ale_linters#gitcommit#gitlint#GetCommand(bufnr('')) diff --git a/test/handler/test_gitlint_handler.vader b/test/handler/test_gitlint_handler.vader new file mode 100644 index 0000000..58f5e67 --- /dev/null +++ b/test/handler/test_gitlint_handler.vader @@ -0,0 +1,37 @@ +Before: + runtime ale_linters/gitcommit/gitlint.vim + +After: + call ale#linter#Reset() + +Execute(The gitlint handler should handle basic warnings and syntax errors): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'type': 'E', + \ 'text': 'B6: Body message is missing', + \ }, + \ { + \ 'lnum': 2, + \ 'type': 'E', + \ 'text': 'B4: Second line is not empty: "to send to upstream"', + \ }, + \ { + \ 'lnum': 3, + \ 'type': 'E', + \ 'text': 'B5: Body message is too short (19<20): "to send to upstream"', + \ }, + \ { + \ 'lnum': 8, + \ 'type': 'E', + \ 'text': 'T1: Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"' + \ }, + \ ], + \ ale_linters#gitcommit#gitlint#Handle(1, [ + \ '1: B6 Body message is missing', + \ '2: B4 Second line is not empty: "to send to upstream"', + \ '3: B5 Body message is too short (19<20): "to send to upstream"', + \ '8: T1 Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"' + \ ]) + From 87ffc9b55ca9f6aa3ca8acc2babeb26cf2a78b51 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 20 Dec 2017 10:46:08 +0000 Subject: [PATCH 303/390] Make the error codes configurable for gitlint --- ale_linters/gitcommit/gitlint.vim | 3 ++- test/handler/test_gitlint_handler.vader | 12 ++++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/ale_linters/gitcommit/gitlint.vim b/ale_linters/gitcommit/gitlint.vim index 991d5a1..49aeda7 100644 --- a/ale_linters/gitcommit/gitlint.vim +++ b/ale_linters/gitcommit/gitlint.vim @@ -30,7 +30,8 @@ function! ale_linters#gitcommit#gitlint#Handle(buffer, lines) abort let l:item = { \ 'lnum': l:match[1] + 0, - \ 'text': l:code . ': ' . l:match[3], + \ 'text': l:match[3], + \ 'code': l:code, \ 'type': 'E', \} diff --git a/test/handler/test_gitlint_handler.vader b/test/handler/test_gitlint_handler.vader index 58f5e67..73ee988 100644 --- a/test/handler/test_gitlint_handler.vader +++ b/test/handler/test_gitlint_handler.vader @@ -10,22 +10,26 @@ Execute(The gitlint handler should handle basic warnings and syntax errors): \ { \ 'lnum': 1, \ 'type': 'E', - \ 'text': 'B6: Body message is missing', + \ 'text': 'Body message is missing', + \ 'code': 'B6', \ }, \ { \ 'lnum': 2, \ 'type': 'E', - \ 'text': 'B4: Second line is not empty: "to send to upstream"', + \ 'text': 'Second line is not empty: "to send to upstream"', + \ 'code': 'B4', \ }, \ { \ 'lnum': 3, \ 'type': 'E', - \ 'text': 'B5: Body message is too short (19<20): "to send to upstream"', + \ 'text': 'Body message is too short (19<20): "to send to upstream"', + \ 'code': 'B5', \ }, \ { \ 'lnum': 8, \ 'type': 'E', - \ 'text': 'T1: Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"' + \ 'text': 'Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"', + \ 'code': 'T1', \ }, \ ], \ ale_linters#gitcommit#gitlint#Handle(1, [ From 2495744fc31e0041cc4ed6b7b6fdc1b1a15ffb62 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 20 Dec 2017 10:49:23 +0000 Subject: [PATCH 304/390] Fix the gitlint test --- test/command_callback/test_gitlint_command_callback.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/command_callback/test_gitlint_command_callback.vader b/test/command_callback/test_gitlint_command_callback.vader index 1a40ea7..6ff95ea 100644 --- a/test/command_callback/test_gitlint_command_callback.vader +++ b/test/command_callback/test_gitlint_command_callback.vader @@ -60,7 +60,7 @@ Execute(The gitlint callbacks shouldn't detect virtualenv directories where they Execute(The gitlint callbacks should detect virtualenv directories): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG') - let b:executable = ale#path#Winify( + let b:executable = ale#path#Simplify( \ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/gitlint' \) From e43e7065da17f45e4cce127a319ceee0a0311883 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 20 Dec 2017 12:20:38 +0000 Subject: [PATCH 305/390] Fix #1115 - Add support for wrapping all commands with an option --- autoload/ale/engine.vim | 2 +- autoload/ale/fix.vim | 2 +- autoload/ale/job.vim | 43 ++++++++++++++++++++++++----- autoload/ale/linter.vim | 2 ++ doc/ale.txt | 33 +++++++++++++++++++++++ plugin/ale.vim | 3 +++ test/fix/test_ale_fix.vader | 6 ++--- test/test_prepare_command.vader | 39 ++++++++++++++------------- test/test_wrap_comand.vader | 48 +++++++++++++++++++++++++++++++++ 9 files changed, 148 insertions(+), 30 deletions(-) create mode 100644 test/test_wrap_comand.vader diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 8441ad1..70b5a3b 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -512,7 +512,7 @@ function! s:RunJob(options) abort endif endif - let l:command = ale#job#PrepareCommand(l:command) + let l:command = ale#job#PrepareCommand(l:buffer, l:command) let l:job_options = { \ 'mode': 'nl', \ 'exit_cb': function('s:HandleExit'), diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 0a270ec..62a4f9b 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -222,7 +222,7 @@ function! s:RunJob(options) abort \) call s:CreateTemporaryFileForJob(l:buffer, l:temporary_file, l:input) - let l:command = ale#job#PrepareCommand(l:command) + let l:command = ale#job#PrepareCommand(l:buffer, l:command) let l:job_options = { \ 'mode': 'nl', \ 'exit_cb': function('s:HandleExit'), diff --git a/autoload/ale/job.vim b/autoload/ale/job.vim index e6a75c8..2e0b8ca 100644 --- a/autoload/ale/job.vim +++ b/autoload/ale/job.vim @@ -165,23 +165,54 @@ function! ale#job#ValidateArguments(command, options) abort endif endfunction -function! ale#job#PrepareCommand(command) abort +function! s:PrepareWrappedCommand(original_wrapper, command) abort + let l:match = matchlist(a:command, '\v^(.*(\&\&|;)) *(.*)$') + let l:prefix = '' + let l:command = a:command + + if !empty(l:match) + let l:prefix = l:match[1] . ' ' + let l:command = l:match[3] + endif + + let l:format = a:original_wrapper + + if l:format =~# '%@' + let l:wrapped = substitute(l:format, '%@', ale#Escape(l:command), '') + else + if l:format !~# '%\*' + let l:format .= ' %*' + endif + + let l:wrapped = substitute(l:format, '%\*', l:command, '') + endif + + return l:prefix . l:wrapped +endfunction + +function! ale#job#PrepareCommand(buffer, command) abort + let l:wrapper = ale#Var(a:buffer, 'command_wrapper') + + let l:command = !empty(l:wrapper) + \ ? s:PrepareWrappedCommand(l:wrapper, a:command) + \ : a:command + " The command will be executed in a subshell. This fixes a number of " issues, including reading the PATH variables correctly, %PATHEXT% " expansion on Windows, etc. " " NeoVim handles this issue automatically if the command is a String, - " but we'll do this explicitly, so we use thes same exact command for both + " but we'll do this explicitly, so we use the same exact command for both " versions. - if ale#Has('win32') - return 'cmd /c ' . a:command + if has('win32') + return 'cmd /c ' . l:command endif if &shell =~? 'fish$' - return ['/bin/sh', '-c', a:command] + return ['/bin/sh', '-c', l:command] endif - return split(&shell) + split(&shellcmdflag) + [a:command] + return split(&shell) + split(&shellcmdflag) + [l:command] endfunction " Start a job with options which are agnostic to Vim and NeoVim. diff --git a/autoload/ale/linter.vim b/autoload/ale/linter.vim index f4fa0c4..d059a12 100644 --- a/autoload/ale/linter.vim +++ b/autoload/ale/linter.vim @@ -1,3 +1,4 @@ +call ale#Set('wrap_command_as_one_argument', 0) " Author: w0rp " Description: Linter registration and lazy-loading " Retrieves linters as requested by the engine, loading them if needed. @@ -432,6 +433,7 @@ function! ale#linter#StartLSP(buffer, linter, callback) abort endif let l:command = ale#job#PrepareCommand( + \ a:buffer, \ ale#linter#GetCommand(a:buffer, a:linter), \) let l:conn_id = ale#lsp#StartProgram( diff --git a/doc/ale.txt b/doc/ale.txt index 7cc6b22..bec086d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -646,6 +646,39 @@ g:ale_change_sign_column_color *g:ale_change_sign_column_color* windows. +g:ale_command_wrapper *g:ale_command_wrapper* + *b:ale_command_wrapper* + Type: |String| + Default: `''` + + An option for wrapping all commands that ALE runs, for linters, fixers, + and LSP commands. This option can be set globally, or for specific buffers. + + This option can be used to apply nice to all commands. For example: > + + " Prefix all commands with nice. + let g:ale_command_wrapper = 'nice -n5' +< + Use the |ALEInfo| command to view the commands that are run. All of the + arguments for commands will be put on the end of the wrapped command by + default. A `%*` marker can be used to spread the arguments in the wrapped + command. > + + " Has the same effect as the above. + let g:ale_command_wrapper = 'nice -n5 %*' +< + + For passing all of the arguments for a command as one argument to a wrapper, + `%@` can be used instead. > + + " Will result in say: /bin/bash -c 'other-wrapper -c "some command" -x' + let g:ale_command_wrapper = 'other-wrapper -c %@ -x' +< + For commands including `&&` or `;`, only the last command in the list will + be passed to the wrapper. `&&` is most commonly used in ALE to change the + working directory before running a command. + + g:ale_completion_delay *g:ale_completion_delay* Type: |Number| diff --git a/plugin/ale.vim b/plugin/ale.vim index 2f613b5..d75d33b 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -209,6 +209,9 @@ call ale#Set('completion_enabled', 0) call ale#Set('completion_delay', 100) call ale#Set('completion_max_suggestions', 50) +" A setting for wrapping commands. +call ale#Set('command_wrapper', '') + if g:ale_set_balloons call ale#balloon#Enable() endif diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index fa1101e..817c243 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -581,8 +581,8 @@ Execute(Test fixing with chained callbacks): " The buffer shouldn't be piped in for earlier commands in the chain. AssertEqual \ [ - \ string(ale#job#PrepareCommand('echo echoline')), - \ string(ale#job#PrepareCommand('echo echoline')), + \ string(ale#job#PrepareCommand(bufnr(''), 'echo echoline')), + \ string(ale#job#PrepareCommand(bufnr(''), 'echo echoline')), \ ], \ map(ale#history#Get(bufnr(''))[-2:-1], 'string(v:val.command)') @@ -635,7 +635,7 @@ Execute(A temporary file shouldn't be piped into the command when disabled): ALEFix AssertEqual - \ string(ale#job#PrepareCommand('echo new line')), + \ string(ale#job#PrepareCommand(bufnr(''), 'echo new line')), \ string(ale#history#Get(bufnr(''))[-1].command) " Remove trailing whitespace for Windows. diff --git a/test/test_prepare_command.vader b/test/test_prepare_command.vader index ebb9998..16772e8 100644 --- a/test/test_prepare_command.vader +++ b/test/test_prepare_command.vader @@ -4,35 +4,36 @@ Before: After: Restore - let g:ale_has_override = {} Execute(sh should be used when the shell is fish): - " Set something else, so we will replace that too. - let &shellcmdflag = '-f' - let g:ale_has_override = {'win32': 0} + if !has('win32') + " Set something else, so we will replace that too. + let &shellcmdflag = '-f' + let &shell = 'fish' - let &shell = 'fish' + AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand(bufnr(''), 'foobar') - AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand('foobar') + let &shell = '/usr/bin/fish' - let &shell = '/usr/bin/fish' + AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand(bufnr(''), 'foobar') - AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand('foobar') + let &shell = '/usr/local/bin/fish' - let &shell = '/usr/local/bin/fish' - - AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand('foobar') + AssertEqual ['/bin/sh', '-c', 'foobar'], ale#job#PrepareCommand(bufnr(''), 'foobar') + endif Execute(Other shells should be used when set): - let &shell = '/bin/bash' - let &shellcmdflag = '-c' - let g:ale_has_override = {'win32': 0} + if !has('win32') + let &shell = '/bin/bash' + let &shellcmdflag = '-c' - AssertEqual ['/bin/bash', '-c', 'foobar'], ale#job#PrepareCommand('foobar') + AssertEqual ['/bin/bash', '-c', 'foobar'], ale#job#PrepareCommand(bufnr(''), 'foobar') + endif Execute(cmd /c as a string should be used on Windows): - let &shell = 'who cares' - let &shellcmdflag = 'whatever' - let g:ale_has_override = {'win32': 1} + if has('win32') + let &shell = 'who cares' + let &shellcmdflag = 'whatever' - AssertEqual 'cmd /c foobar', ale#job#PrepareCommand('foobar') + AssertEqual 'cmd /c foobar', ale#job#PrepareCommand(bufnr(''), 'foobar') + endif diff --git a/test/test_wrap_comand.vader b/test/test_wrap_comand.vader new file mode 100644 index 0000000..8c1569b --- /dev/null +++ b/test/test_wrap_comand.vader @@ -0,0 +1,48 @@ +Before: + Save g:ale_command_wrapper + + let g:ale_command_wrapper = '' + + function! TestCommand(expected_part, input) abort + let l:expected = has('win32') + \ ? 'cmd /c ' . a:expected_part + \ : split(&shell) + split(&shellcmdflag) + [a:expected_part] + + AssertEqual l:expected, ale#job#PrepareCommand(bufnr(''), a:input) + endfunction + +After: + Restore + + unlet! b:ale_command_wrapper + + delfunction TestCommand + +Execute(The command wrapper should work with a nice command): + let b:ale_command_wrapper = 'nice -n 5' + + call TestCommand('nice -n 5 foo bar', 'foo bar') + +Execute(The command wrapper should work with a nice command with an explicit marker): + let b:ale_command_wrapper = 'nice -n 5 %*' + + call TestCommand('nice -n 5 foo bar', 'foo bar') + +Execute(Wrappers with spread arguments in the middle should be suppported): + let b:ale_command_wrapper = 'wrap %* --' + + call TestCommand('wrap foo bar --', 'foo bar') + +Execute(Wrappers with the command as one argument should be supported): + let b:ale_command_wrapper = 'wrap -c %@ -x' + + call TestCommand('wrap -c ' . ale#Escape('foo bar') . ' -x', 'foo bar') + +Execute(&& and ; should be moved to the front): + let b:ale_command_wrapper = 'wrap -c %@ -x' + + call TestCommand('foo && bar; wrap -c ' . ale#Escape('baz') . ' -x', 'foo && bar;baz') + + let b:ale_command_wrapper = 'nice -n 5' + + call TestCommand('foo && bar; nice -n 5 baz -z', 'foo && bar;baz -z') From 2c9c5dec1e1337ecaffbe5e9818f98b09c134cd3 Mon Sep 17 00:00:00 2001 From: Jansen Mitchell Date: Wed, 20 Dec 2017 12:39:10 -0600 Subject: [PATCH 306/390] Add Fountain with proselint info to ale.txt. Add Fountain online documentation. --- doc/ale-fountain.txt | 6 ++++++ doc/ale.txt | 2 ++ 2 files changed, 8 insertions(+) create mode 100644 doc/ale-fountain.txt diff --git a/doc/ale-fountain.txt b/doc/ale-fountain.txt new file mode 100644 index 0000000..ac0870c --- /dev/null +++ b/doc/ale-fountain.txt @@ -0,0 +1,6 @@ +=============================================================================== +ALE Fountain Integration *ale-fountain-options* + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index bdcb39f..b343989 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -66,6 +66,7 @@ CONTENTS *ale-contents* eruby.................................|ale-eruby-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| + fountain..............................|ale-fountain-options| fusionscript..........................|ale-fuse-options| fusion-lint.........................|ale-fuse-fusionlint| glsl..................................|ale-glsl-options| @@ -299,6 +300,7 @@ Notes: * Erb: `erb`, `erubis` * Erlang: `erlc`, `SyntaxErl` * Fortran: `gcc` +* Fountain: `proselint` * FusionScript: `fusion-lint` * GLSL: glslang, `glslls` * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! From 4d4d2d812292b0976c6e0241df53208131d3291c Mon Sep 17 00:00:00 2001 From: Jansen Mitchell Date: Wed, 20 Dec 2017 22:53:03 -0600 Subject: [PATCH 307/390] Add four spaces, not tabs. --- ale_linters/fountain/proselint.vim | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ale_linters/fountain/proselint.vim b/ale_linters/fountain/proselint.vim index 5761adc..353a2e5 100644 --- a/ale_linters/fountain/proselint.vim +++ b/ale_linters/fountain/proselint.vim @@ -2,8 +2,8 @@ " Description: proselint for Fountain files call ale#linter#Define('fountain', { -\ 'name': 'proselint', -\ 'executable': 'proselint', -\ 'command': 'proselint %t', -\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\ 'name': 'proselint', +\ 'executable': 'proselint', +\ 'command': 'proselint %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', \}) From 0548cf9177870b7c5b702833481f4655a0483932 Mon Sep 17 00:00:00 2001 From: Yaroslav Ryabukha Date: Mon, 25 Dec 2017 16:40:25 +0300 Subject: [PATCH 308/390] Fix c# documentation variable typo --- doc/ale-cs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index ad8b2bb..237e848 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -92,7 +92,7 @@ g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies* For example: > " Compile C# programs with the Unity engine DLL file on Mac. - let g:ale_cs_mcss_assemblies = [ + let g:ale_cs_mcsc_assemblies = [ \ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll', \] < From c165c7c5d11eb827a3be6bab691f20eeb6f6e487 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 26 Dec 2017 18:15:51 +0000 Subject: [PATCH 309/390] Fix #1251 - Handle an empty list in the line callback when NeoVim crashes --- autoload/ale/job.vim | 2 +- test/test_line_join.vader | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/autoload/ale/job.vim b/autoload/ale/job.vim index 2e0b8ca..9cebcf5 100644 --- a/autoload/ale/job.vim +++ b/autoload/ale/job.vim @@ -36,7 +36,7 @@ function! ale#job#JoinNeovimOutput(job, last_line, data, mode, callback) abort let l:lines[0] = a:last_line . l:lines[0] let l:new_last_line = a:data[-1] else - let l:new_last_line = a:last_line . a:data[0] + let l:new_last_line = a:last_line . get(a:data, 0, '') endif for l:line in l:lines diff --git a/test/test_line_join.vader b/test/test_line_join.vader index c93b192..25cefbc 100644 --- a/test/test_line_join.vader +++ b/test/test_line_join.vader @@ -17,6 +17,12 @@ After: delfunction LineCallback delfunction RawCallback +Execute (ALE should handle empty Lists for the lines): + let g:last_line = ale#job#JoinNeovimOutput(1, '', [], 'nl', function('LineCallback')) + + AssertEqual [], g:lines + AssertEqual '', g:last_line + Execute (ALE should pass on full lines for NeoVim): let g:last_line = ale#job#JoinNeovimOutput(1, '', ['x', 'y', ''], 'nl', function('LineCallback')) From e2d3dca48644136d62346d45d8b031a138e18700 Mon Sep 17 00:00:00 2001 From: Niraj Thapaliya Date: Mon, 25 Dec 2017 23:50:08 -0600 Subject: [PATCH 310/390] Support for fish file linting --- ale_linters/fish/fish.vim | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 ale_linters/fish/fish.vim diff --git a/ale_linters/fish/fish.vim b/ale_linters/fish/fish.vim new file mode 100644 index 0000000..19158cb --- /dev/null +++ b/ale_linters/fish/fish.vim @@ -0,0 +1,36 @@ +" Author: Niraj Thapaliya - https://github.com/nthapaliya +" Description: Lints fish files using fish -n + +function! ale_linters#fish#fish#Handle(buffer, lines) abort + " Matches patterns such as: + " + " home/.config/fish/functions/foo.fish (line 1): Missing end to balance this function definition + " function foo + " ^ + " fish: Error while reading file .config/fish/functions/foo.fish + let l:pattern = '^.* (line \(\d\+\)): \(.*\)$' + let l:output = [] + + let l:i = 0 + while l:i < len(a:lines) + let l:match = matchlist(a:lines[l:i], l:pattern) + if len(l:match) && len(l:match[2]) + call add(l:output, { + \ 'col': len(a:lines[l:i + 2]), + \ 'lnum': str2nr(l:match[1]), + \ 'text': l:match[2], + \}) + endif + let l:i += 1 + endwhile + + return l:output +endfunction + +call ale#linter#Define('fish', { +\ 'name': 'fish', +\ 'output_stream': 'stderr', +\ 'executable': 'fish', +\ 'command': 'fish -n %t', +\ 'callback': 'ale_linters#fish#fish#Handle', +\}) From c90b45c559342f22fdeee9e8ace0927406aa4b0b Mon Sep 17 00:00:00 2001 From: Niraj Thapaliya Date: Tue, 26 Dec 2017 12:00:28 -0600 Subject: [PATCH 311/390] Edit README and help --- README.md | 1 + doc/ale-fish.txt | 14 ++++++++++++++ doc/ale.txt | 2 ++ 3 files changed, 17 insertions(+) create mode 100644 doc/ale-fish.txt diff --git a/README.md b/README.md index 129033c..c8d44ff 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,7 @@ formatting. | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | | Erb | [erb](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | +| Fish | fish [-n flag](https://linux.die.net/man/1/fish) | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) | diff --git a/doc/ale-fish.txt b/doc/ale-fish.txt new file mode 100644 index 0000000..8450b38 --- /dev/null +++ b/doc/ale-fish.txt @@ -0,0 +1,14 @@ +=============================================================================== +ALE Fish Integration *ale-fish-options* + +Lints fish files using `fish -n`. + +Note that `fish -n` is not foolproof: it sometimes gives false positives or +errors that are difficult to parse without more context. This integration skips +displaying errors if an error message is not found. + +If ALE is not showing any errors but your file does not run as expected, run +`fish -n ` from the command line. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index bec086d..ce6ae6b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -64,6 +64,7 @@ CONTENTS *ale-contents* erlc................................|ale-erlang-erlc| syntaxerl...........................|ale-erlang-syntaxerl| eruby.................................|ale-eruby-options| + fish..................................|ale-fish-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| fusionscript..........................|ale-fuse-options| @@ -300,6 +301,7 @@ Notes: * Elm: `elm-format, elm-make` * Erb: `erb`, `erubis` * Erlang: `erlc`, `SyntaxErl` +* Fish: `fish` (-n flag) * Fortran: `gcc` * FusionScript: `fusion-lint` * Git Commit Messages: `gitlint` From 3b0c67e42c4bffbe90edb98a181497a9791d9de4 Mon Sep 17 00:00:00 2001 From: Niraj Thapaliya Date: Tue, 26 Dec 2017 13:04:06 -0600 Subject: [PATCH 312/390] Add handler test --- test/handler/test_fish_handler.vader | 39 ++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 test/handler/test_fish_handler.vader diff --git a/test/handler/test_fish_handler.vader b/test/handler/test_fish_handler.vader new file mode 100644 index 0000000..567952e --- /dev/null +++ b/test/handler/test_fish_handler.vader @@ -0,0 +1,39 @@ +Before: + runtime ale_linters/fish/fish.vim + +After: + call ale#linter#Reset() + +Execute(The fish handler should handle basic warnings and syntax errors): + AssertEqual + \ [ + \ { + \ 'lnum': 20, + \ 'col': 23, + \ 'text': "Unsupported use of '||'. In fish, please use 'COMMAND; or COMMAND'.", + \ }, + \ { + \ 'lnum': 26, + \ 'col': 7, + \ 'text': "Illegal command name '(prompt_pwd)'", + \ }, + \ { + \ 'lnum': 36, + \ 'col': 1, + \ 'text': "'end' outside of a block", + \ }, + \ ], + \ ale_linters#fish#fish#Handle(1, [ + \ "fish_prompt.fish (line 20): Unsupported use of '||'. In fish, please use 'COMMAND; or COMMAND'.", + \ 'if set -q SSH_CLIENT || set -q SSH_TTY', + \ ' ^', + \ "fish_prompt.fish (line 26): Illegal command name '(prompt_pwd)'", + \ ' (prompt_pwd) \', + \ ' ^', + \ "fish_prompt.fish (line 36): 'end' outside of a block", + \ 'end', + \ '^', + \ 'config.fish (line 45):', + \ "abbr --add p 'cd ~/Projects'", + \ '^', + \ ]) From b0eaddadc9b4b99f8f0163a5b55ab4dc0499d238 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Lindstr=C3=B6m?= Date: Wed, 27 Dec 2017 23:03:46 +0700 Subject: [PATCH 313/390] Don't use temporary file for rustfmt fixer rustfmt normally acts on a file in place, and applies configuration from rustfmt.toml files according to the path of the file. Using a temporary file for rustfmt breaks this functionality, so removing the '%t' from the rustfmt command. --- autoload/ale/fixers/rustfmt.vim | 4 +--- test/fixers/test_rustfmt_fixer_callback.vader | 8 ++------ 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/autoload/ale/fixers/rustfmt.vim b/autoload/ale/fixers/rustfmt.vim index fb5ac61..38882fb 100644 --- a/autoload/ale/fixers/rustfmt.vim +++ b/autoload/ale/fixers/rustfmt.vim @@ -10,8 +10,6 @@ function! ale#fixers#rustfmt#Fix(buffer) abort return { \ 'command': ale#Escape(l:executable) - \ . (empty(l:options) ? '' : ' ' . l:options) - \ . ' %t', - \ 'read_temporary_file': 1, + \ . (empty(l:options) ? '' : ' ' . l:options), \} endfunction diff --git a/test/fixers/test_rustfmt_fixer_callback.vader b/test/fixers/test_rustfmt_fixer_callback.vader index 36dd58a..95c78de 100644 --- a/test/fixers/test_rustfmt_fixer_callback.vader +++ b/test/fixers/test_rustfmt_fixer_callback.vader @@ -18,9 +18,7 @@ Execute(The rustfmt callback should return the correct default values): AssertEqual \ { - \ 'read_temporary_file': 1, - \ 'command': ale#Escape('xxxinvalid') - \ . ' %t', + \ 'command': ale#Escape('xxxinvalid'), \ }, \ ale#fixers#rustfmt#Fix(bufnr('')) @@ -30,9 +28,7 @@ Execute(The rustfmt callback should include custom rustfmt options): AssertEqual \ { - \ 'read_temporary_file': 1, \ 'command': ale#Escape('xxxinvalid') - \ . ' ' . g:ale_rust_rustfmt_options - \ . ' %t', + \ . ' ' . g:ale_rust_rustfmt_options, \ }, \ ale#fixers#rustfmt#Fix(bufnr('')) From d8f71c46daf21706fa0f2f87de14e04d6675fa5b Mon Sep 17 00:00:00 2001 From: Kevin Tindall Date: Mon, 1 Jan 2018 22:21:21 -0600 Subject: [PATCH 314/390] haskell_ghc_options are now added to the ghc command --- ale_linters/haskell/ghc.vim | 10 +++++++++- doc/ale-haskell.txt | 10 ++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/ale_linters/haskell/ghc.vim b/ale_linters/haskell/ghc.vim index fdf22f9..daf91c8 100644 --- a/ale_linters/haskell/ghc.vim +++ b/ale_linters/haskell/ghc.vim @@ -1,10 +1,18 @@ " Author: w0rp " Description: ghc for Haskell files +call ale#Set('haskell_ghc_options', '-fno-code -v0') + +function! ale_linters#haskell#ghc#GetCommand(buffer) abort + return 'ghc ' + \ . ale#Var(a:buffer, 'haskell_ghc_options') + \ . ' %t' +endfunction + call ale#linter#Define('haskell', { \ 'name': 'ghc', \ 'output_stream': 'stderr', \ 'executable': 'ghc', -\ 'command': 'ghc -fno-code -v0 %t', +\ 'command_callback': 'ale_linters#haskell#ghc#GetCommand', \ 'callback': 'ale#handlers#haskell#HandleGHCFormat', \}) diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt index 0ea4037..9fab39b 100644 --- a/doc/ale-haskell.txt +++ b/doc/ale-haskell.txt @@ -12,6 +12,16 @@ g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable* This variable can be changed to use a different executable for brittany. +=============================================================================== +ghc *ale-haskell-ghc* + +g:ale_haskell_ghc_options *g:ale_haskell_ghc_options* + *b:ale_haskell_ghc_options* + Type: |String| + Default: `'-fno-code -v0'` + + This variable can be changed to modify flags given to ghc. + =============================================================================== hdevtools *ale-haskell-hdevtools* From 681c35169f7b8a71c311902d9e530a3e5906648f Mon Sep 17 00:00:00 2001 From: Kevin Tindall Date: Mon, 1 Jan 2018 22:28:49 -0600 Subject: [PATCH 315/390] add ghc entry to the ToC --- doc/ale.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/ale.txt b/doc/ale.txt index bec086d..572abe8 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -83,6 +83,7 @@ CONTENTS *ale-contents* ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| brittany............................|ale-haskell-brittany| + ghc.................................|ale-haskell-ghc| hdevtools...........................|ale-haskell-hdevtools| hfmt................................|ale-haskell-hfmt| stack-build.........................|ale-haskell-stack-build| From 1e34210f9a231da26074e6af6643e57ae7f1f402 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 2 Jan 2018 13:22:40 +0000 Subject: [PATCH 316/390] Fix some bad indentation --- doc/ale.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index b343989..61465ed 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -66,7 +66,7 @@ CONTENTS *ale-contents* eruby.................................|ale-eruby-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| - fountain..............................|ale-fountain-options| + fountain..............................|ale-fountain-options| fusionscript..........................|ale-fuse-options| fusion-lint.........................|ale-fuse-fusionlint| glsl..................................|ale-glsl-options| From ff8d4c5286ff3d290b155a554289075afc653b8c Mon Sep 17 00:00:00 2001 From: Jonatan Olofsson Date: Mon, 1 Jan 2018 12:02:32 +0100 Subject: [PATCH 317/390] Fix #1255: Move extra clang-check args to before user options --- ale_linters/cpp/clangcheck.vim | 2 +- .../test_cpp_clangcheck_command_callbacks.vader | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/ale_linters/cpp/clangcheck.vim b/ale_linters/cpp/clangcheck.vim index 4b6169c..a109d5d 100644 --- a/ale_linters/cpp/clangcheck.vim +++ b/ale_linters/cpp/clangcheck.vim @@ -24,9 +24,9 @@ function! ale_linters#cpp#clangcheck#GetCommand(buffer) abort " detected. return ale#Escape(ale_linters#cpp#clangcheck#GetExecutable(a:buffer)) \ . ' -analyze %s' + \ . (empty(l:build_dir) ? ' -extra-arg -Xclang -extra-arg -analyzer-output=text' : '') \ . (!empty(l:user_options) ? ' ' . l:user_options : '') \ . (!empty(l:build_dir) ? ' -p ' . ale#Escape(l:build_dir) : '') - \ . (empty(l:build_dir) ? ' -extra-arg -Xanalyzer -extra-arg -analyzer-output=text' : '') endfunction call ale#linter#Define('cpp', { diff --git a/test/command_callback/test_cpp_clangcheck_command_callbacks.vader b/test/command_callback/test_cpp_clangcheck_command_callbacks.vader index 34b87fc..9e9f7f6 100644 --- a/test/command_callback/test_cpp_clangcheck_command_callbacks.vader +++ b/test/command_callback/test_cpp_clangcheck_command_callbacks.vader @@ -28,7 +28,7 @@ Execute(The executable should be used in the command): AssertEqual \ ale#Escape('clang-check') \ . ' -analyze %s' - \ . ' -extra-arg -Xanalyzer -extra-arg -analyzer-output=text', + \ . ' -extra-arg -Xclang -extra-arg -analyzer-output=text', \ ale_linters#cpp#clangcheck#GetCommand(bufnr('')) let b:ale_cpp_clangcheck_executable = 'foobar' @@ -38,7 +38,7 @@ Execute(The executable should be used in the command): AssertEqual \ ale#Escape('foobar') \ . ' -analyze %s' - \ . ' -extra-arg -Xanalyzer -extra-arg -analyzer-output=text', + \ . ' -extra-arg -Xclang -extra-arg -analyzer-output=text', \ ale_linters#cpp#clangcheck#GetCommand(bufnr('')) Execute(The options should be configurable): @@ -46,8 +46,9 @@ Execute(The options should be configurable): AssertEqual \ ale#Escape('clang-check') - \ . ' -analyze %s --something' - \ . ' -extra-arg -Xanalyzer -extra-arg -analyzer-output=text', + \ . ' -analyze %s' + \ . ' -extra-arg -Xclang -extra-arg -analyzer-output=text', + \ . ' --something' \ ale_linters#cpp#clangcheck#GetCommand(bufnr('')) Execute(The build directory should be used when set): From 401b964e9ce212bfaafd98f7ef075ab5f9d7c805 Mon Sep 17 00:00:00 2001 From: rhysd Date: Wed, 3 Jan 2018 01:42:08 +0900 Subject: [PATCH 318/390] html: Avoid old tidy on macOS On macOS, Apple's command line toolchain installs very old `tidy` command (It was released on 31 Oct 2006). It does not consider new specs such as HTML5 so we should avoid it. --- ale_linters/html/tidy.vim | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/ale_linters/html/tidy.vim b/ale_linters/html/tidy.vim index 4a55d62..34152c6 100644 --- a/ale_linters/html/tidy.vim +++ b/ale_linters/html/tidy.vim @@ -25,8 +25,16 @@ function! ale_linters#html#tidy#GetCommand(buffer) abort \ 'utf-8': '-utf8', \ }, &fileencoding, '-utf8') + " On macOS, old tidy (released on 31 Oct 2006) is installed. It does not + " consider HTML5 so we should avoid it. + let l:executable = ale#Var(a:buffer, 'html_tidy_executable') + if has('mac') && l:executable is# 'tidy' && exists('*exepath') + \ && exepath(l:executable) is# '/usr/bin/tidy' + return '' + endif + return printf('%s %s %s -', - \ ale#Var(a:buffer, 'html_tidy_executable'), + \ l:executable, \ ale#Var(a:buffer, 'html_tidy_options'), \ l:file_encoding \) From 7a1a5343054549c571425b6c48ab15ca5422337a Mon Sep 17 00:00:00 2001 From: rhysd Date: Sat, 6 Jan 2018 19:58:10 +0900 Subject: [PATCH 319/390] Explain /usr/bin/tidy is ignored on macOS and how to install the latest tidy --- doc/ale-html.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/ale-html.txt b/doc/ale-html.txt index 14e705e..c5d5afa 100644 --- a/doc/ale-html.txt +++ b/doc/ale-html.txt @@ -32,6 +32,21 @@ g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global* =============================================================================== tidy *ale-html-tidy* +`tidy` is a console application which corrects and cleans up HTML and XML +documents by fixing markup errors and upgrading legacy code to modern +standards. + +Note: +`/usr/bin/tidy` on macOS (installed by default) is too old. It was released +on 31 Oct 2006. It does not consider modern HTML specs (HTML5) and shows +outdated warnings. So |ale| ignores `/usr/bin/tidy` on macOS. + +To use `tidy` on macOS, please install the latest version with Homebrew: +> + $ brew install tidy-html5 +< +`/usr/local/bin/tidy` is installed. + g:ale_html_tidy_executable *g:ale_html_tidy_executable* *b:ale_html_tidy_executable* Type: |String| From c9d66b861b4593e1797cedd302a2203bd7110a99 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 7 Jan 2018 12:01:20 +0000 Subject: [PATCH 320/390] Show more ALE variables in ALEInfo --- autoload/ale/debugging.vim | 25 +++++++++++++++++ test/test_ale_info.vader | 56 ++++++++++++++++++++++++++++++++------ 2 files changed, 72 insertions(+), 9 deletions(-) diff --git a/autoload/ale/debugging.vim b/autoload/ale/debugging.vim index 9ce69ce..9be1fbf 100644 --- a/autoload/ale/debugging.vim +++ b/autoload/ale/debugging.vim @@ -2,30 +2,55 @@ " Description: This file implements debugging information for ALE let s:global_variable_list = [ +\ 'ale_cache_executable_check_failures', +\ 'ale_change_sign_column_color', +\ 'ale_command_wrapper', +\ 'ale_completion_delay', +\ 'ale_completion_enabled', +\ 'ale_completion_max_suggestions', \ 'ale_echo_cursor', \ 'ale_echo_msg_error_str', \ 'ale_echo_msg_format', +\ 'ale_echo_msg_info_str', \ 'ale_echo_msg_warning_str', \ 'ale_enabled', \ 'ale_fix_on_save', \ 'ale_fixers', +\ 'ale_history_enabled', +\ 'ale_history_log_output', \ 'ale_keep_list_window_open', \ 'ale_lint_delay', \ 'ale_lint_on_enter', +\ 'ale_lint_on_filetype_changed', \ 'ale_lint_on_save', \ 'ale_lint_on_text_changed', +\ 'ale_lint_on_insert_leave', \ 'ale_linter_aliases', \ 'ale_linters', +\ 'ale_linters_explicit', +\ 'ale_list_window_size', +\ 'ale_loclist_msg_format', +\ 'ale_max_buffer_history_size', +\ 'ale_max_signs', +\ 'ale_maximum_file_size', \ 'ale_open_list', +\ 'ale_pattern_options', +\ 'ale_pattern_options_enabled', +\ 'ale_set_balloons', \ 'ale_set_highlights', \ 'ale_set_loclist', \ 'ale_set_quickfix', \ 'ale_set_signs', \ 'ale_sign_column_always', \ 'ale_sign_error', +\ 'ale_sign_info', \ 'ale_sign_offset', +\ 'ale_sign_style_error', +\ 'ale_sign_style_warning', \ 'ale_sign_warning', \ 'ale_statusline_format', +\ 'ale_type_map', +\ 'ale_warn_about_trailing_blank_lines', \ 'ale_warn_about_trailing_whitespace', \] diff --git a/test/test_ale_info.vader b/test/test_ale_info.vader index 2ca1834..e20125a 100644 --- a/test/test_ale_info.vader +++ b/test/test_ale_info.vader @@ -1,14 +1,30 @@ Before: - Save g:ale_warn_about_trailing_whitespace - Save g:ale_linters - Save g:ale_fixers - Save g:ale_lint_on_text_changed + Save g:ale_buffer_info Save g:ale_cache_executable_check_failures + Save g:ale_completion_enabled + Save g:ale_fixers + Save g:ale_history_log_output + Save g:ale_lint_on_insert_leave + Save g:ale_lint_on_text_changed + Save g:ale_linters + Save g:ale_maximum_file_size + Save g:ale_pattern_options + Save g:ale_pattern_options_enabled + Save g:ale_set_balloons + Save g:ale_warn_about_trailing_whitespace unlet! b:ale_history - let g:ale_lint_on_text_changed = 'always' + let g:ale_buffer_info = {} let g:ale_cache_executable_check_failures = 0 + let g:ale_completion_enabled = 0 + let g:ale_history_log_output = 1 + let g:ale_lint_on_insert_leave = 0 + let g:ale_lint_on_text_changed = 'always' + let g:ale_maximum_file_size = 0 + let g:ale_pattern_options = {} + let g:ale_pattern_options_enabled = 0 + let g:ale_set_balloons = 0 let g:ale_warn_about_trailing_whitespace = 1 let g:testlinter1 = {'name': 'testlinter1', 'executable': 'testlinter1', 'command': 'testlinter1', 'callback': 'testCB1', 'output_stream': 'stdout'} @@ -23,30 +39,55 @@ Before: let g:globals_lines = [ \ ' Global Variables:', \ '', + \ 'let g:ale_cache_executable_check_failures = 0', + \ 'let g:ale_change_sign_column_color = 0', + \ 'let g:ale_command_wrapper = ''''', + \ 'let g:ale_completion_delay = 100', + \ 'let g:ale_completion_enabled = 0', + \ 'let g:ale_completion_max_suggestions = 50', \ 'let g:ale_echo_cursor = 1', \ 'let g:ale_echo_msg_error_str = ''Error''', \ 'let g:ale_echo_msg_format = ''%code: %%s''', + \ 'let g:ale_echo_msg_info_str = ''Info''', \ 'let g:ale_echo_msg_warning_str = ''Warning''', \ 'let g:ale_enabled = 1', \ 'let g:ale_fix_on_save = 0', \ 'let g:ale_fixers = {}', + \ 'let g:ale_history_enabled = 1', + \ 'let g:ale_history_log_output = 1', \ 'let g:ale_keep_list_window_open = 0', \ 'let g:ale_lint_delay = 200', \ 'let g:ale_lint_on_enter = 1', + \ 'let g:ale_lint_on_filetype_changed = 1', \ 'let g:ale_lint_on_save = 1', \ 'let g:ale_lint_on_text_changed = ''always''', + \ 'let g:ale_lint_on_insert_leave = 0', \ 'let g:ale_linter_aliases = {}', \ 'let g:ale_linters = {}', + \ 'let g:ale_linters_explicit = 0', + \ 'let g:ale_list_window_size = 10', + \ 'let g:ale_loclist_msg_format = ''%code: %%s''', + \ 'let g:ale_max_buffer_history_size = 20', + \ 'let g:ale_max_signs = -1', + \ 'let g:ale_maximum_file_size = 0', \ 'let g:ale_open_list = 0', + \ 'let g:ale_pattern_options = {}', + \ 'let g:ale_pattern_options_enabled = 0', + \ 'let g:ale_set_balloons = 0', \ 'let g:ale_set_highlights = 1', \ 'let g:ale_set_loclist = 1', \ 'let g:ale_set_quickfix = 0', \ 'let g:ale_set_signs = 1', \ 'let g:ale_sign_column_always = 0', \ 'let g:ale_sign_error = ''>>''', + \ 'let g:ale_sign_info = ''--''', \ 'let g:ale_sign_offset = 1000000', + \ 'let g:ale_sign_style_error = ''>>''', + \ 'let g:ale_sign_style_warning = ''--''', \ 'let g:ale_sign_warning = ''--''', \ 'let g:ale_statusline_format = [''%d error(s)'', ''%d warning(s)'', ''OK'']', + \ 'let g:ale_type_map = {}', + \ 'let g:ale_warn_about_trailing_blank_lines = 1', \ 'let g:ale_warn_about_trailing_whitespace = 1', \] let g:command_header = [ @@ -66,8 +107,6 @@ Before: After: Restore - let g:ale_buffer_info = {} - unlet! g:testlinter1 unlet! g:testlinter2 @@ -76,8 +115,6 @@ After: unlet! g:output unlet! g:globals_string unlet! g:command_header - let g:ale_buffer_info = {} - let g:ale_history_log_output = 0 unlet! g:ale_testft_testlinter1_foo unlet! g:ale_testft_testlinter1_bar unlet! g:ale_testft2_testlinter2_foo @@ -378,6 +415,7 @@ Execute (ALEInfo should include executable checks in the history): Execute (The option for caching failing executable checks should work): let g:ale_cache_executable_check_failures = 1 + let g:globals_lines[2] = 'let g:ale_cache_executable_check_failures = 1' call ale#linter#Define('testft', g:testlinter1) From b6d1c419255d335a1e87a5eb32fd910081fa16ac Mon Sep 17 00:00:00 2001 From: Jelte Fennema Date: Sun, 7 Jan 2018 13:11:01 +0100 Subject: [PATCH 321/390] Go: Add gotype support (#1099) --- README.md | 2 +- ale_linters/go/gotype.vim | 23 +++++++++++++++++++ autoload/ale/util.vim | 7 ++++++ doc/ale.txt | 2 +- .../test_gotype_command_callback.vader | 19 +++++++++++++++ test/go_files/testfile2.go | 0 6 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 ale_linters/go/gotype.vim create mode 100644 test/command_callback/test_gotype_command_callback.vader create mode 100644 test/go_files/testfile2.go diff --git a/README.md b/README.md index c6bf76e..55be933 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ formatting. | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | -| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | +| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gotype](https://godoc.org/golang.org/x/tools/cmd/gotype), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | diff --git a/ale_linters/go/gotype.vim b/ale_linters/go/gotype.vim new file mode 100644 index 0000000..731f4c9 --- /dev/null +++ b/ale_linters/go/gotype.vim @@ -0,0 +1,23 @@ +" Author: Jelte Fennema +" Description: gotype for Go files + +call ale#linter#Define('go', { +\ 'name': 'gotype', +\ 'output_stream': 'stderr', +\ 'executable': 'gotype', +\ 'command_callback': 'ale_linters#go#gotype#GetCommand', +\ 'callback': 'ale#handlers#unix#HandleAsError', +\}) + +"\ 'command': +function! ale_linters#go#gotype#GetCommand(buffer) abort + let l:cur_file = expand('#' . a:buffer . ':p') + if l:cur_file =~# '_test\.go$' + return + endif + + let l:module_files = globpath(expand('#' . a:buffer . ':p:h'), '*.go', 0, 1) + let l:other_module_files = filter(l:module_files, 'v:val isnot# ' . ale#util#EscapeVim(l:cur_file) . ' && v:val !~# "_test\.go$"') + return 'gotype %t ' . join(map(l:other_module_files, 'ale#Escape(v:val)')) + +endfunction diff --git a/autoload/ale/util.vim b/autoload/ale/util.vim index 1f590ad..b94a11b 100644 --- a/autoload/ale/util.vim +++ b/autoload/ale/util.vim @@ -236,6 +236,13 @@ function! ale#util#EscapePCRE(unsafe_string) abort return substitute(a:unsafe_string, '\([\-\[\]{}()*+?.^$|]\)', '\\\1', 'g') endfunction +" Escape a string so that it can be used as a literal string inside an evaled +" vim command. +function! ale#util#EscapeVim(unsafe_string) abort + return "'" . substitute(a:unsafe_string, "'", "''", 'g') . "'" +endfunction + + " Given a String or a List of String values, try and decode the string(s) " as a JSON value which can be decoded with json_decode. If the JSON string " is invalid, the default argument value will be returned instead. diff --git a/doc/ale.txt b/doc/ale.txt index 53b19b3..25c1abe 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -309,7 +309,7 @@ Notes: * FusionScript: `fusion-lint` * Git Commit Messages: `gitlint` * GLSL: glslang, `glslls` -* Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! +* Go: `gofmt`, `goimports`, `go vet`, `golint`, `gotype`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `eslint`, `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` diff --git a/test/command_callback/test_gotype_command_callback.vader b/test/command_callback/test_gotype_command_callback.vader new file mode 100644 index 0000000..f95e842 --- /dev/null +++ b/test/command_callback/test_gotype_command_callback.vader @@ -0,0 +1,19 @@ +Before: + runtime ale_linters/go/gotype.vim + call ale#test#SetFilename('../go_files/testfile2.go') + +After: + call ale#linter#Reset() + + +Execute(The gotype callback should include other files from the directory but exclude the file itself): + let dir = expand('#' . bufnr('') . ':p:h') + AssertEqual + \ "gotype %t ". ale#Escape(ale#path#Simplify(dir . "/testfile.go")), + \ ale_linters#go#gotype#GetCommand(bufnr('')) + +Execute(The gotype callback should ignore test files): + call ale#test#SetFilename('bla_test.go') + AssertEqual + \ 0, + \ ale_linters#go#gotype#GetCommand(bufnr('')) diff --git a/test/go_files/testfile2.go b/test/go_files/testfile2.go new file mode 100644 index 0000000..e69de29 From eecbacb742f0e884e2f47f0aee57caf9cb2dd683 Mon Sep 17 00:00:00 2001 From: Benjamin Bannier Date: Sun, 7 Jan 2018 17:53:01 +0100 Subject: [PATCH 322/390] Removed unneeded `SetDirectory` call in proto handler test. The test already handled arbitrary paths reasonably well, but setting the directory interfered via leakage with others tests for some reason. This patch removes the call to `SetDirectory` in the fixture setup and the subsequent cleanup in the teardown as they are not required. --- test/command_callback/test_proto_command_callback.vader | 2 -- 1 file changed, 2 deletions(-) diff --git a/test/command_callback/test_proto_command_callback.vader b/test/command_callback/test_proto_command_callback.vader index 2fd7775..79c1cf8 100644 --- a/test/command_callback/test_proto_command_callback.vader +++ b/test/command_callback/test_proto_command_callback.vader @@ -1,11 +1,9 @@ Before: - call ale#test#SetDirectory('/testplugin/test/command_callback') call ale#test#SetFilename('test.proto') After: Restore - call ale#test#RestoreDirectory() call ale#linter#Reset() Execute(The default command should be correct): From b5a5cdf920a9875650b021c8116ac02b739a9e9e Mon Sep 17 00:00:00 2001 From: Benjamin Bannier Date: Sat, 6 Jan 2018 20:56:28 +0100 Subject: [PATCH 323/390] Make it possible to inject flags of protoc invocation. Typically proto files depend on and make use of proto definitions in other files. When invoking protoc user can supply paths to inspect for dependencies. This patch makes it possible to configure flags passed to protoc. This makes it e.g., possible to change include paths of the linter's protoc invocation. --- ale_linters/proto/protoc_gen_lint.vim | 14 +++++++++++--- doc/ale-proto.txt | 9 +++++++++ .../test_proto_command_callback.vader | 9 +++++++++ 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/ale_linters/proto/protoc_gen_lint.vim b/ale_linters/proto/protoc_gen_lint.vim index 9d5ceac..c8b5c33 100644 --- a/ale_linters/proto/protoc_gen_lint.vim +++ b/ale_linters/proto/protoc_gen_lint.vim @@ -1,12 +1,20 @@ " Author: Jeff Willette " Description: run the protoc-gen-lint plugin for the protoc binary +call ale#Set('proto_protoc_gen_lint_options', '') + function! ale_linters#proto#protoc_gen_lint#GetCommand(buffer) abort let l:dirname = expand('#' . a:buffer . ':p:h') - return 'protoc' - \ . ' -I ' . ale#Escape(l:dirname) - \ . ' --lint_out=. ' . '%s' + let l:options = ['-I ' . ale#Escape(l:dirname)] + + if !empty(ale#Var(a:buffer, 'proto_protoc_gen_lint_options')) + let l:options += [ale#Var(a:buffer, 'proto_protoc_gen_lint_options')] + endif + + let l:options += ['--lint_out=. ' . '%s'] + + return 'protoc' . ' ' . join(l:options) endfunction call ale#linter#Define('proto', { diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt index 6a25638..734e23d 100644 --- a/doc/ale-proto.txt +++ b/doc/ale-proto.txt @@ -20,5 +20,14 @@ protoc-gen-lint *ale-proto-protoc-gen-lint* The linter is a plugin for the `protoc` binary. As long as the binary resides in the system path, `protoc` will find it. +g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options* + + Type: |String| + Default: `''` + + This variable can be changed to modify flags given to protoc. Note that the + directory of the linted file is always passed as an include path with '-I' + before any user-supplied options. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/test/command_callback/test_proto_command_callback.vader b/test/command_callback/test_proto_command_callback.vader index 79c1cf8..76050c6 100644 --- a/test/command_callback/test_proto_command_callback.vader +++ b/test/command_callback/test_proto_command_callback.vader @@ -4,9 +4,18 @@ Before: After: Restore + unlet! b:ale_proto_protoc_gen_lint_options + call ale#linter#Reset() Execute(The default command should be correct): AssertEqual \ 'protoc' . ' -I ' . ale#Escape(getcwd()) . ' --lint_out=. ' . '%s', \ ale_linters#proto#protoc_gen_lint#GetCommand(bufnr('')) + +Execute(The callback should include any additional options): + let b:ale_proto_protoc_gen_lint_options = '--some-option' + + AssertEqual + \ 'protoc' . ' -I ' . ale#Escape(getcwd()) . ' --some-option --lint_out=. ' . '%s', + \ ale_linters#proto#protoc_gen_lint#GetCommand(bufnr('')) From ff388bbcd5374bb76507c2b6af1e1167c8189ea4 Mon Sep 17 00:00:00 2001 From: Kevin Tindall Date: Sun, 7 Jan 2018 11:41:06 -0600 Subject: [PATCH 324/390] test for ghc options --- .../test_haskell_ghc_command_callbacks.vader | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 test/command_callback/test_haskell_ghc_command_callbacks.vader diff --git a/test/command_callback/test_haskell_ghc_command_callbacks.vader b/test/command_callback/test_haskell_ghc_command_callbacks.vader new file mode 100644 index 0000000..edaf2b9 --- /dev/null +++ b/test/command_callback/test_haskell_ghc_command_callbacks.vader @@ -0,0 +1,23 @@ +Before: + Save g:ale_haskell_ghc_options + + unlet! g:ale_haskell_ghc_options + unlet! b:ale_haskell_ghc_options + + runtime ale_linters/haskell/ghc.vim + +After: + Restore + unlet! b:ale_haskell_ghc_options + call ale#linter#Reset() + +Execute(The options should be used in the command): + AssertEqual + \ 'ghc -fno-code -v0 %t', + \ ale_linters#haskell#ghc#GetCommand(bufnr('')) + + let b:ale_haskell_ghc_options = 'foobar' + + AssertEqual + \ 'ghc foobar %t', + \ ale_linters#haskell#ghc#GetCommand(bufnr('')) From 68d4a2216ca8edb7396f88352cfe807fa771ca7e Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 8 Jan 2018 13:28:01 +0000 Subject: [PATCH 325/390] Fix a syntax error in a test --- .../test_cpp_clangcheck_command_callbacks.vader | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/command_callback/test_cpp_clangcheck_command_callbacks.vader b/test/command_callback/test_cpp_clangcheck_command_callbacks.vader index 9e9f7f6..f708c52 100644 --- a/test/command_callback/test_cpp_clangcheck_command_callbacks.vader +++ b/test/command_callback/test_cpp_clangcheck_command_callbacks.vader @@ -47,8 +47,8 @@ Execute(The options should be configurable): AssertEqual \ ale#Escape('clang-check') \ . ' -analyze %s' - \ . ' -extra-arg -Xclang -extra-arg -analyzer-output=text', - \ . ' --something' + \ . ' -extra-arg -Xclang -extra-arg -analyzer-output=text' + \ . ' --something', \ ale_linters#cpp#clangcheck#GetCommand(bufnr('')) Execute(The build directory should be used when set): From 112fcf7dd57a077f70ae39bb03d192f5c832aa2e Mon Sep 17 00:00:00 2001 From: "jiangzhi.xie" Date: Mon, 8 Jan 2018 23:19:17 +0800 Subject: [PATCH 326/390] Add a luac linter for Lua --- README.md | 2 +- ale_linters/lua/luac.vim | 40 +++++++++++++++++++ doc/ale-lua.txt | 9 +++++ doc/ale.txt | 3 +- .../test_luac_command_callback.vader | 16 ++++++++ test/handler/test_luac_handler.vader | 36 +++++++++++++++++ ...dler.vader => test_luacheck_handler.vader} | 0 7 files changed, 104 insertions(+), 2 deletions(-) create mode 100644 ale_linters/lua/luac.vim create mode 100644 test/command_callback/test_luac_command_callback.vader create mode 100644 test/handler/test_luac_handler.vader rename test/handler/{test_lua_handler.vader => test_luacheck_handler.vader} (100%) diff --git a/README.md b/README.md index 55be933..c393e49 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ formatting. | LaTeX | [alex](https://github.com/wooorm/alex) !!, [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | | LLVM | [llc](https://llvm.org/docs/CommandGuide/llc.html) | -| Lua | [luacheck](https://github.com/mpeterv/luacheck) | +| Lua | [luac](https://www.lua.org/manual/5.1/luac.html), [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | | Markdown | [alex](https://github.com/wooorm/alex) !!, [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | diff --git a/ale_linters/lua/luac.vim b/ale_linters/lua/luac.vim new file mode 100644 index 0000000..4a6bb40 --- /dev/null +++ b/ale_linters/lua/luac.vim @@ -0,0 +1,40 @@ +" Author: Jon Xie https://github.com/xiejiangzhi +" Description: luac linter for lua files + +call ale#Set('lua_luac_executable', 'luac') + +function! ale_linters#lua#luac#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'lua_luac_executable') +endfunction + +function! ale_linters#lua#luac#GetCommand(buffer) abort + let l:executable = ale_linters#lua#luac#GetExecutable(a:buffer) + return ale#Escape(l:executable) . ' -p - ' +endfunction + +function! ale_linters#lua#luac#Handle(buffer, lines) abort + " Matches patterns line the following: + " + " luac: stdin:5: '=' expected near ')' + " luac: stdin:8: ')' expected (to close '(' at line 6) near '123' + let l:pattern = '\v^.*:(\d+): (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'lnum': l:match[1] + 0, + \ 'type': 'E', + \ 'text': l:match[2], + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('lua', { +\ 'name': 'luac', +\ 'executable_callback': 'ale_linters#lua#luac#GetExecutable', +\ 'command_callback': 'ale_linters#lua#luac#GetCommand', +\ 'output_stream': 'stderr', +\ 'callback': 'ale_linters#lua#luac#Handle', +\}) diff --git a/doc/ale-lua.txt b/doc/ale-lua.txt index 74d6b94..b6fab37 100644 --- a/doc/ale-lua.txt +++ b/doc/ale-lua.txt @@ -1,6 +1,15 @@ =============================================================================== ALE Lua Integration *ale-lua-options* +=============================================================================== +luac *ale-lua-luac* + +g:ale_lua_luac_executable *g:ale_lua_luac_executable* + *b:ale_lua_luac_executable* + Type: |String| + Default: `'luac'` + + This variable can be changed to change the path to luac. =============================================================================== luacheck *ale-lua-luacheck* diff --git a/doc/ale.txt b/doc/ale.txt index 25c1abe..6cebbce 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -125,6 +125,7 @@ CONTENTS *ale-contents* llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| lua...................................|ale-lua-options| + luac................................|ale-lua-luac| luacheck............................|ale-lua-luacheck| markdown..............................|ale-markdown-options| write-good..........................|ale-markdown-write-good| @@ -323,7 +324,7 @@ Notes: * LaTeX (tex): `alex`!!, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` * Less: `lessc`, `prettier`, `stylelint` * LLVM: `llc` -* Lua: `luacheck` +* Lua: `luac`, `luacheck` * Mail: `alex`!!, `proselint`, `vale` * Make: `checkmake` * Markdown: `alex`!!, `mdl`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` diff --git a/test/command_callback/test_luac_command_callback.vader b/test/command_callback/test_luac_command_callback.vader new file mode 100644 index 0000000..f9eb4d3 --- /dev/null +++ b/test/command_callback/test_luac_command_callback.vader @@ -0,0 +1,16 @@ +Before: + runtime ale_linters/lua/luac.vim + +After: + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual ale#Escape('luac') . ' -p -', + \ join(split(ale_linters#lua#luac#GetCommand(1))) + +Execute(The luac executable should be configurable): + let g:ale_lua_luac_executable = 'luac.sh' + + AssertEqual 'luac.sh', ale_linters#lua#luac#GetExecutable(1) + AssertEqual ale#Escape('luac.sh') . ' -p -', + \ join(split(ale_linters#lua#luac#GetCommand(1))) diff --git a/test/handler/test_luac_handler.vader b/test/handler/test_luac_handler.vader new file mode 100644 index 0000000..3a2e769 --- /dev/null +++ b/test/handler/test_luac_handler.vader @@ -0,0 +1,36 @@ +Before: + Save g:ale_warn_about_trailing_whitespace + + let g:ale_warn_about_trailing_whitespace = 1 + + runtime ale_linters/lua/luac.vim + +After: + Restore + call ale#linter#Reset() + +Execute(The luac handler should parse lines correctly): + AssertEqual + \ [ + \ { + \ 'lnum': 1, + \ 'text': 'line contains trailing whitespace', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 3, + \ 'text': 'unexpected symbol near ''-''', + \ 'type': 'E', + \ }, + \ { + \ 'lnum': 5, + \ 'text': '''='' expected near '')''', + \ 'type': 'E', + \ }, + \ ], + \ ale_linters#lua#luac#Handle(347, [ + \ 'luac /file/path/here.lua:1: line contains trailing whitespace', + \ 'luac /file/path/here.lua:3: unexpected symbol near ''-''', + \ 'luac /file/path/here.lua:5: ''='' expected near '')''', + \ ]) + diff --git a/test/handler/test_lua_handler.vader b/test/handler/test_luacheck_handler.vader similarity index 100% rename from test/handler/test_lua_handler.vader rename to test/handler/test_luacheck_handler.vader From 547716eabb3a436f2de623555fb488d3496ccbd4 Mon Sep 17 00:00:00 2001 From: "jiangzhi.xie" Date: Mon, 8 Jan 2018 23:39:04 +0800 Subject: [PATCH 327/390] Fix the doc style for ale-lua --- doc/ale-lua.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/ale-lua.txt b/doc/ale-lua.txt index b6fab37..f1286f8 100644 --- a/doc/ale-lua.txt +++ b/doc/ale-lua.txt @@ -2,10 +2,10 @@ ALE Lua Integration *ale-lua-options* =============================================================================== -luac *ale-lua-luac* +luac *ale-lua-luac* -g:ale_lua_luac_executable *g:ale_lua_luac_executable* - *b:ale_lua_luac_executable* +g:ale_lua_luac_executable *g:ale_lua_luac_executable* + *b:ale_lua_luac_executable* Type: |String| Default: `'luac'` From 29acafdaf4f59861aeff64c5f56a584e40260c5e Mon Sep 17 00:00:00 2001 From: sharils Date: Tue, 26 Dec 2017 22:13:05 +0800 Subject: [PATCH 328/390] Work around hot-reloading issue See https://github.com/phoenixframework/phoenix/issues/1165 for more detail --- ale_linters/elixir/credo.vim | 2 +- ale_linters/elixir/dogma.vim | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ale_linters/elixir/credo.vim b/ale_linters/elixir/credo.vim index 3699dd2..af2ff48 100644 --- a/ale_linters/elixir/credo.vim +++ b/ale_linters/elixir/credo.vim @@ -32,6 +32,6 @@ endfunction call ale#linter#Define('elixir', { \ 'name': 'credo', \ 'executable': 'mix', -\ 'command': 'mix credo suggest --format=flycheck --read-from-stdin %s', +\ 'command': 'mix help credo && mix credo suggest --format=flycheck --read-from-stdin %s', \ 'callback': 'ale_linters#elixir#credo#Handle', \}) diff --git a/ale_linters/elixir/dogma.vim b/ale_linters/elixir/dogma.vim index b4f32b0..71cf4f4 100644 --- a/ale_linters/elixir/dogma.vim +++ b/ale_linters/elixir/dogma.vim @@ -32,7 +32,7 @@ endfunction call ale#linter#Define('elixir', { \ 'name': 'dogma', \ 'executable': 'mix', -\ 'command': 'mix dogma %s --format=flycheck', +\ 'command': 'mix help dogma && mix dogma %s --format=flycheck', \ 'lint_file': 1, \ 'callback': 'ale_linters#elixir#dogma#Handle', \}) From adba2bd919d5463e16c586a90698588cca9725b6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 11 Jan 2018 16:43:10 +0000 Subject: [PATCH 329/390] Allow syntax errors for mypy to be ignored --- ale_linters/python/mypy.vim | 14 +++++++++---- doc/ale-python.txt | 22 ++++++++++++++------ test/handler/test_mypy_handler.vader | 30 ++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 10 deletions(-) diff --git a/ale_linters/python/mypy.vim b/ale_linters/python/mypy.vim index 6884a9a..c1c9174 100644 --- a/ale_linters/python/mypy.vim +++ b/ale_linters/python/mypy.vim @@ -1,10 +1,10 @@ " Author: Keith Smiley , w0rp " Description: mypy support for optional python typechecking -let g:ale_python_mypy_executable = -\ get(g:, 'ale_python_mypy_executable', 'mypy') -let g:ale_python_mypy_options = get(g:, 'ale_python_mypy_options', '') -let g:ale_python_mypy_use_global = get(g:, 'ale_python_mypy_use_global', 0) +call ale#Set('python_mypy_executable', 'mypy') +call ale#Set('python_mypy_ignore_invalid_syntax', 0) +call ale#Set('python_mypy_options', '') +call ale#Set('python_mypy_use_global', 0) function! ale_linters#python#mypy#GetExecutable(buffer) abort return ale#python#FindExecutable(a:buffer, 'python_mypy', ['mypy']) @@ -45,6 +45,12 @@ function! ale_linters#python#mypy#Handle(buffer, lines) abort let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) + " Skip invalid syntax errors if the option is on. + if l:match[5] is# 'invalid syntax' + \&& ale#Var(a:buffer, 'python_mypy_ignore_invalid_syntax') + continue + endif + call add(l:output, { \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), \ 'lnum': l:match[2] + 0, diff --git a/doc/ale-python.txt b/doc/ale-python.txt index 742a854..4d55e75 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -104,6 +104,16 @@ g:ale_python_mypy_executable *g:ale_python_mypy_executable* See |ale-integrations-local-executables| +g:ale_python_mypy_ignore_invalid_syntax + *g:ale_python_mypy_ignore_invalid_syntax* + *b:ale_python_mypy_ignore_invalid_syntax* + Type: |Number| + Default: `0` + + When set to `1`, syntax error messages for mypy will be ignored. This option + can be used when running other Python linters which check for syntax errors, + as mypy can take a while to finish executing. + g:ale_python_mypy_options *g:ale_python_mypy_options* *b:ale_python_mypy_options* @@ -125,16 +135,16 @@ g:ale_python_mypy_use_global *g:ale_python_mypy_use_global* =============================================================================== prospector *ale-python-prospector* -g:ale_python_prospector_executable *g:ale_python_prospector_executable* - *b:ale_python_prospector_executable* +g:ale_python_prospector_executable *g:ale_python_prospector_executable* + *b:ale_python_prospector_executable* Type: |String| Default: `'prospector'` See |ale-integrations-local-executables| -g:ale_python_prospector_options *g:ale_python_prospector_options* - *b:ale_python_prospector_options* +g:ale_python_prospector_options *g:ale_python_prospector_options* + *b:ale_python_prospector_options* Type: |String| Default: `''` @@ -154,8 +164,8 @@ g:ale_python_prospector_options *g:ale_python_prospector_option `python3 -m pip install --user prospector`). -g:ale_python_prospector_use_global *g:ale_python_prospector_use_global* - *b:ale_python_prospector_use_global* +g:ale_python_prospector_use_global *g:ale_python_prospector_use_global* + *b:ale_python_prospector_use_global* Type: |Number| Default: `0` diff --git a/test/handler/test_mypy_handler.vader b/test/handler/test_mypy_handler.vader index abb8504..f3d4cbf 100644 --- a/test/handler/test_mypy_handler.vader +++ b/test/handler/test_mypy_handler.vader @@ -1,9 +1,15 @@ Before: + Save g:ale_python_mypy_ignore_invalid_syntax + + unlet! g:ale_python_mypy_ignore_invalid_syntax + runtime ale_linters/python/mypy.vim call ale#test#SetDirectory('/testplugin/test/handler') After: + Restore + call ale#test#RestoreDirectory() call ale#linter#Reset() @@ -80,3 +86,27 @@ Execute(The mypy handler should handle Windows names with spaces): \ ale_linters#python#mypy#Handle(bufnr(''), [ \ 'C:\something\with spaces.py:4: error: No library stub file for module ''django.db''', \ ]) + +Execute(The mypy syntax errors shouldn't be ignored by default): + AssertEqual + \ [ + \ { + \ 'lnum': 4, + \ 'col': 0, + \ 'filename': ale#path#Simplify(g:dir . '/foo.py'), + \ 'type': 'E', + \ 'text': 'invalid syntax', + \ }, + \ ], + \ ale_linters#python#mypy#Handle(bufnr(''), [ + \ 'foo.py:4: error: invalid syntax', + \ ]) + +Execute(The mypy syntax errors should be ignored when the option is on): + let g:ale_python_mypy_ignore_invalid_syntax = 1 + + AssertEqual + \ [], + \ ale_linters#python#mypy#Handle(bufnr(''), [ + \ 'foo.py:4: error: invalid syntax', + \ ]) From 2ef45ab7457566a10354b7833cbdf5137118cebf Mon Sep 17 00:00:00 2001 From: Ivan Petkov Date: Tue, 9 Jan 2018 19:18:18 -0800 Subject: [PATCH 330/390] Teach ALE about cargo features and add some configuration options * When working on rust/cargo projects of varying sizes, it may be useful to either build all possible features (i.e. lint all possible conditionally compiled code), or even turn off other features for a quicker edit-lint cycle (e.g. for large projects with large build times) * Added a g:ale_rust_cargo_default_feature_behavior flag for instructing cargo to not build any features at all (via `--no-default-features`), building default features (via no extra flags), or building all possible features (via `--all-features`) * Also added a g:ale_rust_cargo_include_features flag for including arbitrary features to be checked by cargo. When coupled with g:ale_rust_cargo_default_feature_behavior this allows for full customization of what features are checked and which ones are ignored --- ale_linters/rust/cargo.vim | 22 ++++++++- doc/ale-rust.txt | 30 ++++++++++++ .../test_cargo_command_callbacks.vader | 48 +++++++++++++++++++ 3 files changed, 99 insertions(+), 1 deletion(-) diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim index a0e123a..09f41bb 100644 --- a/ale_linters/rust/cargo.vim +++ b/ale_linters/rust/cargo.vim @@ -1,8 +1,11 @@ -" Author: Daniel Schemala +" Author: Daniel Schemala , +" Ivan Petkov " Description: rustc invoked by cargo for rust files call ale#Set('rust_cargo_use_check', 1) call ale#Set('rust_cargo_check_all_targets', 0) +call ale#Set('rust_cargo_default_feature_behavior', 'default') +call ale#Set('rust_cargo_include_features', '') function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# '' @@ -29,10 +32,27 @@ function! ale_linters#rust#cargo#GetCommand(buffer, version_output) abort \ && ale#Var(a:buffer, 'rust_cargo_check_all_targets') \ && ale#semver#GTE(l:version, [0, 22, 0]) + let l:include_features = ale#Var(a:buffer, 'rust_cargo_include_features') + if !empty(l:include_features) + let l:include_features = ' --features ' . ale#Escape(l:include_features) + endif + + let l:default_feature_behavior = ale#Var(a:buffer, 'rust_cargo_default_feature_behavior') + if l:default_feature_behavior is# 'all' + let l:include_features = '' + let l:default_feature = ' --all-features' + elseif l:default_feature_behavior is# 'none' + let l:default_feature = ' --no-default-features' + else + let l:default_feature = '' + endif + return 'cargo ' \ . (l:use_check ? 'check' : 'build') \ . (l:use_all_targets ? ' --all-targets' : '') \ . ' --frozen --message-format=json -q' + \ . l:default_feature + \ . l:include_features endfunction call ale#linter#Define('rust', { diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 535f21d..dad9ae6 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -59,6 +59,36 @@ g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets* is used. See |g:ale_rust_cargo_use_check|, +g:ale_rust_cargo_default_feature_behavior + *g:ale_rust_cargo_default_feature_behavior* + *b:ale_rust_cargo_default_feature_behavior* + Type: |String| + Default: `default` + + When set to `none`, ALE will set the `--no-default-features` option when + invoking `cargo`. Only the features specified in + |g:ale_rust_cargo_include_features| will be included when performing the + lint check. + + When set to `default`, ALE will instruct `cargo` to build all default + features specified in the project's `Cargo.toml` file, in addition to + including any additional features defined in + |g:ale_rust_cargo_include_features|. + + When set to `all`, ALE will set the `--all-features` option when + invoking `cargo`, which will include all features defined in the project's + `Cargo.toml` file when performing the lint check. + + +g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features* + *b:ale_rust_cargo_include_features* + Type: |String| + Default: `''` + + When defined, ALE will set the `--features` option when invoking `cargo` to + perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|. + + =============================================================================== rls *ale-rust-rls* diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader index 65ea5a8..9c06f27 100644 --- a/test/command_callback/test_cargo_command_callbacks.vader +++ b/test/command_callback/test_cargo_command_callbacks.vader @@ -1,9 +1,13 @@ Before: Save g:ale_rust_cargo_use_check Save g:ale_rust_cargo_check_all_targets + Save g:ale_rust_cargo_default_feature_behavior + Save g:ale_rust_cargo_include_features unlet! g:ale_rust_cargo_use_check unlet! g:ale_cargo_check_all_targets + unlet! g:ale_rust_cargo_default_feature_behavior + unlet! g:ale_rust_cargo_include_features runtime ale_linters/rust/cargo.vim call ale#test#SetDirectory('/testplugin/test/command_callback') @@ -114,3 +118,47 @@ Execute(--all-targets should be used when g:ale_rust_cargo_check_all_targets is \ ale_linters#rust#cargo#GetCommand(bufnr(''), []) AssertEqual '', ale_linters#rust#cargo#VersionCheck(bufnr('')) + +Execute(--no-default-features should be used when g:ale_rust_cargo_default_feature_behavior is none): + let g:ale_rust_cargo_default_feature_behavior = 'none' + + AssertEqual + \ 'cargo check' . g:suffix . ' --no-default-features', + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + +Execute(g:ale_rust_cargo_include_features added when g:ale_rust_cargo_default_feature_behavior is none): + let g:ale_rust_cargo_default_feature_behavior = 'none' + let g:ale_rust_cargo_include_features = 'foo bar' + + AssertEqual + \ 'cargo check' . g:suffix . ' --no-default-features --features ' . + \ (fnamemodify(&shell, ':t') is? 'cmd.exe' ? '"foo bar"' : "'foo bar'"), + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + +Execute(g:ale_rust_cargo_include_features added and escaped): + let g:ale_rust_cargo_default_feature_behavior = 'default' + let g:ale_rust_cargo_include_features = "foo bar baz" + + AssertEqual + \ 'cargo check' . g:suffix . ' --features ' . + \ (fnamemodify(&shell, ':t') is? 'cmd.exe' ? '"foo bar baz"' : "'foo bar baz'"), + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) + +Execute(--all-features should be used when g:ale_rust_cargo_default_feature_behavior is all): + let g:ale_rust_cargo_default_feature_behavior = 'all' + + " When all features are enabled we should ignore extra features to add + " since it won't do anything + let g:ale_rust_cargo_include_features = 'foo bar' + + AssertEqual + \ 'cargo check' . g:suffix . ' --all-features', + \ ale_linters#rust#cargo#GetCommand(bufnr(''), [ + \ 'cargo 0.22.0 (3423351a5 2017-10-06)', + \ ]) From ba1540a5452fe4523ed91b99f1469f4e86112a6b Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 12 Jan 2018 08:55:24 +0000 Subject: [PATCH 331/390] Show only the master status for AppVeyor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55be933..451d485 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Asynchronous Lint Engine [![Travis CI Build Status](https://travis-ci.org/w0rp/ale.svg?branch=master)](https://travis-ci.org/w0rp/ale) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/w0rp/ale?svg=true)](https://ci.appveyor.com/project/w0rp/ale) +# Asynchronous Lint Engine [![Travis CI Build Status](https://travis-ci.org/w0rp/ale.svg?branch=master)](https://travis-ci.org/w0rp/ale) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/r0ef1xu8xjmik58d/branch/master?svg=true)](https://ci.appveyor.com/project/w0rp/ale) ![ALE Logo by Mark Grealish - https://www.bhalash.com/](img/logo.jpg?raw=true) From 13c839cf16e6dfb8deab30666748b7ae6c8f9aa0 Mon Sep 17 00:00:00 2001 From: rhysd Date: Mon, 15 Jan 2018 11:22:09 +0900 Subject: [PATCH 332/390] Enable prettier to format markdown files --- README.md | 2 +- autoload/ale/fix/registry.vim | 2 +- doc/ale-markdown.txt | 6 ++++++ doc/ale.txt | 3 ++- 4 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 451d485..5ee74db 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ formatting. | Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Mail | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) | | Make | [checkmake](https://github.com/mrtazz/checkmake) | -| Markdown | [alex](https://github.com/wooorm/alex) !!, [mdl](https://github.com/mivok/markdownlint), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | +| Markdown | [alex](https://github.com/wooorm/alex) !!, [mdl](https://github.com/mivok/markdownlint), [prettier](https://github.com/prettier/prettier), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 53df7cc..4b69240 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -45,7 +45,7 @@ let s:default_registry = { \ }, \ 'prettier': { \ 'function': 'ale#fixers#prettier#Fix', -\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less'], +\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less', 'markdown'], \ 'description': 'Apply prettier to a file.', \ }, \ 'prettier_eslint': { diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt index 3ce9619..b59f018 100644 --- a/doc/ale-markdown.txt +++ b/doc/ale-markdown.txt @@ -2,6 +2,12 @@ ALE Markdown Integration *ale-markdown-options* +=============================================================================== +prettier *ale-markdown-prettier* + +See |ale-javascript-prettier| for information about the available options. + + =============================================================================== write-good *ale-markdown-write-good* diff --git a/doc/ale.txt b/doc/ale.txt index 25c1abe..61d6eee 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -127,6 +127,7 @@ CONTENTS *ale-contents* lua...................................|ale-lua-options| luacheck............................|ale-lua-luacheck| markdown..............................|ale-markdown-options| + prettier............................|ale-markdown-prettier| write-good..........................|ale-markdown-write-good| nroff.................................|ale-nroff-options| write-good..........................|ale-nroff-write-good| @@ -326,7 +327,7 @@ Notes: * Lua: `luacheck` * Mail: `alex`!!, `proselint`, `vale` * Make: `checkmake` -* Markdown: `alex`!!, `mdl`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` +* Markdown: `alex`!!, `mdl`, `prettier`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` From aa29c91cdc9c5dc737e93c1f91080aa174363bef Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sun, 12 Nov 2017 00:53:02 -0500 Subject: [PATCH 333/390] [eruby] Add erubi linter MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Erubi is yet another parser for eRuby. This is the default parser in Rails as of version 5.1. It supports some additional syntax with similar behavior to Rails' extensions to the language, though incompatible. Rails currently still recommends their own syntax, so GetCommand still has to do the translation introduced in https://github.com/w0rp/ale/pull/1114 . Erubi does not supply an executable—It is intended to be invoked only from within a Ruby program. In this case, a one-liner on the command line. --- README.md | 2 +- ale_linters/eruby/erubi.vim | 35 +++++++++++++++++++ doc/ale-eruby.txt | 12 +++---- doc/ale.txt | 2 +- .../test_erubi_command_callback.vader | 31 ++++++++++++++++ 5 files changed, 73 insertions(+), 9 deletions(-) create mode 100644 ale_linters/eruby/erubi.vim create mode 100644 test/command_callback/test_erubi_command_callback.vader diff --git a/README.md b/README.md index 7382789..598c3cb 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ formatting. | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | -| Erb | [erb](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | +| Erb | [erb](https://apidock.com/ruby/ERB), [erubi](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | | Fortran | [gcc](https://gcc.gnu.org/) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | diff --git a/ale_linters/eruby/erubi.vim b/ale_linters/eruby/erubi.vim new file mode 100644 index 0000000..6f2d3ac --- /dev/null +++ b/ale_linters/eruby/erubi.vim @@ -0,0 +1,35 @@ +" Author: Eddie Lebow https://github.com/elebow +" Description: eruby checker using `erubi` + +function! ale_linters#eruby#erubi#CheckErubi(buffer) abort + return 'ruby -r erubi/capture_end -e ' . ale#Escape('""') +endfunction + +function! ale_linters#eruby#erubi#GetCommand(buffer, check_erubi_output) abort + let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) + + if (!empty(a:check_erubi_output)) + " The empty command in CheckErubi returns nothing if erubi runs and + " emits an error if erubi is not present + return '' + endif + + if empty(l:rails_root) + return 'ruby -r erubi/capture_end -e ' . ale#Escape('puts Erubi::CaptureEndEngine.new($stdin.read).src') . '< %t | ruby -c' + endif + + " Rails-flavored eRuby does not comply with the standard as understood by + " Erubi, so we'll have to do some substitution. This does not reduce the + " effectiveness of the linter---the translated code is still evaluated. + return 'ruby -r erubi/capture_end -e ' . ale#Escape('puts Erubi::CaptureEndEngine.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . '< %t | ruby -c' +endfunction + +call ale#linter#Define('eruby', { +\ 'name': 'erubi', +\ 'executable': 'ruby', +\ 'command_chain': [ +\ {'callback': 'ale_linters#eruby#erubi#CheckErubi'}, +\ {'callback': 'ale_linters#eruby#erubi#GetCommand', 'output_stream': 'stderr'}, +\ ], +\ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', +\}) diff --git a/doc/ale-eruby.txt b/doc/ale-eruby.txt index bfbe9ad..a0f6f4f 100644 --- a/doc/ale-eruby.txt +++ b/doc/ale-eruby.txt @@ -1,17 +1,15 @@ =============================================================================== ALE Eruby Integration *ale-eruby-options* -There are two linters for `eruby` files: +There are three linters for `eruby` files: - `erb` - `erubis` +- `erubi` -If you don't know which one your project uses, it's probably `erb`. -To selectively enable one or the other, see |g:ale_linters|. - -(Note that ALE already disables linters if the executable for that linter is -not found; thus, there's probably no need to disable one of these if you're -using the other one.) +`erb` is in the Ruby standard library and is mostly universal. `erubis` is the +default parser in Rails between 3.0 and 5.1. `erubi` is the default in Rails +5.1 and later. To selectively enable a subset, see |g:ale_linters|. =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 6399111..be57768 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -286,7 +286,7 @@ Notes: * Dockerfile: `hadolint` * Elixir: `credo`, `dogma`!! * Elm: `elm-format, elm-make` -* Erb: `erb`, `erubis` +* Erb: `erb`, `erubi`, `erubis` * Erlang: `erlc`, `SyntaxErl` * Fortran: `gcc` * FusionScript: `fusion-lint` diff --git a/test/command_callback/test_erubi_command_callback.vader b/test/command_callback/test_erubi_command_callback.vader new file mode 100644 index 0000000..1953d76 --- /dev/null +++ b/test/command_callback/test_erubi_command_callback.vader @@ -0,0 +1,31 @@ +Before: + runtime ale_linters/eruby/erubi.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(Executable should not contain any filter code by default): + call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb') + + AssertEqual + \ 'ruby -r erubi/capture_end -e ' . ale#Escape('puts Erubi::CaptureEndEngine.new($stdin.read).src') . '< %t | ruby -c', + \ ale_linters#eruby#erubi#GetCommand(bufnr(''), []) + +Execute(Executable should filter invalid eRuby when inside a Rails project): + call ale#test#SetFilename('../ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb') + + AssertEqual + \ 'ruby -r erubi/capture_end -e ' . ale#Escape('puts Erubi::CaptureEndEngine.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . '< %t | ruby -c', + \ ale_linters#eruby#erubi#GetCommand(bufnr(''), []) + +Execute(Command should be blank if the first command in the chain return output): + let output_lines = [ + \ "/usr/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require': cannot load such file -- erubi/capture_end (LoadError)", + \ " from /usr/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require'", + \] + + AssertEqual + \ '', + \ ale_linters#eruby#erubi#GetCommand(bufnr(''), output_lines) From 045c92ed655214ef7503c2d592e41eb0ba4bf041 Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 17 Jan 2018 18:08:17 +0000 Subject: [PATCH 334/390] Fix #1298 - Escape commands for PowerShell --- autoload/ale/job.vim | 2 +- test/smoke_test.vader | 62 +++++++++++++++++++++++++++++++++ test/test_history_saving.vader | 4 +-- test/test_prepare_command.vader | 4 +-- 4 files changed, 67 insertions(+), 5 deletions(-) diff --git a/autoload/ale/job.vim b/autoload/ale/job.vim index 9cebcf5..2909dab 100644 --- a/autoload/ale/job.vim +++ b/autoload/ale/job.vim @@ -205,7 +205,7 @@ function! ale#job#PrepareCommand(buffer, command) abort " but we'll do this explicitly, so we use the same exact command for both " versions. if has('win32') - return 'cmd /c ' . l:command + return 'cmd /s/c "' . l:command . '"' endif if &shell =~? 'fish$' diff --git a/test/smoke_test.vader b/test/smoke_test.vader index 7635cbd..f6d0be5 100644 --- a/test/smoke_test.vader +++ b/test/smoke_test.vader @@ -1,6 +1,7 @@ Before: Save g:ale_set_lists_synchronously Save g:ale_buffer_info + Save &shell let g:ale_buffer_info = {} let g:ale_set_lists_synchronously = 1 @@ -59,6 +60,67 @@ Execute(Linters should run with the default options): \ 'valid': 1, \ }], getloclist(0) +Execute(Linters should run in PowerShell too): + if has('win32') + set shell=powershell + + AssertEqual 'foobar', &filetype + + " Replace the callback to handle two lines. + function! TestCallback(buffer, output) + " Windows adds extra spaces to the text from echo. + return [ + \ { + \ 'lnum': 1, + \ 'col': 3, + \ 'text': substitute(a:output[0], ' *$', '', ''), + \ }, + \ { + \ 'lnum': 2, + \ 'col': 3, + \ 'text': substitute(a:output[1], ' *$', '', ''), + \ }, + \] + endfunction + + " Recreate the command string to use &&, which PowerShell does not support. + call ale#linter#Reset() + call ale#linter#Define('foobar', { + \ 'name': 'testlinter', + \ 'callback': 'TestCallback', + \ 'executable': 'cmd', + \ 'command': 'echo foo && echo bar', + \}) + + call ale#Lint() + call ale#engine#WaitForJobs(2000) + + AssertEqual [ + \ { + \ 'bufnr': bufnr('%'), + \ 'lnum': 1, + \ 'vcol': 0, + \ 'col': 3, + \ 'text': 'foo', + \ 'type': 'E', + \ 'nr': -1, + \ 'pattern': '', + \ 'valid': 1, + \ }, + \ { + \ 'bufnr': bufnr('%'), + \ 'lnum': 2, + \ 'vcol': 0, + \ 'col': 3, + \ 'text': 'bar', + \ 'type': 'E', + \ 'nr': -1, + \ 'pattern': '', + \ 'valid': 1, + \ }, + \], getloclist(0) + endif + Execute(Previous errors should be removed when linters change): call ale#Lint() call ale#engine#WaitForJobs(2000) diff --git a/test/test_history_saving.vader b/test/test_history_saving.vader index 020ceb5..7dabcd9 100644 --- a/test/test_history_saving.vader +++ b/test/test_history_saving.vader @@ -76,7 +76,7 @@ Execute(History should be set when commands are run): AssertEqual sort(['status', 'exit_code', 'job_id', 'command']), sort(keys(g:history[0])) if has('win32') - AssertEqual 'cmd /c echo command history test', g:history[0].command + AssertEqual 'cmd /s/c "echo command history test"', g:history[0].command else AssertEqual ['/bin/sh', '-c', '/bin/sh -c ''echo command history test'''], g:history[0].command endif @@ -151,7 +151,7 @@ Execute(The history should be updated when fixers are run): AssertEqual ['finished'], map(copy(b:ale_history), 'v:val.status') if has('win32') - AssertEqual 'cmd /c echo foo ', split(b:ale_history[0].command, '<')[0] + AssertEqual 'cmd /s/c "echo foo ', split(b:ale_history[0].command, '<')[0] else AssertEqual '/bin/sh -c echo foo ', split(join(b:ale_history[0].command), '<')[0] endif diff --git a/test/test_prepare_command.vader b/test/test_prepare_command.vader index 16772e8..ed9272a 100644 --- a/test/test_prepare_command.vader +++ b/test/test_prepare_command.vader @@ -30,10 +30,10 @@ Execute(Other shells should be used when set): AssertEqual ['/bin/bash', '-c', 'foobar'], ale#job#PrepareCommand(bufnr(''), 'foobar') endif -Execute(cmd /c as a string should be used on Windows): +Execute(cmd /s/c as a string should be used on Windows): if has('win32') let &shell = 'who cares' let &shellcmdflag = 'whatever' - AssertEqual 'cmd /c foobar', ale#job#PrepareCommand(bufnr(''), 'foobar') + AssertEqual 'cmd /s/c "foobar"', ale#job#PrepareCommand(bufnr(''), 'foobar') endif From eddda2f8b599a52e92c99795f42c0c4ba8e15f7c Mon Sep 17 00:00:00 2001 From: w0rp Date: Wed, 17 Jan 2018 18:11:20 +0000 Subject: [PATCH 335/390] Fix a command wrapper test on Windows --- test/test_wrap_comand.vader | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/test_wrap_comand.vader b/test/test_wrap_comand.vader index 8c1569b..7ddb06a 100644 --- a/test/test_wrap_comand.vader +++ b/test/test_wrap_comand.vader @@ -5,7 +5,7 @@ Before: function! TestCommand(expected_part, input) abort let l:expected = has('win32') - \ ? 'cmd /c ' . a:expected_part + \ ? 'cmd /s/c "' . a:expected_part . '"' \ : split(&shell) + split(&shellcmdflag) + [a:expected_part] AssertEqual l:expected, ale#job#PrepareCommand(bufnr(''), a:input) From 042dec059a3da01477cbc76e9893973dd374872d Mon Sep 17 00:00:00 2001 From: Rafael Lerm Date: Fri, 19 Jan 2018 14:40:55 -0200 Subject: [PATCH 336/390] Send didSave message to LSP-based linters (#1295) * Also send didSave to LSP linters. * Add tests for messages sent to LSP linters. --- autoload/ale/engine.vim | 7 ++ test/lsp/test_lsp_communication.vader | 97 +++++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 test/lsp/test_lsp_communication.vader diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 70b5a3b..c415e7c 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -703,6 +703,13 @@ function! s:CheckWithLSP(buffer, linter) abort \ : ale#lsp#message#DidChange(a:buffer) let l:request_id = ale#lsp#Send(l:id, l:change_message, l:root) + " If this was a file save event, also notify the server of that. + let l:is_save = getbufvar(a:buffer, 'ale_save_event_fired', 0) + if l:is_save != 0 + let l:save_message = ale#lsp#message#DidSave(a:buffer) + let l:request_id = ale#lsp#Send(l:id, l:save_message, l:root) + endif + if l:request_id != 0 if index(l:info.active_linter_list, a:linter.name) < 0 call add(l:info.active_linter_list, a:linter.name) diff --git a/test/lsp/test_lsp_communication.vader b/test/lsp/test_lsp_communication.vader new file mode 100644 index 0000000..7a4c67e --- /dev/null +++ b/test/lsp/test_lsp_communication.vader @@ -0,0 +1,97 @@ +Before: + Save g:ale_lint_on_save + Save g:ale_enabled + Save g:ale_linters + Save g:ale_run_synchronously + + call ale#test#SetDirectory('/testplugin/test/completion') + call ale#test#SetFilename('dummy.txt') + + runtime autoload/ale/lsp.vim + + let g:ale_lint_on_save = 1 + let b:ale_enabled = 1 + let g:ale_lsp_next_message_id = 1 + let g:ale_run_synchronously = 1 + let g:message_list = [] + let g:Callback = '' + + call ale#linter#Define('foobar', { + \ 'name': 'dummy_linter', + \ 'lsp': 'stdio', + \ 'command': 'cat - > /dev/null', + \ 'executable': has('win32') ? 'cmd' : 'echo', + \ 'language_callback': {buffer -> 'foobar'}, + \ 'project_root_callback': {buffer -> expand('.')}, + \ }) + let g:ale_linters = {'foobar': ['dummy_linter']} + + function! ale#linter#StartLSP(buffer, linter, callback) abort + let g:Callback = a:callback + + return { + \ 'connection_id': 347, + \ 'project_root': '/foo/bar', + \} + endfunction + + " Replace the Send function for LSP, so we can monitor calls to it. + function! ale#lsp#Send(conn_id, message, ...) abort + call add(g:message_list, a:message) + endfunction + +After: + Restore + + unlet! b:ale_enabled + unlet! b:ale_linters + unlet! g:Callback + unlet! g:message_list + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + + " Stop any timers we left behind. + " This stops the tests from failing randomly. + call ale#completion#StopTimer() + + runtime autoload/ale/completion.vim + runtime autoload/ale/lsp.vim + +Given foobar (Some imaginary filetype): + + +Execute(Server should be notified on save): + call ale#events#SaveEvent(bufnr('')) + + AssertEqual + \ [ + \ [1, 'textDocument/didChange', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ 'version': g:ale_lsp_next_version_id - 1, + \ }, + \ 'contentChanges': [{'text': join(getline(1, '$'), "\n") . "\n"}], + \ }], + \ [1, 'textDocument/didSave', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ }, + \ }], + \ ], + \ g:message_list + +Execute(Server should be notified on change): + call ale#events#FileChangedEvent(bufnr('')) + + AssertEqual + \ [ + \ [1, 'textDocument/didChange', { + \ 'textDocument': { + \ 'uri': ale#path#ToURI(expand('%:p')), + \ 'version': g:ale_lsp_next_version_id - 1, + \ }, + \ 'contentChanges': [{'text': join(getline(1, '$'), "\n") . "\n"}], + \ }], + \ ], + \ g:message_list From a5ec4143d2ed0527649d4143e244b62b9f879661 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 19 Jan 2018 16:50:04 +0000 Subject: [PATCH 337/390] Fix the didSave tests so they work in NeoVim 0.1.7, and do not send the message for tsserver --- autoload/ale/engine.vim | 4 ++-- ...munication.vader => test_did_save_event.vader} | 15 +++++++++++++-- 2 files changed, 15 insertions(+), 4 deletions(-) rename test/lsp/{test_lsp_communication.vader => test_did_save_event.vader} (88%) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index c415e7c..8c3d4c7 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -704,8 +704,8 @@ function! s:CheckWithLSP(buffer, linter) abort let l:request_id = ale#lsp#Send(l:id, l:change_message, l:root) " If this was a file save event, also notify the server of that. - let l:is_save = getbufvar(a:buffer, 'ale_save_event_fired', 0) - if l:is_save != 0 + if a:linter.lsp isnot# 'tsserver' + \&& getbufvar(a:buffer, 'ale_save_event_fired', 0) let l:save_message = ale#lsp#message#DidSave(a:buffer) let l:request_id = ale#lsp#Send(l:id, l:save_message, l:root) endif diff --git a/test/lsp/test_lsp_communication.vader b/test/lsp/test_did_save_event.vader similarity index 88% rename from test/lsp/test_lsp_communication.vader rename to test/lsp/test_did_save_event.vader index 7a4c67e..042a3ce 100644 --- a/test/lsp/test_lsp_communication.vader +++ b/test/lsp/test_did_save_event.vader @@ -16,13 +16,21 @@ Before: let g:message_list = [] let g:Callback = '' + function! LanguageCallback() abort + return 'foobar' + endfunction + + function! ProjectRootCallback() abort + return expand('.') + endfunction + call ale#linter#Define('foobar', { \ 'name': 'dummy_linter', \ 'lsp': 'stdio', \ 'command': 'cat - > /dev/null', \ 'executable': has('win32') ? 'cmd' : 'echo', - \ 'language_callback': {buffer -> 'foobar'}, - \ 'project_root_callback': {buffer -> expand('.')}, + \ 'language_callback': 'LanguageCallback', + \ 'project_root_callback': 'ProjectRootCallback', \ }) let g:ale_linters = {'foobar': ['dummy_linter']} @@ -48,6 +56,9 @@ After: unlet! g:Callback unlet! g:message_list + delfunction LanguageCallback + delfunction ProjectRootCallback + call ale#test#RestoreDirectory() call ale#linter#Reset() From 7cd25181b29dd0484a11fefc03d2239564fcba06 Mon Sep 17 00:00:00 2001 From: Christoffer Aasted <402927+dezza@users.noreply.github.com> Date: Sat, 20 Jan 2018 03:20:13 +0100 Subject: [PATCH 338/390] Fix #1246 - Newer ESLint outputs to stderr I think Vader test still applies for this one. --- ale_linters/javascript/eslint.vim | 1 + 1 file changed, 1 insertion(+) diff --git a/ale_linters/javascript/eslint.vim b/ale_linters/javascript/eslint.vim index 785b8bb..23e1694 100644 --- a/ale_linters/javascript/eslint.vim +++ b/ale_linters/javascript/eslint.vim @@ -3,6 +3,7 @@ call ale#linter#Define('javascript', { \ 'name': 'eslint', +\ 'output_stream': 'both', \ 'executable_callback': 'ale#handlers#eslint#GetExecutable', \ 'command_callback': 'ale#handlers#eslint#GetCommand', \ 'callback': 'ale#handlers#eslint#Handle', From 038789f0ed42cfffbd442a6a399cb2395591821d Mon Sep 17 00:00:00 2001 From: Fran Casas Date: Mon, 22 Jan 2018 13:21:07 +0100 Subject: [PATCH 339/390] Add Elixir linter for dialyxir (#1257) * Add Elixir linter for dialyxir * Update doc/ale.txt with dialyxir * Keep elixir tools alphabetically ordered in README * Add a missing entry for dialyxir to the main documentation file. --- README.md | 2 +- ale_linters/elixir/dialyxir.vim | 34 +++++++++++++++++++++++++++++++++ doc/ale-elixir.txt | 15 +++++++++++++++ doc/ale.txt | 3 ++- 4 files changed, 52 insertions(+), 2 deletions(-) create mode 100644 ale_linters/elixir/dialyxir.vim diff --git a/README.md b/README.md index 29095df..c42f4bf 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ formatting. | Dafny | [dafny](https://rise4fun.com/Dafny) !! | | Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !!, [language_server](https://github.com/natebosch/dart_language_server) | | Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | -| Elixir | [credo](https://github.com/rrrene/credo), [dogma](https://github.com/lpil/dogma) !! | +| Elixir | [credo](https://github.com/rrrene/credo), [dialyxir](https://github.com/jeremyjh/dialyxir), [dogma](https://github.com/lpil/dogma) !!| | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | | Erb | [erb](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | diff --git a/ale_linters/elixir/dialyxir.vim b/ale_linters/elixir/dialyxir.vim new file mode 100644 index 0000000..5ef3a04 --- /dev/null +++ b/ale_linters/elixir/dialyxir.vim @@ -0,0 +1,34 @@ +" Author: Fran C. - https://github.com/franciscoj +" Description: Add dialyzer support for elixir through dialyxir +" https://github.com/jeremyjh/dialyxir + +function! ale_linters#elixir#dialyxir#Handle(buffer, lines) abort + " Matches patterns line the following: + " + " lib/filename.ex:19: Function fname/1 has no local return + let l:pattern = '\v(.+):(\d+): (.+)$' + let l:output = [] + let l:type = 'W' + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + if bufname(a:buffer) == l:match[1] + call add(l:output, { + \ 'bufnr': a:buffer, + \ 'lnum': l:match[2] + 0, + \ 'col': 0, + \ 'type': l:type, + \ 'text': l:match[3], + \}) + endif + endfor + + return l:output +endfunction + +call ale#linter#Define('elixir', { +\ 'name': 'dialyxir', +\ 'executable': 'mix', +\ 'command': 'mix dialyzer', +\ 'callback': 'ale_linters#elixir#dialyxir#Handle', +\}) + diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt index a5318c0..b7d4922 100644 --- a/doc/ale-elixir.txt +++ b/doc/ale-elixir.txt @@ -13,5 +13,20 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options* This variable can be changed to specify the mix executable. +=============================================================================== +dialyxir *ale-elixir-dialyxir* + +Dialyzer, a DIscrepancy AnaLYZer for ERlang programs. +http://erlang.org/doc/man/dialyzer.html + +It can be used with elixir through dialyxir +https://github.com/jeremyjh/dialyxir + +Options for dialyzer are not configurable by ale, but they are instead +configured on your project's `mix.exs`. + +See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more +information. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index b99c800..4776568 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -57,6 +57,7 @@ CONTENTS *ale-contents* hadolint............................|ale-dockerfile-hadolint| elixir................................|ale-elixir-options| mix.................................|ale-elixir-mix| + dialyxir............................|ale-elixir-dialyxir| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-make............................|ale-elm-elm-make| @@ -301,7 +302,7 @@ Notes: * Dafny: `dafny`!! * Dart: `dartanalyzer`!!, `language_server` * Dockerfile: `hadolint` -* Elixir: `credo`, `dogma`!! +* Elixir: `credo`, `dialyxir`, `dogma`!! * Elm: `elm-format, elm-make` * Erb: `erb`, `erubis` * Erlang: `erlc`, `SyntaxErl` From dd413a4732ed52e33ec318c7c15a30cf413c87a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Lorenzo=20Rodr=C3=ADguez?= Date: Tue, 23 Jan 2018 22:46:59 +0100 Subject: [PATCH 340/390] Improving hadolint checker - Displaying dockerfile parse errors instead of silently failing - Adding error detail with link to the docs --- ale_linters/dockerfile/hadolint.vim | 30 ++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/ale_linters/dockerfile/hadolint.vim b/ale_linters/dockerfile/hadolint.vim index 5550d69..6e1c737 100644 --- a/ale_linters/dockerfile/hadolint.vim +++ b/ale_linters/dockerfile/hadolint.vim @@ -7,26 +7,46 @@ call ale#Set('dockerfile_hadolint_docker_image', 'lukasmartinelli/hadolint') function! ale_linters#dockerfile#hadolint#Handle(buffer, lines) abort " Matches patterns line the following: " - " stdin:19: F: Pipe chain should start with a raw value. - let l:pattern = '\v^/dev/stdin:?(\d+)? (\S+) (.+)$' + " /dev/stdin:19 DL3001 Pipe chain should start with a raw value. + " /dev/stdin:19:3 unexpected thing + let l:pattern = '\v^/dev/stdin:(\d+):?(\d+)? ((DL|SC)(\d+) )?(.+)$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) let l:lnum = 0 + let l:colnum = 0 if l:match[1] isnot# '' let l:lnum = l:match[1] + 0 endif + if l:match[2] isnot# '' + let l:colnum = l:match[2] + 0 + endif + let l:type = 'W' - let l:text = l:match[3] + let l:text = l:match[6] + let l:detail = l:match[6] + let l:domain = 'https://github.com/hadolint/hadolint/wiki/' + + if l:match[4] is# 'SC' + let l:domain = 'https://github.com/koalaman/shellcheck/wiki/' + endif + + if l:match[5] isnot# '' + let l:code = l:match[4] . l:match[5] + let l:link = ' ( ' . l:domain . l:code . ' )' + let l:detail = l:code . l:link . "\n\n" . l:detail + else + let l:type = 'E' + endif call add(l:output, { \ 'lnum': l:lnum, - \ 'col': 0, + \ 'col': l:colnum, \ 'type': l:type, \ 'text': l:text, - \ 'nr': l:match[2], + \ 'detail': l:detail \}) endfor From d562d531024a2a2210fdf08594639a0b068bacce Mon Sep 17 00:00:00 2001 From: Rafael Rinaldi Date: Wed, 24 Jan 2018 10:12:29 +0000 Subject: [PATCH 341/390] Add jq as a JSON fixer --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 +++++ autoload/ale/fixers/jq.vim | 18 ++++++++++++++++++ doc/ale-json.txt | 27 +++++++++++++++++++++++++++ doc/ale.txt | 3 ++- 5 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/jq.vim diff --git a/README.md b/README.md index c42f4bf..6ac88cc 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ formatting. | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html), [google-java-format](https://github.com/google/google-java-format) | | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), [prettier-eslint](https://github.com/prettier/prettier-eslint), [prettier-standard](https://github.com/sheerun/prettier-standard), [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) -| JSON | [jsonlint](http://zaa.ch/jsonlint/), [prettier](https://github.com/prettier/prettier) | +| JSON | [jsonlint](http://zaa.ch/jsonlint/), [jq](https://stedolan.github.io/jq/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [alex](https://github.com/wooorm/alex) !!, [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 4b69240..2e8e6e0 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -159,6 +159,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['java'], \ 'description': 'Fix Java files with google-java-format.', \ }, +\ 'jq': { +\ 'function': 'ale#fixers#jq#Fix', +\ 'suggested_filetypes': ['json'], +\ 'description': 'Fix JSON files with jq.', +\ }, \} " Reset the function registry to the default entries. diff --git a/autoload/ale/fixers/jq.vim b/autoload/ale/fixers/jq.vim new file mode 100644 index 0000000..4604b24 --- /dev/null +++ b/autoload/ale/fixers/jq.vim @@ -0,0 +1,18 @@ +call ale#Set('json_jq_executable', 'jq') +call ale#Set('json_jq_use_global', 0) +call ale#Set('json_jq_options', '') + +function! ale#fixers#jq#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'jq', [ + \ 'jq', + \]) +endfunction + +function! ale#fixers#jq#Fix(buffer) abort + let l:options = ale#Var(a:buffer, 'json_jq_options') + + return { + \ 'command': ale#Escape(ale#fixers#jq#GetExecutable(a:buffer)) + \ . ' . ' . l:options, + \} +endfunction diff --git a/doc/ale-json.txt b/doc/ale-json.txt index 1d052d5..92c4609 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -8,6 +8,33 @@ jsonlint *ale-json-jsonlint* There are no options available. +=============================================================================== +jq *ale-json-jq* + +g:ale_json_jq_executable *g:ale_json_jq_executable* + *b:ale_json_jq_executable* + Type: |String| + Default: `'jq'` + + See |ale-integrations-local-executables| + + +g:ale_json_jq_use_global *g:ale_json_jq_use_global* + *b:ale_json_jq_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + +g:ale_json_jq_options *g:ale_json_jq_options* + *b:ale_json_jq_options* + Type: |String| + Default: `''` + + This option can be changed to pass extra options to `jq`. + + =============================================================================== prettier *ale-json-prettier* diff --git a/doc/ale.txt b/doc/ale.txt index 4776568..f25e884 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -113,6 +113,7 @@ CONTENTS *ale-contents* xo..................................|ale-javascript-xo| json..................................|ale-json-options| jsonlint............................|ale-json-jsonlint| + jq..................................|ale-json-jq| prettier............................|ale-json-prettier| kotlin................................|ale-kotlin-options| kotlinc.............................|ale-kotlin-kotlinc| @@ -321,7 +322,7 @@ Notes: * Idris: `idris` * Java: `checkstyle`, `javac`, `google-java-format` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo` -* JSON: `jsonlint`, `prettier` +* JSON: `jsonlint`, `jq`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `alex`!!, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` * Less: `lessc`, `prettier`, `stylelint` From b28a6ddbe4cf573ea993288a6ad4db569d535adf Mon Sep 17 00:00:00 2001 From: rhysd Date: Wed, 24 Jan 2018 10:36:02 +0000 Subject: [PATCH 342/390] Support fixing JSON files with fixjson --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 ++ autoload/ale/fixers/fixjson.vim | 20 ++++++++ doc/ale-json.txt | 39 +++++++++++++++ doc/ale.txt | 3 +- test/fixers/test_fixjson_fixer_callback.vader | 50 +++++++++++++++++++ test/json_files/testfile.json | 1 + 7 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/fixjson.vim create mode 100644 test/fixers/test_fixjson_fixer_callback.vader create mode 100644 test/json_files/testfile.json diff --git a/README.md b/README.md index 6ac88cc..ff46a40 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ formatting. | Idris | [idris](http://www.idris-lang.org/) | | Java | [checkstyle](http://checkstyle.sourceforge.net), [javac](http://www.oracle.com/technetwork/java/javase/downloads/index.html), [google-java-format](https://github.com/google/google-java-format) | | JavaScript | [eslint](http://eslint.org/), [flow](https://flowtype.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/), [prettier](https://github.com/prettier/prettier), [prettier-eslint](https://github.com/prettier/prettier-eslint), [prettier-standard](https://github.com/sheerun/prettier-standard), [standard](http://standardjs.com/), [xo](https://github.com/sindresorhus/xo) -| JSON | [jsonlint](http://zaa.ch/jsonlint/), [jq](https://stedolan.github.io/jq/), [prettier](https://github.com/prettier/prettier) | +| JSON | [fixjson](https://github.com/rhysd/fixjson), [jsonlint](http://zaa.ch/jsonlint/), [jq](https://stedolan.github.io/jq/), [prettier](https://github.com/prettier/prettier) | | Kotlin | [kotlinc](https://kotlinlang.org) !!, [ktlint](https://ktlint.github.io) !! see `:help ale-integration-kotlin` for configuration instructions | | LaTeX | [alex](https://github.com/wooorm/alex) !!, [chktex](http://www.nongnu.org/chktex/), [lacheck](https://www.ctan.org/pkg/lacheck), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Less | [lessc](https://www.npmjs.com/package/less), [prettier](https://github.com/prettier/prettier), [stylelint](https://github.com/stylelint/stylelint) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 2e8e6e0..2d0b4a5 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -159,6 +159,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['java'], \ 'description': 'Fix Java files with google-java-format.', \ }, +\ 'fixjson': { +\ 'function': 'ale#fixers#fixjson#Fix', +\ 'suggested_filetypes': ['json'], +\ 'description': 'Fix JSON files with fixjson.', +\ }, \ 'jq': { \ 'function': 'ale#fixers#jq#Fix', \ 'suggested_filetypes': ['json'], diff --git a/autoload/ale/fixers/fixjson.vim b/autoload/ale/fixers/fixjson.vim new file mode 100644 index 0000000..84728f2 --- /dev/null +++ b/autoload/ale/fixers/fixjson.vim @@ -0,0 +1,20 @@ +" Author: rhysd +" Description: Integration of fixjson with ALE. + +call ale#Set('json_fixjson_executable', 'fixjson') +call ale#Set('json_fixjson_options', '') + +function! ale#fixers#fixjson#Fix(buffer) abort + let l:executable = ale#Escape(ale#Var(a:buffer, 'json_fixjson_executable')) + let l:filename = ale#Escape(bufname(a:buffer)) + let l:command = l:executable . ' --stdin-filename ' . l:filename + + let l:options = ale#Var(a:buffer, 'json_fixjson_options') + if l:options isnot# '' + let l:command .= ' ' . l:options + endif + + return { + \ 'command': l:command + \} +endfunction diff --git a/doc/ale-json.txt b/doc/ale-json.txt index 92c4609..b8e13cd 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -2,6 +2,45 @@ ALE JSON Integration *ale-json-options* +=============================================================================== +fixjson *ale-json-fixjson* + +fixjson is a JSON file fixer/formatter for humans using (relaxed) JSON5. +It provides: + +- Pretty-prints JSON input +- Fixes various failures while humans writing JSON + - Fixes trailing commas objects or arrays + - Fixes missing commas for elements of objects or arrays + - Adds quotes to keys in objects + - Newlines in strings + - Hex numbers + - Fixes single quotes to double quotes + +You can install it using npm: +> + $ npm install -g fixjson +< +ALE provides fixjson integration as a fixer. See |ale-fix|. + +g:ale_json_fixjson_executable *g:ale_json_fixjson_executable* + *b:ale_json_fixjson_executable* + + Type: |String| + Default: `'fixjson'` + + The executable that will be run for fixjson. + +g:ale_json_fixjson_options *g:ale_json_fixjson_options* + *b:ale_json_fixjson_options* + + Type: |String| + Default: `''` + + This variable can add extra options to the command executed for running + fixjson. + + =============================================================================== jsonlint *ale-json-jsonlint* diff --git a/doc/ale.txt b/doc/ale.txt index f25e884..ddda902 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -112,6 +112,7 @@ CONTENTS *ale-contents* standard............................|ale-javascript-standard| xo..................................|ale-javascript-xo| json..................................|ale-json-options| + fixjson.............................|ale-json-fixjson| jsonlint............................|ale-json-jsonlint| jq..................................|ale-json-jq| prettier............................|ale-json-prettier| @@ -322,7 +323,7 @@ Notes: * Idris: `idris` * Java: `checkstyle`, `javac`, `google-java-format` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo` -* JSON: `jsonlint`, `jq`, `prettier` +* JSON: `fixjson`, `jsonlint`, `jq`, `prettier` * Kotlin: `kotlinc`, `ktlint` * LaTeX (tex): `alex`!!, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good` * Less: `lessc`, `prettier`, `stylelint` diff --git a/test/fixers/test_fixjson_fixer_callback.vader b/test/fixers/test_fixjson_fixer_callback.vader new file mode 100644 index 0000000..1a3bdcf --- /dev/null +++ b/test/fixers/test_fixjson_fixer_callback.vader @@ -0,0 +1,50 @@ +Before: + Save g:ale_json_fixjson_executable + Save g:ale_json_fixjson_options + + let g:ale_json_fixjson_executable = '/path/to/fixjson' + let g:ale_json_fixjson_options = '' + + call ale#test#SetDirectory('/testplugin/test/fixers') + +After: + Restore + +Execute(The fixjson callback should return the correct default command): + AssertEqual + \ { + \ 'command': ale#Escape('/path/to/fixjson') + \ . ' --stdin-filename ' + \ . ale#Escape(bufname(bufnr(''))) + \ }, + \ ale#fixers#fixjson#Fix(bufnr('')) + +Execute(The fixjson callback should set the buffer name as file name): + call ale#test#SetFilename('../json_files/testfile.json') + + AssertEqual + \ { + \ 'command': ale#Escape('/path/to/fixjson') + \ . ' --stdin-filename ' + \ . ale#Escape(bufname(bufnr(''))) + \ }, + \ ale#fixers#fixjson#Fix(bufnr('')) + + AssertNotEqual + \ stridx( + \ ale#fixers#fixjson#Fix(bufnr('')).command, + \ 'testfile.json', + \ ), + \ -1 + +Execute(The fixjson callback should include additional options): + let g:ale_json_fixjson_options = '-i 2' + + AssertEqual + \ { + \ 'command': ale#Escape('/path/to/fixjson') + \ . ' --stdin-filename ' + \ . ale#Escape(bufname(bufnr(''))) + \ . ' -i 2' + \ }, + \ ale#fixers#fixjson#Fix(bufnr('')) diff --git a/test/json_files/testfile.json b/test/json_files/testfile.json new file mode 100644 index 0000000..fe317eb --- /dev/null +++ b/test/json_files/testfile.json @@ -0,0 +1 @@ +{"answer":42} From be47e37bbcaf99220a617f6a1e067852f1be74e3 Mon Sep 17 00:00:00 2001 From: butlerx Date: Fri, 5 Jan 2018 12:02:05 +0000 Subject: [PATCH 343/390] add prettier support for graphql --- README.md | 2 +- autoload/ale/fix/registry.vim | 2 +- doc/ale-graphql.txt | 5 +++++ doc/ale.txt | 3 ++- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f058df2..df25337 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ formatting. | Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gotype](https://godoc.org/golang.org/x/tools/cmd/gotype), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | -| GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | +| GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint), [prettier](https://github.com/prettier/prettier) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | | Haskell | [brittany](https://github.com/lspitzner/brittany), [ghc](https://www.haskell.org/ghc/), [stack-ghc](https://haskellstack.org/), [stack-build](https://haskellstack.org/) !!, [ghc-mod](https://github.com/DanielG/ghc-mod), [stack-ghc-mod](https://github.com/DanielG/ghc-mod), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools), [hfmt](https://github.com/danstiner/hfmt) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 2d0b4a5..e456884 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -45,7 +45,7 @@ let s:default_registry = { \ }, \ 'prettier': { \ 'function': 'ale#fixers#prettier#Fix', -\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less', 'markdown'], +\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less', 'markdown', 'graphql'], \ 'description': 'Apply prettier to a file.', \ }, \ 'prettier_eslint': { diff --git a/doc/ale-graphql.txt b/doc/ale-graphql.txt index de41276..603694b 100644 --- a/doc/ale-graphql.txt +++ b/doc/ale-graphql.txt @@ -13,5 +13,10 @@ You will need the GraphQL ESLint plugin installed for this to work. =============================================================================== gqlint *ale-graphql-gqlint* +=============================================================================== +prettier *ale-graphql-prettier* + +See |ale-javascript-prettier| for information about the available options. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index e0002f7..26d2d0a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -82,6 +82,7 @@ CONTENTS *ale-contents* graphql...............................|ale-graphql-options| eslint..............................|ale-graphql-eslint| gqlint..............................|ale-graphql-gqlint| + prettier............................|ale-graphql-prettier| handlebars............................|ale-handlebars-options| ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| @@ -315,7 +316,7 @@ Notes: * Git Commit Messages: `gitlint` * GLSL: glslang, `glslls` * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gotype`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! -* GraphQL: `eslint`, `gqlint` +* GraphQL: `eslint`, `gqlint`, `prettier` * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` From ef898fa3033c10a6176995aba4ccb4567c85e601 Mon Sep 17 00:00:00 2001 From: rhysd Date: Thu, 25 Jan 2018 03:45:07 +0900 Subject: [PATCH 344/390] fixjson: Add support for local installation --- autoload/ale/fixers/fixjson.vim | 9 ++++++++- doc/ale-json.txt | 8 ++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/autoload/ale/fixers/fixjson.vim b/autoload/ale/fixers/fixjson.vim index 84728f2..43eb063 100644 --- a/autoload/ale/fixers/fixjson.vim +++ b/autoload/ale/fixers/fixjson.vim @@ -3,9 +3,16 @@ call ale#Set('json_fixjson_executable', 'fixjson') call ale#Set('json_fixjson_options', '') +call ale#Set('json_fixjson_use_global', 0) + +function! ale#fixers#fixjson#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'json_fixjson', [ + \ 'node_modules/.bin/fixjson', + \]) +endfunction function! ale#fixers#fixjson#Fix(buffer) abort - let l:executable = ale#Escape(ale#Var(a:buffer, 'json_fixjson_executable')) + let l:executable = ale#Escape(ale#fixers#fixjson#GetExecutable(a:buffer)) let l:filename = ale#Escape(bufname(a:buffer)) let l:command = l:executable . ' --stdin-filename ' . l:filename diff --git a/doc/ale-json.txt b/doc/ale-json.txt index b8e13cd..6377833 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -40,6 +40,14 @@ g:ale_json_fixjson_options *g:ale_json_fixjson_options* This variable can add extra options to the command executed for running fixjson. +g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global* + *b:ale_json_fixjson_use_global* + + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + =============================================================================== jsonlint *ale-json-jsonlint* From 34e6368610c83a0e3a82dda301d798c7f2f9219d Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 25 Jan 2018 14:54:33 +0000 Subject: [PATCH 345/390] #1316 Mention that the quickfix list option shouldn't be used with :cfdo --- doc/ale.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/ale.txt b/doc/ale.txt index e0002f7..9b8cae4 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1307,6 +1307,11 @@ g:ale_set_quickfix *g:ale_set_quickfix* Problems from every buffer ALE has checked will be included in the quickfix list, which can be checked with |:copen|. Problems will be de-duplicated. + This feature should not be used in combination with tools for searching for + matches and commands like |:cfdo|, as ALE will replace the quickfix list + pretty frequently. If you wish to use such tools, you should populate the + loclist instead. + g:ale_set_signs *g:ale_set_signs* From 9dad25778fa3c848d9ce010979323e91d00a3819 Mon Sep 17 00:00:00 2001 From: butlerx Date: Sat, 27 Jan 2018 11:40:40 +0000 Subject: [PATCH 346/390] add po support with proselint, writegood, msgfmt and alex --- README.md | 1 + ale_linters/po/alex.vim | 11 +++++++++++ ale_linters/po/msgfmt.vim | 10 ++++++++++ ale_linters/po/proselint.vim | 9 +++++++++ ale_linters/po/write-good.vim | 9 +++++++++ doc/ale-po.txt | 12 ++++++++++++ doc/ale.txt | 3 +++ 7 files changed, 55 insertions(+) create mode 100644 ale_linters/po/alex.vim create mode 100644 ale_linters/po/msgfmt.vim create mode 100644 ale_linters/po/proselint.vim create mode 100644 ale_linters/po/write-good.vim create mode 100644 doc/ale-po.txt diff --git a/README.md b/README.md index f058df2..112c8e1 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,7 @@ formatting. | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | +| PO | [alex](https://github.com/wooorm/alex) !!, [msgfmt](https://www.gnu.org/software/gettext/manual/html_node/msgfmt-Invocation.html), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pod | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | diff --git a/ale_linters/po/alex.vim b/ale_linters/po/alex.vim new file mode 100644 index 0000000..411d835 --- /dev/null +++ b/ale_linters/po/alex.vim @@ -0,0 +1,11 @@ +" 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, +\}) diff --git a/ale_linters/po/msgfmt.vim b/ale_linters/po/msgfmt.vim new file mode 100644 index 0000000..60c25d3 --- /dev/null +++ b/ale_linters/po/msgfmt.vim @@ -0,0 +1,10 @@ +" Author: Cian Butler https://github.com/butlerx +" Description: msgfmt for PO files + +call ale#linter#Define('po', { +\ 'name': 'msgfmt', +\ 'executable': 'msgfmt', +\ 'output_stream': 'stderr', +\ 'command': 'msgfmt --statistics %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\}) diff --git a/ale_linters/po/proselint.vim b/ale_linters/po/proselint.vim new file mode 100644 index 0000000..ce13250 --- /dev/null +++ b/ale_linters/po/proselint.vim @@ -0,0 +1,9 @@ +" Author: Cian Butler https://github.com/butlerx +" Description: proselint for PO files + +call ale#linter#Define('po', { +\ 'name': 'proselint', +\ 'executable': 'proselint', +\ 'command': 'proselint %t', +\ 'callback': 'ale#handlers#unix#HandleAsWarning', +\}) diff --git a/ale_linters/po/write-good.vim b/ale_linters/po/write-good.vim new file mode 100644 index 0000000..5a01cb6 --- /dev/null +++ b/ale_linters/po/write-good.vim @@ -0,0 +1,9 @@ +" Author: Cian Butler https://github.com/butlerx +" Description: write-good for PO files + +call ale#linter#Define('po', { +\ 'name': 'write-good', +\ 'executable_callback': 'ale#handlers#writegood#GetExecutable', +\ 'command_callback': 'ale#handlers#writegood#GetCommand', +\ 'callback': 'ale#handlers#writegood#Handle', +\}) diff --git a/doc/ale-po.txt b/doc/ale-po.txt new file mode 100644 index 0000000..1e03b7b --- /dev/null +++ b/doc/ale-po.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE PO Integration *ale-po-options* + + +=============================================================================== +write-good *ale-po-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index e0002f7..ce6e6d5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -154,6 +154,8 @@ CONTENTS *ale-contents* phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| + po....................................|ale-po-options| + write-good..........................|ale-po-write-good| pod...................................|ale-pod-options| write-good..........................|ale-pod-write-good| proto.................................|ale-proto-options| @@ -341,6 +343,7 @@ Notes: * OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` +* PO: `alex`!!, `msgfmt`, `proselint`, `write-good` * Pod: `alex`!!, `proselint`, `write-good` * proto: `protoc-gen-lint` * Pug: `pug-lint` From ea60fcea393da1b84dfd62ac1ff10dba6d2dccd2 Mon Sep 17 00:00:00 2001 From: Kent Sibilev Date: Sat, 27 Jan 2018 16:15:29 -0500 Subject: [PATCH 347/390] fixed rust errors parsing use correct column values instead of absolute byte positions --- autoload/ale/handlers/rust.vim | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/autoload/ale/handlers/rust.vim b/autoload/ale/handlers/rust.vim index 395b915..537bc73 100644 --- a/autoload/ale/handlers/rust.vim +++ b/autoload/ale/handlers/rust.vim @@ -51,8 +51,8 @@ function! ale#handlers#rust#HandleRustErrors(buffer, lines) abort call add(l:output, { \ 'lnum': l:span.line_start, \ 'end_lnum': l:span.line_end, - \ 'col': l:span.byte_start, - \ 'end_col': l:span.byte_end, + \ 'col': l:span.column_start, + \ 'end_col': l:span.column_end, \ 'text': empty(l:span.label) ? l:error.message : printf('%s: %s', l:error.message, l:span.label), \ 'type': toupper(l:error.level[0]), \}) From 7ef55a86152c3e17e13702f0d9753d7fc9c4d256 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 28 Jan 2018 11:51:20 +0000 Subject: [PATCH 348/390] #1303 jq isn't a Node program --- autoload/ale/fixers/jq.vim | 5 +---- doc/ale-json.txt | 10 +--------- test/fixers/test_jq_fixer_callback.vader | 14 ++++++++++++++ 3 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 test/fixers/test_jq_fixer_callback.vader diff --git a/autoload/ale/fixers/jq.vim b/autoload/ale/fixers/jq.vim index 4604b24..b0a43fe 100644 --- a/autoload/ale/fixers/jq.vim +++ b/autoload/ale/fixers/jq.vim @@ -1,11 +1,8 @@ call ale#Set('json_jq_executable', 'jq') -call ale#Set('json_jq_use_global', 0) call ale#Set('json_jq_options', '') function! ale#fixers#jq#GetExecutable(buffer) abort - return ale#node#FindExecutable(a:buffer, 'jq', [ - \ 'jq', - \]) + return ale#Var(a:buffer, 'json_jq_executable') endfunction function! ale#fixers#jq#Fix(buffer) abort diff --git a/doc/ale-json.txt b/doc/ale-json.txt index 6377833..1e97abc 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -63,15 +63,7 @@ g:ale_json_jq_executable *g:ale_json_jq_executable* Type: |String| Default: `'jq'` - See |ale-integrations-local-executables| - - -g:ale_json_jq_use_global *g:ale_json_jq_use_global* - *b:ale_json_jq_use_global* - Type: |Number| - Default: `0` - - See |ale-integrations-local-executables| + This option can be changed to change the path for `jq`. g:ale_json_jq_options *g:ale_json_jq_options* diff --git a/test/fixers/test_jq_fixer_callback.vader b/test/fixers/test_jq_fixer_callback.vader new file mode 100644 index 0000000..2e32bf8 --- /dev/null +++ b/test/fixers/test_jq_fixer_callback.vader @@ -0,0 +1,14 @@ +Before: + Save g:ale_json_jq_executable + Save g:ale_json_jq_options + +After: + Restore + +Execute(The jq fixer should use the options you set): + let g:ale_json_jq_executable = 'foo' + let g:ale_json_jq_options = '--bar' + + AssertEqual + \ {'command': ale#Escape('foo') . ' . --bar'}, + \ ale#fixers#jq#Fix(bufnr('')) From 65fc5d11c77527bbf19a94da919fb37b5a02924b Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 28 Jan 2018 12:44:42 +0000 Subject: [PATCH 349/390] Fix #1038 - Automatically detect and use htmlhint configuration files --- ale_linters/html/htmlhint.vim | 21 ++++-- doc/ale-html.txt | 2 +- .../htmlhint_paths/node_modules/.bin/htmlhint | 0 .../htmlhint_paths/with_config/.htmlhintrc | 0 .../test_htmlhint_command_callback.vader | 71 +++++++++++++++++++ 5 files changed, 89 insertions(+), 5 deletions(-) create mode 100755 test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint create mode 100644 test/command_callback/htmlhint_paths/with_config/.htmlhintrc create mode 100644 test/command_callback/test_htmlhint_command_callback.vader diff --git a/ale_linters/html/htmlhint.vim b/ale_linters/html/htmlhint.vim index e142d22..88a83f1 100644 --- a/ale_linters/html/htmlhint.vim +++ b/ale_linters/html/htmlhint.vim @@ -1,7 +1,7 @@ " Author: KabbAmine , deathmaz <00maz1987@gmail.com>, diartyz " Description: HTMLHint for checking html files -call ale#Set('html_htmlhint_options', '--format=unix') +call ale#Set('html_htmlhint_options', '') call ale#Set('html_htmlhint_executable', 'htmlhint') call ale#Set('html_htmlhint_use_global', 0) @@ -12,9 +12,22 @@ function! ale_linters#html#htmlhint#GetExecutable(buffer) abort endfunction function! ale_linters#html#htmlhint#GetCommand(buffer) abort - return ale_linters#html#htmlhint#GetExecutable(a:buffer) - \ . ' ' . ale#Var(a:buffer, 'html_htmlhint_options') - \ . ' %t' + let l:options = ale#Var(a:buffer, 'html_htmlhint_options') + let l:config = l:options !~# '--config' + \ ? ale#path#FindNearestFile(a:buffer, '.htmlhintrc') + \ : '' + + if !empty(l:config) + let l:options .= ' --config ' . ale#Escape(l:config) + endif + + if !empty(l:options) + let l:options = substitute(l:options, '--format=unix', '', '') + endif + + return ale#Escape(ale_linters#html#htmlhint#GetExecutable(a:buffer)) + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' --format=unix %t' endfunction call ale#linter#Define('html', { diff --git a/doc/ale-html.txt b/doc/ale-html.txt index c5d5afa..416e932 100644 --- a/doc/ale-html.txt +++ b/doc/ale-html.txt @@ -16,7 +16,7 @@ g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable* g:ale_html_htmlhint_options *g:ale_html_htmlhint_options* *b:ale_html_htmlhint_options* Type: |String| - Default: `'--format=unix'` + Default: `''` This variable can be changed to modify flags given to HTMLHint. diff --git a/test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint b/test/command_callback/htmlhint_paths/node_modules/.bin/htmlhint new file mode 100755 index 0000000..e69de29 diff --git a/test/command_callback/htmlhint_paths/with_config/.htmlhintrc b/test/command_callback/htmlhint_paths/with_config/.htmlhintrc new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/test_htmlhint_command_callback.vader b/test/command_callback/test_htmlhint_command_callback.vader new file mode 100644 index 0000000..5bb21a6 --- /dev/null +++ b/test/command_callback/test_htmlhint_command_callback.vader @@ -0,0 +1,71 @@ +Before: + Save g:ale_html_htmlhint_options + Save g:ale_html_htmlhint_executable + Save g:ale_html_htmlhint_use_global + + unlet! g:ale_html_htmlhint_options + unlet! g:ale_html_htmlhint_executable + unlet! g:ale_html_htmlhint_use_global + + runtime ale_linters/html/htmlhint.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('htmlhint_paths/test.html') + + let g:node_executable = ale#path#Simplify( + \ g:dir + \ . '/htmlhint_paths/node_modules/.bin/htmlhint' + \) + let g:config_path = ale#path#Simplify( + \ g:dir + \ . '/htmlhint_paths/with_config/.htmlhintrc' + \) + +After: + Restore + + unlet! g:node_executable + unlet! g:config_path + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual + \ ale#Escape(g:node_executable) . ' --format=unix %t', + \ ale_linters#html#htmlhint#GetCommand(bufnr('')) + +Execute(The global executable should be uesd if the option is set): + let g:ale_html_htmlhint_executable = 'foo' + let g:ale_html_htmlhint_use_global = 1 + + AssertEqual + \ ale#Escape('foo') . ' --format=unix %t', + \ ale_linters#html#htmlhint#GetCommand(bufnr('')) + +" This is so old configurations which might include this still work. +Execute(--format=unix should be removed from the options if added): + let g:ale_html_htmlhint_options = '--format=unix' + + AssertEqual + \ ale#Escape(g:node_executable) . ' --format=unix %t', + \ ale_linters#html#htmlhint#GetCommand(bufnr('')) + +Execute(The configuration file should be automatically detected): + call ale#test#SetFilename('htmlhint_paths/with_config/test.html') + + AssertEqual + \ ale#Escape(g:node_executable) + \ . ' --config ' . ale#Escape(g:config_path) + \ . ' --format=unix %t', + \ ale_linters#html#htmlhint#GetCommand(bufnr('')) + +" This is so old configurations which might include the config will work. +Execute(The configuration file should be configurable through the options variable): + call ale#test#SetFilename('htmlhint_paths/with_config/test.html') + let g:ale_html_htmlhint_options = '--config=/foo/bar/.htmlhintrc' + + AssertEqual + \ ale#Escape(g:node_executable) + \ . ' --config=/foo/bar/.htmlhintrc' + \ . ' --format=unix %t', + \ ale_linters#html#htmlhint#GetCommand(bufnr('')) From 863fb60695764a41a6fd8139544938f343f61278 Mon Sep 17 00:00:00 2001 From: Kent Sibilev Date: Sun, 28 Jan 2018 18:35:46 -0500 Subject: [PATCH 350/390] updated rust handler test case --- test/handler/test_rust_handler.vader | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/test/handler/test_rust_handler.vader b/test/handler/test_rust_handler.vader index 05bd1e9..e3ab3e8 100644 --- a/test/handler/test_rust_handler.vader +++ b/test/handler/test_rust_handler.vader @@ -7,16 +7,16 @@ Execute(The Rust handler should handle rustc output): \ 'lnum': 15, \ 'end_lnum': 15, \ 'type': 'E', - \ 'col': 418, - \ 'end_col': 421, + \ 'col': 5, + \ 'end_col': 8, \ 'text': 'expected one of `.`, `;`, `?`, `}`, or an operator, found `for`', \ }, \ { \ 'lnum': 13, \ 'end_lnum': 13, \ 'type': 'E', - \ 'col': 407, - \ 'end_col': 410, + \ 'col': 7, + \ 'end_col': 10, \ 'text': 'no method named `wat` found for type `std::string::String` in the current scope', \ }, \ ], @@ -83,16 +83,16 @@ Execute(The Rust handler should handle cargo output): \ 'lnum': 15, \ 'end_lnum': 15, \ 'type': 'E', - \ 'col': 11505, - \ 'end_col': 11508, + \ 'col': 5, + \ 'end_col': 8, \ 'text': 'expected one of `.`, `;`, `?`, `}`, or an operator, found `for`', \ }, \ { \ 'lnum': 13, \ 'end_lnum': 13, \ 'type': 'E', - \ 'col': 11494, - \ 'end_col': 11497, + \ 'col': 7, + \ 'end_col': 10, \ 'text': 'no method named `wat` found for type `std::string::String` in the current scope', \ }, \ ], @@ -157,8 +157,8 @@ Execute(The Rust handler should should errors from expansion spans): \ 'lnum': 4, \ 'end_lnum': 4, \ 'type': 'E', - \ 'col': 52, - \ 'end_col': 54, + \ 'col': 21, + \ 'end_col': 23, \ 'text': 'mismatched types: expected bool, found integral variable', \ }, \ ], @@ -207,8 +207,8 @@ Execute(The Rust handler should show detailed errors): \ 'lnum': 4, \ 'end_lnum': 4, \ 'type': 'E', - \ 'col': 52, - \ 'end_col': 54, + \ 'col': 21, + \ 'end_col': 23, \ 'text': 'mismatched types: expected bool, found integral variable', \ }, \ ], From 4df87eaaddfceaddd625294c0e601aebf2f68a85 Mon Sep 17 00:00:00 2001 From: Jose Lorenzo Rodriguez Date: Mon, 29 Jan 2018 22:21:50 +0100 Subject: [PATCH 351/390] Added tests for hadolint --- README.md | 2 +- ale_linters/dockerfile/hadolint.vim | 2 +- doc/ale-dockerfile.txt | 6 +++--- test/test_dockerfile_hadolint_linter.vader | 23 +++++++++++++++++++++- 4 files changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c42f4bf..bd7a705 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ formatting. | D | [dmd](https://dlang.org/dmd-linux.html) | | Dafny | [dafny](https://rise4fun.com/Dafny) !! | | Dart | [dartanalyzer](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli) !!, [language_server](https://github.com/natebosch/dart_language_server) | -| Dockerfile | [hadolint](https://github.com/lukasmartinelli/hadolint) | +| Dockerfile | [hadolint](https://github.com/hadolint/hadolint) | | Elixir | [credo](https://github.com/rrrene/credo), [dialyxir](https://github.com/jeremyjh/dialyxir), [dogma](https://github.com/lpil/dogma) !!| | Elm | [elm-format](https://github.com/avh4/elm-format), [elm-make](https://github.com/elm-lang/elm-make) | | Erb | [erb](https://github.com/jeremyevans/erubi), [erubis](https://github.com/kwatch/erubis) | diff --git a/ale_linters/dockerfile/hadolint.vim b/ale_linters/dockerfile/hadolint.vim index 6e1c737..7772afb 100644 --- a/ale_linters/dockerfile/hadolint.vim +++ b/ale_linters/dockerfile/hadolint.vim @@ -2,7 +2,7 @@ " always, yes, never call ale#Set('dockerfile_hadolint_use_docker', 'never') -call ale#Set('dockerfile_hadolint_docker_image', 'lukasmartinelli/hadolint') +call ale#Set('dockerfile_hadolint_docker_image', 'hadolint/hadolint') function! ale_linters#dockerfile#hadolint#Handle(buffer, lines) abort " Matches patterns line the following: diff --git a/doc/ale-dockerfile.txt b/doc/ale-dockerfile.txt index 288addb..805cc47 100644 --- a/doc/ale-dockerfile.txt +++ b/doc/ale-dockerfile.txt @@ -5,7 +5,7 @@ ALE Dockerfile Integration *ale-dockerfile-options* =============================================================================== hadolint *ale-dockerfile-hadolint* - hadolint can be found at: https://github.com/lukasmartinelli/hadolint + hadolint can be found at: https://github.com/hadolint/hadolint g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker* @@ -25,12 +25,12 @@ g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker* g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image* *b:ale_dockerfile_hadolint_image* Type: |String| - Default: `'lukasmartinelli/hadolint'` + Default: `'hadolint/hadolint'` This variable controls the docker image used to run hadolint. The default is hadolint's author's build, and can be found at: - https://hub.docker.com/r/lukasmartinelli/hadolint/ + https://hub.docker.com/r/hadolint/hadolint/ =============================================================================== diff --git a/test/test_dockerfile_hadolint_linter.vader b/test/test_dockerfile_hadolint_linter.vader index 7262c5b..3edbb2b 100644 --- a/test/test_dockerfile_hadolint_linter.vader +++ b/test/test_dockerfile_hadolint_linter.vader @@ -55,7 +55,7 @@ Execute(command is correct when using docker): let b:ale_dockerfile_hadolint_use_docker = 'always' AssertEqual - \ "docker run --rm -i lukasmartinelli/hadolint", + \ "docker run --rm -i hadolint/hadolint", \ ale_linters#dockerfile#hadolint#GetCommand(bufnr('')) @@ -66,4 +66,25 @@ Execute(command is correct when not docker): \ "hadolint -", \ ale_linters#dockerfile#hadolint#GetCommand(bufnr('')) +Execute(test warnings from hadolint): + AssertEqual + \ [{'lnum': 10, 'col': 0, 'type': 'W', 'text': 'Using latest is prone to errors', 'detail': "DL3007 ( https://github.com/hadolint/hadolint/wiki/DL3007 )\n\nUsing latest is prone to errors"}], + \ ale_linters#dockerfile#hadolint#Handle(bufnr(''), [ + \ '/dev/stdin:10 DL3007 Using latest is prone to errors', + \ ]) + +Execute(test warnings from shellcheck): + AssertEqual + \ [{'lnum': 3, 'col': 0, 'type': 'W', 'text': 'bar is referenced but not assigned.', 'detail': "SC2154 ( https://github.com/koalaman/shellcheck/wiki/SC2154 )\n\nbar is referenced but not assigned."}], + \ ale_linters#dockerfile#hadolint#Handle(bufnr(''), [ + \ '/dev/stdin:3 SC2154 bar is referenced but not assigned.', + \ ]) + +Execute(test errors from dockerfile parser): + AssertEqual + \ [{'lnum': 3, 'col': 4, 'type': 'E', 'text': 'unexpected "A" expecting at least one space after ''RUN''', 'detail': 'unexpected "A" expecting at least one space after ''RUN'''}], + \ ale_linters#dockerfile#hadolint#Handle(bufnr(''), [ + \ "/dev/stdin:3:4 unexpected \"A\" expecting at least one space after 'RUN'", + \ ]) + " fin... From bb095df25e7fb6e3090061572bf9b1c472ac550f Mon Sep 17 00:00:00 2001 From: Michael Quinn Date: Mon, 29 Jan 2018 20:18:14 -0800 Subject: [PATCH 352/390] Call lintr library before linting This solves namespace issues related to the objects used to set linting options. --- ale_linters/r/lintr.vim | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/ale_linters/r/lintr.vim b/ale_linters/r/lintr.vim index 86b591c..9db63c7 100644 --- a/ale_linters/r/lintr.vim +++ b/ale_linters/r/lintr.vim @@ -1,14 +1,17 @@ " Author: Michel Lang , w0rp " Description: This file adds support for checking R code with lintr. -let g:ale_r_lintr_options = -\ get(g:, 'ale_r_lintr_options', 'lintr::with_defaults()') +let g:ale_r_lintr_options = get(g:, 'ale_r_lintr_options', 'with_defaults()') " A reasonable alternative default: -" \ get(g:, 'ale_r_lintr_options', 'lintr::with_defaults(object_usage_linter = NULL)') +" get(g:, 'ale_r_lintr_options', 'with_defaults(object_usage_linter = NULL)') function! ale_linters#r#lintr#GetCommand(buffer) abort + let l:cmd_string = 'suppressPackageStartupMessages(library(lintr));' + \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . ale#Var(a:buffer, 'r_lintr_options') . ')' return ale#path#BufferCdString(a:buffer) - \ . 'Rscript -e ' . ale#Escape('lintr::lint(commandArgs(TRUE)[1], eval(parse(text = commandArgs(TRUE)[2])))') . ' %t' . ' ' . ale#Escape(ale#Var(a:buffer, 'r_lintr_options')) + \ . 'Rscript -e ' + \ . ale#Escape(l:cmd_string) . ' %t' endfunction call ale#linter#Define('r', { @@ -18,3 +21,4 @@ call ale#linter#Define('r', { \ 'callback': 'ale#handlers#gcc#HandleGCCFormat', \ 'output_stream': 'both', \}) + From 23db293bdfda820dcff2464d2c4e533f52eb86be Mon Sep 17 00:00:00 2001 From: blyoa Date: Thu, 1 Feb 2018 01:29:01 +0900 Subject: [PATCH 353/390] Add prettier fixer support to vue --- README.md | 1 + autoload/ale/fix/registry.vim | 2 +- doc/ale-vue.txt | 11 +++++++++++ doc/ale.txt | 3 +++ 4 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 doc/ale-vue.txt diff --git a/README.md b/README.md index eed06cf..b09a643 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,7 @@ formatting. | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) | | Vim | [vint](https://github.com/Kuniwak/vint) | | Vim help^ | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Vue | [prettier](https://github.com/prettier/prettier) | | XHTML | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | XML | [xmllint](http://xmlsoft.org/xmllint.html) | | YAML | [swaglint](https://github.com/byCedric/swaglint), [yamllint](https://yamllint.readthedocs.io/) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index e456884..29e263a 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -45,7 +45,7 @@ let s:default_registry = { \ }, \ 'prettier': { \ 'function': 'ale#fixers#prettier#Fix', -\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less', 'markdown', 'graphql'], +\ 'suggested_filetypes': ['javascript', 'typescript', 'json', 'css', 'scss', 'less', 'markdown', 'graphql', 'vue'], \ 'description': 'Apply prettier to a file.', \ }, \ 'prettier_eslint': { diff --git a/doc/ale-vue.txt b/doc/ale-vue.txt new file mode 100644 index 0000000..937b603 --- /dev/null +++ b/doc/ale-vue.txt @@ -0,0 +1,11 @@ +=============================================================================== +ALE Vue Integration *ale-vue-options* + + +=============================================================================== +prettier *ale-vue-prettier* + +See |ale-javascript-prettier| for information about the available options. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 417db58..2644ebc 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -239,6 +239,8 @@ CONTENTS *ale-contents* vint................................|ale-vim-vint| vim help..............................|ale-vim-help-options| write-good..........................|ale-vim-help-write-good| + vue...................................|ale-vue-options| + prettier............................|ale-vue-prettier| xhtml.................................|ale-xhtml-options| write-good..........................|ale-xhtml-write-good| xml...................................|ale-xml-options| @@ -375,6 +377,7 @@ Notes: * Verilog: `iverilog`, `verilator` * Vim: `vint` * Vim help^: `alex`!!, `proselint`, `write-good` +* Vue: `prettier` * XHTML: `alex`!!, `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` From b13f290390ba62180f731fef6cea58d6fef8bc3e Mon Sep 17 00:00:00 2001 From: Michael Quinn Date: Wed, 31 Jan 2018 18:06:35 -0800 Subject: [PATCH 354/390] Update formatting and tests. --- ale_linters/r/lintr.vim | 6 +++--- .../test_lintr_command_callback.vader | 16 +++++++++------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/ale_linters/r/lintr.vim b/ale_linters/r/lintr.vim index 9db63c7..e163905 100644 --- a/ale_linters/r/lintr.vim +++ b/ale_linters/r/lintr.vim @@ -7,8 +7,9 @@ let g:ale_r_lintr_options = get(g:, 'ale_r_lintr_options', 'with_defaults()') function! ale_linters#r#lintr#GetCommand(buffer) abort let l:cmd_string = 'suppressPackageStartupMessages(library(lintr));' - \ . 'lint(cache = FALSE, commandArgs(TRUE),' - \ . ale#Var(a:buffer, 'r_lintr_options') . ')' + \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . ale#Var(a:buffer, 'r_lintr_options') . ')' + return ale#path#BufferCdString(a:buffer) \ . 'Rscript -e ' \ . ale#Escape(l:cmd_string) . ' %t' @@ -21,4 +22,3 @@ call ale#linter#Define('r', { \ 'callback': 'ale#handlers#gcc#HandleGCCFormat', \ 'output_stream': 'both', \}) - diff --git a/test/command_callback/test_lintr_command_callback.vader b/test/command_callback/test_lintr_command_callback.vader index 3199b49..256618c 100644 --- a/test/command_callback/test_lintr_command_callback.vader +++ b/test/command_callback/test_lintr_command_callback.vader @@ -17,18 +17,20 @@ Execute(The default lintr command should be correct): AssertEqual \ 'cd ' . ale#Escape(getcwd()) . ' && ' \ . 'Rscript -e ' - \ . ale#Escape('lintr::lint(commandArgs(TRUE)[1], eval(parse(text = commandArgs(TRUE)[2])))') - \ . ' %t ' - \ . ale#Escape('lintr::with_defaults()'), + \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' + \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . 'with_defaults())') + \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) Execute(The lintr options should be configurable): - let b:ale_r_lintr_options = 'lintr::with_defaults(object_usage_linter = NULL)' + let b:ale_r_lintr_options = 'with_defaults(object_usage_linter = NULL)' AssertEqual \ 'cd ' . ale#Escape(getcwd()) . ' && ' \ . 'Rscript -e ' - \ . ale#Escape('lintr::lint(commandArgs(TRUE)[1], eval(parse(text = commandArgs(TRUE)[2])))') - \ . ' %t ' - \ . ale#Escape('lintr::with_defaults(object_usage_linter = NULL)'), + \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' + \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . 'with_defaults(object_usage_linter = NULL))') + \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) From 0f822b063cb9553c9e00bc63d0184ba8577e6248 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 4 Feb 2018 13:16:44 +0000 Subject: [PATCH 355/390] Fix #1330 - Find isort configs better by changing the working directory --- autoload/ale/fixers/isort.vim | 8 ++------ test/fixers/test_isort_fixer_callback.vader | 5 ++++- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/autoload/ale/fixers/isort.vim b/autoload/ale/fixers/isort.vim index 00d968f..b631822 100644 --- a/autoload/ale/fixers/isort.vim +++ b/autoload/ale/fixers/isort.vim @@ -15,12 +15,8 @@ function! ale#fixers#isort#Fix(buffer) abort return 0 endif - let l:config = ale#path#FindNearestFile(a:buffer, '.isort.cfg') - let l:config_options = !empty(l:config) - \ ? ' --settings-path ' . ale#Escape(l:config) - \ : '' - return { - \ 'command': ale#Escape(l:executable) . l:config_options . ' -', + \ 'command': ale#path#BufferCdString(a:buffer) + \ . ale#Escape(l:executable) . ' -', \} endfunction diff --git a/test/fixers/test_isort_fixer_callback.vader b/test/fixers/test_isort_fixer_callback.vader index 503057b..7c2b515 100644 --- a/test/fixers/test_isort_fixer_callback.vader +++ b/test/fixers/test_isort_fixer_callback.vader @@ -25,5 +25,8 @@ Execute(The isort callback should return the correct default values): silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py') AssertEqual - \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/isort')) . ' -' }, + \ { + \ 'command': 'cd ' . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/subdir/foo')) . ' && ' + \ . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/isort')) . ' -', + \ }, \ ale#fixers#isort#Fix(bufnr('')) From 33b3331b0499e502f01730af60fb0e9b5a30951f Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 4 Feb 2018 13:55:09 +0000 Subject: [PATCH 356/390] #1206 Add support for setting options for gobuild, and escape paths better --- ale_linters/go/gobuild.vim | 21 ++++++-- doc/ale-go.txt | 12 +++++ doc/ale.txt | 1 + .../test_gobuild_command_callback.vader | 52 +++++++++++++++++++ 4 files changed, 82 insertions(+), 4 deletions(-) create mode 100644 test/command_callback/test_gobuild_command_callback.vader diff --git a/ale_linters/go/gobuild.vim b/ale_linters/go/gobuild.vim index 783b9e0..068877a 100644 --- a/ale_linters/go/gobuild.vim +++ b/ale_linters/go/gobuild.vim @@ -1,9 +1,14 @@ " Author: Joshua Rubin , Ben Reedy , " Jeff Willette " Description: go build for Go files - " inspired by work from dzhou121 +call ale#Set('go_gobuild_options', '') + +function! ale_linters#go#gobuild#ResetEnv() abort + unlet! s:go_env +endfunction + function! ale_linters#go#gobuild#GoEnv(buffer) abort if exists('s:go_env') return '' @@ -13,6 +18,8 @@ function! ale_linters#go#gobuild#GoEnv(buffer) abort endfunction function! ale_linters#go#gobuild#GetCommand(buffer, goenv_output) abort + let l:options = ale#Var(a:buffer, 'go_gobuild_options') + if !exists('s:go_env') let s:go_env = { \ 'GOPATH': a:goenv_output[0], @@ -20,10 +27,16 @@ function! ale_linters#go#gobuild#GetCommand(buffer, goenv_output) abort \} endif + let l:gopath_env_command = has('win32') + \ ? 'set GOPATH=' . ale#Escape(s:go_env.GOPATH) . ' && ' + \ : 'GOPATH=' . ale#Escape(s:go_env.GOPATH) . ' ' + " Run go test in local directory with relative path - return 'GOPATH=' . s:go_env.GOPATH - \ . ' cd ' . fnamemodify(bufname(a:buffer), ':.:h') - \ . ' && go test -c -o /dev/null ./' + return l:gopath_env_command + \ . ale#path#BufferCdString(a:buffer) + \ . 'go test' + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' -c -o /dev/null ./' endfunction function! ale_linters#go#gobuild#GetMatches(lines) abort diff --git a/doc/ale-go.txt b/doc/ale-go.txt index c5a6887..502f237 100644 --- a/doc/ale-go.txt +++ b/doc/ale-go.txt @@ -20,6 +20,18 @@ the benefit of running a number of linters, more than ALE would by default, while ensuring it doesn't run any linters known to be slow or resource intensive. +=============================================================================== +gobuild *ale-go-gobuild* + +g:ale_go_gobuild_options *g:ale_go_gobuild_options* + *b:ale_go_gobuild_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the gobuild linter. + They are injected directly after "go test". + + =============================================================================== gofmt *ale-go-gofmt* diff --git a/doc/ale.txt b/doc/ale.txt index 2644ebc..6ace9d5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -77,6 +77,7 @@ CONTENTS *ale-contents* glslang.............................|ale-glsl-glslang| glslls..............................|ale-glsl-glslls| go....................................|ale-go-options| + gobuild.............................|ale-go-gobuild| gofmt...............................|ale-go-gofmt| gometalinter........................|ale-go-gometalinter| graphql...............................|ale-graphql-options| diff --git a/test/command_callback/test_gobuild_command_callback.vader b/test/command_callback/test_gobuild_command_callback.vader new file mode 100644 index 0000000..240f29c --- /dev/null +++ b/test/command_callback/test_gobuild_command_callback.vader @@ -0,0 +1,52 @@ +Before: + Save g:ale_go_gobuild_options + + unlet! g:ale_go_gobuild_options + + let g:env_prefix = has('win32') + \ ? 'set GOPATH=' . ale#Escape('/foo/bar') . ' && ' + \ : 'GOPATH=' . ale#Escape('/foo/bar') . ' ' + + runtime ale_linters/go/gobuild.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + + call ale_linters#go#gobuild#ResetEnv() + +After: + Restore + + unlet! g:env_prefix + + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(The default gobuild command should be correct): + AssertEqual + \ ale_linters#go#gobuild#GetCommand(bufnr(''), ['/foo/bar', '/foo/baz']), + \ g:env_prefix . 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'go test -c -o /dev/null ./' + +Execute(The command for getting GOPATH should be correct): + AssertEqual ale_linters#go#gobuild#GoEnv(bufnr('')), 'go env GOPATH GOROOT' + + call ale_linters#go#gobuild#GetCommand(bufnr(''), ['/foo/bar', '/foo/baz']) + + " We shouldn't run `go env` many times after we've got it. + AssertEqual ale_linters#go#gobuild#GoEnv(bufnr('')), '' + +Execute(The GOPATH output should be used after it has been read once): + call ale_linters#go#gobuild#GetCommand(bufnr(''), ['/foo/bar', '/foo/baz']) + + AssertEqual + \ ale_linters#go#gobuild#GetCommand(bufnr(''), []), + \ g:env_prefix . 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'go test -c -o /dev/null ./' + +Execute(Extra options should be supported): + let g:ale_go_gobuild_options = '--foo-bar' + + AssertEqual + \ ale_linters#go#gobuild#GetCommand(bufnr(''), ['/foo/bar', '/foo/baz']), + \ g:env_prefix . 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'go test --foo-bar -c -o /dev/null ./' From dda132c1a2818390cafd674e5db0e3b6ce802965 Mon Sep 17 00:00:00 2001 From: Fenner Macrae <13209544+fennerm@users.noreply.github.com> Date: Sun, 4 Feb 2018 10:57:52 -0800 Subject: [PATCH 357/390] Add lint_package support to lintr --- ale_linters/r/lintr.vim | 14 ++++++++++++-- doc/ale-r.txt | 9 +++++++++ .../test_lintr_command_callback.vader | 12 ++++++++++++ 3 files changed, 33 insertions(+), 2 deletions(-) diff --git a/ale_linters/r/lintr.vim b/ale_linters/r/lintr.vim index e163905..006bf47 100644 --- a/ale_linters/r/lintr.vim +++ b/ale_linters/r/lintr.vim @@ -1,13 +1,23 @@ -" Author: Michel Lang , w0rp +" Author: Michel Lang , w0rp , +" Fenner Macrae " Description: This file adds support for checking R code with lintr. let g:ale_r_lintr_options = get(g:, 'ale_r_lintr_options', 'with_defaults()') " A reasonable alternative default: " get(g:, 'ale_r_lintr_options', 'with_defaults(object_usage_linter = NULL)') + +let g:ale_r_lintr_lint_package = get(g:, 'ale_r_lintr_lint_package', 0) + function! ale_linters#r#lintr#GetCommand(buffer) abort + if ale#Var(a:buffer, 'r_lintr_lint_package') + let l:lint_cmd = 'lint_package' + else + let l:lint_cmd = 'lint' + endif + let l:cmd_string = 'suppressPackageStartupMessages(library(lintr));' - \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . l:lint_cmd . '(cache = FALSE, commandArgs(TRUE),' \ . ale#Var(a:buffer, 'r_lintr_options') . ')' return ale#path#BufferCdString(a:buffer) diff --git a/doc/ale-r.txt b/doc/ale-r.txt index 6372f80..f85f48f 100644 --- a/doc/ale-r.txt +++ b/doc/ale-r.txt @@ -16,5 +16,14 @@ g:ale_r_lintr_options *g:ale_r_lintr_options* options. Consult the lintr documentation for more information. +g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package* + *b:ale_r_lintr_lint_package* + Type: |Number| + Default: `0` + + When set to `1`, the file will be checked with `lintr::lint_package` instead + of `lintr::lint`. This prevents erroneous namespace warnings when linting + package files. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/test/command_callback/test_lintr_command_callback.vader b/test/command_callback/test_lintr_command_callback.vader index 256618c..33259e0 100644 --- a/test/command_callback/test_lintr_command_callback.vader +++ b/test/command_callback/test_lintr_command_callback.vader @@ -34,3 +34,15 @@ Execute(The lintr options should be configurable): \ . 'with_defaults(object_usage_linter = NULL))') \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) + +Execute(If the lint_package flag is set, lintr::lint_package should be called): + let b:ale_r_lintr_lint_package = 1 + + AssertEqual + \ 'cd ' . ale#Escape(getcwd()) . ' && ' + \ . 'Rscript -e ' + \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' + \ . 'lint_package(cache = FALSE, commandArgs(TRUE),' + \ . 'with_defaults())') + \ . ' %t', + \ ale_linters#r#lintr#GetCommand(bufnr('')) From 5dc884b24dff08e48287134f903b8ff5e93b33cb Mon Sep 17 00:00:00 2001 From: Fenner Macrae <13209544+fennerm@users.noreply.github.com> Date: Mon, 5 Feb 2018 09:54:15 -0800 Subject: [PATCH 358/390] Fixed lintr::lint_package command --- ale_linters/r/lintr.vim | 9 +++++---- test/command_callback/test_lintr_command_callback.vader | 8 ++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/ale_linters/r/lintr.vim b/ale_linters/r/lintr.vim index 006bf47..ac1d856 100644 --- a/ale_linters/r/lintr.vim +++ b/ale_linters/r/lintr.vim @@ -11,14 +11,15 @@ let g:ale_r_lintr_lint_package = get(g:, 'ale_r_lintr_lint_package', 0) function! ale_linters#r#lintr#GetCommand(buffer) abort if ale#Var(a:buffer, 'r_lintr_lint_package') - let l:lint_cmd = 'lint_package' + let l:lint_cmd = 'lint_package(cache = FALSE, linters = ' + \ . ale#Var(a:buffer, 'r_lintr_options') . ')' else - let l:lint_cmd = 'lint' + let l:lint_cmd = 'lint(cache = FALSE, commandArgs(TRUE), ' + \ . ale#Var(a:buffer, 'r_lintr_options') . ')' endif let l:cmd_string = 'suppressPackageStartupMessages(library(lintr));' - \ . l:lint_cmd . '(cache = FALSE, commandArgs(TRUE),' - \ . ale#Var(a:buffer, 'r_lintr_options') . ')' + \ . l:lint_cmd return ale#path#BufferCdString(a:buffer) \ . 'Rscript -e ' diff --git a/test/command_callback/test_lintr_command_callback.vader b/test/command_callback/test_lintr_command_callback.vader index 33259e0..e655328 100644 --- a/test/command_callback/test_lintr_command_callback.vader +++ b/test/command_callback/test_lintr_command_callback.vader @@ -18,7 +18,7 @@ Execute(The default lintr command should be correct): \ 'cd ' . ale#Escape(getcwd()) . ' && ' \ . 'Rscript -e ' \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' - \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . 'lint(cache = FALSE, commandArgs(TRUE), ' \ . 'with_defaults())') \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) @@ -30,7 +30,7 @@ Execute(The lintr options should be configurable): \ 'cd ' . ale#Escape(getcwd()) . ' && ' \ . 'Rscript -e ' \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' - \ . 'lint(cache = FALSE, commandArgs(TRUE),' + \ . 'lint(cache = FALSE, commandArgs(TRUE), ' \ . 'with_defaults(object_usage_linter = NULL))') \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) @@ -42,7 +42,7 @@ Execute(If the lint_package flag is set, lintr::lint_package should be called): \ 'cd ' . ale#Escape(getcwd()) . ' && ' \ . 'Rscript -e ' \ . ale#Escape('suppressPackageStartupMessages(library(lintr));' - \ . 'lint_package(cache = FALSE, commandArgs(TRUE),' - \ . 'with_defaults())') + \ . 'lint_package(cache = FALSE, ' + \ . 'linters = with_defaults())') \ . ' %t', \ ale_linters#r#lintr#GetCommand(bufnr('')) From c2ab8853849d1fc64d448d6e65920c988ca9c0fa Mon Sep 17 00:00:00 2001 From: Fenner Macrae <13209544+fennerm@users.noreply.github.com> Date: Mon, 5 Feb 2018 11:33:23 -0800 Subject: [PATCH 359/390] Removed trailing whitespaces --- ale_linters/r/lintr.vim | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ale_linters/r/lintr.vim b/ale_linters/r/lintr.vim index ac1d856..51e5c56 100644 --- a/ale_linters/r/lintr.vim +++ b/ale_linters/r/lintr.vim @@ -11,7 +11,7 @@ let g:ale_r_lintr_lint_package = get(g:, 'ale_r_lintr_lint_package', 0) function! ale_linters#r#lintr#GetCommand(buffer) abort if ale#Var(a:buffer, 'r_lintr_lint_package') - let l:lint_cmd = 'lint_package(cache = FALSE, linters = ' + let l:lint_cmd = 'lint_package(cache = FALSE, linters = ' \ . ale#Var(a:buffer, 'r_lintr_options') . ')' else let l:lint_cmd = 'lint(cache = FALSE, commandArgs(TRUE), ' @@ -19,7 +19,7 @@ function! ale_linters#r#lintr#GetCommand(buffer) abort endif let l:cmd_string = 'suppressPackageStartupMessages(library(lintr));' - \ . l:lint_cmd + \ . l:lint_cmd return ale#path#BufferCdString(a:buffer) \ . 'Rscript -e ' From 716b46e10d2abe54daa09e876d4b7a6b56024ad0 Mon Sep 17 00:00:00 2001 From: Kevin Tindall Date: Sat, 10 Feb 2018 13:04:43 -0600 Subject: [PATCH 360/390] functional pony linter --- README.md | 1 + ale_linters/pony/ponyc.vim | 21 ++++++++++++ autoload/ale/handlers/pony.vim | 34 +++++++++++++++++++ doc/ale-pony.txt | 25 ++++++++++++++ doc/ale.txt | 3 ++ .../test_pony_ponyc_command_callbacks.vader | 23 +++++++++++++ test/handler/test_pony_handler.vader | 21 ++++++++++++ 7 files changed, 128 insertions(+) create mode 100644 ale_linters/pony/ponyc.vim create mode 100644 autoload/ale/handlers/pony.vim create mode 100644 doc/ale-pony.txt create mode 100644 test/command_callback/test_pony_ponyc_command_callbacks.vader create mode 100644 test/handler/test_pony_handler.vader diff --git a/README.md b/README.md index b09a643..0a0e0d9 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,7 @@ formatting. | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | | PO | [alex](https://github.com/wooorm/alex) !!, [msgfmt](https://www.gnu.org/software/gettext/manual/html_node/msgfmt-Invocation.html), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pod | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | +| Pony | [ponyc](https://github.com/ponylang/ponyc) | | proto | [protoc-gen-lint](https://github.com/ckaznocha/protoc-gen-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | diff --git a/ale_linters/pony/ponyc.vim b/ale_linters/pony/ponyc.vim new file mode 100644 index 0000000..4120df5 --- /dev/null +++ b/ale_linters/pony/ponyc.vim @@ -0,0 +1,21 @@ +" Description: ponyc linter for pony files + +call ale#Set('pony_ponyc_executable', 'ponyc') +call ale#Set('pony_ponyc_options', '--pass paint') + +function! ale_linters#pony#ponyc#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'pony_ponyc_executable') +endfunction + +function! ale_linters#pony#ponyc#GetCommand(buffer) abort + return ale_linters#pony#ponyc#GetExecutable(a:buffer) + \ . ' ' . ale#Var(a:buffer, 'pony_ponyc_options') +endfunction + +call ale#linter#Define('pony', { +\ 'name': 'ponyc', +\ 'output_stream': 'stderr', +\ 'executable_callback': 'ale_linters#pony#ponyc#GetExecutable', +\ 'command_callback': 'ale_linters#pony#ponyc#GetCommand', +\ 'callback': 'ale#handlers#pony#HandlePonycFormat', +\}) diff --git a/autoload/ale/handlers/pony.vim b/autoload/ale/handlers/pony.vim new file mode 100644 index 0000000..0ac18e7 --- /dev/null +++ b/autoload/ale/handlers/pony.vim @@ -0,0 +1,34 @@ +scriptencoding utf-8 +" Description: This file defines a handler function which ought to work for +" any program which outputs errors in the format that ponyc uses. + +function! s:RemoveUnicodeQuotes(text) abort + let l:text = a:text + let l:text = substitute(l:text, '[`´‘’]', '''', 'g') + let l:text = substitute(l:text, '\v\\u2018([^\\]+)\\u2019', '''\1''', 'g') + let l:text = substitute(l:text, '[“”]', '"', 'g') + + return l:text +endfunction + +function! ale#handlers#pony#HandlePonycFormat(buffer, lines) abort + " Look for lines like the following. + " /home/code/pony/classes/Wombat.pony:22:30: can't lookup private fields from outside the type + + let l:pattern = '\v^([^:]+):(\d+):(\d+)?:? (.+)$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + let l:item = { + \ 'filename': l:match[1], + \ 'lnum': str2nr(l:match[2]), + \ 'col': str2nr(l:match[3]), + \ 'type': 'E', + \ 'text': s:RemoveUnicodeQuotes(l:match[4]), + \} + + call add(l:output, l:item) + endfor + + return l:output +endfunction diff --git a/doc/ale-pony.txt b/doc/ale-pony.txt new file mode 100644 index 0000000..3b32168 --- /dev/null +++ b/doc/ale-pony.txt @@ -0,0 +1,25 @@ +=============================================================================== +ALE Pony Integration *ale-pony-options* + + +=============================================================================== +ponyc *ale-pony-ponyc* + +g:ale_pony_ponyc_executable *g:ale_pony_ponyc_executable* + *b:ale_pony_ponyc_executable* + Type: |String| + Default: `'ponyc'` + + See |ale-integrations-local-executables| + + +g:ale_pony_ponyc_options *g:ale_pony_ponyc_options* + *b:ale_pony_ponyc_options* + Type: |String| + Default: `'--pass paint'` + + This variable can be set to pass options to ponyc. + + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 6ace9d5..296d640 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -160,6 +160,8 @@ CONTENTS *ale-contents* write-good..........................|ale-po-write-good| pod...................................|ale-pod-options| write-good..........................|ale-pod-write-good| + pony..................................|ale-pony-options| + ponyc...............................|ale-pony-ponyc| proto.................................|ale-proto-options| protoc-gen-lint.....................|ale-proto-protoc-gen-lint| pug...................................|ale-pug-options| @@ -349,6 +351,7 @@ Notes: * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` * PO: `alex`!!, `msgfmt`, `proselint`, `write-good` * Pod: `alex`!!, `proselint`, `write-good` +* Pony: `ponyc` * proto: `protoc-gen-lint` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` diff --git a/test/command_callback/test_pony_ponyc_command_callbacks.vader b/test/command_callback/test_pony_ponyc_command_callbacks.vader new file mode 100644 index 0000000..e48346e --- /dev/null +++ b/test/command_callback/test_pony_ponyc_command_callbacks.vader @@ -0,0 +1,23 @@ +Before: + Save g:ale_pony_ponyc_options + + unlet! g:ale_pony_ponyc_options + unlet! b:ale_pony_ponyc_options + + runtime ale_linters/pony/ponyc.vim + +After: + Restore + unlet! b:ale_pony_ponyc_options + call ale#linter#Reset() + +Execute(The options should be used in the command): + AssertEqual + \ 'ponyc --pass paint', + \ ale_linters#pony#ponyc#GetCommand(bufnr('')) + + let b:ale_pony_ponyc_options = 'foobar' + + AssertEqual + \ 'ponyc foobar', + \ ale_linters#pony#ponyc#GetCommand(bufnr('')) diff --git a/test/handler/test_pony_handler.vader b/test/handler/test_pony_handler.vader new file mode 100644 index 0000000..25a8254 --- /dev/null +++ b/test/handler/test_pony_handler.vader @@ -0,0 +1,21 @@ +Execute(The pony handler should handle ponyc output): + call ale#test#SetFilename('foo.pony') + + AssertEqual + \ [ + \ { + \ 'filename': '/home/projects/Wombat.pony', + \ 'lnum': 22, + \ 'type': 'E', + \ 'col': 30, + \ 'text': 'can''t lookup private fields from outside the type', + \ }, + \ ], + \ ale#handlers#pony#HandlePonycFormat(bufnr(''), [ + \ 'Building builtin -> /usr/lib/pony/0.21.3/packages/builtin', + \ 'Building . -> /home/projects', + \ 'Error:', + \ '/home/projects/Wombat.pony:22:30: can''t lookup private fields from outside the type', + \ ' env.out.print(defaultWombat._hunger_level)', + \ ' ^', + \ ]) From f979da54d417a0e390c686d9a02e63a2439cfc3f Mon Sep 17 00:00:00 2001 From: Dennis Falling Date: Mon, 12 Feb 2018 22:52:39 -0500 Subject: [PATCH 361/390] Fix reason help reference `ale-integration-reason-merlin` doesn't exist, changed to `ale-reasonml-ols` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b09a643..56a53a8 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ formatting. | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [prospector](http://github.com/landscapeio/prospector), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) | | R | [lintr](https://github.com/jimhester/lintr) | -| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | +| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-reasonml-ols` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) | | reStructuredText | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [rstcheck](https://github.com/myint/rstcheck), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) | | Re:VIEW | [redpen](http://redpen.cc/) | | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) | From 5972b9722370e95f48382fc1d696d17a9fa30c85 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 18 Feb 2018 09:44:04 +0000 Subject: [PATCH 362/390] #476 Make F401 a warning and E112 a syntax error --- ale_linters/python/flake8.vim | 11 +++++--- ale_linters/python/pycodestyle.vim | 4 +-- test/handler/test_flake8_handler.vader | 30 +++++++++++++++++++++ test/handler/test_pycodestyle_handler.vader | 15 +++++++++++ 4 files changed, 55 insertions(+), 5 deletions(-) diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim index 400e60f..e7bbcfb 100644 --- a/ale_linters/python/flake8.vim +++ b/ale_linters/python/flake8.vim @@ -105,11 +105,16 @@ function! ale_linters#python#flake8#Handle(buffer, lines) abort \ 'type': 'W', \} - if l:code[:0] is# 'F' || l:code is# 'E999' - let l:item.type = 'E' + if l:code[:0] is# 'F' + if l:code isnot# 'F401' + let l:item.type = 'E' + endif elseif l:code[:0] is# 'E' let l:item.type = 'E' - let l:item.sub_type = 'style' + + if l:code isnot# 'E999' && l:code isnot# 'E112' + let l:item.sub_type = 'style' + endif elseif l:code[:0] is# 'W' let l:item.sub_type = 'style' endif diff --git a/ale_linters/python/pycodestyle.vim b/ale_linters/python/pycodestyle.vim index bbecdf0..19f05a5 100644 --- a/ale_linters/python/pycodestyle.vim +++ b/ale_linters/python/pycodestyle.vim @@ -44,8 +44,8 @@ function! ale_linters#python#pycodestyle#Handle(buffer, lines) abort \ 'code': l:match[4], \} - " E999 is not a style error, it's a syntax error. - if l:match[4] is# 'E999' + " E999 and E112 are syntax errors. + if l:match[4] is# 'E999' || l:match[4] is# 'E112' unlet l:item.sub_type endif diff --git a/test/handler/test_flake8_handler.vader b/test/handler/test_flake8_handler.vader index 492941c..efacdfb 100644 --- a/test/handler/test_flake8_handler.vader +++ b/test/handler/test_flake8_handler.vader @@ -214,3 +214,33 @@ Execute(Disabling trailing blank line warnings should work): \ ale_linters#python#flake8#Handle(bufnr(''), [ \ 'foo.py:6:1: W391 blank line at end of file', \ ]) + +Execute(F401 should be a warning): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'F401', + \ 'type': 'W', + \ 'text': 'module imported but unused', + \ }, + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: F401 module imported but unused', + \ ]) + +Execute(E112 should be a syntax error): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'E112', + \ 'type': 'E', + \ 'text': 'expected an indented block', + \ }, + \ ], + \ ale_linters#python#flake8#Handle(bufnr(''), [ + \ 'foo.py:6:1: E112 expected an indented block', + \ ]) diff --git a/test/handler/test_pycodestyle_handler.vader b/test/handler/test_pycodestyle_handler.vader index 0fd885d..3664455 100644 --- a/test/handler/test_pycodestyle_handler.vader +++ b/test/handler/test_pycodestyle_handler.vader @@ -137,3 +137,18 @@ Execute(Disabling trailing blank line warnings should work): \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ \ 'foo.py:6:1: W391 blank line at end of file', \ ]) + +Execute(E112 should be a syntax error): + AssertEqual + \ [ + \ { + \ 'lnum': 6, + \ 'col': 1, + \ 'code': 'E112', + \ 'type': 'E', + \ 'text': 'expected an indented block', + \ }, + \ ], + \ ale_linters#python#pycodestyle#Handle(bufnr(''), [ + \ 'foo.py:6:1: E112 expected an indented block', + \ ]) From 5915a0ee39ba04a5a4118d5f71766912a6b87fe9 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 18 Feb 2018 10:06:40 +0000 Subject: [PATCH 363/390] Escape the ponyc executable --- ale_linters/pony/ponyc.vim | 2 +- test/command_callback/test_pony_ponyc_command_callbacks.vader | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/ale_linters/pony/ponyc.vim b/ale_linters/pony/ponyc.vim index 4120df5..b332905 100644 --- a/ale_linters/pony/ponyc.vim +++ b/ale_linters/pony/ponyc.vim @@ -8,7 +8,7 @@ function! ale_linters#pony#ponyc#GetExecutable(buffer) abort endfunction function! ale_linters#pony#ponyc#GetCommand(buffer) abort - return ale_linters#pony#ponyc#GetExecutable(a:buffer) + return ale#Escape(ale_linters#pony#ponyc#GetExecutable(a:buffer)) \ . ' ' . ale#Var(a:buffer, 'pony_ponyc_options') endfunction diff --git a/test/command_callback/test_pony_ponyc_command_callbacks.vader b/test/command_callback/test_pony_ponyc_command_callbacks.vader index e48346e..7acbfa9 100644 --- a/test/command_callback/test_pony_ponyc_command_callbacks.vader +++ b/test/command_callback/test_pony_ponyc_command_callbacks.vader @@ -13,11 +13,11 @@ After: Execute(The options should be used in the command): AssertEqual - \ 'ponyc --pass paint', + \ ale#Escape('ponyc') . ' --pass paint', \ ale_linters#pony#ponyc#GetCommand(bufnr('')) let b:ale_pony_ponyc_options = 'foobar' AssertEqual - \ 'ponyc foobar', + \ ale#Escape('ponyc') . ' foobar', \ ale_linters#pony#ponyc#GetCommand(bufnr('')) From 89f8d3e456713846d1ebdd934027ae7a910cf5f8 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 18 Feb 2018 10:13:30 +0000 Subject: [PATCH 364/390] Fix #1336 - Print a friendly message when using invalid function names for fixers --- autoload/ale/fix.vim | 10 ++++++++-- test/fix/test_ale_fix.vader | 10 ++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/autoload/ale/fix.vim b/autoload/ale/fix.vim index 62a4f9b..9111db3 100644 --- a/autoload/ale/fix.vim +++ b/autoload/ale/fix.vim @@ -392,7 +392,13 @@ function! s:GetCallbacks() abort endif endif - call add(l:corrected_list, ale#util#GetFunction(l:Item)) + try + call add(l:corrected_list, ale#util#GetFunction(l:Item)) + catch /E475/ + " Rethrow exceptions for failing to get a function so we can print + " a friendly message about it. + throw 'BADNAME ' . v:exception + endtry endfor return l:corrected_list @@ -427,7 +433,7 @@ function! ale#fix#Fix(...) abort try let l:callback_list = s:GetCallbacks() - catch /E700/ + catch /E700\|BADNAME/ let l:function_name = join(split(split(v:exception, ':')[3])) let l:echo_message = printf( \ 'There is no fixer named `%s`. Check :ALEFixSuggest', diff --git a/test/fix/test_ale_fix.vader b/test/fix/test_ale_fix.vader index 817c243..5b66c92 100644 --- a/test/fix/test_ale_fix.vader +++ b/test/fix/test_ale_fix.vader @@ -574,6 +574,16 @@ Execute(ALE should print a message telling you something isn't a valid fixer whe AssertEqual 'There is no fixer named `invalidname`. Check :ALEFixSuggest', GetLastMessage() +Execute(ALE should complain about invalid fixers with minuses in the name): + let g:ale_fixers.testft = ['foo-bar'] + ALEFix + + AssertEqual 'There is no fixer named `foo-bar`. Check :ALEFixSuggest', GetLastMessage() + +Execute(ALE should tolerate valid fixers with minuses in the name): + let g:ale_fixers.testft = ['prettier-standard'] + ALEFix + Execute(Test fixing with chained callbacks): let g:ale_fixers.testft = ['FirstChainCallback'] ALEFix From ab5257c3442f5d5b5236905a4c77f4f09a24d8b5 Mon Sep 17 00:00:00 2001 From: Sander van Harmelen Date: Thu, 15 Feb 2018 12:23:36 +0100 Subject: [PATCH 365/390] This fixes issue #936 by linting the whole package --- ale_linters/go/staticcheck.vim | 24 ++++++++++- doc/ale-go.txt | 32 +++++++++++++++ doc/ale.txt | 1 + .../test_staticcheck_command_callback.vader | 41 +++++++++++++++++++ 4 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 test/command_callback/test_staticcheck_command_callback.vader diff --git a/ale_linters/go/staticcheck.vim b/ale_linters/go/staticcheck.vim index 255fd17..ce9e6e3 100644 --- a/ale_linters/go/staticcheck.vim +++ b/ale_linters/go/staticcheck.vim @@ -1,10 +1,32 @@ " Author: Ben Reedy " Description: staticcheck for Go files +call ale#Set('go_staticcheck_options', '') +call ale#Set('go_staticcheck_lint_package', 0) + +function! ale_linters#go#staticcheck#GetCommand(buffer) abort + let l:filename = expand('#' . a:buffer . ':t') + let l:options = ale#Var(a:buffer, 'go_staticcheck_options') + let l:lint_package = ale#Var(a:buffer, 'go_staticcheck_lint_package') + + " BufferCdString is used so that we can be sure the paths output from + " staticcheck can be calculated to absolute paths in the Handler + if l:lint_package + return ale#path#BufferCdString(a:buffer) + \ . 'staticcheck' + \ . (!empty(l:options) ? ' ' . l:options : '') . ' .' + endif + + return ale#path#BufferCdString(a:buffer) + \ . 'staticcheck' + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . ' ' . ale#Escape(l:filename) +endfunction + call ale#linter#Define('go', { \ 'name': 'staticcheck', \ 'executable': 'staticcheck', -\ 'command': 'staticcheck %s', +\ 'command_callback': 'ale_linters#go#staticcheck#GetCommand', \ 'callback': 'ale#handlers#unix#HandleAsWarning', \ 'output_stream': 'both', \ 'lint_file': 1, diff --git a/doc/ale-go.txt b/doc/ale-go.txt index 502f237..b80bd45 100644 --- a/doc/ale-go.txt +++ b/doc/ale-go.txt @@ -20,6 +20,7 @@ the benefit of running a number of linters, more than ALE would by default, while ensuring it doesn't run any linters known to be slow or resource intensive. + =============================================================================== gobuild *ale-go-gobuild* @@ -42,6 +43,7 @@ g:ale_go_gofmt_options *g:ale_go_gofmt_options* This variable can be set to pass additional options to the gofmt fixer. + =============================================================================== gometalinter *ale-go-gometalinter* @@ -71,5 +73,35 @@ g:ale_go_gometalinter_options *g:ale_go_gometalinter_options* number of linters known to be slow or consume a lot of resources. +g:ale_go_gometalinter_package *g:ale_go_gometalinter_package* + *b:ale_go_gometalinter_package* + Type: |Number| + Default: `0` + + When set to `1`, the whole Go package will be checked instead of only the + current file. + + +=============================================================================== +staticcheck *ale-go-staticcheck* + +g:ale_go_staticcheck_options *g:ale_go_staticcheck_options* + *b:ale_go_staticcheck_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to the staticcheck + linter. + + +g:ale_go_staticcheck_package *g:ale_go_staticcheck_package* + *b:ale_go_staticcheck_package* + Type: |Number| + Default: `0` + + When set to `1`, the whole Go package will be checked instead of only the + current file. + + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 6ace9d5..fa0e1c1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -80,6 +80,7 @@ CONTENTS *ale-contents* gobuild.............................|ale-go-gobuild| gofmt...............................|ale-go-gofmt| gometalinter........................|ale-go-gometalinter| + staticcheck.........................|ale-go-staticcheck| graphql...............................|ale-graphql-options| eslint..............................|ale-graphql-eslint| gqlint..............................|ale-graphql-gqlint| diff --git a/test/command_callback/test_staticcheck_command_callback.vader b/test/command_callback/test_staticcheck_command_callback.vader new file mode 100644 index 0000000..e9628eb --- /dev/null +++ b/test/command_callback/test_staticcheck_command_callback.vader @@ -0,0 +1,41 @@ +Before: + Save b:ale_go_staticcheck_options + Save b:ale_go_staticcheck_lint_package + + let b:ale_go_staticcheck_options = '' + let b:ale_go_staticcheck_lint_package = 0 + + runtime ale_linters/go/staticcheck.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + call ale#test#SetFilename('test.go') + +After: + Restore + + call ale#test#RestoreDirectory() + call ale#linter#Reset() + +Execute(The staticcheck callback should return the right defaults): + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'staticcheck ' + \ . ale#Escape(expand('%' . ':t')), + \ ale_linters#go#staticcheck#GetCommand(bufnr('')) + +Execute(The staticcheck callback should use configured options): + let b:ale_go_staticcheck_options = '-test' + + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'staticcheck ' + \ . '-test ' . ale#Escape(expand('%' . ':t')), + \ ale_linters#go#staticcheck#GetCommand(bufnr('')) + +Execute(The staticcheck `lint_package` option should use the correct command): + let b:ale_go_staticcheck_lint_package = 1 + + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . 'staticcheck .', + \ ale_linters#go#staticcheck#GetCommand(bufnr('')) From 8b304f77b7b8efd7a03d51e5b2533631dc646094 Mon Sep 17 00:00:00 2001 From: David Briscoe Date: Fri, 23 Feb 2018 14:43:24 -0800 Subject: [PATCH 366/390] Add Unity project path to Unity example in docs For Ale to recognize the symbols in your project, you need to point it at where Unity builds your assemblies. Add this path to the example. --- doc/ale-cs.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index 237e848..3a02df6 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -94,6 +94,7 @@ g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies* " Compile C# programs with the Unity engine DLL file on Mac. let g:ale_cs_mcsc_assemblies = [ \ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll', + \ 'path-to-unityproject/obj/Debug', \] < From 4941bd8d0e5d64dea92892fe52c14d856518462c Mon Sep 17 00:00:00 2001 From: John Eikenberry Date: Sun, 25 Feb 2018 11:39:45 +0000 Subject: [PATCH 367/390] Fix #1358, fix #1369 - Lint the package on save for go vet instead --- ale_linters/go/govet.vim | 29 +++++++++++++++++-- .../test_govet_command_callback.vader | 16 ++++++++++ test/handler/test_govet_handler.vader | 28 ++++++++++++++++++ 3 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 test/command_callback/test_govet_command_callback.vader create mode 100644 test/handler/test_govet_handler.vader diff --git a/ale_linters/go/govet.vim b/ale_linters/go/govet.vim index f5bb47a..aae5969 100644 --- a/ale_linters/go/govet.vim +++ b/ale_linters/go/govet.vim @@ -1,10 +1,35 @@ " Author: neersighted " Description: go vet for Go files +" +" Author: John Eikenberry +" Description: updated to work with go1.10 + +function! ale_linters#go#govet#GetCommand(buffer) abort + return ale#path#BufferCdString(a:buffer) . ' go vet .' +endfunction + +function! ale_linters#go#govet#Handler(buffer, lines) abort + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):?(\d+)?:? ?(.+)$' + let l:output = [] + let l:dir = expand('#' . a:buffer . ':p:h') + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + call add(l:output, { + \ 'filename': ale#path#GetAbsPath(l:dir, l:match[1]), + \ 'lnum': l:match[2] + 0, + \ 'col': l:match[3] + 0, + \ 'text': l:match[4], + \ 'type': 'E', + \}) + endfor + return l:output +endfunction call ale#linter#Define('go', { \ 'name': 'go vet', \ 'output_stream': 'stderr', \ 'executable': 'go', -\ 'command': 'go vet %t', -\ 'callback': 'ale#handlers#unix#HandleAsError', +\ 'command_callback': 'ale_linters#go#govet#GetCommand', +\ 'callback': 'ale_linters#go#govet#Handler', +\ 'lint_file': 1, \}) diff --git a/test/command_callback/test_govet_command_callback.vader b/test/command_callback/test_govet_command_callback.vader new file mode 100644 index 0000000..a9b2960 --- /dev/null +++ b/test/command_callback/test_govet_command_callback.vader @@ -0,0 +1,16 @@ +Before: + runtime ale_linters/go/govet.vim + + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + Restore + + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(The default command should be correct): + AssertEqual + \ 'cd ' . ale#Escape(expand('%:p:h')) . ' && ' + \ . ' go vet .', + \ ale_linters#go#govet#GetCommand(bufnr('')) diff --git a/test/handler/test_govet_handler.vader b/test/handler/test_govet_handler.vader new file mode 100644 index 0000000..b4bfdc9 --- /dev/null +++ b/test/handler/test_govet_handler.vader @@ -0,0 +1,28 @@ +Before: + runtime ale_linters/go/govet.vim + +After: + call ale#linter#Reset() + +Execute(The govet handler should return the correct filenames): + AssertEqual + \ [ + \ { + \ 'lnum': 27, + \ 'col': 0, + \ 'text': 'some error', + \ 'type': 'E', + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/test.go'), + \ }, + \ { + \ 'lnum': 27, + \ 'col': 5, + \ 'text': 'some error with a column', + \ 'type': 'E', + \ 'filename': ale#path#Simplify(expand('%:p:h') . '/other.go'), + \ }, + \ ], + \ ale_linters#go#govet#Handler(bufnr(''), [ + \ 'test.go:27: some error', + \ 'other.go:27:5: some error with a column', + \ ]) From b5209d31e85bdb5f2f1c7c1bdd9ee6fd42ca9574 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 25 Feb 2018 11:53:36 +0000 Subject: [PATCH 368/390] go vet can only check files now --- README.md | 2 +- doc/ale.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dca1db8..9fe00bc 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ formatting. | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | -| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gotype](https://godoc.org/golang.org/x/tools/cmd/gotype), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | +| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/) !!, [golint](https://godoc.org/github.com/golang/lint), [gotype](https://godoc.org/golang.org/x/tools/cmd/gotype), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint), [prettier](https://github.com/prettier/prettier) | | Haml | [haml-lint](https://github.com/brigade/haml-lint) | | Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) | diff --git a/doc/ale.txt b/doc/ale.txt index 296d640..ae0f97d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -322,7 +322,7 @@ Notes: * FusionScript: `fusion-lint` * Git Commit Messages: `gitlint` * GLSL: glslang, `glslls` -* Go: `gofmt`, `goimports`, `go vet`, `golint`, `gotype`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! +* Go: `gofmt`, `goimports`, `go vet`!!, `golint`, `gotype`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `eslint`, `gqlint`, `prettier` * Haml: `haml-lint` * Handlebars: `ember-template-lint` From 0ddf16194d8f1b272127c5a6b2d84b5345757b17 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 25 Feb 2018 12:43:13 +0000 Subject: [PATCH 369/390] Fix #1306 - Tell users how to automatically close the loclist window in the documentation --- doc/ale.txt | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index ad4a960..999d2af 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -921,10 +921,10 @@ g:ale_keep_list_window_open *g:ale_keep_list_window_open* Type: |Number| Default: `0` - When set to `1`, this option will keep the loclist or quickfix windows - event after all warnings/errors have been removed for files. By default - the loclist or quicfix windows will be closed automatically when there - are no warnings or errors. + When set to `1`, this option will keep the loclist or quickfix windows event + after all warnings/errors have been removed for files. By default the + loclist or quickfix windows will be closed automatically when there are no + warnings or errors. See |g:ale_open_list| @@ -1215,10 +1215,19 @@ g:ale_open_list *g:ale_open_list* The window will be kept open until all warnings or errors are cleared, including those not set by ALE, unless |g:ale_keep_list_window_open| is set - to `1`, in which case the window will be kept open until closed manually. + to `1`, in which case the window will be kept open when no problems are + found. The window size can be configured with |g:ale_list_window_size|. + If you want to close the loclist window automatically when the buffer is + closed, you can set up the following |autocmd| command: > + + augroup CloseLoclistWindowGroup + autocmd! + autocmd QuitPre * if empty(&buftype) | lclose | endif + augroup END +< g:ale_pattern_options *g:ale_pattern_options* From 478a2883a6c75e888bce2b0e7c800d5d8990f29e Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 25 Feb 2018 12:57:54 +0000 Subject: [PATCH 370/390] #1363 Make ale#engine#IsCheckingBuffer part of the public API --- autoload/ale/engine.vim | 2 ++ doc/ale.txt | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 8c3d4c7..a21eecd 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -76,6 +76,8 @@ function! ale#engine#InitBufferInfo(buffer) abort return 0 endfunction +" This function is documented and part of the public API. +" " Return 1 if ALE is busy checking a given buffer function! ale#engine#IsCheckingBuffer(buffer) abort let l:info = get(g:ale_buffer_info, a:buffer, {}) diff --git a/doc/ale.txt b/doc/ale.txt index 999d2af..fd3e489 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1907,6 +1907,13 @@ ale#engine#GetLoclist(buffer) *ale#engine#GetLoclist()* be copied before applying |map()| or |filter()|. +ale#engine#IsCheckingBuffer(buffer) *ale#engine#IsCheckingBuffer()* + + Given a buffer number, returns `1` when ALE is busy checking that buffer. + + This function can be used for status lines, tab names, etc. + + ale#engine#ManageFile(buffer, filename) *ale#engine#ManageFile()* Given a buffer number for a buffer currently running some linting tasks From 82f8a04e18000bc3311340f820edfc98005e99a9 Mon Sep 17 00:00:00 2001 From: Christian-Gibbons Date: Sun, 25 Feb 2018 09:11:04 -0500 Subject: [PATCH 371/390] New linter: Flawfinder (#1361) * Flawfinder support added for C and C++ A minor modification to gcc handler was made to support flawfinder's single-line output format that does not have a space following the colon denoting the warning level. gcc handler still passes its Vader tests after this modification. * Documentation fixes * Revert documentation regression * Added Flawfinder to table of contents * Removed trailing whitespace * Follow ALE conventions better Added additional documentation and Vader tests --- README.md | 4 +- ale_linters/c/flawfinder.vim | 30 +++++++++++ ale_linters/cpp/flawfinder.vim | 30 +++++++++++ autoload/ale/handlers/gcc.vim | 2 +- doc/ale-c.txt | 27 ++++++++++ doc/ale-cpp.txt | 27 ++++++++++ doc/ale.txt | 6 ++- .../test_c_flawfinder_command_callbacks.vader | 51 +++++++++++++++++++ ...est_cpp_flawfinder_command_callbacks.vader | 51 +++++++++++++++++++ 9 files changed, 223 insertions(+), 5 deletions(-) create mode 100644 ale_linters/c/flawfinder.vim create mode 100644 ale_linters/cpp/flawfinder.vim create mode 100644 test/command_callback/test_c_flawfinder_command_callbacks.vader create mode 100644 test/command_callback/test_cpp_flawfinder_command_callbacks.vader diff --git a/README.md b/README.md index 9fe00bc..3857e32 100644 --- a/README.md +++ b/README.md @@ -79,8 +79,8 @@ formatting. | Awk | [gawk](https://www.gnu.org/software/gawk/)| | Bash | shell [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | | Bourne Shell | shell [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/), [shfmt](https://github.com/mvdan/sh) | -| C | [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/), [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html)| -| C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangcheck](http://clang.llvm.org/docs/ClangCheck.html) !!, [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html), [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) !!, [gcc](https://gcc.gnu.org/) | +| C | [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint), [clang](http://clang.llvm.org/), [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html), [flawfinder](https://www.dwheeler.com/flawfinder/), [gcc](https://gcc.gnu.org/) | +| C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangcheck](http://clang.llvm.org/docs/ClangCheck.html) !!, [clangtidy](http://clang.llvm.org/extra/clang-tidy/) !!, [clang-format](https://clang.llvm.org/docs/ClangFormat.html), [cppcheck](http://cppcheck.sourceforge.net), [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) !!, [flawfinder](https://www.dwheeler.com/flawfinder/), [gcc](https://gcc.gnu.org/) | | CUDA | [nvcc](http://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/index.html) | | C# | [mcs](http://www.mono-project.com/docs/about-mono/languages/csharp/) see:`help ale-cs-mcs` for details, [mcsc](http://www.mono-project.com/docs/about-mono/languages/csharp/) !! see:`help ale-cs-mcsc` for details and configuration| | Chef | [foodcritic](http://www.foodcritic.io/) | diff --git a/ale_linters/c/flawfinder.vim b/ale_linters/c/flawfinder.vim new file mode 100644 index 0000000..27f269f --- /dev/null +++ b/ale_linters/c/flawfinder.vim @@ -0,0 +1,30 @@ +" Author: Christian Gibbons +" Description: flawfinder linter for c files + +call ale#Set('c_flawfinder_executable', 'flawfinder') +call ale#Set('c_flawfinder_options', '') +call ale#Set('c_flawfinder_minlevel', 1) + +function! ale_linters#c#flawfinder#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'c_flawfinder_executable') +endfunction + +function! ale_linters#c#flawfinder#GetCommand(buffer) abort + + " Set the minimum vulnerability level for flawfinder to bother with + let l:minlevel = ' --minlevel=' . ale#Var(a:buffer, 'c_flawfinder_minlevel') + + return ale#Escape(ale_linters#c#flawfinder#GetExecutable(a:buffer)) + \ . ' -CDQS' + \ . ale#Var(a:buffer, 'c_flawfinder_options') + \ . l:minlevel + \ . ' %t' +endfunction + +call ale#linter#Define('c', { +\ 'name': 'flawfinder', +\ 'output_stream': 'stdout', +\ 'executable_callback': 'ale_linters#c#flawfinder#GetExecutable', +\ 'command_callback': 'ale_linters#c#flawfinder#GetCommand', +\ 'callback': 'ale#handlers#gcc#HandleGCCFormat', +\}) diff --git a/ale_linters/cpp/flawfinder.vim b/ale_linters/cpp/flawfinder.vim new file mode 100644 index 0000000..a19f596 --- /dev/null +++ b/ale_linters/cpp/flawfinder.vim @@ -0,0 +1,30 @@ +" Author: Christian Gibbons +" Description: flawfinder linter for c++ files + +call ale#Set('cpp_flawfinder_executable', 'flawfinder') +call ale#Set('cpp_flawfinder_options', '') +call ale#Set('cpp_flawfinder_minlevel', 1) + +function! ale_linters#cpp#flawfinder#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'cpp_flawfinder_executable') +endfunction + +function! ale_linters#cpp#flawfinder#GetCommand(buffer) abort + + " Set the minimum vulnerability level for flawfinder to bother with + let l:minlevel = ' --minlevel=' . ale#Var(a:buffer, 'cpp_flawfinder_minlevel') + + return ale#Escape(ale_linters#cpp#flawfinder#GetExecutable(a:buffer)) + \ . ' -CDQS' + \ . ale#Var(a:buffer, 'cpp_flawfinder_options') + \ . l:minlevel + \ . ' %t' +endfunction + +call ale#linter#Define('cpp', { +\ 'name': 'flawfinder', +\ 'output_stream': 'stdout', +\ 'executable_callback': 'ale_linters#cpp#flawfinder#GetExecutable', +\ 'command_callback': 'ale_linters#cpp#flawfinder#GetCommand', +\ 'callback': 'ale#handlers#gcc#HandleGCCFormat', +\}) diff --git a/autoload/ale/handlers/gcc.vim b/autoload/ale/handlers/gcc.vim index 9ec7b11..7f2078a 100644 --- a/autoload/ale/handlers/gcc.vim +++ b/autoload/ale/handlers/gcc.vim @@ -24,7 +24,7 @@ function! ale#handlers#gcc#HandleGCCFormat(buffer, lines) abort " :8:5: warning: conversion lacks type at end of format [-Wformat=] " :10:27: error: invalid operands to binary - (have ‘int’ and ‘char *’) " -:189:7: note: $/${} is unnecessary on arithmetic variables. [SC2004] - let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+)$' + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): ?(.+)$' let l:output = [] for l:match in ale#util#GetMatches(a:lines, l:pattern) diff --git a/doc/ale-c.txt b/doc/ale-c.txt index fc2c45c..62445de 100644 --- a/doc/ale-c.txt +++ b/doc/ale-c.txt @@ -143,6 +143,33 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* This variable can be changed to modify flags given to cppcheck. +=============================================================================== +flawfinder *ale-c-flawfinder* + +g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable* + *g:ale_c_flawfinder_executable* + Type: |String| + Default: `'flawfinder'` + + This variable can be changed to use a different executable for flawfinder. + + +g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel* + *b:ale_c_flawfinder_minlevel* + Type: |Number| + Default: `1` + + This variable can be changed to ignore risks under the given risk threshold. + + +g:ale_c_flawfinder_options *g:ale-c-flawfinder* + *b:ale-c-flawfinder* + Type: |String| + Default: `''` + + This variable can be used to pass extra options into the flawfinder command. + + =============================================================================== gcc *ale-c-gcc* diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt index cda5768..19ef589 100644 --- a/doc/ale-cpp.txt +++ b/doc/ale-cpp.txt @@ -153,6 +153,33 @@ g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options* This variable can be changed to modify flags given to cpplint. +=============================================================================== +flawfinder *ale-cpp-flawfinder* + +g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable* + *g:ale_cpp_flawfinder_executable* + Type: |String| + Default: `'flawfinder'` + + This variable can be changed to use a different executable for flawfinder. + + +g:ale_cpp_flawfinder_minlevel *g:ale_cpp_flawfinder_minlevel* + *b:ale_cpp_flawfinder_minlevel* + Type: |Number| + Default: `1` + + This variable can be changed to ignore risks under the given risk threshold. + + +g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder* + *b:ale-cpp-flawfinder* + Type: |String| + Default: `''` + + This variable can be used to pass extra options into the flawfinder command. + + =============================================================================== gcc *ale-cpp-gcc* diff --git a/doc/ale.txt b/doc/ale.txt index fd3e489..d2e050a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -28,6 +28,7 @@ CONTENTS *ale-contents* clang-format........................|ale-c-clangformat| clangtidy...........................|ale-c-clangtidy| cppcheck............................|ale-c-cppcheck| + flawfinder..........................|ale-c-flawfinder| gcc.................................|ale-c-gcc| chef..................................|ale-chef-options| foodcritic..........................|ale-chef-foodcritic| @@ -42,6 +43,7 @@ CONTENTS *ale-contents* clangtidy...........................|ale-cpp-clangtidy| cppcheck............................|ale-cpp-cppcheck| cpplint.............................|ale-cpp-cpplint| + flawfinder..........................|ale-cpp-flawfinder| gcc.................................|ale-cpp-gcc| c#....................................|ale-cs-options| mcs.................................|ale-cs-mcs| @@ -298,8 +300,8 @@ Notes: * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck`, `shfmt` * Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt` -* C: `cppcheck`, `cpplint`!!, `gcc`, `clang`, `clangtidy`!!, `clang-format` -* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `gcc` +* C: `cppcheck`, `cpplint`!!, `clang`, `clangtidy`!!, `clang-format`, `flawfinder`, `gcc` +* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `flawfinder`, `gcc` * CUDA: `nvcc`!! * C#: `mcs`, `mcsc`!! * Chef: `foodcritic` diff --git a/test/command_callback/test_c_flawfinder_command_callbacks.vader b/test/command_callback/test_c_flawfinder_command_callbacks.vader new file mode 100644 index 0000000..38a602d --- /dev/null +++ b/test/command_callback/test_c_flawfinder_command_callbacks.vader @@ -0,0 +1,51 @@ +Before: + Save g:ale_c_flawfinder_executable + Save g:ale_c_flawfinder_options + Save g:ale_c_flawfinder_minlevel + + unlet! g:ale_c_flawfinder_executable + unlet! b:ale_c_flawfinder_executable + unlet! g:ale_c_flawfinder_options + unlet! b:ale_c_flawfinder_options + unlet! g:ale_c_flawfinder_minlevel + unlet! b:ale_c_flawfinder_minlevel + + runtime ale_linters/c/flawfinder.vim + +After: + unlet! b:ale_c_flawfinder_executable + unlet! b:ale_c_flawfinder_options + unlet! b:ale_c_flawfinder_minlevel + + Restore + call ale#linter#Reset() + +Execute(The flawfinder command should be correct): + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --minlevel=1 %t', + \ ale_linters#c#flawfinder#GetCommand(bufnr('')) + +Execute(The minlevel of flawfinder should be configurable): + let b:ale_c_flawfinder_minlevel = 8 + + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --minlevel=8 %t', + \ ale_linters#c#flawfinder#GetCommand(bufnr('')) + +Execute(Additional flawfinder options should be configurable): + let b:ale_c_flawfinder_options = ' --foobar' + + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --foobar --minlevel=1 %t', + \ ale_linters#c#flawfinder#GetCommand(bufnr('')) + +Execute(The flawfinder exectable should be configurable): + let b:ale_c_flawfinder_executable = 'foo/bar' + + AssertEqual + \ ale#Escape('foo/bar') + \ . ' -CDQS --minlevel=1 %t', + \ ale_linters#c#flawfinder#GetCommand(bufnr('')) diff --git a/test/command_callback/test_cpp_flawfinder_command_callbacks.vader b/test/command_callback/test_cpp_flawfinder_command_callbacks.vader new file mode 100644 index 0000000..8769ec9 --- /dev/null +++ b/test/command_callback/test_cpp_flawfinder_command_callbacks.vader @@ -0,0 +1,51 @@ +Before: + Save g:ale_cpp_flawfinder_executable + Save g:ale_cpp_flawfinder_options + Save g:ale_cpp_flawfinder_minlevel + + unlet! g:ale_cpp_flawfinder_executable + unlet! b:ale_cpp_flawfinder_executable + unlet! g:ale_cpp_flawfinder_options + unlet! b:ale_cpp_flawfinder_options + unlet! g:ale_cpp_flawfinder_minlevel + unlet! b:ale_cpp_flawfinder_minlevel + + runtime ale_linters/cpp/flawfinder.vim + +After: + unlet! b:ale_cpp_flawfinder_executable + unlet! b:ale_cpp_flawfinder_options + unlet! b:ale_cpp_flawfinder_minlevel + + Restore + call ale#linter#Reset() + +Execute(The flawfinder command should be correct): + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --minlevel=1 %t', + \ ale_linters#cpp#flawfinder#GetCommand(bufnr('')) + +Execute(The minlevel of flawfinder should be configurable): + let b:ale_cpp_flawfinder_minlevel = 8 + + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --minlevel=8 %t', + \ ale_linters#cpp#flawfinder#GetCommand(bufnr('')) + +Execute(Additional flawfinder options should be configurable): + let b:ale_cpp_flawfinder_options = ' --foobar' + + AssertEqual + \ ale#Escape('flawfinder') + \ . ' -CDQS --foobar --minlevel=1 %t', + \ ale_linters#cpp#flawfinder#GetCommand(bufnr('')) + +Execute(The flawfinder exectable should be configurable): + let b:ale_cpp_flawfinder_executable = 'foo/bar' + + AssertEqual + \ ale#Escape('foo/bar') + \ . ' -CDQS --minlevel=1 %t', + \ ale_linters#cpp#flawfinder#GetCommand(bufnr('')) From cfa3e6a92401021e7ea35fff5134cbd3c71524fe Mon Sep 17 00:00:00 2001 From: Koichi Shiraishi Date: Sun, 25 Feb 2018 23:31:38 +0900 Subject: [PATCH 372/390] doc/c: fix duplicate ale_c_flawfinder_executable help tag --- doc/ale-c.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-c.txt b/doc/ale-c.txt index 62445de..cf483fb 100644 --- a/doc/ale-c.txt +++ b/doc/ale-c.txt @@ -147,7 +147,7 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* flawfinder *ale-c-flawfinder* g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable* - *g:ale_c_flawfinder_executable* + *b:ale_c_flawfinder_executable* Type: |String| Default: `'flawfinder'` From b15706d9a97b12db088cd7c2e1923ca257024ab1 Mon Sep 17 00:00:00 2001 From: Koichi Shiraishi Date: Mon, 26 Feb 2018 00:04:56 +0900 Subject: [PATCH 373/390] doc/cpp: fix duplicate ale_cpp_flawfinder_executable help tag both of 'g:' prefix. --- doc/ale-cpp.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt index 19ef589..315f293 100644 --- a/doc/ale-cpp.txt +++ b/doc/ale-cpp.txt @@ -157,7 +157,7 @@ g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options* flawfinder *ale-cpp-flawfinder* g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable* - *g:ale_cpp_flawfinder_executable* + *b:ale_cpp_flawfinder_executable* Type: |String| Default: `'flawfinder'` From 7e20d9c63996c9e189651bf687d921e5f20d12cf Mon Sep 17 00:00:00 2001 From: Josh Leeb-du Toit Date: Mon, 26 Feb 2018 14:46:51 +1100 Subject: [PATCH 374/390] Add options for markdown_mdl linter --- ale_linters/markdown/mdl.vim | 17 ++++++++++++++--- doc/ale-markdown.txt | 19 +++++++++++++++++++ doc/ale.txt | 1 + 3 files changed, 34 insertions(+), 3 deletions(-) diff --git a/ale_linters/markdown/mdl.vim b/ale_linters/markdown/mdl.vim index f239025..9bb2031 100644 --- a/ale_linters/markdown/mdl.vim +++ b/ale_linters/markdown/mdl.vim @@ -1,5 +1,8 @@ -" Author: Steve Dignam -" Description: Support for mdl, a markdown linter +" Author: Steve Dignam , Josh Leeb-du Toit +" Description: Support for mdl, a markdown linter. + +call ale#Set('markdown_mdl_executable', 'mdl') +call ale#Set('markdown_mdl_options', '') function! ale_linters#markdown#mdl#Handle(buffer, lines) abort " matches: '(stdin):173: MD004 Unordered list style' @@ -17,9 +20,17 @@ function! ale_linters#markdown#mdl#Handle(buffer, lines) abort return l:output endfunction +function! ale_linters#markdown#mdl#GetCommand(buffer) abort + let l:executable = ale#Var(a:buffer, 'markdown_mdl_executable') + let l:options = ale#Var(a:buffer, 'markdown_mdl_options') + + return l:executable . (!empty(l:options) ? ' ' . l:options : '') +endfunction + + call ale#linter#Define('markdown', { \ 'name': 'mdl', \ 'executable': 'mdl', -\ 'command': 'mdl', +\ 'command_callback': 'ale_linters#markdown#mdl#GetCommand', \ 'callback': 'ale_linters#markdown#mdl#Handle' \}) diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt index b59f018..9a5290b 100644 --- a/doc/ale-markdown.txt +++ b/doc/ale-markdown.txt @@ -2,6 +2,25 @@ ALE Markdown Integration *ale-markdown-options* +=============================================================================== +mdl *ale-markdown-mdl* + +g:ale_markdown_mdl_executable *g:ale_markdown_mdl_executable* + *b:ale_markdown_mdl_executable* + Type: |String| + Default: `'mdl'` + + See |ale-integrations-local-executables| + + +g:ale_markdown_mdl_options *g:ale_markdown_mdl_options* + *b:ale_markdown_mdl_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to mdl. + + =============================================================================== prettier *ale-markdown-prettier* diff --git a/doc/ale.txt b/doc/ale.txt index d2e050a..3acd118 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -136,6 +136,7 @@ CONTENTS *ale-contents* luac................................|ale-lua-luac| luacheck............................|ale-lua-luacheck| markdown..............................|ale-markdown-options| + mdl.................................|ale-markdown-mdl| prettier............................|ale-markdown-prettier| write-good..........................|ale-markdown-write-good| nroff.................................|ale-nroff-options| From f64db199f1c8e4379cc642f6df6de1f70af14a57 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 26 Feb 2018 17:04:54 +0000 Subject: [PATCH 375/390] Fix a typo in the documentation --- doc/ale.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/ale.txt b/doc/ale.txt index d2e050a..4e1ae44 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1251,8 +1251,8 @@ g:ale_pattern_options *g:ale_pattern_options* See |b:ale_linters| and |b:ale_fixers| for information for those options. Filenames are matched with |match()|, and patterns depend on the |magic| - setting, unless prefixed with the special escape sequences like `'\v'`, - etc.The patterns can match any part of a filename. The absolute path of the + setting, unless prefixed with the special escape sequences like `'\v'`, etc. + The patterns can match any part of a filename. The absolute path of the filename will be used for matching, taken from `expand('%:p')`. The options for every match for the filename will be applied, with the From aea5de282ec6d7e8ed0a192c8c8eb0dbf6ff85b0 Mon Sep 17 00:00:00 2001 From: Olaf Alders Date: Wed, 28 Feb 2018 10:26:44 -0500 Subject: [PATCH 376/390] Explain in more detail why perl checks are disabled by default --- doc/ale-perl.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt index 414856b..0a4adff 100644 --- a/doc/ale-perl.txt +++ b/doc/ale-perl.txt @@ -3,6 +3,9 @@ ALE Perl Integration *ale-perl-options* ALE offers a few ways to check Perl code. Checking code with `perl` is disabled by default, as `perl` code cannot be checked without executing it. +Specifically, we use the `-c` flag to see if `perl` code compiles. This does +not execute all of the code in a file, but it does run `BEGIN` and `CHECK` +blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224 See |g:ale_linters|. From fbbb8c17d9634304fd6d10789e78d00c75b70e07 Mon Sep 17 00:00:00 2001 From: Julien Deniau Date: Thu, 1 Mar 2018 15:41:05 +0100 Subject: [PATCH 377/390] add php-cs-fixer to list of fixers --- README.md | 2 +- autoload/ale/fix/registry.vim | 5 ++ autoload/ale/fixers/php_cs_fixer.vim | 23 ++++++++++ doc/ale-php.txt | 17 +++++++ doc/ale.txt | 3 +- .../project-with-php-cs-fixer/test.php | 0 .../vendor/bin/php-cs-fixer | 0 .../project-without-php-cs-fixer/test.php | 0 test/fixers/test_php_cs_fixer.vader | 46 +++++++++++++++++++ 9 files changed, 94 insertions(+), 2 deletions(-) create mode 100644 autoload/ale/fixers/php_cs_fixer.vim create mode 100644 test/command_callback/php_paths/project-with-php-cs-fixer/test.php create mode 100644 test/command_callback/php_paths/project-with-php-cs-fixer/vendor/bin/php-cs-fixer create mode 100644 test/command_callback/php_paths/project-without-php-cs-fixer/test.php create mode 100644 test/fixers/test_php_cs_fixer.vader diff --git a/README.md b/README.md index 3857e32..e964c65 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ formatting. | Objective-C++ | [clang](http://clang.llvm.org/) | | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | -| PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) | +| PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer), [php-cs-fixer](http://cs.sensiolabs.org/) | | PO | [alex](https://github.com/wooorm/alex) !!, [msgfmt](https://www.gnu.org/software/gettext/manual/html_node/msgfmt-Invocation.html), [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pod | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) | | Pony | [ponyc](https://github.com/ponylang/ponyc) | diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim index 29e263a..3e407c5 100644 --- a/autoload/ale/fix/registry.vim +++ b/autoload/ale/fix/registry.vim @@ -104,6 +104,11 @@ let s:default_registry = { \ 'suggested_filetypes': ['php'], \ 'description': 'Fix PHP files with phpcbf.', \ }, +\ 'php_cs_fixer': { +\ 'function': 'ale#fixers#php_cs_fixer#Fix', +\ 'suggested_filetypes': ['php'], +\ 'description': 'Fix PHP files with php-cs-fixer.', +\ }, \ 'clang-format': { \ 'function': 'ale#fixers#clangformat#Fix', \ 'suggested_filetypes': ['c', 'cpp'], diff --git a/autoload/ale/fixers/php_cs_fixer.vim b/autoload/ale/fixers/php_cs_fixer.vim new file mode 100644 index 0000000..56aa915 --- /dev/null +++ b/autoload/ale/fixers/php_cs_fixer.vim @@ -0,0 +1,23 @@ +" Author: Julien Deniau +" Description: Fixing files with php-cs-fixer. + +call ale#Set('php_cs_fixer_executable', 'php-cs-fixer') +call ale#Set('php_cs_fixer_use_global', 0) + +function! ale#fixers#php_cs_fixer#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'php_cs_fixer', [ + \ 'vendor/bin/php-cs-fixer', + \ 'php-cs-fixer' + \]) +endfunction + +function! ale#fixers#php_cs_fixer#Fix(buffer) abort + let l:executable = ale#fixers#php_cs_fixer#GetExecutable(a:buffer) + return { + \ 'command': ale#Escape(l:executable) . ' fix %t', + \ 'read_temporary_file': 1, + \} +endfunction + + + diff --git a/doc/ale-php.txt b/doc/ale-php.txt index 455472f..7edfe23 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -166,5 +166,22 @@ g:ale_php_phpstan_configuration *g:ale_php_phpstan_configuration* This variable sets path to phpstan configuration file. +=============================================================================== +php-cs-fixer *ale-php-php-cs-fixer* + +g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable* + *b:ale_php_cs_fixer_executable* + Type: |String| + Default: `'php-cs-fixer'` + + This variable sets executable used for php-cs-fixer. + +g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global* + *b:ale_php_cs_fixer_use_global* + Type: |Boolean| + Default: `0` + + This variable force globally installed fixer. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 4e1ae44..76ad058 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -159,6 +159,7 @@ CONTENTS *ale-contents* phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| + php-cs-fixer........................|ale-php-php-cs-fixer| po....................................|ale-po-options| write-good..........................|ale-po-write-good| pod...................................|ale-pod-options| @@ -351,7 +352,7 @@ Notes: * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` * Perl: `perl -c`, `perl-critic` -* PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` +* PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`, `php-cs-fixer` * PO: `alex`!!, `msgfmt`, `proselint`, `write-good` * Pod: `alex`!!, `proselint`, `write-good` * Pony: `ponyc` diff --git a/test/command_callback/php_paths/project-with-php-cs-fixer/test.php b/test/command_callback/php_paths/project-with-php-cs-fixer/test.php new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/php_paths/project-with-php-cs-fixer/vendor/bin/php-cs-fixer b/test/command_callback/php_paths/project-with-php-cs-fixer/vendor/bin/php-cs-fixer new file mode 100644 index 0000000..e69de29 diff --git a/test/command_callback/php_paths/project-without-php-cs-fixer/test.php b/test/command_callback/php_paths/project-without-php-cs-fixer/test.php new file mode 100644 index 0000000..e69de29 diff --git a/test/fixers/test_php_cs_fixer.vader b/test/fixers/test_php_cs_fixer.vader new file mode 100644 index 0000000..b657967 --- /dev/null +++ b/test/fixers/test_php_cs_fixer.vader @@ -0,0 +1,46 @@ +Before: + Save g:ale_php_cs_fixer_executable + let g:ale_php_cs_fixer_executable = 'php-cs-fixer' + + call ale#test#SetDirectory('/testplugin/test/fixers') + silent cd .. + silent cd command_callback + let g:dir = getcwd() + +After: + Restore + + call ale#test#RestoreDirectory() + + +Execute(project with php-cs-fixer should use local by default): + call ale#test#SetFilename('php_paths/project-with-php-cs-fixer/test.php') + + AssertEqual + \ ale#path#Simplify(g:dir . '/php_paths/project-with-php-cs-fixer/vendor/bin/php-cs-fixer'), + \ ale#fixers#php_cs_fixer#GetExecutable(bufnr('')) + +Execute(use-global should override local detection): + let g:ale_php_cs_fixer_use_global = 1 + call ale#test#SetFilename('php_paths/project-with-php-cs-fixer/test.php') + + AssertEqual + \ 'php-cs-fixer', + \ ale#fixers#php_cs_fixer#GetExecutable(bufnr('')) + +Execute(project without php-cs-fixer should use global): + call ale#test#SetFilename('php_paths/project-without-php-cs-fixer/test.php') + + AssertEqual + \ 'php-cs-fixer', + \ ale#fixers#php_cs_fixer#GetExecutable(bufnr('')) + + + + +Execute(The php-cs-fixer callback should return the correct default values): + call ale#test#SetFilename('php_paths/project-without-php-cs-fixer/foo/test.php') + + AssertEqual + \ {'read_temporary_file': 1, 'command': ale#Escape('php-cs-fixer') . ' fix %t' }, + \ ale#fixers#php_cs_fixer#Fix(bufnr('')) From 2096562899aa0994a2c6d2c30320810001d98591 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 2 Mar 2018 12:10:27 +0000 Subject: [PATCH 378/390] Make updating linter results slightly faster when the list is empty --- autoload/ale/engine.vim | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index a21eecd..9ef3ba3 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -145,35 +145,39 @@ function! s:GatherOutput(job_id, line) abort endfunction function! s:HandleLoclist(linter_name, buffer, loclist) abort - let l:buffer_info = get(g:ale_buffer_info, a:buffer, {}) + let l:info = get(g:ale_buffer_info, a:buffer, {}) - if empty(l:buffer_info) + if empty(l:info) return endif " Remove this linter from the list of active linters. " This may have already been done when the job exits. - call filter(l:buffer_info.active_linter_list, 'v:val isnot# a:linter_name') + call filter(l:info.active_linter_list, 'v:val isnot# a:linter_name') " Make some adjustments to the loclists to fix common problems, and also " to set default values for loclist items. let l:linter_loclist = ale#engine#FixLocList(a:buffer, a:linter_name, a:loclist) " Remove previous items for this linter. - call filter(g:ale_buffer_info[a:buffer].loclist, 'v:val.linter_name isnot# a:linter_name') - " Add the new items. - call extend(g:ale_buffer_info[a:buffer].loclist, l:linter_loclist) + call filter(l:info.loclist, 'v:val.linter_name isnot# a:linter_name') - " Sort the loclist again. - " We need a sorted list so we can run a binary search against it - " for efficient lookup of the messages in the cursor handler. - call sort(g:ale_buffer_info[a:buffer].loclist, 'ale#util#LocItemCompare') + " We don't need to add items or sort the list when this list is empty. + if !empty(l:linter_loclist) + " Add the new items. + call extend(l:info.loclist, l:linter_loclist) + + " Sort the loclist again. + " We need a sorted list so we can run a binary search against it + " for efficient lookup of the messages in the cursor handler. + call sort(l:info.loclist, 'ale#util#LocItemCompare') + endif if ale#ShouldDoNothing(a:buffer) return endif - call ale#engine#SetResults(a:buffer, g:ale_buffer_info[a:buffer].loclist) + call ale#engine#SetResults(a:buffer, l:info.loclist) endfunction function! s:HandleExit(job_id, exit_code) abort From acbe527e15f1f388b8dbc9889216e9368d98e6c6 Mon Sep 17 00:00:00 2001 From: Andrew Crites Date: Fri, 2 Mar 2018 15:22:29 -0500 Subject: [PATCH 379/390] Option to open lists vertically (#1381) * Add configuration option to open lists vertically * Add tests, clean up vertical list config * Vertical list option cleanup * Use is# for tests * Order properties in documentation alphabetically --- README.md | 3 +++ autoload/ale/debugging.vim | 1 + autoload/ale/list.vim | 9 +++++-- doc/ale.txt | 12 +++++++++ plugin/ale.vim | 3 +++ test/test_ale_info.vader | 1 + test/test_list_opening.vader | 51 ++++++++++++++++++++++++++++++++++++ 7 files changed, 78 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3857e32..bbf817d 100644 --- a/README.md +++ b/README.md @@ -577,6 +577,9 @@ let g:ale_open_list = 1 let g:ale_keep_list_window_open = 1 ``` +You can also set `let g:ale_list_vertical = 1` to open the windows vertically +instead of the default horizontally. + ### 5.xii. How can I check JSX files with both stylelint and eslint? diff --git a/autoload/ale/debugging.vim b/autoload/ale/debugging.vim index 9be1fbf..cb93ec1 100644 --- a/autoload/ale/debugging.vim +++ b/autoload/ale/debugging.vim @@ -29,6 +29,7 @@ let s:global_variable_list = [ \ 'ale_linters', \ 'ale_linters_explicit', \ 'ale_list_window_size', +\ 'ale_list_vertical', \ 'ale_loclist_msg_format', \ 'ale_max_buffer_history_size', \ 'ale_max_signs', diff --git a/autoload/ale/list.vim b/autoload/ale/list.vim index b1a8d4a..30b8f5c 100644 --- a/autoload/ale/list.vim +++ b/autoload/ale/list.vim @@ -97,12 +97,17 @@ function! s:SetListsImpl(timer_id, buffer, loclist) abort let l:reset_visual_selection = l:mode is? 'v' || l:mode is# "\" let l:reset_character_selection = l:mode is? 's' || l:mode is# "\" + " open windows vertically instead of default horizontally + let l:open_type = '' + if ale#Var(a:buffer, 'list_vertical') == 1 + let l:open_type = 'vert ' + endif if g:ale_set_quickfix if !ale#list#IsQuickfixOpen() - silent! execute 'copen ' . str2nr(ale#Var(a:buffer, 'list_window_size')) + silent! execute l:open_type . 'copen ' . str2nr(ale#Var(a:buffer, 'list_window_size')) endif elseif g:ale_set_loclist - silent! execute 'lopen ' . str2nr(ale#Var(a:buffer, 'list_window_size')) + silent! execute l:open_type . 'lopen ' . str2nr(ale#Var(a:buffer, 'list_window_size')) endif " If focus changed, restore it (jump to the last window). diff --git a/doc/ale.txt b/doc/ale.txt index 4e1ae44..16e4ba9 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1151,6 +1151,16 @@ g:ale_linters_explicit *g:ale_linters_explicit* as possible, unless otherwise specified. +g:ale_list_vertical *g:ale_list_vertical* + *b:ale_list_vertical* + Type: |Number| + Default: `0` + + When set to `1`, this will cause ALE to open any windows (loclist or + quickfix) vertically instead of horizontally (|vert| |lopen|) or (|vert| + |copen|) + + g:ale_loclist_msg_format *g:ale_loclist_msg_format* b:ale_loclist_msg_format *b:ale_loclist_msg_format* @@ -1222,6 +1232,8 @@ g:ale_open_list *g:ale_open_list* The window size can be configured with |g:ale_list_window_size|. + Windows can be opened vertically with |g:ale_list_vertical|. + If you want to close the loclist window automatically when the buffer is closed, you can set up the following |autocmd| command: > diff --git a/plugin/ale.vim b/plugin/ale.vim index d75d33b..1a473df 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -118,6 +118,9 @@ let g:ale_open_list = get(g:, 'ale_open_list', 0) " This flag dictates if ale keeps open loclist even if there is no error in loclist let g:ale_keep_list_window_open = get(g:, 'ale_keep_list_window_open', 0) +" This flag dictates that quickfix windows should be opened vertically +let g:ale_list_vertical = get(g:, 'ale_list_vertical', 0) + " The window size to set for the quickfix and loclist windows call ale#Set('list_window_size', 10) diff --git a/test/test_ale_info.vader b/test/test_ale_info.vader index e20125a..05c045b 100644 --- a/test/test_ale_info.vader +++ b/test/test_ale_info.vader @@ -66,6 +66,7 @@ Before: \ 'let g:ale_linters = {}', \ 'let g:ale_linters_explicit = 0', \ 'let g:ale_list_window_size = 10', + \ 'let g:ale_list_vertical = 0', \ 'let g:ale_loclist_msg_format = ''%code: %%s''', \ 'let g:ale_max_buffer_history_size = 20', \ 'let g:ale_max_signs = -1', diff --git a/test/test_list_opening.vader b/test/test_list_opening.vader index 63b30ef..a24e8de 100644 --- a/test/test_list_opening.vader +++ b/test/test_list_opening.vader @@ -5,6 +5,7 @@ Before: Save g:ale_open_list Save g:ale_keep_list_window_open Save g:ale_list_window_size + Save g:ale_list_vertical Save g:ale_buffer_info Save g:ale_set_lists_synchronously @@ -13,6 +14,7 @@ Before: let g:ale_open_list = 0 let g:ale_keep_list_window_open = 0 let g:ale_list_window_size = 10 + let g:ale_list_vertical = 0 let g:ale_set_lists_synchronously = 1 let g:loclist = [ @@ -33,16 +35,29 @@ Before: return 0 endfunction + " If the window is vertical, window size should match column size/width + function GetQuickfixIsVertical(cols) abort + for l:win in range(1, winnr('$')) + if getwinvar(l:win, '&buftype') is# 'quickfix' + return winwidth(l:win) == a:cols + endif + endfor + + return 0 + endfunction + After: Restore unlet! g:loclist + unlet! b:ale_list_vertical unlet! b:ale_list_window_size unlet! b:ale_open_list unlet! b:ale_keep_list_window_open unlet! b:ale_save_event_fired delfunction GetQuickfixHeight + delfunction GetQuickfixIsVertical " Close quickfix window after every execute block lcl @@ -98,6 +113,24 @@ Execute(The quickfix window height should be correct for the loclist with buffer AssertEqual 8, GetQuickfixHeight() +Execute(The quickfix window should be vertical for the loclist with appropriate variables): + let g:ale_open_list = 1 + let b:ale_list_window_size = 8 + let b:ale_list_vertical = 1 + + call ale#list#SetLists(bufnr('%'), g:loclist) + + AssertEqual 1, GetQuickfixIsVertical(b:ale_list_window_size) + +Execute(The quickfix window should be horizontal for the loclist with appropriate variables): + let g:ale_open_list = 1 + let b:ale_list_window_size = 8 + let b:ale_list_vertical = 0 + + call ale#list#SetLists(bufnr('%'), g:loclist) + + AssertEqual 0, GetQuickfixIsVertical(b:ale_list_window_size) + Execute(The quickfix window should stay open for just the loclist): let g:ale_open_list = 1 let g:ale_keep_list_window_open = 1 @@ -167,6 +200,24 @@ Execute(The quickfix window height should be correct for the quickfix list with AssertEqual 8, GetQuickfixHeight() +Execute(The quickfix window should be vertical for the quickfix with appropriate variables): + let g:ale_open_list = 1 + let b:ale_list_window_size = 8 + let b:ale_list_vertical = 1 + + call ale#list#SetLists(bufnr('%'), g:loclist) + + AssertEqual 1, GetQuickfixIsVertical(b:ale_list_window_size) + +Execute(The quickfix window should be horizontal for the quickfix with appropriate variables): + let g:ale_open_list = 1 + let b:ale_list_window_size = 8 + let b:ale_list_vertical = 0 + + call ale#list#SetLists(bufnr('%'), g:loclist) + + AssertEqual 0, GetQuickfixIsVertical(b:ale_list_window_size) + Execute(The buffer ale_open_list option should be respected): let b:ale_open_list = 1 From 2c2c7ceb1d2f3de97ba8a40dd7858e83b6755fcd Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 2 Mar 2018 20:33:45 +0000 Subject: [PATCH 380/390] Fix #1384 - Handle warnings and suggestions for tsserver --- autoload/ale/lsp/response.vim | 8 ++++++ test/lsp/test_read_lsp_diagnostics.vader | 35 ++++++++++++++++++++++-- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/autoload/ale/lsp/response.vim b/autoload/ale/lsp/response.vim index 13219ef..5a43128 100644 --- a/autoload/ale/lsp/response.vim +++ b/autoload/ale/lsp/response.vim @@ -59,6 +59,14 @@ function! ale#lsp#response#ReadTSServerDiagnostics(response) abort let l:loclist_item.nr = l:diagnostic.code endif + if get(l:diagnostic, 'category') is# 'warning' + let l:loclist_item.type = 'W' + endif + + if get(l:diagnostic, 'category') is# 'suggestion' + let l:loclist_item.type = 'I' + endif + call add(l:loclist, l:loclist_item) endfor diff --git a/test/lsp/test_read_lsp_diagnostics.vader b/test/lsp/test_read_lsp_diagnostics.vader index 3e63741..444272a 100644 --- a/test/lsp/test_read_lsp_diagnostics.vader +++ b/test/lsp/test_read_lsp_diagnostics.vader @@ -121,7 +121,8 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle multiple messages): \ ]}}) Execute(ale#lsp#response#ReadTSServerDiagnostics() should handle tsserver responses): - AssertEqual [ + AssertEqual + \ [ \ { \ 'type': 'E', \ 'nr': 2365, @@ -131,5 +132,35 @@ Execute(ale#lsp#response#ReadTSServerDiagnostics() should handle tsserver respon \ 'end_lnum': 1, \ 'end_col': 17, \ }, - \], + \ ], \ ale#lsp#response#ReadTSServerDiagnostics({"seq":0,"type":"event","event":"semanticDiag","body":{"file":"/bar/foo.ts","diagnostics":[{"start":{"line":1,"offset":11},"end":{"line":1,"offset":17},"text":"Operator ''+'' cannot be applied to types ''3'' and ''{}''.","code":2365}]}}) + +Execute(ale#lsp#response#ReadTSServerDiagnostics() should handle warnings from tsserver): + AssertEqual + \ [ + \ { + \ 'lnum': 27, + \ 'col': 3, + \ 'nr': 2515, + \ 'end_lnum': 27, + \ 'type': 'W', + \ 'end_col': 14, + \ 'text': 'Calls to ''console.log'' are not allowed. (no-console)', + \ } + \ ], + \ ale#lsp#response#ReadTSServerDiagnostics({"seq":0,"type":"event","event":"semanticDiag","body":{"file":"","diagnostics":[{"start":{"line":27,"offset":3},"end":{"line":27,"offset":14},"text":"Calls to 'console.log' are not allowed. (no-console)","code":2515,"category":"warning","source":"tslint"}]}}) + +Execute(ale#lsp#response#ReadTSServerDiagnostics() should handle suggestions from tsserver): + AssertEqual + \ [ + \ { + \ 'lnum': 27, + \ 'col': 3, + \ 'nr': 2515, + \ 'end_lnum': 27, + \ 'type': 'I', + \ 'end_col': 14, + \ 'text': 'Some info', + \ } + \ ], + \ ale#lsp#response#ReadTSServerDiagnostics({"seq":0,"type":"event","event":"semanticDiag","body":{"file":"","diagnostics":[{"start":{"line":27,"offset":3},"end":{"line":27,"offset":14},"text":"Some info","code":2515,"category":"suggestion","source":"tslint"}]}}) From 540952ca8e46d7be064b020d8ff308b205e7920c Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 2 Mar 2018 20:47:13 +0000 Subject: [PATCH 381/390] Try to fix a test which is failing on Windows --- test/handler/test_mcsc_handler.vader | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/test/handler/test_mcsc_handler.vader b/test/handler/test_mcsc_handler.vader index ac55ee8..6d6c4ba 100644 --- a/test/handler/test_mcsc_handler.vader +++ b/test/handler/test_mcsc_handler.vader @@ -3,10 +3,14 @@ Before: unlet! g:ale_cs_mcsc_source + call ale#test#SetDirectory('/testplugin/test/handler') + runtime ale_linters/cs/mcsc.vim After: unlet! g:ale_cs_mcsc_source + + call ale#test#RestoreDirectory() call ale#linter#Reset() Execute(The mcs handler should work with the default of the buffer's directory): @@ -18,7 +22,7 @@ Execute(The mcs handler should work with the default of the buffer's directory): \ 'text': '; expected', \ 'code': 'CS1001', \ 'type': 'E', - \ 'filename': ale#path#Simplify(expand('%:p:h') . '/Test.cs'), + \ 'filename': ale#path#Simplify(g:dir . '/Test.cs'), \ }, \ ], \ ale_linters#cs#mcsc#Handle(347, [ From b6bf6ecdbc692f05f0f89eee31018c2d659b35aa Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 2 Mar 2018 20:57:55 +0000 Subject: [PATCH 382/390] Try to fix it again --- ale_linters/cs/mcsc.vim | 2 +- test/handler/test_mcsc_handler.vader | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/ale_linters/cs/mcsc.vim b/ale_linters/cs/mcsc.vim index f16e4b4..8a78d3b 100644 --- a/ale_linters/cs/mcsc.vim +++ b/ale_linters/cs/mcsc.vim @@ -10,7 +10,7 @@ function! s:GetWorkingDirectory(buffer) abort return l:working_directory endif - return fnamemodify(bufname(a:buffer), ':p:h') + return expand('#' . a:buffer . ':p:h') endfunction function! ale_linters#cs#mcsc#GetCommand(buffer) abort diff --git a/test/handler/test_mcsc_handler.vader b/test/handler/test_mcsc_handler.vader index 6d6c4ba..8ae4735 100644 --- a/test/handler/test_mcsc_handler.vader +++ b/test/handler/test_mcsc_handler.vader @@ -4,6 +4,7 @@ Before: unlet! g:ale_cs_mcsc_source call ale#test#SetDirectory('/testplugin/test/handler') + call ale#test#SetFilename('Test.cs') runtime ale_linters/cs/mcsc.vim @@ -25,7 +26,7 @@ Execute(The mcs handler should work with the default of the buffer's directory): \ 'filename': ale#path#Simplify(g:dir . '/Test.cs'), \ }, \ ], - \ ale_linters#cs#mcsc#Handle(347, [ + \ ale_linters#cs#mcsc#Handle(bufnr(''), [ \ 'Test.cs(12,29): error CS1001: ; expected', \ 'Compilation failed: 2 error(s), 1 warnings', \ ]) @@ -60,7 +61,7 @@ Execute(The mcs handler should handle cannot find symbol errors): \ 'filename': ale#path#Simplify('/home/foo/project/bar/Test.cs'), \ }, \ ], - \ ale_linters#cs#mcsc#Handle(347, [ + \ ale_linters#cs#mcsc#Handle(bufnr(''), [ \ 'Test.cs(12,29): error CS1001: ; expected', \ 'Test.cs(101,0): error CS1028: Unexpected processor directive (no #if for this #endif)', \ 'Test.cs(10,12): warning CS0123: some warning', From 8a772905539ccfe306219addae5a506def88fe44 Mon Sep 17 00:00:00 2001 From: Olaf Alders Date: Fri, 2 Mar 2018 16:04:52 -0500 Subject: [PATCH 383/390] [WIP] Begin to distinguish between Perl warnings and errors (#933) * If a Perl script compiles, there are only warnings and no errors * Let the first Perl error or warning win. Take the following example: *** sub foo { my $thing; *** This might have the following messages when we compile it: Missing right curly or square bracket at warning.pl line 7, at end of line syntax error at warning.pl line 7, at EOF warning.pl had compilation errors. With the current behaviour, we just get a "syntax error" message, which isn't all that helpful. With this patch we get "Missing right curly or square bracket". * Fix variable scope and pattern matching syntax * Use named variable to enhance clarity when matching Perl output * Add more tests for Perl linter * Remove unnecessary parens * Simplify check for pattern match --- ale_linters/perl/perl.vim | 14 ++++++++-- test/handler/test_perl_handler.vader | 39 ++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 2 deletions(-) diff --git a/ale_linters/perl/perl.vim b/ale_linters/perl/perl.vim index fcc88f3..1b9aa95 100644 --- a/ale_linters/perl/perl.vim +++ b/ale_linters/perl/perl.vim @@ -27,12 +27,20 @@ function! ale_linters#perl#perl#Handle(buffer, lines) abort let l:output = [] let l:basename = expand('#' . a:buffer . ':t') + let l:type = 'E' + if a:lines[-1] =~# 'syntax OK' + let l:type = 'W' + endif + + let l:seen = {} + for l:match in ale#util#GetMatches(a:lines, l:pattern) let l:line = l:match[3] + let l:file = l:match[2] let l:text = l:match[1] - let l:type = 'E' - if ale#path#IsBufferPath(a:buffer, l:match[2]) + if ale#path#IsBufferPath(a:buffer, l:file) + \ && !has_key(l:seen,l:line) \ && ( \ l:text isnot# 'BEGIN failed--compilation aborted' \ || empty(l:output) @@ -43,6 +51,8 @@ function! ale_linters#perl#perl#Handle(buffer, lines) abort \ 'text': l:text, \ 'type': l:type, \}) + + let l:seen[l:line] = 1 endif endfor diff --git a/test/handler/test_perl_handler.vader b/test/handler/test_perl_handler.vader index 75e8f22..c5791d7 100644 --- a/test/handler/test_perl_handler.vader +++ b/test/handler/test_perl_handler.vader @@ -47,3 +47,42 @@ Execute(The Perl linter should complain about failing to locate modules): \ 'Unable to build `ro` accessor for slot `path` in `App::CPANFileUpdate` because the slot cannot be found. at /extlib/Method/Traits.pm line 189.', \ 'BEGIN failed--compilation aborted at - line 10.', \ ]) + +Execute(The Perl linter should not report warnings as errors): + AssertEqual + \ [ + \ {'lnum': '5', 'type': 'W', 'text': '"my" variable $foo masks earlier declaration in same scope'}, + \ ], + \ ale_linters#perl#perl#Handle(bufnr(''), [ + \ '"my" variable $foo masks earlier declaration in same scope at - line 5.', + \ 't.pl syntax OK', + \ ]) + +Execute(The Perl linter does not default to reporting generic error): + AssertEqual + \ [ + \ {'lnum': '8', 'type': 'E', 'text': 'Missing right curly or square bracket'}, + \ ], + \ ale_linters#perl#perl#Handle(bufnr(''), [ + \ 'Missing right curly or square bracket at - line 8, at end of line', + \ 'syntax error at - line 8, at EOF', + \ 'Execution of t.pl aborted due to compilation errors.', + \ ]) + +" The first "error" is actually a warning, but the current implementation +" doesn't have a good way of teasing out the warnings from amongst the +" errors. If we're able to do this in future, then we'll want to switch +" the first "E" to a "W". + +Execute(The Perl linter reports errors even when mixed with warnings): + AssertEqual + \ [ + \ {'lnum': '5', 'type': 'E', 'text': '"my" variable $foo masks earlier declaration in same scope'}, + \ {'lnum': '8', 'type': 'E', 'text': 'Missing right curly or square bracket'}, + \ ], + \ ale_linters#perl#perl#Handle(bufnr(''), [ + \ '"my" variable $foo masks earlier declaration in same scope at - line 5.', + \ 'Missing right curly or square bracket at - line 8, at end of line', + \ 'syntax error at - line 8, at EOF', + \ 'Execution of t.pl aborted due to compilation errors.', + \ ]) From 565ffa0dc5e2fe53663f7228c05ad927c190b9e6 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 3 Mar 2018 13:27:19 +0000 Subject: [PATCH 384/390] Use the configured mdl executable, escape it in the command, and add test for it --- ale_linters/markdown/mdl.vim | 22 +++++++++------ .../test_markdown_mdl_command_callback.vader | 28 +++++++++++++++++++ 2 files changed, 41 insertions(+), 9 deletions(-) create mode 100644 test/command_callback/test_markdown_mdl_command_callback.vader diff --git a/ale_linters/markdown/mdl.vim b/ale_linters/markdown/mdl.vim index 9bb2031..16b08cc 100644 --- a/ale_linters/markdown/mdl.vim +++ b/ale_linters/markdown/mdl.vim @@ -4,6 +4,18 @@ call ale#Set('markdown_mdl_executable', 'mdl') call ale#Set('markdown_mdl_options', '') +function! ale_linters#markdown#mdl#GetExecutable(buffer) abort + return ale#Var(a:buffer, 'markdown_mdl_executable') +endfunction + +function! ale_linters#markdown#mdl#GetCommand(buffer) abort + let l:executable = ale_linters#markdown#mdl#GetExecutable(a:buffer) + let l:options = ale#Var(a:buffer, 'markdown_mdl_options') + + return ale#Escape(l:executable) + \ . (!empty(l:options) ? ' ' . l:options : '') +endfunction + function! ale_linters#markdown#mdl#Handle(buffer, lines) abort " matches: '(stdin):173: MD004 Unordered list style' let l:pattern = ':\(\d*\): \(.*\)$' @@ -20,17 +32,9 @@ function! ale_linters#markdown#mdl#Handle(buffer, lines) abort return l:output endfunction -function! ale_linters#markdown#mdl#GetCommand(buffer) abort - let l:executable = ale#Var(a:buffer, 'markdown_mdl_executable') - let l:options = ale#Var(a:buffer, 'markdown_mdl_options') - - return l:executable . (!empty(l:options) ? ' ' . l:options : '') -endfunction - - call ale#linter#Define('markdown', { \ 'name': 'mdl', -\ 'executable': 'mdl', +\ 'executable_callback': 'ale_linters#markdown#mdl#GetExecutable', \ 'command_callback': 'ale_linters#markdown#mdl#GetCommand', \ 'callback': 'ale_linters#markdown#mdl#Handle' \}) diff --git a/test/command_callback/test_markdown_mdl_command_callback.vader b/test/command_callback/test_markdown_mdl_command_callback.vader new file mode 100644 index 0000000..3a68a4b --- /dev/null +++ b/test/command_callback/test_markdown_mdl_command_callback.vader @@ -0,0 +1,28 @@ +Before: + Save g:ale_markdown_mdl_executable + Save g:ale_markdown_mdl_options + + unlet! g:ale_markdown_mdl_executable + unlet! g:ale_markdown_mdl_options + + runtime ale_linters/markdown/mdl.vim + +After: + Restore + + call ale#linter#Reset() + +Execute(The default command should be correct): + AssertEqual ale_linters#markdown#mdl#GetExecutable(bufnr('')), 'mdl' + AssertEqual + \ ale_linters#markdown#mdl#GetCommand(bufnr('')), + \ ale#Escape('mdl') + +Execute(The executable and options should be configurable): + let g:ale_markdown_mdl_executable = 'foo bar' + let g:ale_markdown_mdl_options = '--wat' + + AssertEqual ale_linters#markdown#mdl#GetExecutable(bufnr('')), 'foo bar' + AssertEqual + \ ale_linters#markdown#mdl#GetCommand(bufnr('')), + \ ale#Escape('foo bar') . ' --wat' From 08cfd5f90c8113f4db25f60833b690665046b495 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 3 Mar 2018 16:22:56 +0000 Subject: [PATCH 385/390] Close #1379 - Increment b:ale_linted when a buffer is checked --- autoload/ale/engine.vim | 6 ++++++ doc/ale.txt | 13 +++++++++++++ test/test_alelint_autocmd.vader | 21 +++++++++++++++++++-- 3 files changed, 38 insertions(+), 2 deletions(-) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 9ef3ba3..6ccc3a3 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -321,6 +321,12 @@ function! ale#engine#SetResults(buffer, loclist) abort " Reset the save event marker, used for opening windows, etc. call setbufvar(a:buffer, 'ale_save_event_fired', 0) + " Set a marker showing how many times a buffer has been checked. + call setbufvar( + \ a:buffer, + \ 'ale_linted', + \ getbufvar(a:buffer, 'ale_linted', 0) + 1 + \) " Automatically remove all managed temporary files and directories " now that all jobs have completed. diff --git a/doc/ale.txt b/doc/ale.txt index adcdccd..95c3c0e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2280,6 +2280,19 @@ ale#statusline#Count(buffer) *ale#statusline#Count()* `total` -> The total number of problems. +b:ale_linted *b:ale_linted* + + `b:ale_linted` is set to the number of times a buffer has been checked by + ALE after all linters for one lint cycle have finished checking a buffer. + This variable may not be defined until ALE first checks a buffer, so it + should be accessed with |get()| or |getbufvar()|. For example: > + + " Print a message indicating how many times ALE has checked this buffer. + echo 'ALE has checked this buffer ' . get(b:, 'ale_linted') . ' time(s).' + " Print 'checked' using getbufvar() if a buffer has been checked. + echo getbufvar(bufnr(''), 'ale_linted', 0) > 0 ? 'checked' : 'not checked' +< + ALELintPre *ALELintPre-autocmd* ALELintPost *ALELintPost-autocmd* diff --git a/test/test_alelint_autocmd.vader b/test/test_alelint_autocmd.vader index b19e6b4..d51694f 100644 --- a/test/test_alelint_autocmd.vader +++ b/test/test_alelint_autocmd.vader @@ -3,12 +3,18 @@ Before: let g:post_success = 0 let g:ale_run_synchronously = 1 + unlet! b:ale_linted + After: let g:ale_run_synchronously = 0 let g:ale_buffer_info = {} - augroup! VaderTest -Execute (Run a lint cycle, and check that a variable is set in the autocmd): + try + augroup! VaderTest + catch + endtry + +Execute(Run a lint cycle, and check that a variable is set in the autocmd): augroup VaderTest autocmd! autocmd User ALELintPre let g:pre_success = 1 @@ -19,3 +25,14 @@ Execute (Run a lint cycle, and check that a variable is set in the autocmd): AssertEqual g:pre_success, 1 AssertEqual g:post_success, 1 + +Execute(b:ale_linted should be increased after each lint cycle): + AssertEqual get(b:, 'ale_linted'), 0 + + call ale#Lint() + + AssertEqual get(b:, 'ale_linted'), 1 + + call ale#Lint() + + AssertEqual get(b:, 'ale_linted'), 2 From f476c28b296ccd6322067756c5215707ee57f408 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 3 Mar 2018 17:50:09 +0000 Subject: [PATCH 386/390] Add deprecation warnings for old NeoVim versions and old functions --- autoload/ale/statusline.vim | 5 +++++ plugin/ale.vim | 15 +++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/autoload/ale/statusline.vim b/autoload/ale/statusline.vim index a073f7a..adb35e7 100644 --- a/autoload/ale/statusline.vim +++ b/autoload/ale/statusline.vim @@ -95,6 +95,11 @@ endfunction " This function is deprecated, and should not be used. Use the airline plugin " instead, or write your own status function with ale#statusline#Count() function! ale#statusline#Status() abort + if !get(g:, 'ale_deprecation_ale_statusline_status', 0) + echom 'ale#statusline#Status() is deprecated, use ale#statusline#Count() to write your own function.' + let g:ale_deprecation_ale_statusline_status = 1 + endif + if !exists('g:ale_statusline_format') return 'OK' endif diff --git a/plugin/ale.vim b/plugin/ale.vim index 1a473df..0ca7617 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -32,6 +32,11 @@ if !s:has_features finish endif +if has('nvim') && !has('nvim-0.2.0') && !get(g:, 'ale_use_deprecated_neovim') + echom 'ALE support for NeoVim versions below 0.2.0 is deprecated.' + echom 'Use `let g:ale_use_deprecated_neovim = 1` to silence this warning for now.' +endif + " This flag can be set to 0 to disable emitting conflict warnings. let g:ale_emit_conflict_warnings = get(g:, 'ale_emit_conflict_warnings', 1) @@ -298,9 +303,19 @@ augroup END " Backwards Compatibility function! ALELint(delay) abort + if !get(g:, 'ale_deprecation_ale_lint', 0) + echom 'ALELint() is deprecated, use ale#Queue() instead.' + let g:ale_deprecation_ale_lint = 1 + endif + call ale#Queue(a:delay) endfunction function! ALEGetStatusLine() abort + if !get(g:, 'ale_deprecation_ale_get_status_line', 0) + echom 'ALEGetStatusLine() is deprecated.' + let g:ale_deprecation_ale_get_status_line = 1 + endif + return ale#statusline#Status() endfunction From 193a4b9336e8e108b1e936a5aedb252253688616 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 3 Mar 2018 18:13:57 +0000 Subject: [PATCH 387/390] Satisfy my own checks --- autoload/ale/statusline.vim | 2 +- plugin/ale.vim | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/autoload/ale/statusline.vim b/autoload/ale/statusline.vim index adb35e7..3f53368 100644 --- a/autoload/ale/statusline.vim +++ b/autoload/ale/statusline.vim @@ -96,7 +96,7 @@ endfunction " instead, or write your own status function with ale#statusline#Count() function! ale#statusline#Status() abort if !get(g:, 'ale_deprecation_ale_statusline_status', 0) - echom 'ale#statusline#Status() is deprecated, use ale#statusline#Count() to write your own function.' + execute 'echom ''ale#statusline#Status() is deprecated, use ale#statusline#Count() to write your own function.''' let g:ale_deprecation_ale_statusline_status = 1 endif diff --git a/plugin/ale.vim b/plugin/ale.vim index 0ca7617..69c0849 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -33,8 +33,8 @@ if !s:has_features endif if has('nvim') && !has('nvim-0.2.0') && !get(g:, 'ale_use_deprecated_neovim') - echom 'ALE support for NeoVim versions below 0.2.0 is deprecated.' - echom 'Use `let g:ale_use_deprecated_neovim = 1` to silence this warning for now.' + execute 'echom ''ALE support for NeoVim versions below 0.2.0 is deprecated.''' + execute 'echom ''Use `let g:ale_use_deprecated_neovim = 1` to silence this warning for now.''' endif " This flag can be set to 0 to disable emitting conflict warnings. @@ -304,7 +304,7 @@ augroup END function! ALELint(delay) abort if !get(g:, 'ale_deprecation_ale_lint', 0) - echom 'ALELint() is deprecated, use ale#Queue() instead.' + execute 'echom ''ALELint() is deprecated, use ale#Queue() instead.''' let g:ale_deprecation_ale_lint = 1 endif @@ -313,7 +313,7 @@ endfunction function! ALEGetStatusLine() abort if !get(g:, 'ale_deprecation_ale_get_status_line', 0) - echom 'ALEGetStatusLine() is deprecated.' + execute 'echom ''ALEGetStatusLine() is deprecated.''' let g:ale_deprecation_ale_get_status_line = 1 endif From b7363bef7d8bdd553f10a6a168f4cd814616f6f9 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sun, 4 Mar 2018 11:50:39 +0000 Subject: [PATCH 388/390] Update the licence year. --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 650050f..739ccae 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2016-2017, w0rp +Copyright (c) 2016-2018, w0rp All rights reserved. Redistribution and use in source and binary forms, with or without From 0a0535546f4d9a0dfe02671630fdaba72ea5828d Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 6 Mar 2018 10:23:49 +0000 Subject: [PATCH 389/390] Add a command for stopping all LSP clients --- autoload/ale/definition.vim | 4 ++ autoload/ale/engine.vim | 13 +++-- autoload/ale/lsp.vim | 14 ++++++ autoload/ale/lsp/reset.vim | 25 ++++++++++ doc/ale.txt | 9 ++++ plugin/ale.vim | 2 + test/lsp/test_reset_lsp.vader | 90 +++++++++++++++++++++++++++++++++++ 7 files changed, 153 insertions(+), 4 deletions(-) create mode 100644 autoload/ale/lsp/reset.vim create mode 100644 test/lsp/test_reset_lsp.vader diff --git a/autoload/ale/definition.vim b/autoload/ale/definition.vim index b20c01a..521cd0b 100644 --- a/autoload/ale/definition.vim +++ b/autoload/ale/definition.vim @@ -19,6 +19,10 @@ function! ale#definition#Execute(expr) abort execute a:expr endfunction +function! ale#definition#ClearLSPData() abort + let s:go_to_definition_map = {} +endfunction + function! ale#definition#Open(options, filename, line, column) abort if a:options.open_in_tab call ale#definition#Execute('tabedit ' . fnameescape(a:filename)) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 6ccc3a3..8916987 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -76,6 +76,11 @@ function! ale#engine#InitBufferInfo(buffer) abort return 0 endfunction +" Clear LSP linter data for the linting engine. +function! ale#engine#ClearLSPData() abort + let s:lsp_linter_map = {} +endfunction + " This function is documented and part of the public API. " " Return 1 if ALE is busy checking a given buffer @@ -144,7 +149,7 @@ function! s:GatherOutput(job_id, line) abort endif endfunction -function! s:HandleLoclist(linter_name, buffer, loclist) abort +function! ale#engine#HandleLoclist(linter_name, buffer, loclist) abort let l:info = get(g:ale_buffer_info, a:buffer, {}) if empty(l:info) @@ -223,7 +228,7 @@ function! s:HandleExit(job_id, exit_code) abort let l:loclist = ale#util#GetFunction(l:linter.callback)(l:buffer, l:output) - call s:HandleLoclist(l:linter.name, l:buffer, l:loclist) + call ale#engine#HandleLoclist(l:linter.name, l:buffer, l:loclist) endfunction function! s:HandleLSPDiagnostics(conn_id, response) abort @@ -237,7 +242,7 @@ function! s:HandleLSPDiagnostics(conn_id, response) abort let l:loclist = ale#lsp#response#ReadDiagnostics(a:response) - call s:HandleLoclist(l:linter_name, l:buffer, l:loclist) + call ale#engine#HandleLoclist(l:linter_name, l:buffer, l:loclist) endfunction function! s:HandleTSServerDiagnostics(response, error_type) abort @@ -262,7 +267,7 @@ function! s:HandleTSServerDiagnostics(response, error_type) abort let l:loclist = get(l:info, 'semantic_loclist', []) \ + get(l:info, 'syntax_loclist', []) - call s:HandleLoclist('tsserver', l:buffer, l:loclist) + call ale#engine#HandleLoclist('tsserver', l:buffer, l:loclist) endfunction function! s:HandleLSPErrorMessage(error_message) abort diff --git a/autoload/ale/lsp.vim b/autoload/ale/lsp.vim index 126d6c1..8db9348 100644 --- a/autoload/ale/lsp.vim +++ b/autoload/ale/lsp.vim @@ -325,6 +325,20 @@ function! ale#lsp#ConnectToAddress(address, project_root, callback) abort return 1 endfunction +" Stop all LSP connections, closing all jobs and channels, and removing any +" queued messages. +function! ale#lsp#StopAll() abort + for l:conn in s:connections + if has_key(l:conn, 'channel') + call ch_close(l:conn.channel) + else + call ale#job#Stop(l:conn.id) + endif + endfor + + let s:connections = [] +endfunction + function! s:SendMessageData(conn, data) abort if has_key(a:conn, 'executable') call ale#job#SendRaw(a:conn.id, a:data) diff --git a/autoload/ale/lsp/reset.vim b/autoload/ale/lsp/reset.vim new file mode 100644 index 0000000..c206ed0 --- /dev/null +++ b/autoload/ale/lsp/reset.vim @@ -0,0 +1,25 @@ +" Stop all LSPs and remove all of the data for them. +function! ale#lsp#reset#StopAllLSPs() abort + call ale#lsp#StopAll() + + if exists('*ale#definition#ClearLSPData') + " Clear the mapping for connections, etc. + call ale#definition#ClearLSPData() + endif + + if exists('*ale#engine#ClearLSPData') + " Clear the mapping for connections, etc. + call ale#engine#ClearLSPData() + + " Remove the problems for all of the LSP linters in every buffer. + for l:buffer_string in keys(g:ale_buffer_info) + let l:buffer = str2nr(l:buffer_string) + + for l:linter in ale#linter#Get(getbufvar(l:buffer, '&filetype')) + if !empty(l:linter.lsp) + call ale#engine#HandleLoclist(l:linter.name, l:buffer, []) + endif + endfor + endfor + endif +endfunction diff --git a/doc/ale.txt b/doc/ale.txt index 95c3c0e..2e98cd7 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1871,6 +1871,15 @@ ALEResetBuffer *ALEResetBuffer* |ALEDisableBuffer|. +ALEStopAllLSPs *ALEStopAllLSPs* + + `ALEStopAllLSPs` will close and stop all channels and jobs for all LSP-like + clients, including tsserver, remove all of the data stored for them, and + delete all of the problems found for them, updating every linted buffer. + + This command can be used when LSP clients mess up and need to be restarted. + + =============================================================================== 9. API *ale-api* diff --git a/plugin/ale.vim b/plugin/ale.vim index 69c0849..1aa3582 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -249,6 +249,8 @@ command! -bar ALEToggleBuffer :call ale#toggle#ToggleBuffer(bufnr('')) command! -bar ALEEnableBuffer :call ale#toggle#EnableBuffer(bufnr('')) command! -bar ALEDisableBuffer :call ale#toggle#DisableBuffer(bufnr('')) command! -bar ALEResetBuffer :call ale#toggle#ResetBuffer(bufnr('')) +" A command to stop all LSP-like clients, including tsserver. +command! -bar ALEStopAllLSPs :call ale#lsp#reset#StopAllLSPs() " A command for linting manually. command! -bar ALELint :call ale#Queue(0, 'lint_file') diff --git a/test/lsp/test_reset_lsp.vader b/test/lsp/test_reset_lsp.vader new file mode 100644 index 0000000..2bec13d --- /dev/null +++ b/test/lsp/test_reset_lsp.vader @@ -0,0 +1,90 @@ +Before: + Save g:ale_enabled + Save g:ale_set_signs + Save g:ale_set_quickfix + Save g:ale_set_loclist + Save g:ale_set_highlights + Save g:ale_echo_cursor + + let g:ale_enabled = 0 + let g:ale_set_signs = 0 + let g:ale_set_quickfix = 0 + let g:ale_set_loclist = 0 + let g:ale_set_highlights = 0 + let g:ale_echo_cursor = 0 + + function EmptyString() abort + return '' + endfunction + + call ale#engine#InitBufferInfo(bufnr('')) + + call ale#linter#Define('testft', { + \ 'name': 'lsplinter', + \ 'lsp': 'tsserver', + \ 'executable_callback': 'EmptyString', + \ 'command_callback': 'EmptyString', + \ 'project_root_callback': 'EmptyString', + \ 'language_callback': 'EmptyString', + \}) + + call ale#linter#Define('testft', { + \ 'name': 'otherlinter', + \ 'callback': 'TestCallback', + \ 'executable': has('win32') ? 'cmd': 'true', + \ 'command': 'true', + \ 'read_buffer': 0, + \}) + +After: + Restore + + unlet! b:ale_save_event_fired + + delfunction EmptyString + call ale#linter#Reset() + +Given testft(Some file with an imaginary filetype): +Execute(ALEStopAllLSPs should clear the loclist): + let g:ale_buffer_info[bufnr('')].loclist = [ + \ { + \ 'text': 'a', + \ 'lnum': 10, + \ 'col': 0, + \ 'bufnr': bufnr(''), + \ 'vcol': 0, + \ 'type': 'E', + \ 'nr': -1, + \ 'linter_name': 'lsplinter', + \ }, + \ { + \ 'text': 'a', + \ 'lnum': 10, + \ 'col': 0, + \ 'bufnr': bufnr(''), + \ 'vcol': 0, + \ 'type': 'E', + \ 'nr': -1, + \ 'linter_name': 'otherlinter', + \ }, + \] + let g:ale_buffer_info[bufnr('')].active_linter_list = ['lsplinter', 'otherlinter'] + + ALEStopAllLSPs + + " The loclist should be updated. + AssertEqual g:ale_buffer_info[bufnr('')].loclist, [ + \ { + \ 'text': 'a', + \ 'lnum': 10, + \ 'col': 0, + \ 'bufnr': bufnr(''), + \ 'vcol': 0, + \ 'type': 'E', + \ 'nr': -1, + \ 'linter_name': 'otherlinter', + \ }, + \] + + " The LSP linter should be removed from the active linter list. + AssertEqual g:ale_buffer_info[bufnr('')].active_linter_list, ['otherlinter'] From 80ef6ef6a7f1fba7f3dbc770e1807b04caeb3ae4 Mon Sep 17 00:00:00 2001 From: Josh Sherman Date: Tue, 6 Mar 2018 23:27:59 -0600 Subject: [PATCH 390/390] Find executable for `shellcheck` Wanted to be able to use `shellcheck` that was installed in node_modules. --- ale_linters/sh/shellcheck.vim | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/ale_linters/sh/shellcheck.vim b/ale_linters/sh/shellcheck.vim index 27c7453..ac66892 100644 --- a/ale_linters/sh/shellcheck.vim +++ b/ale_linters/sh/shellcheck.vim @@ -12,11 +12,16 @@ let g:ale_sh_shellcheck_exclusions = let g:ale_sh_shellcheck_executable = \ get(g:, 'ale_sh_shellcheck_executable', 'shellcheck') +let g:ale_sh_shellcheck_use_global = +\ get(g:, 'ale_sh_shellcheck_use_global', 0) + let g:ale_sh_shellcheck_options = \ get(g:, 'ale_sh_shellcheck_options', '') function! ale_linters#sh#shellcheck#GetExecutable(buffer) abort - return ale#Var(a:buffer, 'sh_shellcheck_executable') + return ale#node#FindExecutable(a:buffer, 'sh_shellcheck', [ + \ 'node_modules/.bin/shellcheck', + \]) endfunction function! ale_linters#sh#shellcheck#GetDialectArgument(buffer) abort