README.org

lang/lua

Table of Contents

• Description
  • Maintainers
  • Module Flags
  • Plugins
• Prerequisites
  • Language Server Protocol servers
    • LSP-mode
    • Eglot
• Features
• Configuration
• Troubleshooting
  • Install lua-language-server

Description

Adds Lua support to Doom Emacs

• REPL
• Love2D specific functions
• Moonscript support

Maintainers

This module has no dedicated maintainers.

Module Flags

• +moonscript Moonscript language support
• +fennel Fennel language support
• +lsp Language Server Protocol support

Plugins

• lua-mode
• moonscript-mode (+moonscript)
• fennel-mode (+fennel)

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-mode

Three servers are supported, ordered from highest to lowest priority:

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.

Sumneko language server (lua-language-server)

Must be in ~/.config/emacs/.local/etc/lsp/lua-language-server/. See lsp-clients-lua-language-server-bin variable to change this.

lua-lsp

Must be available in ~/.luarocks/bin/lua-lsp. See lsp-clients-lua-lsp-server-install-dir variable to change this.

LSP-mode documentation has more information about setting up the server and the configuration variables correctly.

Eglot

Eglot currently only supports one of the above servers out of the box:

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.

Features

Configuration

lua-lsp-dir

This must be set when using +lsp and using lua-language-server. This controls where the repository has been cloned and built to finish the configuration of the server.

Troubleshooting

Install lua-language-server

A catch-all issue has been created to gather help for installing lua-language-server on non-VSCode platforms.