Close #2179 - Add support for gopls

1 files changed, 92 insertions, 73 deletions

diff --git a/doc/ale-go.txt b/doc/ale-go.txt
index 3fbc6fb9..611e3fdd 100644
--- a/doc/ale-go.txt
+++ b/doc/ale-go.txt
@@ -31,6 +31,23 @@ g:ale_go_go_executable                                    *g:ale_go_go_options*
 
 
 ===============================================================================
+bingo                                                            *ale-go-bingo*
+
+g:ale_go_bingo_executable                           *g:ale_go_bingo_executable*
+                                                    *b:ale_go_bingo_executable*
+  Type: |String|
+  Default: `'bingo'`
+
+  Location of the bingo binary file.
+
+
+g:ale_go_bingo_options                                 *g:ale_go_bingo_options*
+                                                       *b:ale_go_bingo_options*
+  Type: |String|
+  Default: `''`
+
+
+===============================================================================
 gobuild                                                        *ale-go-gobuild*
 
 g:ale_go_gobuild_options                             *g:ale_go_gobuild_options*
@@ -54,6 +71,60 @@ g:ale_go_gofmt_options                                 *g:ale_go_gofmt_options*
 
 
 ===============================================================================
+golangci-lint                                            *ale-go-golangci-lint*
+
+`golangci-lint` is a `lint_file` linter, which only lints files that are
+written to disk. This differs from the default behavior of linting the buffer.
+See: |ale-lint-file|
+
+g:ale_go_golangci_lint_executable           *g:ale_go_golangci_lint_executable*
+                                            *b:ale_go_golangci_lint_executable*
+  Type: |String|
+  Default: `'golangci-lint'`
+
+  The executable that will be run for golangci-lint.
+
+
+g:ale_go_golangci_lint_options                 *g:ale_go_golangci_lint_options*
+                                               *b:ale_go_golangci_lint_options*
+  Type: |String|
+  Default: `'--enable-all'`
+
+  This variable can be changed to alter the command-line arguments to the
+  golangci-lint invocation.
+
+
+g:ale_go_golangci_lint_package                 *g:ale_go_golangci_lint_package*
+                                               *b:ale_go_golangci_lint_package*
+  Type: |Number|
+  Default: `0`
+
+  When set to `1`, the whole Go package will be checked instead of only the
+  current file.
+
+
+===============================================================================
+golangserver                                              *ale-go-golangserver*
+
+g:ale_go_langserver_executable                 *g:ale_go_langserver_executable*
+                                               *b:ale_go_langserver_executable*
+  Type: |String|
+  Default: `'go-langserver'`
+
+  Location of the go-langserver binary file.
+
+
+g:ale_go_langserver_options                       *g:ale_go_langserver_options*
+                                                  *b:ale_go_langserver_options*
+  Type: |String|
+  Default: `''`
+
+  Additional options passed to the go-langserver command. Note that the
+  `-gocodecompletion` option is ignored because it is handled automatically
+  by the |g:ale_completion_enabled| variable.
+
+
+===============================================================================
 golint                                                          *ale-go-golint*
 
 g:ale_go_golint_executable                         *g:ale_go_golint_executable*
@@ -73,17 +144,6 @@ g:ale_go_golint_options                               *g:ale_go_golint_options*
 
 
 ===============================================================================
-govet                                                            *ale-go-govet*
-
-g:ale_go_govet_options                                 *g:ale_go_govet_options*
-                                                       *b:ale_go_govet_options*
-  Type: |String|
-  Default: `''`
-
-  This variable can be set to pass additional options to the go vet linter.
-
-
-===============================================================================
 gometalinter                                              *ale-go-gometalinter*
 
 `gometalinter` is a `lint_file` linter, which only lints files that are
@@ -122,72 +182,47 @@ g:ale_go_gometalinter_lint_package         *g:ale_go_gometalinter_lint_package*
 
 
 ===============================================================================
-staticcheck                                                *ale-go-staticcheck*
+gopls                                                            *ale-go-gopls*
 
-g:ale_go_staticcheck_options                     *g:ale_go_staticcheck_options*
-                                                 *b:ale_go_staticcheck_options*
+g:ale_go_gopls_executable                           *g:ale_go_gopls_executable*
+                                                    *b:ale_go_gopls_executable*
   Type: |String|
-  Default: `''`
-
-  This variable can be set to pass additional options to the staticcheck
-  linter.
+  Default: `'gopls'`
 
+  Location of the gopls binary file.
 
-g:ale_go_staticcheck_lint_package           *g:ale_go_staticcheck_lint_package*
-                                            *b:ale_go_staticcheck_lint_package*
-  Type: |Number|
-  Default: `0`
 
-  When set to `1`, the whole Go package will be checked instead of only the
-  current file.
+g:ale_go_gopls_options                                 *g:ale_go_gopls_options*
+                                                       *b:ale_go_gopls_options*
+  Type: |String|
+  Default: `''`
 
 
 ===============================================================================
-golangserver                                              *ale-go-golangserver*
-
-g:ale_go_langserver_executable                 *g:ale_go_langserver_executable*
-                                               *b:ale_go_langserver_executable*
-  Type: |String|
-  Default: `'go-langserver'`
-
-  Location of the go-langserver binary file.
+govet                                                            *ale-go-govet*
 
-g:ale_go_langserver_options                       *g:ale_go_langserver_options*
-                                                  *b:ale_go_langserver_options*
+g:ale_go_govet_options                                 *g:ale_go_govet_options*
+                                                       *b:ale_go_govet_options*
   Type: |String|
   Default: `''`
 
-  Additional options passed to the go-langserver command. Note that the
-  `-gocodecompletion` option is ignored because it is handled automatically
-  by the |g:ale_completion_enabled| variable.
+  This variable can be set to pass additional options to the go vet linter.
 
 
 ===============================================================================
-golangci-lint                                            *ale-go-golangci-lint*
-
-`golangci-lint` is a `lint_file` linter, which only lints files that are
-written to disk. This differs from the default behavior of linting the buffer.
-See: |ale-lint-file|
-
-g:ale_go_golangci_lint_executable           *g:ale_go_golangci_lint_executable*
-                                            *b:ale_go_golangci_lint_executable*
-  Type: |String|
-  Default: `'golangci-lint'`
-
-  The executable that will be run for golangci-lint.
-
+staticcheck                                                *ale-go-staticcheck*
 
-g:ale_go_golangci_lint_options                 *g:ale_go_golangci_lint_options*
-                                               *b:ale_go_golangci_lint_options*
+g:ale_go_staticcheck_options                     *g:ale_go_staticcheck_options*
+                                                 *b:ale_go_staticcheck_options*
   Type: |String|
-  Default: `'--enable-all'`
+  Default: `''`
 
-  This variable can be changed to alter the command-line arguments to the
-  golangci-lint invocation.
+  This variable can be set to pass additional options to the staticcheck
+  linter.
 
 
-g:ale_go_golangci_lint_package                 *g:ale_go_golangci_lint_package*
-                                               *b:ale_go_golangci_lint_package*
+g:ale_go_staticcheck_lint_package           *g:ale_go_staticcheck_lint_package*
+                                            *b:ale_go_staticcheck_lint_package*
   Type: |Number|
   Default: `0`
 
@@ -196,20 +231,4 @@ g:ale_go_golangci_lint_package                 *g:ale_go_golangci_lint_package*
 
 
 ===============================================================================
-bingo                                                            *ale-go-bingo*
-
-g:ale_go_bingo_executable                           *g:ale_go_bingo_executable*
-                                                    *b:ale_go_bingo_executable*
-  Type: |String|
-  Default: `'go-bingo'`
-
-  Location of the go-bingo binary file.
-
-g:ale_go_bingo_options                                 *g:ale_go_bingo_options*
-                                                       *b:ale_go_bingo_options*
-  Type: |String|
-  Default: `''`
-
-
-===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: