falkicon/mechanic

Overview

This skill ensures Lua code quality for World of Warcraft addons using Luacheck for linting and StyLua for formatting. It helps detect common warnings, enforce consistent style, and apply automated fixes so code is review-ready. Use it to catch bugs early and maintain a uniform codebase across contributors.

How this skill works

The skill runs Luacheck to identify syntax errors, undefined globals, unused variables, shadowing, and other common issues. It applies StyLua to format files according to a configurable style (.stylua.toml). Additional tools provide security and complexity analysis to surface runtime safety and maintainability problems.

When to use it

• Before committing or opening a pull request
• When preparing an addon for review or public release
• During CI to enforce style and lint gates
• To hunt down undefined globals or unused code
• When auditing for security or combat-taint risks

Best practices

• Run lint before every commit to catch issues early
• Keep a project .luacheckrc and .stylua.toml under version control
• Add addon-specific globals to read_globals instead of silencing warnings
• Prefix intentionally unused variables or args with an underscore (e.g., _event)
• Run format then lint: format fixes style, lint catches logic and API issues

Example use cases

• Run addon.lint(addon="MyAddon") to list Luacheck warnings before a release
• Use addon.format(addon="MyAddon") to auto-format the entire addon
• CI pipeline: fail build if addon.format(..., check=true) or addon.lint reports issues
• Run addon.security(addon="MyAddon") to find combat_violation, taint_risk, or secret_leak problems
• Use addon.complexity(addon="MyAddon") to locate long functions and deep nesting for refactoring