| commit | 414d861bb4acf565ff8cb05f9906a2283b7dc75a | [log] [tgz] |
|---|---|---|
| author | Sam Whited <sam@samwhited.com> | Thu Aug 22 10:21:36 2019 -0500 |
| committer | Andrew Bonventre <andybons@golang.org> | Mon Sep 09 23:09:51 2019 +0000 |
| tree | df54732cde93d0cefe948ce1cc6927b68304dd5e | |
| parent | 959b441ac422379a43da2230f62be024250818b0 [diff] |
lint: remove the var decl check Removes the var decl check which often fires when the type is required for documentation purposes. For example, when an enumerated list of pre-defined values of a certain type is created, it may be desirable to group those values under the type itself in the docs. If the type is infered, godoc will not group them, but if the type is manually listed they will be placed in the correct location. Since this lint is not an important stylistic consideration and frequently produces false positives, removing it is consistent with the scope of lints in this project. Fixes golang/lint#429 Change-Id: I2afd928eae0bb11b39886c045556cda0771e3af5 Reviewed-on: https://go-review.googlesource.com/c/lint/+/191317 Run-TryBot: Sam Whited <sam@samwhited.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
Golint is a linter for Go source code.
Golint requires a supported release of Go.
go get -u golang.org/x/lint/golint
To find out where golint was installed you can run go list -f {{.Target}} golang.org/x/lint/golint. For golint to be used globally add that directory to the $PATH environment setting.
Invoke golint with one or more filenames, directories, or packages named by its import path. Golint uses the same import path syntax as the go command and therefore also supports relative import paths like ./.... Additionally the ... wildcard can be used as suffix on relative and absolute file paths to recurse into them.
The output of this tool is a list of suggestions in Vim quickfix format, which is accepted by lots of different editors.
Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes.
Golint differs from govet. Govet is concerned with correctness, whereas golint is concerned with coding style. Golint is in use at Google, and it seeks to match the accepted style of the open source Go project.
The suggestions made by golint are exactly that: suggestions. Golint is not perfect, and has both false positives and false negatives. Do not treat its output as a gold standard. We will not be adding pragmas or other knobs to suppress specific warnings, so do not expect or require code to be completely “lint-free”. In short, this tool is not, and will never be, trustworthy enough for its suggestions to be enforced automatically, for example as part of a build process. Golint makes suggestions for many of the mechanically checkable items listed in Effective Go and the CodeReviewComments wiki page.
Golint is meant to carry out the stylistic conventions put forth in Effective Go and CodeReviewComments. Changes that are not aligned with those documents will not be considered.
Contributions to this project are welcome provided they are in scope, though please send mail before starting work on anything major. Contributors retain their copyright, so we need you to fill out a short form before we can accept your contribution.
Add this to your ~/.vimrc:
set rtp+=$GOPATH/src/golang.org/x/lint/misc/vim
If you have multiple entries in your GOPATH, replace $GOPATH with the right value.
Running :Lint will run golint on the current file and populate the quickfix list.
Optionally, add this to your ~/.vimrc to automatically run golint on :w
autocmd BufWritePost,FileWritePost *.go execute 'Lint' | cwindow
Add this to your .emacs file:
(add-to-list 'load-path (concat (getenv "GOPATH") "/src/github.com/golang/lint/misc/emacs")) (require 'golint)
If you have multiple entries in your GOPATH, replace $GOPATH with the right value.
Running M-x golint will run golint on the current file.
For more usage, see Compilation-Mode.