History

Henrik Lissner a70e634ebd refactor(:lang): move tree-sitter init Moved add-hook calls (for tree-sitter initialization) into their respective modes' config blocks, or nearby, to be consistent with how other, similar tools (like lsp!) are initialized, and does so at runtime, rather than at expansion/compile time, which eval-when! caused.		2022-07-25 17:34:44 +02:00
..
autoload.el	fix(go): exactly match test function name	2022-06-18 17:21:20 +02:00
config.el	refactor(:lang): move tree-sitter init	2022-07-25 17:34:44 +02:00
doctor.el	docs(tree-sitter): add doctor checks for flag	2022-05-22 21:26:00 +01:00
packages.el	bump: :lang	2022-03-31 21:09:38 +02:00
README.org	docs(go): use `go install` instead of `go get` (#5638 )	2021-10-18 01:37:03 +02:00

README.org

lang/go

Table of Contents
Description
- Module Flags
- Plugins
Prerequisites
- Go
- Dependencies
Features
Configuration
Troubleshooting

Description

This module adds Go support, with optional (but recommended) LSP support via gopls.

Code completion (gocode)
Documentation lookup (godoc)
Eldoc support (go-eldoc)
REPL (gore)
Syntax-checking (flycheck)
Auto-formatting on save (gofmt) (requires :editor (format +onsave))
Code navigation & refactoring (go-guru)
File templates
Snippets
Generate testing code (go-gen-test)
Code checking (flycheck-golangci-lint)

Module Flags

+lsp Enables integration for the gopls LSP server. It is highly recommended you use this, as the non-LSP experience is deprecated (and poor).

Plugins

go-mode
go-eldoc
go-guru
gorepl-mode
go-tag
company-go* DEPRECATED
go-gen-test
flycheck-golangci-lint (if :checkers syntax is enabled)

Prerequisites

Go

To get started with Go, you need the go tool:

MacOS

brew install go

Arch Linux

sudo pacman -S go

openSUSE

sudo zypper install go

Dependencies

This module requires a valid GOPATH, and the following Go packages:

gocode (for code completion & eldoc support)
godoc (for documentation lookup)
gorename (for extra refactoring commands)
gore (for the REPL)
guru (for code navigation & refactoring commands)
goimports (optional: for auto-formatting code on save & fixing imports)
gotests (for generate test code)
gomodifytags (for manipulating tags)

export GOPATH=~/work/go

go install github.com/x-motemen/gore/cmd/gore@latest
go install github.com/stamblerre/gocode@latest
go install golang.org/x/tools/cmd/godoc@latest
go install golang.org/x/tools/cmd/goimports@latest
go install golang.org/x/tools/cmd/gorename@latest
go install golang.org/x/tools/cmd/guru@latest
go install github.com/cweill/gotests/gotests@latest
go install github.com/fatih/gomodifytags@latest

golangci-lint (optional: for flycheck to integrate golangci-lint results) it is recommended to not use go get to install this one, check the documentation.