emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(idris): +lsp and idris2 compatibility

Browse source 
Close: #7229
This commit is contained in:
Henrik Lissner 2024-09-10 17:16:29 -04:00
parent 08f5eef3ce
commit e6514cdf47
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
1 changed files with 24 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

31
modules/lang/idris/README.org
View file

@ -10,7 +10,9 @@ This module adds rudimentary [[https://www.idris-lang.org/][Idris]] support to D
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]] *This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags ** Module flags
/This module has no flags./ - +lsp ::
Enable LSP support for ~idris-mode~. Requires [[doom-module::tools lsp]] and
[[https://github.com/idris-community/idris2-lsp][idris2-lsp]].
** Packages ** Packages
- [[doom-package:idris-mode]] - [[doom-package:idris-mode]]
@ -25,23 +27,38 @@ This module adds rudimentary [[https://www.idris-lang.org/][Idris]] support to D
* TODO Installation * TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]] [[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
For [[doom-module:+lsp]], [[https://github.com/idris-community/idris2-lsp][idris2-lsp]] is required.
#+begin_quote #+begin_quote
󱌣 /No installation steps have been documented./ [[doom-contrib-module:][Document them?]] 󱌣 /No installation steps have been documented./ [[doom-contrib-module:][Document them?]]
#+end_quote #+end_quote
* TODO Usage * TODO Usage
#+begin_quote #+begin_quote
󱌣 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]] 󱌣 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote #+end_quote
In addition to ~idris-mode~ goodness, adds frequently used functions under the In addition to ~idris-mode~ goodness, this module adds frequently used functions
[[kbd:][<localleader>]] key. under the [[kbd:][<localleader>]] key.
* TODO Configuration * TODO Configuration
#+begin_quote #+begin_quote
󱌣 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]] 󱌣 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote #+end_quote
** Support for Idris 2
While [[doom-package:idris-mode]] was designed for v1 of the IDE-Protocol of Idris,
it tries to maintain compatibility with v2. However, not all the features have
been realized, so expect a little jank.
To get this working, simply set [[var:idris-interpreter-path]] to the path of the
=idris2= executable. E.g.
#+begin_src emacs-lisp
;;; add to $DOODMIR/config.el
(after! idris-mode
(setq idris-interpreter-path "idris2"))
#+end_src
* Troubleshooting * Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]] /There are no known problems with this module./ [[doom-report:][Report one?]]
@ -50,5 +67,5 @@ In addition to ~idris-mode~ goodness, adds frequently used functions under the
* TODO Appendix * TODO Appendix
#+begin_quote #+begin_quote
󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]] 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote #+end_quote