Сode style guidelines

Designed to control code quality and standardization.

Glossary

• Lua

  • Spacing

    • Indentation
    • Around operators
    • Inside parenthesis
    • After commas
    • Inside square brackets
    • Comments

  • Newlines

    • Limits
    • Top-level blocks
    • Nested blocks
    • Returns
    • Chunking

  • GLua Additions

    • Operators
    • Comments
    • Continue

  • Naming

    • Local variables and functions
    • Global variables and functions
    • Library names
    • Constants
    • Table keys
    • Throwaway variables
    • Hooks

  • General

    • Quotations
    • Redundant parenthesis
    • Multiline tables
    • Multiline function calls
    • Return early from functions
    • Never use semicolons
    • Constants
    • Function calls

  • Numbers

    • Decimals
    • Starting zeros
    • Trailing zeros
    • Negative numbers

  • Comments

    • Useless comments

• Yue

  • Import
  • Table values
  • Complex function calls
  • Decorators

• Files/Folders

  • File paths style
  • Code initialization files