summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2021-05-26 22:43:30 +0100
committerw0rp <devw0rp@gmail.com>2021-05-26 22:43:33 +0100
commitf53431331e2e2030a84de081baec93aad1e62363 (patch)
treec44ff92c5e4aaf6b39100e9ee40484a49ae39f78 /doc
parent3f386ae5e988d6e1b39332a760f9e990d2df7f31 (diff)
downloadale-f53431331e2e2030a84de081baec93aad1e62363.zip
Enable gopls by default with GOPATH detection
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-go.txt29
-rw-r--r--doc/ale.txt2
2 files changed, 29 insertions, 2 deletions
diff --git a/doc/ale-go.txt b/doc/ale-go.txt
index 8364fd5b..e2616a62 100644
--- a/doc/ale-go.txt
+++ b/doc/ale-go.txt
@@ -194,12 +194,30 @@ g:ale_go_gometalinter_lint_package *g:ale_go_gometalinter_lint_package*
===============================================================================
gopls *ale-go-gopls*
+gopls is the official Go language server, and is enabled for use with ALE by
+default.
+
+To install the latest stable version of `gopls` to your `$GOPATH`, try the
+following command: >
+
+ GO111MODULE=on go get golang.org/x/tools/gopls@latest
+<
+If `$GOPATH` is readable by ALE, it should probably work without you having to
+do anything else. See the `gopls` README file for more information:
+
+https://github.com/golang/tools/blob/master/gopls/README.md
+
+
g:ale_go_gopls_executable *g:ale_go_gopls_executable*
*b:ale_go_gopls_executable*
Type: |String|
Default: `'gopls'`
- Location of the gopls binary file.
+ See |ale-integrations-local-executables|
+
+ ALE will search for `gopls` in locally installed directories first by
+ default, and fall back on a globally installed `gopls` if it can't be found
+ otherwise.
g:ale_go_gopls_options *g:ale_go_gopls_options*
@@ -229,6 +247,15 @@ g:ale_go_gopls_init_options *g:ale_go_gopls_init_options*
For a full list of supported analyzers, see:
https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
+
+g:ale_go_gopls_use_global *g:ale_go_gopls_use_global*
+ *b:ale_go_gopls_use_global*
+ Type: |String|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
===============================================================================
govet *ale-go-govet*
diff --git a/doc/ale.txt b/doc/ale.txt
index 96069d5a..b7059af9 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1580,7 +1580,7 @@ g:ale_linters *g:ale_linters*
\ 'apkbuild': ['apkbuild_lint', 'secfixes_check'],
\ 'csh': ['shell'],
\ 'elixir': ['credo', 'dialyxir', 'dogma'],
- \ 'go': ['gofmt', 'golint', 'go vet'],
+ \ 'go': ['gofmt', 'golint', 'gopls', 'govet'],
\ 'hack': ['hack'],
\ 'help': [],
\ 'inko': ['inko'],