alex/g3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add non-obvious Racket style guide recommendations

Browse Source 
From docs.racket-lang.org/style, added only the non-obvious tips:
- Prefer define over let/let* (reduces indentation)
- Put provide before require (interface at top)
- Use racket/base for libraries (faster loading)
- Naming: prefix functions with data type (board-free-spaces)
- Use in-list/in-vector explicitly in for loops (performance)
- Use module+ test submodules with raco test
- Size limits: ~500 lines/module, ~66 lines/function

Skipped basic conventions LLMs already know (predicate suffixes, etc).
This commit is contained in:
Dhanji R. Prasanna
2026-01-15 07:25:38 +05:30
parent 5ad9fb3718
commit e222b9affc
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
prompts/langs/carmack.racket.md
View File

@@ -14,6 +14,7 @@ Prefer **obvious, readable Racket** over cleverness.
- Use `match` / `match-define` for destructuring. - Use `match` / `match-define` for destructuring.
- Use `for/*` loops and sequences instead of manual recursion unless recursion is clearer. - Use `for/*` loops and sequences instead of manual recursion unless recursion is clearer.
- Use `cond`, `case`, `and`, `or` cleanly; avoid nested `if` pyramids. - Use `cond`, `case`, `and`, `or` cleanly; avoid nested `if` pyramids.
- Prefer `define` over `let`/`let*` when it reduces indentation.
- Use immutable data by default; reach for mutation only when it materially improves clarity/perf. - Use immutable data by default; reach for mutation only when it materially improves clarity/perf.
## Modules: explicit exports ## Modules: explicit exports
@@ -27,9 +28,14 @@ Prefer **obvious, readable Racket** over cleverness.
(provide (all-defined-out)) (provide (all-defined-out))
``` ```
- Organize code into small modules with explicit `provide` lists. - Organize code into small modules with explicit `provide` lists.
- Put `provide` before `require` — interface at top.
- Prefer `contract-out` when exporting public APIs. - Prefer `contract-out` when exporting public APIs.
- Avoid `provide (all-defined-out)` except in quick prototypes/tests. - Avoid `provide (all-defined-out)` except in quick prototypes/tests.
- Prefer `require` with explicit identifiers; avoid huge wildcard imports. - Prefer `require` with explicit identifiers; avoid huge wildcard imports.
- Use `racket/base` for libraries (faster loading); use `racket` for scripts.
## Naming
- Prefix functions with data type of main argument: `board-free-spaces` not `free-spaces`.
## Contracts and types ## Contracts and types
- If in untyped Racket: add contracts at module boundaries for public APIs, especially for callbacks and data shapes. - If in untyped Racket: add contracts at module boundaries for public APIs, especially for callbacks and data shapes.
@@ -52,6 +58,7 @@ Prefer **obvious, readable Racket** over cleverness.
## Performance ## Performance
- Prefer vectors for hot loops / indexed access; lists for iteration; hashes for keyed lookup. - Prefer vectors for hot loops / indexed access; lists for iteration; hashes for keyed lookup.
- Use `for/fold` or `for/hash` to build results efficiently. - Use `for/fold` or `for/hash` to build results efficiently.
- Use `in-list`, `in-vector`, etc. explicitly in `for` loops for better performance.
- Avoid repeated `append` in loops; accumulate then reverse if needed. - Avoid repeated `append` in loops; accumulate then reverse if needed.
## Macros: use sparingly ## Macros: use sparingly
@@ -80,8 +87,13 @@ Prefer **obvious, readable Racket** over cleverness.
## Testing ## Testing
- Add `rackunit` tests for tricky logic; prefer table-driven tests. - Add `rackunit` tests for tricky logic; prefer table-driven tests.
- Use `module+ test` submodules; run with `raco test`.
- Consider Scribble docs for library boundaries. - Consider Scribble docs for library boundaries.
## Size limits
- ~500 lines per module (1000 tolerable, 10000 is a god-file).
- ~66 lines per function (one screen).
## Packages/tooling ## Packages/tooling
- Assume `raco fmt` style; keep formatting consistent. - Assume `raco fmt` style; keep formatting consistent.
- Use `raco pkg install --auto` for dependency resolution. - Use `raco pkg install --auto` for dependency resolution.