coder icon indicating copy to clipboard operation
coder copied to clipboard

Added Emacs Tips Documentation

Open Mainstay-Noah-Huppert opened this issue 3 years ago • 9 comments

This PR adds some light documentation on how to develop inside a Coder instance using the Emacs editor. It documents what I learned using Coder in Emacs for a few weeks.

Specifically:

  • Methods used to connect Emacs to the Coder workspace instance
  • Configuration you need to set in Emacs
  • Coder workspace setup so workspace instances play nice with Emacs

Mainstay-Noah-Huppert avatar Jul 27 '22 13:07 Mainstay-Noah-Huppert

@code-asher could you give this a review?

kylecarbs avatar Jul 27 '22 13:07 kylecarbs

Thanks for the contribution! I just pushed some code that will add the page to our side menu.

bpmct avatar Jul 27 '22 13:07 bpmct

Thanks :)

Mainstay-Noah-Huppert avatar Jul 27 '22 13:07 Mainstay-Noah-Huppert

I really like the wording you came up with, thanks again!

code-asher avatar Jul 28 '22 16:07 code-asher

I'll make sure the new page lays out correctly and handle the merge. Thank you for the contribution @Mainstay-Noah-Huppert.

ammario avatar Jul 28 '22 16:07 ammario

I finally got code completion working in Emacs on Coder so I added some additional notes. I will leave it up to y'all for coordinating additional PR reviews.

Mainstay-Noah-Huppert avatar Jul 28 '22 20:07 Mainstay-Noah-Huppert

@Mainstay-Noah-Huppert please git apply patch.txt and then we can merge.

ammario avatar Jul 29 '22 18:07 ammario

I have not tried lsp-mode but surface level the new additions look good to me. We could also add a reference to eglot as an alternative which for me worked out of the box for (requires Emacs 27.1 or later and one downside is that dap-mode does not support eglot so if you need debugging with eglot you have to do it on the command line).

code-asher avatar Jul 29 '22 18:07 code-asher

eglot

👀 Hey I gotta say lsp-mode certainly doesn't work out of the box and I've had lots of trouble getting anything to work. So maybe I'll give it a shot!

catvec avatar Jul 30 '22 01:07 catvec

I have not tried lsp-mode but surface level the new additions look good to me. We could also add a reference to eglot as an alternative which for me worked out of the box for (requires Emacs 27.1 or later and one downside is that dap-mode does not support eglot so if you need debugging with eglot you have to do it on the command line).

https://github.com/joaotavora/eglot/discussions/1005

I'm having a little less luck getting Eglot to run over TRAMP, but locally it works like a charm!

Mainstay-Noah-Huppert avatar Aug 01 '22 19:08 Mainstay-Noah-Huppert

@Mainstay-Noah-Huppert please git apply patch.txt and then we can merge.

@Noah-Huppert gentle reminder to apply that patch since the PR is beginning to accumulate conflicts and I want to get it in ASAP.

ammario avatar Aug 01 '22 19:08 ammario

@Mainstay-Noah-Huppert please git apply patch.txt and then we can merge.

@Noah-Huppert gentle reminder to apply that patch since the PR is beginning to accumulate conflicts and I want to get it in ASAP.

Thanks for the reminder, done

Mainstay-Noah-Huppert avatar Aug 01 '22 19:08 Mainstay-Noah-Huppert

@Noah-Huppert now resolve the conflicts plz :)

ammario avatar Aug 01 '22 20:08 ammario