This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/go
Steven Allen 48c12d48d0 Partially tame exec-path-from-shell
1. Make it possible to exclude the package (fix the go and rust layers).
2. Import variables all at once (avoid spawning multiple login shells).
3. Import variables early (during the "pre" package loading stage).
4. Centralize the platform check by using a package toggle in the
   `spacemacs-base`.
5. Avoid importing already defined variables (except `PATH`/`MANPATH`).

Relates to #8537.

TODO: We can probably trim the platform list to macos only.
2017-03-24 14:23:38 +03:00
..
img
local/go-rename Fix usage of gorename on symlinked projects 2016-10-17 13:33:35 +02:00
config.el fix go layer headers 2017-02-01 16:06:00 +02:00
funcs.el Bump year in copyright headers 2017-01-05 23:08:17 -05:00
packages.el Partially tame exec-path-from-shell 2017-03-24 14:23:38 +03:00
README.org update docs with go-guru info 2016-10-17 13:36:40 +02:00

GO layer

/TakeV/spacemacs/media/commit/48c12d48d0e4e3ace050f9b40a1c7a439a1f5ca5/layers/+lang/go/img/go.png

Description

This layer adds extensive support for go.

Features:

  • gofmt/goimports on file save
  • Auto-completion using go-autocomplete (with the auto-completion layer)
  • Source analysis using go-guru
  • Linting with flycheck's built-in checkers or flycheck-gometalinter
  • Coverage profile visualization

Install

Pre-requisites

You will need gocode and godef:

  go get -u -v github.com/nsf/gocode
  go get -u -v github.com/rogpeppe/godef
  go get -u -v golang.org/x/tools/cmd/guru
  go get -u -v golang.org/x/tools/cmd/gorename
  go get -u -v golang.org/x/tools/cmd/goimports

If you wish to use gometalinter set the value of go-use-gometalinter to t:

  (go :variables go-use-gometalinter t)

and install the tool:

  go get -u -v github.com/alecthomas/gometalinter
  gometalinter --install --update

For more information read gometalinter README.md and flycheck-gometalinter README.md

Make sure that gocode executable is in your PATH. For information about setting up $PATH, check out the corresponding section in the FAQ (SPC h SPC $PATH RET).

For best results, make sure that the auto-completion and syntax-checking layers are enabled as well.

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add go to the existing dotspacemacs-configuration-layers list in this file.

Configuration

By default, go buffers are run through gofmt on save. To use a different formatter, set the value of gofmt-command, e.g.

  (setq gofmt-command "goimports")

or

  (go :variables gofmt-command "goimports")

Indentation

By default, the tab width in Go mode is 8 spaces. To use a different value set the layer variable go-tab-width, e.g.

  (go :variables go-tab-width 4)

Tests

If you're using gocheck in your project you can use the go-use-gocheck-for-testing variable to enable suite testing and to get single function testing to work.

go-coverage-display-buffer-func controls how go-coverage should display the coverage buffer. See display-buffer for a list of possible functions. The default value is display-buffer-reuse-window.

Guru

Go Oracle has been deprecated as of October 1, 2016, it's replacement is go-guru.

If you would like to use the goguru bindings in your work, you will need to install it, and in your project you will need to set the scope with SPC m f o. The scope is a comma separated set of packages, and go's recursive operator is supported. In addition, you can prefix with - to exclude a package from searching.

In addition, GOPATH must be set prior to go-guru initialization.

Working with Go

Go commands (start with m):

Key Binding Description
SPC m h h godoc at point
SPC m i g goto imports
SPC m i a add import
SPC m i r remove unused import
SPC m e b go-play buffer
SPC m e r go-play region
SPC m e d download go-play snippet
SPC m x x run "go run" for the current 'main' package
SPC m g a jump to matching test file or back from test to code file
SPC m g c open a clone of the current buffer with a coverage info (go tool cover -h for help)
SPC m g g go jump to definition
SPC m r n go rename
SPC m t p run "go test" for the current package
SPC m t P run "go test" for the current package and all packages under it
SPC m t t run "go test" for the function you're currently in (while you're in a _.test.go file)
SPC m t s run "go test" for the suite you're currently in (requires gocheck)

Go Guru

Key Binding Description
SPC m f d go-guru describe symbol at point
SPC m f f go-guru show free variables
SPC m f i go-guru show implements relation
SPC m f c go-guru show channel sends/receives
SPC m f r go-guru show referrers
SPC m f j go-guru jump to symbol definition
SPC m f p go-guru show what the select expression points to
SPC m f s go-guru show callstack
SPC m f e go-guru show possible contants/types for error value
SPC m f < go-guru show possible callers
SPC m f > go-guru show call targets
SPC m f o go-guru set analysis scope