merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
Henrik Lissner
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
|
@ -1,57 +1,66 @@
|
|||
#+TITLE: lang/lua
|
||||
#+DATE: Jun 3, 2020
|
||||
#+SINCE: v3.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :lang lua
|
||||
#+subtitle: One-based indices? one-based indices
|
||||
#+created: Jun 03, 2020
|
||||
#+since: 21.12.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#language-server-protocol-servers][Language Server Protocol servers]]
|
||||
- [[#lsp-mode][LSP-mode]]
|
||||
- [[#eglot][Eglot]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
- [[#install-lua-language-server][Install lua-language-server]]
|
||||
* Description :unfold:
|
||||
This module adds Lua support to Doom Emacs.
|
||||
|
||||
* Description
|
||||
Adds Lua support to Doom Emacs
|
||||
# A summary of what this module does.
|
||||
|
||||
+ REPL
|
||||
+ Love2D specific functions
|
||||
+ Moonscript support
|
||||
- REPL
|
||||
- Love2D specific functions
|
||||
- Moonscript support
|
||||
- Fennel support
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers.
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Module Flags
|
||||
+ =+moonscript= Moonscript language support
|
||||
+ =+fennel= Fennel language support
|
||||
+ =+lsp= Language Server Protocol support
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
# A list of linked plugins
|
||||
+ [[https://github.com/immerrr/lua-mode][lua-mode]]
|
||||
+ [[https://github.com/k2052/moonscript-mode][moonscript-mode]] (=+moonscript=)
|
||||
+ [[https://gitlab.com/technomancy/fennel-mode][fennel-mode]] (=+fennel=)
|
||||
** Module flags
|
||||
- +fennel ::
|
||||
Enable support for the Fennel language.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~lua-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
(supports EmmyLua, lua-language-server, and lua-lsp).
|
||||
- +moonscript ::
|
||||
Enable support for the Moonscript language.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-lua]] if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][fennel-mode]] if [[doom-module:][+fennel]]
|
||||
- [[doom-package:][lua-mode]]
|
||||
- if [[doom-module:][+moonscript]]
|
||||
- [[doom-package:][flycheck-moonscript]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][moonscript-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.]]
|
||||
|
||||
This module requires Lua 5.1+ for most of its capabilities and, optionally, the
|
||||
fennel and moonscript transpilers. An LSP server is also required for LSP
|
||||
support.
|
||||
|
||||
* Prerequisites
|
||||
** Language Server Protocol servers
|
||||
LSP server support depends on which flavor of the =:tools lsp= module you have
|
||||
installed (Eglot or LSP-mode).
|
||||
LSP server support depends on which flavor of the [[doom-module:][:tools lsp]] module you have
|
||||
installed ([[doom-package:][eglot]] or [[doom-package:][lsp-mode]]).
|
||||
|
||||
*** LSP-mode
|
||||
Three servers are supported, ordered from highest to lowest priority:
|
||||
|
||||
+ [[https://github.com/EmmyLua/EmmyLua-LanguageServer][EmmyLua-LanguageServer]] :: Must be in =~/.emacs.d/.local/etc/lsp/EmmyLua-LS-all.jar=. See ~lsp-clients-emmy-lua-jar-path~ variable to change this.
|
||||
+ [[https://github.com/sumneko/lua-language-server][Sumneko language server]] (lua-language-server) :: Must be in
|
||||
=~/.config/emacs/.local/etc/lsp/lua-language-server/=. See
|
||||
- [[https://github.com/EmmyLua/EmmyLua-LanguageServer][EmmyLua-LanguageServer]] :: Must be in
|
||||
=$EMACSDIR/.local/etc/lsp/EmmyLua-LS-all.jar=. See
|
||||
~lsp-clients-emmy-lua-jar-path~ variable to change this.
|
||||
- [[https://github.com/sumneko/lua-language-server][Sumneko language server]] (lua-language-server) :: Must be in
|
||||
=$EMACSDIR/.local/etc/lsp/lua-language-server/=. See
|
||||
~lsp-clients-lua-language-server-bin~ variable to change this.
|
||||
+ [[https://github.com/Alloyed/lua-lsp][lua-lsp]] :: Must be available in =~/.luarocks/bin/lua-lsp=. See
|
||||
- [[https://github.com/Alloyed/lua-lsp][lua-lsp]] :: Must be available in =~/.luarocks/bin/lua-lsp=. See
|
||||
~lsp-clients-lua-lsp-server-install-dir~ variable to change this.
|
||||
|
||||
[[https://emacs-lsp.github.io/lsp-mode/page/lsp-emmy-lua/][LSP-mode documentation]] has more information about setting up the server and the
|
||||
|
|
@ -59,20 +68,35 @@ configuration variables correctly.
|
|||
|
||||
*** Eglot
|
||||
Eglot currently only supports one of the above servers out of the box:
|
||||
|
||||
+ [[https://github.com/sumneko/lua-language-server][Sumneko language server]] (lua-language-server) :: Must be in
|
||||
=~/.config/emacs/.local/etc/lsp/lua-language-server/=. See
|
||||
~+lua-lsp-dir~ variable to change this.
|
||||
=$EMACSDIR/.local/etc/lsp/lua-language-server/=. See ~+lua-lsp-dir~ variable
|
||||
to change this.
|
||||
|
||||
* TODO Features
|
||||
# An in-depth list of features, how to use them, and their dependencies.
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
- lua-lsp-dir :: This must be set when using =+lsp= and using
|
||||
[[https://github.com/sumneko/lua-language-server][lua-language-server]]. This controls where the repository has been cloned and
|
||||
built to finish the configuration of the server.
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- lua-lsp-dir :: This must be set when using [[doom-module:][+lsp]] and using [[https://github.com/sumneko/lua-language-server][lua-language-server]].
|
||||
This controls where the repository has been cloned and built to finish the
|
||||
configuration of the server.
|
||||
|
||||
* Troubleshooting
|
||||
[[doom-report:][Report an issue?]]
|
||||
|
||||
** Install lua-language-server
|
||||
A [[https://github.com/sumneko/lua-language-server/issues/60][catch-all issue]] has been created to gather help for installing
|
||||
lua-language-server on non-VSCode platforms.
|
||||
|
||||
* 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue