Luau Best Practices

What it does

This skill enforces dig1t's Luau style guide, ensuring Roblox game development code adheres to specific conventions and patterns. It promotes readability, maintainability, and a consistent project structure by applying rules for naming conventions (PascalCase, camelCase, SCREAMING_SNAKE_CASE), file organization, and module design. The skill aims to produce production-quality Luau code following principles like server authority and fail fast validation.

When to use it

• When developing new Roblox game projects where consistency is important.
• To refactor existing Luau codebases to improve readability and maintainability.
• For teams working collaboratively on a Roblox project, ensuring everyone follows the same coding style.
• During code reviews to automatically check for adherence to dig1t's best practices.

Key capabilities

• Naming Convention Enforcement: Ensures proper use of PascalCase for types and modules, camelCase for variables and functions, and SCREAMING_SNAKE_CASE for constants.
• File Organization Guidelines: Dictates a specific order for services/imports, constants, types, module table, private state, private functions, public API, and the return statement within Luau scripts.
• Module Pattern Implementation: Supports the Service Pattern with Start() and Stop() methods for proper initialization and cleanup.
• Private Variable Prefixing: Encourages using an underscore prefix (_) to denote private variables and functions.

Example prompts

• "Apply Luau best practices to this script."
• "Check this code for adherence to the dig1t style guide."
• "Refactor this module according to the recommended file organization pattern."

Tips & gotchas

• The skill enforces a specific, opinionated style guide. It may require adjustments to existing codebases.
• This skill focuses on coding style and patterns; it does not guarantee bug-free or performant code.
• Familiarize yourself with the dig1t's core principles (Server Authority, Fail Fast, Explicit > Implicit, Minimal Surface Area) for optimal results.