Configuration

The configuration file that Fabricate looks for by default is “fab.lua”. However, by passing the config flag any path can be used.

The configuration is written in Lua (Lua 5.4). All of the standard lua functions are available, that is to say, the configuration is not sandboxed. Fabricate exposes a lot of helpers and the fab global for interacting with fab.

In the configuration documentation there are a couple concepts that need to be described:

• In function descriptions the a returns field describes the, quite intuitively, return value. Respectively varargs describes the arguments to be passed as variable arguments.

• The type annotations follow the style of the Lua Language Server type annotations.

API

• Fab Library
• Object Types
• Builtins

Identifier

An identifier is a sequence of characters that:

• Consists of:

  • Alphabetic or numeric characters

  • -, _, .

• Does not begin with fab_