Skip to content

Added Emacs Tips Documentation #3247

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

Merged
merged 14 commits into from
Aug 1, 2022
Merged

Conversation

Mainstay-Noah-Huppert
Copy link
Contributor

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

@kylecarbs
Copy link
Member

@code-asher could you give this a review?

@bpmct
Copy link
Member

bpmct commented Jul 27, 2022

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

@Mainstay-Noah-Huppert
Copy link
Contributor Author

Thanks :)

@misskniss misskniss requested a review from code-asher July 27, 2022 14:48
Copy link
Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this! I have been using eshell which works perfectly by default but I tried out the ansi-term setup and it works like a charm.

@code-asher code-asher enabled auto-merge (squash) July 28, 2022 16:16
@code-asher
Copy link
Member

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

@ammario
Copy link
Member

ammario commented Jul 28, 2022

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

@ammario ammario disabled auto-merge July 28, 2022 16:51
@ammario ammario self-assigned this Jul 28, 2022
@Mainstay-Noah-Huppert
Copy link
Contributor Author

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.

@ammario
Copy link
Member

ammario commented Jul 29, 2022

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

@code-asher
Copy link
Member

code-asher commented Jul 29, 2022

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).

@catvec
Copy link

catvec commented Jul 30, 2022

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!

@Mainstay-Noah-Huppert
Copy link
Contributor Author

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).

joaotavora/eglot#1005

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

@ammario
Copy link
Member

ammario commented Aug 1, 2022

@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.

@Mainstay-Noah-Huppert
Copy link
Contributor Author

@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

@ammario
Copy link
Member

ammario commented Aug 1, 2022

@Noah-Huppert now resolve the conflicts plz :)

Copy link
Member

@ammario ammario left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One final thing

@ammario ammario enabled auto-merge (squash) August 1, 2022 20:55
@ammario ammario merged commit 8775192 into coder:main Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants