codeclimate-gofmt

command module
v0.0.0-...-182ac4f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2023 License: MIT Imports: 7 Imported by: 0

README

Code Climate Gofmt Engine

codeclimate-gofmt is a Code Climate engine that wraps 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.
  2. Add the following to your Code Climate config:
plugins:
  gofmt:
    enabled: true
  1. Run codeclimate engines:install
  2. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.
Building
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.

If you're running into a Code Climate issue, first look over this project's GitHub Issues, as your question may have already been covered. If not, go ahead and open a support ticket with us.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL