Adds elm-format section and advice for absolute paths with npm

This commit is contained in:
bja 2016-07-03 10:37:38 +01:00 committed by syl20bnr
parent 98a4a81375
commit 3bcb84f3e9

View file

@ -11,6 +11,7 @@
- [[#universal-installer-using-npm][Universal installer using npm]]
- [[#source-code][Source code]]
- [[#elm-oracle][elm-oracle]]
- [[#elm-format][elm-format]]
- [[#basic-usage-tips][Basic usage tips]]
- [[#compilation][Compilation]]
- [[#reactor][Reactor]]
@ -64,6 +65,9 @@ certain operating system and architectures.
Also, note that you might need to set the ~ELM_HOME~ environment variables to
the corresponding directory created by the installer.
If you are facing problems with previewing a buffer with ~elm-reactor~ ensure that
the absolute path of the npm global bin file is on your path within emacs
OS X Users facing problems with ~elm-reactor~ failing to properly install or
run, see this issue [[https://github.com/kevva/elm-bin/issues/28][https://github.com/kevva/elm-bin/issues/28]].
@ -86,6 +90,20 @@ run this command:
npm install -g elm-oracle
#+END_SRC
** elm-format
~elm-format~ can be used to format elm code according to a standard set of rules.
To install ~elm-format~ follow the the instructions for the version of elm installed:
https://github.com/avh4/elm-format
Also, note that if you use homebrew to install ~elm-format~ the installed exe has a
version suffix, the installed command name can be set in your =~/spacemacs=:
#+BEGIN_SRC emacs-lisp
(elm :variables
elm-format-command "elm-format-0.17")
#+END_SRC
* Basic usage tips
** Compilation
To control the name of the compiled JavaScript file, use ~SPC m c B~ instead of