Repo hygiene: add .editorconfig, keep artifacts out of root, fix .gitignore #39

New issue

Closed

opened 2026-08-30 12:50:40 +02:00 by orkun · 1 comment

orkun commented

2026-08-30 12:50:40 +02:00

Owner

Problem

A few small repo-hygiene gaps add friction and inconsistency:

No .editorconfig — indentation/charset/newline conventions aren't
machine-enforced, so editors drift (matters for a project that ships its own
formatter and cares about byte-identical output).
Root gets littered with build output — programs write out.ppm into the
working directory (tracked separately in the assets issue); the root should stay
clean.
.gitignore inconsistency — **.zip is ignored yet the Kenney zips are
tracked (see assets issue); the ruleset should be internally consistent.
build/ at the root holds generated .ll/objects during development; make
sure everything generated is under build/ and ignored, and nothing generated
escapes it.

Proposal

Add .editorconfig matching the project's Ludic style (indent width, LF,
UTF-8, trailing-newline, trim trailing whitespace).
Ensure all generated output (render dumps, IR, objects, binaries) lands under
build/ (or bin/) and is ignored; keep the repo root free of artifacts.
Reconcile .gitignore so ignored patterns and tracked files don't contradict.
Optionally add a bin/x clean that wipes generated output predictably.

Acceptance criteria

.editorconfig present and consistent with ludic-fmt.
No generated artifacts land outside build//bin/.
.gitignore is internally consistent with what's tracked.

Found during the repository-cleanup / DX pass.

## Problem A few small repo-hygiene gaps add friction and inconsistency: - **No `.editorconfig`** — indentation/charset/newline conventions aren't machine-enforced, so editors drift (matters for a project that ships its own formatter and cares about byte-identical output). - **Root gets littered with build output** — programs write `out.ppm` into the working directory (tracked separately in the assets issue); the root should stay clean. - **`.gitignore` inconsistency** — `**.zip` is ignored yet the Kenney zips are tracked (see assets issue); the ruleset should be internally consistent. - **`build/` at the root** holds generated `.ll`/objects during development; make sure everything generated is under `build/` and ignored, and nothing generated escapes it. ## Proposal - Add `.editorconfig` matching the project's Ludic style (indent width, LF, UTF-8, trailing-newline, trim trailing whitespace). - Ensure all generated output (render dumps, IR, objects, binaries) lands under `build/` (or `bin/`) and is ignored; keep the repo root free of artifacts. - Reconcile `.gitignore` so ignored patterns and tracked files don't contradict. - Optionally add a `bin/x clean` that wipes generated output predictably. ## Acceptance criteria - [ ] `.editorconfig` present and consistent with `ludic-fmt`. - [ ] No generated artifacts land outside `build/`/`bin/`. - [ ] `.gitignore` is internally consistent with what's tracked. Found during the repository-cleanup / DX pass.

orkun added the

priority:low

area:repo

cleanup

labels 2026-08-30 12:50:40 +02:00

orkun referenced this issue from a commit

2026-08-30 15:46:48 +02:00

chore(repo): add .editorconfig, reconcile .gitignore, add `x clean`

orkun closed this issue

2026-08-30 15:46:48 +02:00

orkun commented

2026-08-30 15:47:32 +02:00

Author

Owner

Done in 1c9235a.

Added .editorconfig mirroring ludic-fmt (2-space, LF, UTF-8, trim trailing whitespace + final newline; 4-space for Python tooling; Markdown keeps trailing whitespace for hard line breaks).
Reconciled .gitignore: root-anchored /build/ and /out.ppm, normalised the misleading **.zip glob to *.zip, and documented that the Kenney art is tracked extracted while the download/plugin zips are local-only (no zip is tracked, so this is now internally consistent). .idea -> .idea/.
Added bin/x clean to sweep build/, the root out.ppm, and stray bin/*.tmp, keeping the toolchain binaries so the running x survives.

Note: I did not redirect the runtime's headless dump into build/ — a shipped game binary shouldn't depend on a ./build dir existing; instead the artifact is gitignored and bin/x clean removes it. All acceptance criteria met; 46/46 tests green.

Done in 1c9235a. - Added `.editorconfig` mirroring ludic-fmt (2-space, LF, UTF-8, trim trailing whitespace + final newline; 4-space for Python tooling; Markdown keeps trailing whitespace for hard line breaks). - Reconciled `.gitignore`: root-anchored `/build/` and `/out.ppm`, normalised the misleading `**.zip` glob to `*.zip`, and documented that the Kenney art is tracked *extracted* while the download/plugin zips are local-only (no zip is tracked, so this is now internally consistent). `.idea` -> `.idea/`. - Added `bin/x clean` to sweep `build/`, the root `out.ppm`, and stray `bin/*.tmp`, keeping the toolchain binaries so the running `x` survives. Note: I did not redirect the runtime's headless dump into `build/` — a shipped game binary shouldn't depend on a `./build` dir existing; instead the artifact is gitignored and `bin/x clean` removes it. All acceptance criteria met; 46/46 tests green.