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

Explain how to integrate with emacs #22

Open
acchou opened this issue Apr 4, 2017 · 2 comments
Open

Explain how to integrate with emacs #22

acchou opened this issue Apr 4, 2017 · 2 comments

Comments

@acchou
Copy link

acchou commented Apr 4, 2017

ReasonProject mentions IDE integration and has links to Atom and Vim. Ideally it could also mention emacs and provide a link to reason-mode as well as specific instructions.

If reason-mode is setup (assuming the user also does npm -g install git://github.com/reasonml/reason-cli.git as the documentation asks), does the user also need to run npm run env -- emacs? On mac that's more likely to be npm run env -- open -a Emacs for users that have installed pure emacs from here.

I'll assume that the right way is to use npm run env -- open -a Emacs. I'll submit a pull request with this assumption.

@jordwalke
Copy link
Member

Thank you! I will look at this soon. If I don't merge in about a day, please feel free to ping me again.

@acchou
Copy link
Author

acchou commented Apr 6, 2017

I'm not so sure the advice on emacs is correct in the readme. The emacs integration docs now says to install the global tools, and that's worked for me. However, installing global tools goes against the entire narrative around non-invasive use of Reason...

It looks like our choices are:
(1) Ask the user to install global tools for emacs. This makes emacs a special case in the readme, but it aligns with the emacs integration doc.
(2) Leave the doc as-is, but my experience was that it's suboptimal for typical emacs users, who live inside emacs all day and don't want to start it per-environment. Plus running emacs from the command line on Mac is unlikely to do what you want.

Let me know which way you'd like this to go, I'd be happy to take a turn at the doc either way.

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

No branches or pull requests

2 participants