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 checks. The default command applies the full repository rule set, including unused import and local variable checks.

npm run lint

Commands

ScriptPurpose
npm run lintRun ESLint with the full repository rule set.

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

Examples

npm run lint
npm run lint -- --fix

Inputs and output

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

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