summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Reedy <breed808@breed808.com>2017-04-13 19:27:09 +1000
committerBen Reedy <breed808@breed808.com>2017-04-13 19:38:32 +1000
commit54991f3082108cb41e5be06a068e3e0472b858b9 (patch)
tree74defd9bf9b3e9709117e35beb69654eb12e7ead
parent1167616726f9e995da9ac5b674cf6ded2d221855 (diff)
downloadale-54991f3082108cb41e5be06a068e3e0472b858b9.zip
Add documentation for gometalinter
-rw-r--r--README.md2
-rw-r--r--doc/ale-go.txt25
2 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9c513e59..7c55fac0 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ name. That seems to be the fairest way to arrange this table.
| Elm | [elm-make](https://github.com/elm-lang/elm-make) |
| Erlang | [erlc](http://erlang.org/doc/man/erlc.html) |
| Fortran | [gcc](https://gcc.gnu.org/) |
-| Go | [gofmt -e](https://golang.org/cmd/gofmt/), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [go build](https://golang.org/cmd/go/), [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple), [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) |
+| Go | [gofmt -e](https://golang.org/cmd/gofmt/), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter), [go build](https://golang.org/cmd/go/), [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple), [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) |
| Haml | [haml-lint](https://github.com/brigade/haml-lint)
| Handlebars | [ember-template-lint](https://github.com/rwjblue/ember-template-lint) |
| Haskell | [ghc](https://www.haskell.org/ghc/), [hlint](https://hackage.haskell.org/package/hlint), [hdevtools](https://hackage.haskell.org/package/hdevtools) |
diff --git a/doc/ale-go.txt b/doc/ale-go.txt
new file mode 100644
index 00000000..e086bcd7
--- /dev/null
+++ b/doc/ale-go.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Go Integration *ale-go-options*
+
+
+-------------------------------------------------------------------------------
+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: