skills.rest
pontscho
pontschoCOMMUNITY
Explore all skills by this author →
GitHub

p:lua-guidelines

Enforce Lua coding standards with tab indentation and Doxygen-style annotations.

1|Updated Jan 7, 2026
Search Tags:#documentation#lua#code-style#coding-guidelines#module-template#tab-indentation
One-click install
npx skills add https://github.com/pontscho/prompt-heaven --skill p-lua-guidelines
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: p:lua-guidelines
Source: https://github.com/pontscho/prompt-heaven/tree/main/ClaudeCode/skills/p%3ALua
Command: npx skills add https://github.com/pontscho/prompt-heaven --skill p-lua-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes clear, consistent Lua coding standards to reduce cognitive load, improve readability, and speed up collaboration across Lua projects.

Core Features & Use Cases

  • Code style & conventions: tab indentation, camelCase naming, early returns, and consistent nil checks.
  • Documentation standards: Doxygen-style annotations using @ parameters and -- comments for clarity.
  • Utility patterns: built-in table helpers (isempty, deepcopy, merge, mergeTables, nkeys, isarray, getNestedValue, containsTable) and common module template patterns.
  • Use Case: When writing or editing Lua files, implementing modules, or documenting functions, apply these guidelines to produce maintainable, well-documented code ready for review.

Quick Start

Create a small Lua module following these guidelines with a Doxygen-style header.

Frequently Asked Questions about p:lua-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the standard Lua coding conventions for consistent module development?▼

Standard Lua coding conventions enforce tab indentation, camelCase naming, early returns, and consistent nil checks to reduce cognitive load and improve readability across modules.

How do I document Lua functions using Doxygen-style annotations?▼

To document Lua functions, apply Doxygen-style annotations using @ parameters and double-dash comments, ensuring clear documentation for maintainable source files ready for review.

What utility table functions should I use for reliable Lua code structure?▼

Use built-in Lua table helpers like isempty, deepcopy, merge, mergeTables, nkeys, isarray, getNestedValue, and containsTable to ensure reliable code structure and utility patterns.

How do I create a Lua module template following coding guidelines?▼

Create a Lua module template by applying coding guidelines that include tab indentation, Id suffix naming, Doxygen-style headers, and built-in table helpers for a maintainable structure.

Why use tab indentation and early returns in Lua code style?▼

Tab indentation and early returns in Lua code style establish clear, consistent standards that speed up collaboration and reduce cognitive load when writing or reviewing source files.

Related Skills

Explore More Software Engineering Skills→
ThePrimeagenThePrimeagen
4.8k

lua-code-print-statement-generator

Insert descriptive print statements before each line of Lua code.

Community
Basic
FilenCloudDiensteFilenCloudDienste
87

verify-changes

Execute ESLint, TypeScript checks, and unit tests on code changes.

Official
Intermediate
AyalaKaguyaAyalaKaguya

link-workspace-packages

Resolve monorepo dependency linking errors with pnpm, yarn, npm, or bun commands.

Community
Basic
t-stringst-strings

Global Code Style

Enforce global code style guidelines when editing or generating code.

Official
Basic