Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surullabs/lint
Run linters from Go code -
https://github.com/surullabs/lint
Last synced: about 1 month ago
JSON representation
Run linters from Go code -
- Host: GitHub
- URL: https://github.com/surullabs/lint
- Owner: surullabs
- License: apache-2.0
- Created: 2016-07-09T09:52:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-28T00:00:40.000Z (about 6 years ago)
- Last Synced: 2024-10-14T09:37:29.895Z (2 months ago)
- Language: Go
- Homepage: https://www.timeferret.com/lint
- Size: 1.27 MB
- Stars: 67
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - lint - Run linters from Go code - - ★ 61 (Code Analysis)
- awesome-go-extra - lint - |66|10|1|2016-07-09T09:52:39Z|2018-10-28T00:00:40Z| (Code Analysis / Routers)
README
## Lint - run linters from Go
[](https://travis-ci.org/surullabs/lint) [](https://godoc.org/github.com/surullabs/lint) [](https://coveralls.io/github/surullabs/lint?branch=master)[](https://goreportcard.com/report/github.com/surullabs/lint)
Lint makes it easy to run linters from Go code. This allows lint checks to be part of a regular `go build` + `go test` workflow. False positives are easily ignored and linters are automatically integrated into CI pipelines without any extra effort. Check the [project website](https://www.timeferret.com/lint) to learn more about how it can be useful.
### Quick Start
Download using
```
go get -t github.com/surullabs/lint
```
Run the default linters by adding a new test at the top level of your repository
```
func TestLint(t *testing.T) {
// Run default linters
err := lint.Default.Check("./...")
// Ignore lint errors from auto-generated files
err = lint.Skip(err, lint.RegexpMatch(`_string\.go`, `\.pb\.go`))
if err != nil {
t.Fatal("lint failures: %v", err)
}
}
```
### How it works
`lint` runs linters using the excellent `os/exec` package. It searches all Go binary directories for the needed binaries and when they don't exist it downloads them using `go get`. Errors generated by running linters are split by newline and can be skipped as needed.
### Default linters
- `gofmt` - [Run `gofmt -d` and report any differences as errors](https://golang.org/cmd/gofmt/)
- `govet` - [Run `go tool vet -shadow`](https://golang.org/cmd/vet/)
- `golint` - [https://github.com/golang/lint](https://github.com/golang/lint)
- `gosimple` - [Code simplification](https://github.com/dominikh/go-simple)
- `gostaticcheck` - [Verify function arguments](https://github.com/dominikh/go-staticcheck)
- `errcheck` - [Find ignored errors](https://github.com/kisielk/errcheck)
## Using `gometalinter`
[Gometalinter](https://github.com/alecthomas/gometalinter) runs a number of linters concurrently. It also vendors each of these and uses the vendored versions automatically. A vendored version of `gometalinter` is included and can be used in the following manner. Please note that not all linters used by gometalinter have been tested.
```
import (
"testing"
"github.com/surullabs/lint/gometalinter"
)
func TestLint(t *testing.T) {
// Run default linters
metalinter := gometalinter.Check{
Args: []string{
// Arguments to gometalinter. Do not include the package names here.
},
}
if err := metalinter.Check("./..."); err != nil {
t.Fatal("lint failures: %v", err)
}
}
```
## Other available linters
- `varcheck` - [Detect unused variables and constants](https://github.com/opennota/check)
- `structcheck` - [Detect unused struct fields](https://github.com/opennota/check)
- `aligncheck` - [Detect suboptimal struct alignment](https://github.com/opennota/check)
- `dupl` - [Detect duplicated code](https://github.com/mibk/dupl)
### Why `lint`?
There are a number of excellent linters available for Go and Lint makes it easy to run them from tests. While building our mobile calendar app [TimeFerret](https://www.timeferret.com), (which is built primarily in Go), including scripts that run linters as part of every repository grew tiresome very soon. Using `lint` to create tests that ran on each commit made the codebase much more stable, since any unneeded false positives were easily skipped. The main advantages of using `lint` over running tools manually is:
- Skip false positives explicitly in your tests - This makes it easy to run only needed checks.
- Enforce linter usage with no overhead - No special build scripts are needed to install linters on each developer machine as they are automatically downloaded.
- Simple CI integration - Since linters are run as part of tests, there are no extra steps needed to integrate them into your CI pipeline.
### Adding a custom linter
Please check if you can use the [gometalinter](https://godoc.org/github.com/surullabs/lint/gometalinter) package first. If not, adding a new linter is made dead simple by the `github.com/surullabs/lint/checkers` package. The entire source for the `golint` integration is
```
import "github.com/surullabs/lint/checkers"
type Check struct {
}
func (Check) Check(pkgs ...string) error {
return checkers.Lint("golint", "", github.com/golang/lint/golint", pkgs)
}
```
The `github.com/surullabs/lint/testutil` package contains utilities for testing custom linters.
You can also take a look at [this CL](https://github.com/surullabs/lint/commit/5e6be15e3b9964e8465655abb9759defd1c46af9) which adds `varcheck` for an example of how to add a linter.
If you'd like to vendor the linter source, please use the same method as the `gometalinter` package.
### License
Lint is available under the Apache License. See the LICENSE file for details.
### Contributing
Pull requests are always welcome! Please ensure any changes you send have an accompanying test case.