sage
/
BatterUp
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
20 Commits 5 Branches 0 Tags 6.9 MiB
Lua 99.9%
Makefile 0.1%
Go to file
Sage Vaillancourt 4546902f2f Backfill with <const> 
Use PascalCase for all constants, explain in new README.
Split 'make check' into a separate command (less likely to shift your files out from under you than 'make lint')
Add __stub.ext.lua with quick explainer for why it's useful.
 		2025-02-01 17:45:10 -05:00
src Backfill with <const> 2025-02-01 17:45:10 -05:00
.gitignore Start up some simple baserunning. 2025-01-26 21:34:19 -05:00
.luarc.json Add .luarc.json for library reading. 2025-01-30 00:18:02 -05:00
Makefile Backfill with <const> 2025-02-01 17:45:10 -05:00
README.md Backfill with <const> 2025-02-01 17:45:10 -05:00
__stub.ext.lua Backfill with <const> 2025-02-01 17:45:10 -05:00

README.md

Batter Up!

Style Guide

This project uses StyLua for linting, and Selene for various other checks.

In addition to using <const>, where applicable, PascalCase is used for any values which should never be mutated, including any elements in a table.

E.g.

local Screen <const> = { x = 400, y = 240 }

should be treated the same as

local ScreenX <const> = 400
local ScreenY <const> = 240

Though the compiler will not enforce this. Furthermore, PascalCase is also used for values that may mutate themselves through method calls. For example, instances of playdate.graphics.animator. The one exception is gfx

N.b. Selene does not understand <const>, so make check uses a sed hack to filter them out.

camelCase tables may be <const>, but can still have mutable fields.