Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Luacheck Processor

Purpose

Lints Lua scripts using luacheck.

How It Works

Discovers .lua files in the project (excluding common build tool directories), runs luacheck on each file, and records success in the cache. A non-zero exit code from luacheck fails the product.

This processor supports batch mode, allowing multiple files to be checked in a single luacheck invocation for better performance.

Source Files

  • Input: **/*.lua
  • Output: none (linter)

Configuration

[processor.luacheck]
linter = "luacheck"                         # The luacheck command to run
args = []                                    # Additional arguments to pass to luacheck
extra_inputs = []                            # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
linterstring"luacheck"The luacheck executable to run
argsstring[][]Extra arguments passed to luacheck
extra_inputsstring[][]Extra files whose changes trigger rebuilds