qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-06 05:36:13 -07:00
Code Releases Activity
59bd84bb0c
go/gopls/doc/emacs.md

77 lines
3.1 KiB
Markdown
Raw Normal View History

cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
# Emacs
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
Use [lsp-mode]. gopls is built in as a client. You first must install `gopls` and put it somewhere in your `PATH`. Here is a basic config to get you started (assuming you are using [use-package]):
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
```lisp
(use-package lsp-mode
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
:ensure t
:commands (lsp lsp-deferred)
:hook (go-mode . lsp-deferred))
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
;; Set up before-save hooks to format buffer and add/delete imports.
;; Make sure you don't have other gofmt/goimports hooks enabled.
(defun lsp-go-install-save-hooks ()
(add-hook 'before-save-hook #'lsp-format-buffer t t)
(add-hook 'before-save-hook #'lsp-organize-imports t t))
(add-hook 'go-mode-hook #'lsp-go-install-save-hooks)
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
;; Optional - provides fancier overlays.
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
(use-package lsp-ui
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
:ensure t
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
:commands lsp-ui-mode)
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
;; Company mode is a standard completion package that works well with lsp-mode.
(use-package company
:ensure t
:config
;; Optionally enable completion-as-you-type behavior.
(setq company-idle-delay 0)
(setq company-minimum-prefix-length 1))
;; company-lsp integrates company mode completion with lsp-mode.
;; completion-at-point also works out of the box but doesn't support snippets.
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
(use-package company-lsp
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
:ensure t
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
:commands company-lsp)
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
;; Optional - provides snippet support.
(use-package yasnippet
:ensure t
:commands yas-minor-mode
:hook (go-mode . yas-minor-mode))
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
```
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
lsp-mode integrates with xref. By default `lsp-find-definition` is bound to `M-.`. To go back, use `M-,`. Explore other `lsp-*` commands (not everything is supported by gopls).
## Gopls Configuration
Stable gopls settings have first-class support in [lsp-mode]. For example, `(setq lsp-gopls-use-placeholders nil)` will disable placeholders in completion snippets. See [lsp-go] for a list of available variables.
Experimental settings can be configured via `lsp-register-custom-settings`:
```lisp
(lsp-register-custom-settings
'(("gopls.completeUnimported" t t)
("gopls.staticcheck" t t)))
```
See [settings] for information about gopls settings.
Note that after changing settings you must restart gopls using e.g. `M-x lsp-restart-workspace`.
## Troubleshooting
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
Common errors:
- When prompted by Emacs for your project folder, if you are using modules you must select the module's root folder (i.e. the directory with the "go.mod"). If you are using GOPATH, select your $GOPATH as your folder.
- Emacs must have your environment set properly (PATH, GOPATH, etc). You can run `M-x getenv <RET> PATH <RET>` to see if your PATH is set in Emacs. If not, you can try starting Emacs from your terminal, using [this package][exec-path-from-shell], or moving your shell config from .bashrc into .bashenv (or .zshenv).
- Make sure `lsp-mode`, `lsp-ui` and `company-lsp` are up-to-date, and make sure `lsp-go` is _not_ installed.
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
- Look for errors in the `*lsp-log*` buffer.
- Ask for help in the #emacs channel on the [Gophers slack].
cmd/gopls: add documentation Much of this documentation has been collated from other sources, but this pulls it all into one coherent and public structure in a way that allows us to peer review changes. Change-Id: Ic24a59bb92b27ec85d2f57affcf2eb396c9de3c0 Reviewed-on: https://go-review.googlesource.com/c/tools/+/191741 Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-05-09 08:35:27 -06:00
[lsp-mode]: https://github.com/emacs-lsp/lsp-mode
[use-package]: https://github.com/jwiegley/use-package
gopls/doc: expand Emacs docs - expand starter config to be more self-contained - add section for gopls config settings Change-Id: I9b2468acd90dff2d0469aa16ce715033eed4973b Reviewed-on: https://go-review.googlesource.com/c/tools/+/206798 Run-TryBot: Muir Manders <muir@mnd.rs> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2019-11-12 10:59:37 -07:00
[exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell
[settings]: settings.md
[lsp-go]: https://github.com/emacs-lsp/lsp-mode/blob/master/lsp-go.el
[Gophers slack]: https://invite.slack.golangbridge.org/
Copy Permalink