https://github.com/codeclimate-community/codeclimate-gofmt

Code Climate Engine for gofmt
https://github.com/codeclimate-community/codeclimate-gofmt

code-quality codeclimate codeclimate-engine formatter formatting go gofmt golang quality static-analysis static-code-analysis

Last synced: 3 months ago
JSON representation

Code Climate Engine for gofmt

• Host: GitHub
• URL: https://github.com/codeclimate-community/codeclimate-gofmt
• Owner: codeclimate-community
• License: mit
• Created: 2015-06-19T13:52:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-30T15:13:47.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T20:10:09.573Z (7 months ago)
• Topics: code-quality, codeclimate, codeclimate-engine, formatter, formatting, go, gofmt, golang, quality, static-analysis, static-code-analysis
• Language: Go
• Size: 3.82 MB
• Stars: 6
• Watchers: 12
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Code Climate Gofmt Engine

`codeclimate-gofmt` is a Code Climate engine that wraps [Gofmt](https://golang.org/cmd/gofmt/). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.

Gofmt automatically formats Go code.

### Installation

1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).

2. Add the following to your Code Climate config:

  ```yaml

  plugins:

    gofmt:

      enabled: true

  ```

3. Run `codeclimate engines:install`

4. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.

### Building

```console

make image

```

This will build a `codeclimate/codeclimate-gofmt` image locally.

### Updating

`gofmt` is a part of the Go distribution and shares version with it. Once in a

while a new version of Go gets packaged. In order to get the latest version

and force a new docker image build, please update the base image in the

`Dockerfile`. Please avoid any unstable tags such as `latest` and keep it

explicit.

### Need help?

For help with Gofmt, [check out their documentation](https://golang.org/cmd/gofmt/).

If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate-community/codeclimate-gofmt/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).