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

Lint

Linting is exposed through package scripts, not a Commander subcommand. Use it for TypeScript, TSX, and CLI source style checks.

npm run lint

Commands

ScriptPurpose
npm run lintRun ESLint with the standard config.
npm run lint:strictRun the stricter ESLint config.

The standard command stores its cache under target/eslint/cache.json.

Examples

npm run lint
npm run lint:strict
npm run lint -- --fix

Inputs and output

Lint reads TypeScript, TSX, and JavaScript sources from the repository and reports rule violations to the terminal. The standard script reuses the ESLint cache, so repeated runs after small edits are faster than a cold run.

Use the normal lint command during documentation-adjacent code edits or focused implementation work. Use strict lint before larger changes when you want the additional repository checks.

Use npm run typecheck for TypeScriptToLua script type checks and npm run typecheck:tests for test TypeScript checks. Use npm test for Jest.