TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

minor improvements in elixir README file

Browse source
This commit is contained in:
d12frosted 2017-02-03 11:10:40 +02:00
parent 52ea26a052
commit 57e653a221
No known key found for this signature in database
GPG key ID: 8F60E862D6F5CE8F
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
layers/+lang/elixir/README.org
View file

@ -24,8 +24,9 @@
* Description * Description
This layer adds support for [[http://elixir-lang.org/][Elixir]] . This layer adds support for [[http://elixir-lang.org/][Elixir]] .
[[https://github.com/tonini/alchemist.el][Alchemist]] brings the Elixir tooling to Emacs and comes with a bunch of [[https://github.com/tonini/alchemist.el][Alchemist]] brings the Elixir tooling to Emacs and comes with a bunch of features
features like: like:
- Powerful IEx integration - Powerful IEx integration
- Mix integration - Mix integration
- Compile & Execution of Elixir code - Compile & Execution of Elixir code
@ -50,20 +51,25 @@ file.
time. time.
*** Credo *** Credo
You need to install [[https://github.com/rrrene/credo][credo]] into your project. Fort this, You need to install [[https://github.com/rrrene/credo][credo]] into your project. Fort this, add ={:credo, "~> 0.5",
add ={:credo, "~> 0.5", only: [:dev, :test]}= to dependencies of your project (in file mix.exs) and only: [:dev, :test]}= to dependencies of your project (in file =mix.exs=) and
run: run:
#+BEGIN_SRC shell #+BEGIN_SRC shell
mix deps.get $ mix deps.get
#+END_SRC #+END_SRC
For more info about mix [[http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html][see]]. For more info about mix [[http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html][see]].
You can tell flycheck-credo to call credo with the '--strict' argument. You can tell flycheck-credo to call credo with the '--strict' argument.
#+BEGIN_SRC elisp #+BEGIN_SRC elisp
(setq flycheck-elixir-credo-strict t) (setq flycheck-elixir-credo-strict t)
#+END_SRC #+END_SRC
*** mix compile *** mix compile
*Important:* *Important:*
Elixir compiler is based on macros and can execute arbitrary during compilation. Elixir compiler is based on macros and can execute arbitrary during compilation.
Therefore Spacemacs disable flycheck compilation checker by default. Therefore Spacemacs disable flycheck compilation checker by default.
@ -76,8 +82,8 @@ Instead you should use directory local variables in order to enable the flycheck
checker only for certain projects. Directory local variables are stored in a checker only for certain projects. Directory local variables are stored in a
file named =.dir-local.el= usually at the root of a project. To easily add a file named =.dir-local.el= usually at the root of a project. To easily add a
directory local variable use the key binding ~SPC f v d~ then choose the directory local variable use the key binding ~SPC f v d~ then choose the
=elixir-mode= and the variable name =elixir-enable-compilation-checking= with =elixir-mode= and the variable name =elixir-enable-compilation-checking= with a
a value of t. The result is a new file =.dir-local.el= with the following value of t. The result is a new file =.dir-local.el= with the following
contents: contents:
#+BEGIN_SRC elisp #+BEGIN_SRC elisp