From 70dfbccde94fe03eb0cbbd4f2a833f9e814b889c Mon Sep 17 00:00:00 2001 From: Oleksii Filonenko Date: Mon, 24 Jun 2019 19:55:27 +0300 Subject: [PATCH 1/3] lang/elixir: Add README.org --- modules/lang/elixir/README.org | 46 ++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 modules/lang/elixir/README.org diff --git a/modules/lang/elixir/README.org b/modules/lang/elixir/README.org new file mode 100644 index 000000000..692036bd3 --- /dev/null +++ b/modules/lang/elixir/README.org @@ -0,0 +1,46 @@ +#+TITLE: lang/elixir +#+DATE: June 24, 2019 +#+SINCE: v2.0.9 + +* Table of Contents :TOC_3:noexport: +- [[#description][Description]] +- [[#prerequisites][Prerequisites]] + - [[#install][Install]] + - [[#with-asdf][With ~asdf~]] + - [[#arch-linux][Arch Linux]] + - [[#gentoo-linux][Gentoo Linux]] +- [[#features][Features]] +- [[#configuration][Configuration]] + - [[#setup-for-lsp-with-elixir-ls][Setup for LSP with elixir-ls]] +- [[#troubleshooting][Troubleshooting]] + +* Description +This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[https://github.com/tonini/alchemist.el][alchemist.el]]. + +- Code completion (~:completion company~) +- Documentation lookup (~:tools lookup~) +- Mix integration +- Phoenix support +- IEx REPL integration (~:tools eval~) +- Syntax checking (~:tools flycheck~, using [[https://github.com/aaronjensen/flycheck-credo][flycheck-credo]]~) +* Prerequisites +You shound have Elixir installed, for example, via your distribution's package +manager or a version management tool such as [[https://github.com/asdf-vm/asdf-elixir][asdf]]. +** Install +*** With ~asdf~ +#+BEGIN_SRC sh +asdf plugin-add elixir +asdf install elixir 1.9.0 +#+END_SRC +*** Arch Linux +#+BEGIN_SRC sh :dir /sudo:: +sudo pacman -S elixir +#+END_SRC +*** Gentoo Linux +#+BEGIN_SRC sh :dir /sudo:: +sudo emerge -v dev-lang/elixir +#+END_SRC +* TODO Features +* TODO Configuration +** TODO Setup for LSP with [[https://github.com/JakeBecker/elixir-ls][elixir-ls]] +* TODO Troubleshooting From 1fb5891f6dbea43fa50fe9fb60c136e38cce5d28 Mon Sep 17 00:00:00 2001 From: Oleksii Filonenko Date: Fri, 26 Jul 2019 21:23:32 +0300 Subject: [PATCH 2/3] lang/elixir: finish README.org --- modules/lang/elixir/README.org | 42 +++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/modules/lang/elixir/README.org b/modules/lang/elixir/README.org index 692036bd3..a1a11f658 100644 --- a/modules/lang/elixir/README.org +++ b/modules/lang/elixir/README.org @@ -4,33 +4,36 @@ * Table of Contents :TOC_3:noexport: - [[#description][Description]] + - [[#plugins][Plugins]] - [[#prerequisites][Prerequisites]] - - [[#install][Install]] + - [[#install-elixir][Install Elixir]] - [[#with-asdf][With ~asdf~]] - [[#arch-linux][Arch Linux]] - [[#gentoo-linux][Gentoo Linux]] - [[#features][Features]] -- [[#configuration][Configuration]] - - [[#setup-for-lsp-with-elixir-ls][Setup for LSP with elixir-ls]] -- [[#troubleshooting][Troubleshooting]] * Description -This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[https://github.com/tonini/alchemist.el][alchemist.el]]. +This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[https://github.com/tonini/alchemist.el][alchemist.el]] +or [[https://github.com/JakeBecker/elixir-ls/][elixir-ls]]. + +** Plugins ++ [[https://github.com/rust-lang/rust-mode][elixir-mode]] ++ [[https://github.com/tonini/alchemist.el][alchemist.el]] ++ [[https://github.com/aaronjensen/flycheck-credo][flycheck-credo]] -- Code completion (~:completion company~) -- Documentation lookup (~:tools lookup~) -- Mix integration -- Phoenix support -- IEx REPL integration (~:tools eval~) -- Syntax checking (~:tools flycheck~, using [[https://github.com/aaronjensen/flycheck-credo][flycheck-credo]]~) * Prerequisites -You shound have Elixir installed, for example, via your distribution's package +You should have Elixir installed, for example, via your distribution's package manager or a version management tool such as [[https://github.com/asdf-vm/asdf-elixir][asdf]]. -** Install + +If you want to add support for LSP ([[modules/tools/lsp][:tools lsp]]), be sure to install [[https://github.com/JakeBecker/elixir-ls/][elixir-ls]] +and enable ~:tools lsp~ in your ~init.el~. + +To support linting with [[https://github.com/rrrene/credo][credo]], add ~:tools flycheck~ to your ~init.el~ +** Install Elixir *** With ~asdf~ #+BEGIN_SRC sh asdf plugin-add elixir -asdf install elixir 1.9.0 +asdf install elixir 1.9.1 #+END_SRC *** Arch Linux #+BEGIN_SRC sh :dir /sudo:: @@ -40,7 +43,10 @@ sudo pacman -S elixir #+BEGIN_SRC sh :dir /sudo:: sudo emerge -v dev-lang/elixir #+END_SRC -* TODO Features -* TODO Configuration -** TODO Setup for LSP with [[https://github.com/JakeBecker/elixir-ls][elixir-ls]] -* TODO Troubleshooting +* Features +- Code completion (~:completion company~) +- Documentation lookup (~:tools lookup~) +- Mix integration +- Phoenix support +- ~iex~ integration (~:tools eval~) +- Syntax checking (~:tools flycheck~, using [[https://github.com/aaronjensen/flycheck-credo][flycheck-credo]]~) From 32fd0162a00150fc258681aa9509441c05602dd7 Mon Sep 17 00:00:00 2001 From: Oleksii Filonenko Date: Fri, 26 Jul 2019 22:14:07 +0300 Subject: [PATCH 3/3] Document +lsp flag for :lang elixir --- modules/lang/elixir/README.org | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/lang/elixir/README.org b/modules/lang/elixir/README.org index a1a11f658..9a6b0aaa0 100644 --- a/modules/lang/elixir/README.org +++ b/modules/lang/elixir/README.org @@ -4,6 +4,7 @@ * Table of Contents :TOC_3:noexport: - [[#description][Description]] + - [[#module-flags][Module flags]] - [[#plugins][Plugins]] - [[#prerequisites][Prerequisites]] - [[#install-elixir][Install Elixir]] @@ -16,6 +17,9 @@ This module provides support for [[https://elixir-lang.org/][Elixir programming language]] via [[https://github.com/tonini/alchemist.el][alchemist.el]] or [[https://github.com/JakeBecker/elixir-ls/][elixir-ls]]. +** Module flags +| ~+lsp~ | add support for LSP | + ** Plugins + [[https://github.com/rust-lang/rust-mode][elixir-mode]] + [[https://github.com/tonini/alchemist.el][alchemist.el]]