doomemacs/modules/lang/kotlin/README.org

#+title:    :lang kotlin
#+subtitle: A Java(Script) that won't depress you
#+created:  March 28, 2019
#+since:    21.12.0

* Description :unfold:
This module adds [[https://kotlinlang.org/][Kotlin]] support to Doom Emacs.

** Maintainers
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
- +lsp ::
  Enable LSP support for ~kotlin-mode~. Requires [[doom-module::tools lsp]] and a langserver
  (supports [[https://github.com/emacs-lsp/lsp-mode][kotlin-language-server]]).

** Packages
- [[doom-package:flycheck-kotlin]] if [[doom-module::checkers syntax]]
- [[doom-package:kotlin-mode]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

Install kotlin through your distribution's package manager, eg:

#+begin_src shell
sudo apt install kotlin # Ubuntu
sudo pacman -S kotlin   # Arch Linux
brew install kotlin     # MacOS
#+end_src

or by getting the [[https://github.com/JetBrains/kotlin/releases/latest][latest]] release and adding to your =$PATH= manually.

** Formatter

Formatting is handled using the [[doom-module::editor format]] module via [[https://pinterest.github.io/ktlint/install/cli/][ktlint]].

* TODO Usage
#+begin_quote
 󱌣 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* TODO Configuration
#+begin_quote
 󱌣 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote