lua(9)

SYNOPSIS

lua - Lua files

FILES

hklua.emf - Lua hook definition
lua.eaf - Lua abbreviation file
lua.etf - Lua template file.

EXTENSIONS

.lua - Lua file

DESCRIPTION

The Lua file type editing provides simple hilighting of Lua files, abbreviations, folding, item-list support and lua function tagging using the luatags(3f) command.

Abbreviations


The installation comes with a default abbreviation file for Lua file editing which can be used by writing short abbreviations like "if", "el" (else) or "fu" (function) - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Auto Layout


The indentation mechanism is enabled which performs automatic layout of the text. restyle-region(3) and restyle-buffer(3) are available to reformat (re-layout) selected sections of the buffer, or the whole buffer, respectively.

Folding and Information Hiding


Generic folding is enabled within the Lua file. The folds occur about functions as these declarations are starting at the beginning of one line and ending at a line starting with the end keyword. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

Navigation via Item List


The Lua mode offers beside folding as well support for displaying an outline of the functions for easy navigation using the item-list(3) command.

Short Cuts


The short cut keys used within the buffer are:-

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with stars (#).
A-C-i - Restyle the current region.
esc q - Format a comment.
esc o - Format a comment.
f2 - (Un)fold the current region.
C-f2 - (Un)fold all regions.
f6 - List items.
esc f6 - Close item list.

Executing, Formatting and Linting Lua Code


The Lua file hook supports the file-exec(3), the file-format(3) and the file-lint(3) macros. The default commands and tools are "luac" for linting, "lua" for execting and the "luafmt" application for formatting. The procedure to install the "luafmt" application on a Unix using the npm package manager system is like this:

     sudo npm install -g lua-fmt 

If the application "luafmt" is not available, the macro restyle-buffer(3), will be used instead.

NOTES

The hilighting and other features are typically extended using a file mylua.emf.

BUGS

None reported so far but many features are added just recently and have not been tested throughly.

SEE ALSO

abbrev-list(3), collapse-all(3), collapse-current(3), expand-abbrev-handle(3), file-exec(3), file-format(3), file-lint(3), item-list(3), luatags(3f), restyle-buffer(3), restyle-region(3), time(2m).

Supported File Types

(c) Copyright JASSPA 2025
Last Modified: 2025/09/11
Generated On: 2025/09/29