Update Clojure module README

+ Fix linter links to mention the currently used one
+ Add actual description for the module
This commit is contained in:
Ivan Kryvoruchko 2020-03-30 22:07:25 +03:00
parent 111a3e0296
commit d2efcfbb0c
No known key found for this signature in database
GPG key ID: 41EF9C7DEE72758A

View file

@ -15,11 +15,14 @@
- [[#troubleshooting][Troubleshooting]] - [[#troubleshooting][Troubleshooting]]
* Description * Description
# A summary of what this module does. This module adds support for the Clojure(Script) language.
+ If possible, include a brief list of feature highlights here + Interactive development environment (~cider~): REPL, compilation, debugging,
+ Like code completion, syntax checking or available snippets running tests, definitions & documentation lookup, code completion, and many
+ Include links to packages & external things where possible more
+ Refactoring (~clj-refactor~)
+ Linting (~clj-kondo~), requires ~:checkers syntax~
+ LSP support
** Maintainers ** Maintainers
This module has no dedicated maintainers. This module has no dedicated maintainers.
@ -30,7 +33,7 @@ This module has no dedicated maintainers.
** Plugins ** Plugins
+ [[https://github.com/clojure-emacs/cider][cider]] + [[https://github.com/clojure-emacs/cider][cider]]
+ [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]] + [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
+ [[https://github.com/candid82/flycheck-joker][flycheck-joker]] + [[https://github.com/borkdude/flycheck-clj-kondo][flycheck-clj-kondo]]
** Hacks ** Hacks
+ Error messages emitted from CIDER are piped into the REPL buffer when it is + Error messages emitted from CIDER are piped into the REPL buffer when it is
@ -44,8 +47,8 @@ This module requires:
+ With =+lsp= + With =+lsp=
+ clojure-lsp + clojure-lsp
+ Without =+lsp= + Without =+lsp=
+ leiningen (REPL) + [[https://leiningen.org/][leiningen]] (REPL)
+ joker (linter) + [[https://github.com/borkdude/clj-kondo][clj-kondo]] (linter)
* TODO Features * TODO Features
# An in-depth list of features, how to use them, and their dependencies. # An in-depth list of features, how to use them, and their dependencies.