From 0af4899605af26dd8ea7fe79acff6ab99f6532b2 Mon Sep 17 00:00:00 2001
From: Sean Enck <enckse@users.noreply.github.com>
Date: Sat, 28 Jan 2023 02:20:29 -0500
Subject: Add `gopls format` as a Go fixer

---
 autoload/ale/fix/registry.vim               |  5 +++
 autoload/ale/fixers/gopls.vim               | 23 ++++++++++++
 doc/ale-go.txt                              | 15 ++++++++
 test/fixers/test_gopls_fixer_callback.vader | 57 +++++++++++++++++++++++++++++
 4 files changed, 100 insertions(+)
 create mode 100644 autoload/ale/fixers/gopls.vim
 create mode 100644 test/fixers/test_gopls_fixer_callback.vader

diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim
index 6657fc3c..7040c4cc 100644
--- a/autoload/ale/fix/registry.vim
+++ b/autoload/ale/fix/registry.vim
@@ -301,6 +301,11 @@ let s:default_registry = {
 \       'suggested_filetypes': ['gomod'],
 \       'description': 'Fix Go module files with go mod edit -fmt.',
 \   },
+\   'gopls': {
+\       'function': 'ale#fixers#gopls#Fix',
+\       'suggested_filetypes': ['go'],
+\       'description': 'Fix Go files with gopls.',
+\   },
 \   'tslint': {
 \       'function': 'ale#fixers#tslint#Fix',
 \       'suggested_filetypes': ['typescript'],
diff --git a/autoload/ale/fixers/gopls.vim b/autoload/ale/fixers/gopls.vim
new file mode 100644
index 00000000..98f553c1
--- /dev/null
+++ b/autoload/ale/fixers/gopls.vim
@@ -0,0 +1,23 @@
+" Author: Sean Enck <enckse@voidedtech.com>
+" Description: Integration of gopls format with ALE.
+
+call ale#Set('go_gopls_fix_executable', 'gopls')
+call ale#Set('go_gopls_fix_options', '')
+
+function! ale#fixers#gopls#Fix(buffer) abort
+    let l:executable = ale#Var(a:buffer, 'go_gopls_fix_executable')
+    let l:options = ale#Var(a:buffer, 'go_gopls_fix_options')
+    let l:env = ale#go#EnvString(a:buffer)
+
+    if !executable(l:executable)
+        return 0
+    endif
+
+    return {
+    \   'command': l:env . ale#Escape(l:executable)
+    \       . ' format'
+    \       . ale#Pad(l:options)
+    \       . ' -l -w %t',
+    \   'read_temporary_file': 1,
+    \}
+endfunction
diff --git a/doc/ale-go.txt b/doc/ale-go.txt
index 367618ea..133096d8 100644
--- a/doc/ale-go.txt
+++ b/doc/ale-go.txt
@@ -269,6 +269,21 @@ g:ale_go_gopls_options                                 *g:ale_go_gopls_options*
   Command-line options passed to the gopls executable. See `gopls -h`.
 
 
+g:ale_go_gopls_fix_executable                   *g:ale_go_gopls_fix_executable*
+                                                *b:ale_go_gopls_fix_executable*
+  Type: |String|
+  Default: `'gopls'`
+
+  Executable to run to use as the gopls fixer.
+
+g:ale_go_gopls_fix_options                         *g:ale_go_gopls_fix_options*
+                                                   *b:ale_go_gopls_fix_options*
+  Type: |String|
+  Default: `''`
+
+  Options to pass to the gopls fixer.
+
+
 g:ale_go_gopls_init_options                       *g:ale_go_gopls_init_options*
                                                   *b:ale_go_gopls_init_options*
   Type: |Dictionary|
diff --git a/test/fixers/test_gopls_fixer_callback.vader b/test/fixers/test_gopls_fixer_callback.vader
new file mode 100644
index 00000000..218a356a
--- /dev/null
+++ b/test/fixers/test_gopls_fixer_callback.vader
@@ -0,0 +1,57 @@
+Before:
+  Save g:ale_go_gopls_fix_executable
+  Save g:ale_go_gopls_fix_options
+  Save g:ale_go_go111module
+
+  " Use an invalid global executable, so we don't match it.
+  let g:ale_go_gopls_fix_executable = 'xxxinvalid'
+  let g:ale_go_gopls_fix_options = ''
+
+  call ale#test#SetDirectory('/testplugin/test/fixers')
+  call ale#test#SetFilename('../test-files/go/testfile.go')
+
+After:
+  Restore
+
+  unlet! b:ale_go_go111module
+
+  call ale#test#RestoreDirectory()
+
+Execute(The gopls callback should return 0 when the executable isn't executable):
+  AssertEqual
+  \ 0,
+  \ ale#fixers#gopls#Fix(bufnr(''))
+
+Execute(The gopls callback should the command when the executable test passes):
+  let g:ale_go_gopls_fix_executable = has('win32') ? 'cmd' : 'echo'
+
+  AssertEqual
+  \ {
+  \   'read_temporary_file': 1,
+  \   'command': ale#Escape(g:ale_go_gopls_fix_executable) . ' format -l -w %t'
+  \ },
+  \ ale#fixers#gopls#Fix(bufnr(''))
+
+Execute(The gopls callback should include extra options):
+  let g:ale_go_gopls_fix_executable = has('win32') ? 'cmd' : 'echo'
+  let g:ale_go_gopls_fix_options = '--xxx'
+
+  AssertEqual
+  \ {
+  \   'read_temporary_file': 1,
+  \   'command': ale#Escape(g:ale_go_gopls_fix_executable) . ' format --xxx -l -w %t'
+  \ },
+  \ ale#fixers#gopls#Fix(bufnr(''))
+
+Execute(The gopls callback should support Go environment variables):
+  let g:ale_go_gopls_fix_executable = has('win32') ? 'cmd' : 'echo'
+  let g:ale_go_go111module = 'on'
+
+  AssertEqual
+  \ {
+  \   'read_temporary_file': 1,
+  \   'command': ale#Env('GO111MODULE', 'on')
+  \     . ale#Escape(g:ale_go_gopls_fix_executable)
+  \     . ' format -l -w %t'
+  \ },
+  \ ale#fixers#gopls#Fix(bufnr(''))
-- 
cgit v1.2.3