summaryrefslogtreecommitdiff
path: root/doc/ale-go.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-go.txt')
-rw-r--r--doc/ale-go.txt37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/ale-go.txt b/doc/ale-go.txt
new file mode 100644
index 00000000..3ae82e80
--- /dev/null
+++ b/doc/ale-go.txt
@@ -0,0 +1,37 @@
+===============================================================================
+ALE Go Integration *ale-go-options*
+
+
+-------------------------------------------------------------------------------
+Integration Information
+
+The `gometalinter` linter is disabled by default, and all other Go linters
+supported by ALE are enabled by default. To enable `gometalinter`, update
+|g:ale_linters| as appropriate:
+
+>
+ " Enable all of the linters you want for Go.
+ let g:ale_linters = {'go': ['gometalinter', 'gofmt']}
+<
+
+-------------------------------------------------------------------------------
+gometalinter *ale-go-gometalinter*
+
+g:ale_go_gometalinter_enabled *g:ale_go_gometalinter_enabled*
+
+ Type: |Integer|
+ Default: 0
+
+ This variable can be change to enable gometalinter for go files.
+
+
+g:ale_go_gometalinter_options *g:ale_go_gometalinter_options*
+
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to alter the command-line arguments to the
+ gometalinter invocation.
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: