summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrandon Maier <brandon.maier@collins.com>2024-02-21 20:11:56 -0600
committerGitHub <noreply@github.com>2024-02-22 11:11:56 +0900
commit38c31302da0414c74cabfc6fbefc5d1bf5183fc1 (patch)
tree3adc26fc9296757368108fe34aa82d76634c5598
parent506d392f6a72a2a494f9575c087e2f518811a534 (diff)
downloadale-38c31302da0414c74cabfc6fbefc5d1bf5183fc1.zip
Add wiki link to ShellCheck linting (#4681)
The ShellCheck integrations wiki suggests providing users with more info by linking back to the ShellCheck wiki. https://www.shellcheck.net/wiki/Integration#linking-to-the-wiki
-rw-r--r--autoload/ale/handlers/shellcheck.vim1
-rw-r--r--test/handler/test_shellcheck_handler.vader3
2 files changed, 4 insertions, 0 deletions
diff --git a/autoload/ale/handlers/shellcheck.vim b/autoload/ale/handlers/shellcheck.vim
index c2514d59..002c4651 100644
--- a/autoload/ale/handlers/shellcheck.vim
+++ b/autoload/ale/handlers/shellcheck.vim
@@ -140,6 +140,7 @@ function! s:HandleShellcheckGCC(buffer, lines) abort
\ 'type': l:type,
\ 'text': l:match[5],
\ 'code': l:match[6],
+ \ 'detail': l:match[5] . "\n\nFor more information:\n https://www.shellcheck.net/wiki/" . 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 7d9e620b..e5c972d7 100644
--- a/test/handler/test_shellcheck_handler.vader
+++ b/test/handler/test_shellcheck_handler.vader
@@ -13,6 +13,7 @@ Execute(The shellcheck handler should handle basic errors or warnings <0.7.0):
\ 'type': 'W',
\ 'text': 'In POSIX sh, ''let'' is not supported.',
\ 'code': 'SC2039',
+ \ 'detail': 'In POSIX sh, ''let'' is not supported.' . "\n\nFor more information:\n https://www.shellcheck.net/wiki/" . 'SC2039',
\ },
\ {
\ 'lnum': 2,
@@ -20,6 +21,7 @@ Execute(The shellcheck handler should handle basic errors or warnings <0.7.0):
\ 'type': 'E',
\ 'text': 'Don''t put spaces around the = in assignments.',
\ 'code': 'SC1068',
+ \ 'detail': 'Don''t put spaces around the = in assignments.' . "\n\nFor more information:\n https://www.shellcheck.net/wiki/" . 'SC1068',
\ },
\ ],
\ ale#handlers#shellcheck#Handle(bufnr(''), [0, 6, 0], [
@@ -36,6 +38,7 @@ Execute(The shellcheck handler should handle notes <0.7.0):
\ 'type': 'I',
\ 'text': 'Double quote to prevent globbing and word splitting.',
\ 'code': 'SC2086',
+ \ 'detail': 'Double quote to prevent globbing and word splitting.' . "\n\nFor more information:\n https://www.shellcheck.net/wiki/" . 'SC2086',
\ },
\ ],
\ ale#handlers#shellcheck#Handle(bufnr(''), [0, 6, 0], [