diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2020-07-04 11:12:55 +0200 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2020-07-04 15:05:30 +0200 |
| commit | c7d7f10bdff703e4a3c0414e8a33d4e45c91eb35 (patch) | |
| tree | 0dff0ee1f98dbfa3ad8776112053a450d176592b /vendor/github.com/go-lintpack/lintpack/README.md | |
| parent | 9573094ce235bd9afe88f5da27a47dd6bcc1e13b (diff) | |
go.mod: vendor golangci-lint
Diffstat (limited to 'vendor/github.com/go-lintpack/lintpack/README.md')
| -rw-r--r-- | vendor/github.com/go-lintpack/lintpack/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/vendor/github.com/go-lintpack/lintpack/README.md b/vendor/github.com/go-lintpack/lintpack/README.md new file mode 100644 index 000000000..5702228eb --- /dev/null +++ b/vendor/github.com/go-lintpack/lintpack/README.md @@ -0,0 +1,32 @@ +[![Build Status][travis-image]][travis-url] +[![Go Report Card][go-report-image]][go-report-url] + +[travis-image]: https://travis-ci.org/go-critic/go-critic.svg?branch=master +[travis-url]: https://travis-ci.org/go-critic/go-critic +[go-report-image]: https://goreportcard.com/badge/github.com/go-critic/go-critic +[go-report-url]: https://goreportcard.com/report/github.com/go-critic/go-critic + +## Quick start / Installation / Usage + +Install `lintpack`: + +```bash +go get -v -u github.com/go-lintpack/lintpack/... +``` + +Install checkers from [go-critic/checkers](https://github.com/go-critic/checkers): + +```bash +# You'll need to have sources under your Go workspace first: +go get -v -u github.com/go-critic/checkers +# Now build a linter that includes all checks from that package: +lintpack build -o gocritic github.com/go-critic/checkers +# Executable gocritic is created and can be used as a standalone linter. +``` + +Produced binary includes basic help as well as supported checks documentation. + +So, the process is simple: + +* Get the `lintpack` linter builder +* Build linter from checks implemented in different repos, by various vendors |
