search

reasonml / ReasonNativeProject

Reason native compilation starter project
MIT License
203 stars 45 forks source link

Explain how to integrate with emacs #22

Open acchou opened 7 years ago

acchou commented 7 years ago

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 commented 7 years ago

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 commented 7 years ago

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.