From 21f1ab6ffc5ea958d558a5d9f5b0e5ab9110ee4e Mon Sep 17 00:00:00 2001
From: Chuck Grindel <chuck.grindel@gmail.com>
Date: Tue, 27 Jun 2023 03:52:25 -0600
Subject: feat: support Bazel `buildifier` linter (#4529)

* Initial buildifier linter files

* Add handler test

* Fix test when options are not set
---
 ale_linters/bzl/buildifier.vim                | 40 +++++++++++++++++++++++++++
 test/handler/test_buildifier_handler.vader    | 26 +++++++++++++++++
 test/linter/test_bzl_buildifier.vader         | 30 ++++++++++++++++++++
 test/test-files/bzl/bazel-package/BUILD.bazel |  0
 4 files changed, 96 insertions(+)
 create mode 100644 ale_linters/bzl/buildifier.vim
 create mode 100644 test/handler/test_buildifier_handler.vader
 create mode 100644 test/linter/test_bzl_buildifier.vader
 create mode 100644 test/test-files/bzl/bazel-package/BUILD.bazel

diff --git a/ale_linters/bzl/buildifier.vim b/ale_linters/bzl/buildifier.vim
new file mode 100644
index 00000000..42cd3cd9
--- /dev/null
+++ b/ale_linters/bzl/buildifier.vim
@@ -0,0 +1,40 @@
+" Author: Chuck Grindel <chuck.grindel@gmail.com>
+" Description: Bazel Starlark lint support using buildifier.
+
+function! ale_linters#bzl#buildifier#GetCommand(buffer) abort
+    let l:executable = ale#Escape(ale#fixers#buildifier#GetExecutable(a:buffer))
+    let l:options = ale#Var(a:buffer, 'bazel_buildifier_options')
+    let l:filename = ale#Escape(bufname(a:buffer))
+
+    let l:command = l:executable . ' -mode check -lint warn -path %s'
+
+    if l:options isnot# ''
+        let l:command .= ' ' . l:options
+    endif
+
+    return l:command
+endfunction
+
+function! ale_linters#bzl#buildifier#Handle(buffer, lines) abort
+    let l:pattern = '\v^[^:]+:(\d+):(\d+)?:?\s+(syntax error near)?(.+)$'
+    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] is# 'syntax error near' ? 'E' : 'W',
+        \})
+    endfor
+
+    return l:output
+endfunction
+
+call ale#linter#Define('bzl', {
+\   'name': 'buildifier',
+\   'output_stream': 'both',
+\   'executable': function('ale#fixers#buildifier#GetExecutable'),
+\   'command': function('ale_linters#bzl#buildifier#GetCommand'),
+\   'callback': function('ale_linters#bzl#buildifier#Handle'),
+\})
diff --git a/test/handler/test_buildifier_handler.vader b/test/handler/test_buildifier_handler.vader
new file mode 100644
index 00000000..7fda0758
--- /dev/null
+++ b/test/handler/test_buildifier_handler.vader
@@ -0,0 +1,26 @@
+Before:
+  runtime ale_linters/bzl/buildifier.vim
+
+After:
+  call ale#linter#Reset()
+
+Execute(The buildifier handler should parse lines correctly):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 26,
+  \     'col': 1,
+  \     'type': 'E',
+  \     'text': 'syntax error near'';'' and move the next statement to the new line',
+  \   },
+  \   {
+  \     'lnum': 7,
+  \     'col': 0,
+  \     'type': 'W',
+  \     'text': 'unused-variable: Variable "foo" is unused. Please remove it. (https://github.com/bazelbuild/buildtools/blob/master/WARNINGS.md#unused-variable)'
+  \   },
+  \ ],
+  \ ale_linters#bzl#buildifier#Handle(bufnr(''), [
+  \   'swiftformat/toolchains/assets.bzl:26:1: syntax error near'';'' and move the next statement to the new line',
+  \   'swiftformat/toolchains/assets.bzl:7: unused-variable: Variable "foo" is unused. Please remove it. (https://github.com/bazelbuild/buildtools/blob/master/WARNINGS.md#unused-variable)',
+  \ ])
diff --git a/test/linter/test_bzl_buildifier.vader b/test/linter/test_bzl_buildifier.vader
new file mode 100644
index 00000000..1fe9c830
--- /dev/null
+++ b/test/linter/test_bzl_buildifier.vader
@@ -0,0 +1,30 @@
+Before:
+  call ale#assert#SetUpLinterTest('bzl', 'buildifier')
+
+After:
+  call ale#assert#TearDownLinterTest()
+
+
+Execute(Should use default command when bazel_buildifier_options are not set):
+  call ale#test#SetDirectory('/testplugin/test/test-files/bzl/bazel-package')
+  call ale#test#SetFilename('BUILD.bazel')
+
+  let g:ale_bazel_buildifier_executable = 'buildifier'
+  let g:ale_bazel_buildifier_options = ''
+
+  AssertLinter 'buildifier',
+  \ ale#Escape('buildifier') . ' -mode check -lint warn -path %s'
+
+  call ale#test#RestoreDirectory()
+
+Execute(Should use custom buildifier options when bazel_buildifier_options are set):
+  call ale#test#SetDirectory('/testplugin/test/test-files/bzl/bazel-package')
+  call ale#test#SetFilename('BUILD.bazel')
+
+  let g:ale_bazel_buildifier_executable = 'buildifier'
+  let g:ale_bazel_buildifier_options = '-v'
+
+  AssertLinter 'buildifier',
+  \ ale#Escape('buildifier') . ' -mode check -lint warn -path %s -v'
+
+  call ale#test#RestoreDirectory()
diff --git a/test/test-files/bzl/bazel-package/BUILD.bazel b/test/test-files/bzl/bazel-package/BUILD.bazel
new file mode 100644
index 00000000..e69de29b
-- 
cgit v1.2.3