From e2a8f759d870ed7a1f0ee4698a73b65e9f36e54d Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Tue, 5 Dec 2017 03:42:36 +0900 Subject: [PATCH] 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 f1abfc83..375a8b0f 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 912396cb..93a541c8 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 603ba22d..703040e2 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)', \ ])