2019-01-03 01:53:13 -05:00
|
|
|
#+TITLE: lang/go
|
|
|
|
|
#+DATE: January 16, 2017
|
|
|
|
|
#+SINCE: v2.0
|
|
|
|
|
#+STARTUP: inlineimages
|
2017-04-27 18:02:54 -04:00
|
|
|
|
2019-01-03 01:53:13 -05:00
|
|
|
* Table of Contents :TOC:
|
|
|
|
|
- [[Description][Description]]
|
|
|
|
|
- [[Module Flags][Module Flags]]
|
|
|
|
|
- [[Plugins][Plugins]]
|
|
|
|
|
- [[Prerequisites][Prerequisites]]
|
|
|
|
|
- [[Go][Go]]
|
|
|
|
|
- [[Dependencies][Dependencies]]
|
|
|
|
|
- [[Features][Features]]
|
|
|
|
|
- [[Configuration][Configuration]]
|
|
|
|
|
- [[Troubleshooting][Troubleshooting]]
|
|
|
|
|
|
|
|
|
|
* Description
|
2017-05-25 20:08:50 +02:00
|
|
|
This module adds [[https://golang.org][Go]] support.
|
2017-04-27 18:02:54 -04:00
|
|
|
|
2017-05-25 20:08:50 +02:00
|
|
|
+ Code completion (~gocode~)
|
2017-05-26 02:13:47 +02:00
|
|
|
+ Documentation lookup (~godoc~)
|
|
|
|
|
+ Eldoc support (~go-eldoc~)
|
2017-05-25 20:08:50 +02:00
|
|
|
+ REPL (~gore~)
|
|
|
|
|
+ Syntax-checking (~flycheck~)
|
|
|
|
|
+ Auto-formatting on save (~gofmt~)
|
|
|
|
|
+ Code navigation & refactoring (~go-guru~)
|
2017-04-27 18:12:44 -04:00
|
|
|
+ [[../../feature/file-templates/templates/go-mode][File templates]]
|
2017-05-25 20:08:50 +02:00
|
|
|
+ [[https://github.com/hlissner/emacs-snippets/tree/master/go-mode][Snippets]]
|
|
|
|
|
|
2019-01-03 01:53:13 -05:00
|
|
|
** Module Flags
|
|
|
|
|
This module provides no flags.
|
2017-05-25 20:08:50 +02:00
|
|
|
|
2019-01-03 01:53:13 -05:00
|
|
|
** Plugins
|
|
|
|
|
+ [[https://github.com/dominikh/go-mode.el][go-mode]]
|
|
|
|
|
+ [[https://github.com/syohex/emacs-go-eldoc][go-eldoc]]
|
|
|
|
|
+ [[https://github.com/dominikh/go-mode.el][go-guru]]
|
|
|
|
|
+ [[https://github.com/manute/gorepl-mode][gorepl-mode]]
|
|
|
|
|
+ [[https://github.com/mdempsky/gocode][company-go]]*
|
2017-08-21 20:07:07 +02:00
|
|
|
|
2019-01-03 01:53:13 -05:00
|
|
|
* Prerequisites
|
2017-08-21 20:07:07 +02:00
|
|
|
** Go
|
2017-05-25 20:08:50 +02:00
|
|
|
To get started with Go, you need the ~go~ tool:
|
2017-04-27 18:02:54 -04:00
|
|
|
|
|
|
|
|
*** MacOS
|
2019-01-03 01:53:13 -05:00
|
|
|
#+BEGIN_SRC bash
|
2017-04-27 18:02:54 -04:00
|
|
|
brew install go
|
|
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
|
|
*** Arch Linux
|
2019-01-03 01:53:13 -05:00
|
|
|
#+BEGIN_SRC bash
|
|
|
|
|
sudo pacman -S go
|
2017-04-27 18:02:54 -04:00
|
|
|
#+END_SRC
|
|
|
|
|
|
2017-05-25 20:08:50 +02:00
|
|
|
** Dependencies
|
|
|
|
|
This module requires a valid ~GOPATH~, and the following Go packages:
|
|
|
|
|
|
2017-05-26 11:44:06 +02:00
|
|
|
+ ~gocode~ (for code completion & eldoc support)
|
2017-05-26 02:13:47 +02:00
|
|
|
+ ~godoc~ (for documentation lookup)
|
|
|
|
|
+ ~gorename~ (for extra refactoring commands)
|
2017-05-25 20:08:50 +02:00
|
|
|
+ ~gore~ (for the REPL)
|
|
|
|
|
+ ~guru~ (for code navigation & refactoring commands)
|
2019-01-03 01:53:13 -05:00
|
|
|
+ ~goimports~ (optional: for auto-formatting code on save & fixing imports)
|
2017-04-27 18:02:54 -04:00
|
|
|
|
|
|
|
|
#+BEGIN_SRC sh
|
2017-05-03 22:36:16 +02:00
|
|
|
export GOPATH=~/work/go
|
2017-04-27 18:02:54 -04:00
|
|
|
|
2019-04-19 18:34:25 -05:00
|
|
|
go get -u github.com/motemen/gore/cmd/gore
|
2018-10-15 09:26:47 +02:00
|
|
|
go get -u github.com/mdempsky/gocode
|
2017-05-26 02:13:47 +02:00
|
|
|
go get -u golang.org/x/tools/cmd/godoc
|
|
|
|
|
go get -u golang.org/x/tools/cmd/goimports
|
2017-05-25 20:08:50 +02:00
|
|
|
go get -u golang.org/x/tools/cmd/gorename
|
2017-05-26 02:13:47 +02:00
|
|
|
go get -u golang.org/x/tools/cmd/guru
|
2017-04-27 18:02:54 -04:00
|
|
|
#+END_SRC
|
|
|
|
|
|
2019-01-03 01:53:13 -05:00
|
|
|
* TODO Features
|
|
|
|
|
|
|
|
|
|
* TODO Configuration
|
|
|
|
|
|
|
|
|
|
* TODO Troubleshooting
|
