go-plus

README

go-plus – Improved Go Experience In Atom

You can install go-plus by opening Atom, going to Preferences > Packages, and searching for go-plus. Alternatively, run apm install go-plus in your terminal.

This package adds extra Atom functionality for the go language:

• Formatting source using gofmt
• Formatting and managing imports using goimports
• Code quality inspection using go vet
• Linting using golint
• Syntax checking using go build and go test
• Display of test coverage using go test -coverprofile

Example

Platforms

The package is currently known to work on OS X and Windows, and has CI jobs for those platforms.

Defaults

By default, the package has the following preferences enabled:

• Environment Overrides Configuration: allow environment variables (e.g. $GOPATH or %GOPATH%) to override configured values (e.g. Gopath)
• Format On Save: run gofmt or goimports on save
• Format With Go Imports: use goimports instead of gofmt
• Get Missing Tools: run go get -u on startup for all missing tools
• Lint On Save: run golint on save
• Run Coverage On Save: run go test -coverprofile & cover on save, and display coverage in the editor
• Show Panel: show the message panel at the bottom of the screen if any errors or warnings are detected
• Syntax Check On Save: run go build / go test on save to check for errors
• Vet On Save: run vet on save to check for errors or warnings

Additionally, the following preferences can be optionally set:

• Golint Args: specify the arguments that should be passed to golint
• Go Installation: you should not need to specify this by default (!); allows you to specify a specific go installation instead of relying on inspection of the path and use of platform defaults
• Go Path: this should usually be set in the environment, but you can specify your GOPATH here also to ensure Atom still works if you accidentally launch it via Finder, Dock, or Spotlight instead of the command line atom helper
• Show Panel When No Issues Exist: show the message panel even if there are no errors or warnings
• Vet Args: specify the arguments that should be passed to vet

The package will search the following locations (in order) for a go executable:

• All directories specified in the PATH environment variable
• OS X: /usr/local/go/bin (package installer)
• OS X: /usr/local/bin (Homebrew)
• Windows: C:\go\bin (package installer)

If you have go installed somewhere else, and not available on the path, specify the full path to the go executable in the Go Installation preference.

GOPATH

Love it or hate it, GOPATH is very important in go land.

Syntax checking requires a valid GOPATH for the files you are checking. You can set your GOPATH using one of two mechanisms:

• Using the environment: set the $GOPATH environment variable to the correct value
• Using go-plus preferences: set the Go Path preference

The environment (if set) is preferred over the Go Path preference by default. You can change this by updating the Environment Overrides Configuration preference.

The most common reason GOPATH might not be set in the environment is due to the way OS X launches processes. When you launch Atom via processes created by launchd (e.g. using Finder, the Dock, or Spotlight) it likely will not have access to your $GOPATH if you set it in your shell initialization files (e.g. .bash_profile, .bashrc, .zshrc, etc).

Consider launching Atom via your shell – using the Atom Shell Commands – where Atom should inherit your environment. Alternatively, try one of the suggestions at http://apple.stackexchange.com/a/87283 to set the GOPATH for processes launched by launchd (and their children, which will include Atom).

Setting the Go Path preference will ensure that you have a sensible fallback for GOPATH if you have launched Atom without the $GOPATH environment variable set.

If both the Go Path preference and the $GOPATH / %GOPATH% environment variable are empty, go-plus will display a warning and will not perform go build / go test powered syntax checking.

Planned Features

The following features will be added soon:

• gocode integration (#2)
• go oracle / godef integration (#11)
• godoc integration (#12)
• ... and others: https://github.com/joefitzgerald/go-plus/issues

Contributors

• Scott Barron @rubyist
  • Gofmt integration (https://github.com/atom/language-go/pull/3)
  • Display test coverage (https://github.com/joefitzgerald/go-plus/pull/27)
• Matt Aimonetti @mattetti - Syntax checking (https://github.com/atom/language-go/pull/11)

Contributing

Contributions are greatly appreciated. Please fork this repository, make your changes, and open a pull request. See Contributing for detailed instructions.