From eb0ebe622102cc6da3d7e943a3b739db7b6ed216 Mon Sep 17 00:00:00 2001
From: Jon Parise <jon@indelible.org>
Date: Tue, 23 Mar 2021 06:04:51 -0700
Subject: Switch to using buildifier's -path option (#3640)

Buildifier offers a -path command line option:

> Buildifier's reformatting depends in part on the path to the file
> relative to the workspace directory. Normally buildifier deduces
> that path from the file names given, but the path can be given
> explicitly with the -path argument. This is especially useful when
> reformatting standard input, or in scripts that reformat a temporary
> copy of a file.

This lets us drop our `-type`-guessing logic.

For the moment, we rely on the buffer filename being "relative to the
workspace directory", which it generally is, but in a future change, we
should introduce logic that will locate the WORKSPACE file and adjusts
the filename relative to that directory. This could be complicated based
on the working directory in which `buildifier` is executed, so a little
more research is necessary to implement that logic correctly.
---
 autoload/ale/fixers/buildifier.vim               | 15 ++------------
 test/fixers/test_buildifier_fixer_callback.vader | 26 ++++++------------------
 2 files changed, 8 insertions(+), 33 deletions(-)

diff --git a/autoload/ale/fixers/buildifier.vim b/autoload/ale/fixers/buildifier.vim
index e3dab5e1..b676068d 100644
--- a/autoload/ale/fixers/buildifier.vim
+++ b/autoload/ale/fixers/buildifier.vim
@@ -14,20 +14,9 @@ endfunction
 function! ale#fixers#buildifier#Fix(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 = fnamemodify(bufname(a:buffer), ':t')
+    let l:filename = ale#Escape(bufname(a:buffer))
 
-    let l:command = l:executable . ' -mode fix -lint fix'
-
-    " Attempt to guess the file type based on the filename. buildifier itself
-    " usually does this based on the filenames provided on the command line,
-    " but because we're piping our buffer via stdin, we do this manually.
-    if l:filename =~? 'WORKSPACE'
-        let l:command .= ' -type workspace'
-    elseif l:filename =~? 'BUILD'
-        let l:command .= ' -type build'
-    elseif l:filename =~? '.bzl$'
-        let l:command .= ' -type bzl'
-    endif
+    let l:command = l:executable . ' -mode fix -lint fix -path ' . l:filename
 
     if l:options isnot# ''
         let l:command .= ' ' . l:options
diff --git a/test/fixers/test_buildifier_fixer_callback.vader b/test/fixers/test_buildifier_fixer_callback.vader
index db9f1e55..f82e8e6e 100644
--- a/test/fixers/test_buildifier_fixer_callback.vader
+++ b/test/fixers/test_buildifier_fixer_callback.vader
@@ -11,7 +11,9 @@ Execute(The buildifier callback should return the correct default values):
   AssertFixer
   \ {
   \   'command': ale#Escape(g:ale_bazel_buildifier_executable)
-  \     . ' -mode fix -lint fix -type workspace -'
+  \     . ' -mode fix -lint fix -path '
+  \     . ale#Escape(ale#test#GetFilename('../test-files/bazel/WORKSPACE'))
+  \     . ' -'
   \ }
 
 Execute(The buildifier callback should include any additional options):
@@ -21,23 +23,7 @@ Execute(The buildifier callback should include any additional options):
   AssertFixer
   \ {
   \   'command': ale#Escape(g:ale_bazel_buildifier_executable)
-  \     . ' -mode fix -lint fix -type workspace --some-option -',
-  \ }
-
-Execute(The buildifier callback should recognize BUILD files):
-  call ale#test#SetFilename('../test-files/bazel/BUILD')
-
-  AssertFixer
-  \ {
-  \   'command': ale#Escape(g:ale_bazel_buildifier_executable)
-  \     . ' -mode fix -lint fix -type build -'
-  \ }
-
-Execute(The buildifier callback should recognize .bzl files):
-  call ale#test#SetFilename('../test-files/bazel/defs.bzl')
-
-  AssertFixer
-  \ {
-  \   'command': ale#Escape(g:ale_bazel_buildifier_executable)
-  \     . ' -mode fix -lint fix -type bzl -'
+  \     . ' -mode fix -lint fix -path '
+  \     . ale#Escape(ale#test#GetFilename('../test-files/bazel/WORKSPACE'))
+  \     . ' --some-option -'
   \ }
-- 
cgit v1.2.3