doomemacs/modules/lang/lua/README.org

lang/lua

• 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
• +lsp Language Server Protocol support

Plugins

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

Prerequisites

Language Server Protocol servers

Currently the servers supported depend on the :tools lsp flavor you are using

LSP-mode

This server is built in Java, so a java environment will be necessary

• EmmyLua-LanguageServer must be installed and configured to use the configuration provided by emacs-lsp.

LSP-mode documentation has more information about setting up the server and the configuration variables correctly (use a bare (setq lsp-clients-emmy-lua-java-path value) in your config.el)

Eglot

This server is built in Lua, so a lua environment will be necessary

• lua-language-server must be installed and built locally, with +lua-lsp-dir variable pointing to the root of the repository

TODO 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.