Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeclimate/codeclimate-golint
Code Climate Engine for golint
https://github.com/codeclimate/codeclimate-golint
code-quality codeclimate codeclimate-engine go golang golint linter linting quality static-analysis static-code-analysis
Last synced: 2 months ago
JSON representation
Code Climate Engine for golint
- Host: GitHub
- URL: https://github.com/codeclimate/codeclimate-golint
- Owner: codeclimate
- License: mit
- Created: 2015-06-19T13:48:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-09T17:05:02.000Z (almost 2 years ago)
- Last Synced: 2024-06-20T00:36:12.908Z (7 months ago)
- Topics: code-quality, codeclimate, codeclimate-engine, go, golang, golint, linter, linting, quality, static-analysis, static-code-analysis
- Language: Go
- Size: 4.18 MB
- Stars: 7
- Watchers: 14
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code Climate Golint Engine
`codeclimate-golint` is a Code Climate engine that wraps [Golint](https://github.com/golang/lint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.
Golint is a linter for Go code. Where as [Gofmt](https://www.github.com/codeclimate/codeclimate-gofmt) automatically reformats code, Golint suggests style issues that may need to be addressed.
### Installation
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
2. Add the following to yout Code Climate config:
```yaml
plugins:
golint:
enabled: true
```
3. Run `codeclimate engines:install`
4. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
### Configuration
Like the `golint` binary, you can configure the minimum confidence threshold of
this engine: issues reported by `golint` must have a confidence value higher than
the threshold in order to be reported. The default value is `0.8`, the same as
`golint`: you can configure your own threshold in your `.codeclimate.yml`:
```yaml
plugins:
golint:
enabled: true
config:
min_confidence: 0.1
```
### Building
```console
make image
```
### Need help?
For help with Golint, [check out their documentation](https://github.com/golang/lint).
If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-golint/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).