Luau Best Practices
CheckedEnsures Lua code adheres to dig1t's style guide, promoting readability, maintainability, and consistent project structure.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add dig1t/skills --skill luau-best-practices -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
dig1t
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned dig1t/skills at 9c4bfddee3.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 9c4bfddee3
- Manifest
- luau-best-practices/SKILL.md
- Scanned
- 12 files, 4,956 lines
- Copies in repo
- 2 — all of them scanned
About this skill
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.