2024-07-08 11:47:28 +01:00
|
|
|
# lune-luau-template
|
|
|
|
|
|
2024-07-08 11:49:02 +01:00
|
|
|
This is a template for initializing [Luau](https://luau-lang.org) projects with [Lune](https://lune-org.github.io/docs).
|
2024-07-08 11:47:28 +01:00
|
|
|
|
|
|
|
|
## What is included in this template?
|
|
|
|
|
|
|
|
|
|
- A barebones structure for an executable hello world Lune script (src/)
|
2024-07-08 12:00:53 +01:00
|
|
|
- A barebones structure for a library (lib/)
|
2024-07-08 11:47:28 +01:00
|
|
|
- Configuration files for various tooling:
|
|
|
|
|
- aftman for toolchain management (aftman.toml)
|
|
|
|
|
- stylua for code formatting (stylua.toml, lune.yml)
|
|
|
|
|
- selene for linting (selene.toml)
|
|
|
|
|
- luau-lsp for code completion (.vscode/settings.json, .nvim.lua)
|
|
|
|
|
- Utility lune scripts (.lune/)
|
|
|
|
|
- Code-formatting
|
|
|
|
|
- Linting
|
|
|
|
|
- Typechecking
|
|
|
|
|
- Unit-testing setup (tests/) -- TODO
|
2024-07-08 12:19:02 +01:00
|
|
|
- GitHub Actions CI configuration to lints and tests (.github)
|
