Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/tools/gopls: add documentation for eglot #40582

Closed
ilohmar opened this issue Aug 5, 2020 · 3 comments
Closed

x/tools/gopls: add documentation for eglot #40582

ilohmar opened this issue Aug 5, 2020 · 3 comments
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@ilohmar
Copy link

ilohmar commented Aug 5, 2020

What version of Go are you using (go version)?

1.14.2

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

Linux amd64

What did you do?

Look up Emacs integration documentation

What did you expect to see?

At least a mention of the "eglot" package.

What did you see instead?

Only the "lsp-mode" package.

Eglot works nicely with gopls.
To the best of my knowledge, lsp-mode will never be integrated more tightly with Emacs, while eglot is on track for that.
Please consider mentioning eglot in https://github.com/golang/tools/blob/master/gopls/doc/emacs.md.
With go-mode, eglot, and gopls properly installed, all it takes is

(add-hook 'go-mode-hook #'eglot-ensure)

I can supply a config snippet to auto-format code (as in the lsp-mode config example) if it helps.

@gopherbot gopherbot added Tools This label describes issues relating to any tools in the x/tools repository. gopls Issues related to the Go language server, gopls. labels Aug 5, 2020
@gopherbot gopherbot added this to the Unreleased milestone Aug 5, 2020
@muirdm
Copy link

muirdm commented Aug 5, 2020

That doc is community maintained, so please open a PR adding an eglot section. Thanks!

@stamblerre stamblerre changed the title x/tools/gopls Documentation suggests lsp-mode for Emacs, should at least mention eglot x/tools/gopls: add documentation for eglot Aug 5, 2020
@stamblerre stamblerre removed this from the Unreleased milestone Aug 5, 2020
@stamblerre stamblerre added this to the gopls/unplanned milestone Oct 21, 2020
@muirdm
Copy link

muirdm commented May 5, 2021

The docs now contain info about eglot so I think this can be closed.

@ilohmar
Copy link
Author

ilohmar commented May 5, 2021

That's great, I (obviously) did not get to it... Thanks a lot!

@ilohmar ilohmar closed this as completed May 5, 2021
@golang golang locked and limited conversation to collaborators May 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

4 participants