doomemacs/modules/lang/clojure/README.org

61 lines
1.7 KiB
Org Mode
Raw Normal View History

2020-02-23 16:24:11 -05:00
#+TITLE: lang/clojure
#+DATE: May 30, 2017
#+SINCE: v2.0
#+STARTUP: inlineimages nofold
* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#maintainers][Maintainers]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description
This module adds support for the Clojure(Script) language.
2020-02-23 16:24:11 -05:00
+ Interactive development environment (~cider~): REPL, compilation, debugging,
running tests, definitions & documentation lookup, code completion, and many
more
+ Refactoring (~clj-refactor~)
+ Linting (~clj-kondo~), requires ~:checkers syntax~
+ LSP support
2020-02-23 16:24:11 -05:00
** Maintainers
This module has no dedicated maintainers.
** Module Flags
+ =+lsp= Enables LSP support, alongside Cider.
2020-02-23 16:24:11 -05:00
** Plugins
+ [[https://github.com/clojure-emacs/cider][cider]]
2020-02-23 16:24:11 -05:00
+ [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
+ [[https://github.com/borkdude/flycheck-clj-kondo][flycheck-clj-kondo]]
2020-02-23 16:24:11 -05:00
** Hacks
+ Error messages emitted from CIDER are piped into the REPL buffer when it is
first opened, to make them easier to notice.
+ Disabled the help banner when opening the cider REPL.
* Prerequisites
This module requires:
+ clojure
+ With =+lsp=
+ clojure-lsp
+ Without =+lsp=
+ [[https://leiningen.org/][leiningen]] (REPL)
+ [[https://github.com/borkdude/clj-kondo][clj-kondo]] (linter)
2020-02-23 16:24:11 -05:00
* TODO Features
# An in-depth list of features, how to use them, and their dependencies.
* TODO Configuration
# How to configure this module, including common problems and how to address them.
* TODO Troubleshooting
# Common issues and their solution, or places to look for help.