2.9 KiB
id, title, status, assignee, created_date, updated_date, labels, dependencies, references, priority
| id | title | status | assignee | created_date | updated_date | labels | dependencies | references | priority | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TASK-113 | Scope make pretty to maintained source files | Done |
|
2026-03-08 00:20 | 2026-03-08 00:22 |
|
|
medium |
Description
Change the make pretty workflow so it formats only the maintained source/config files we intentionally keep under Prettier, instead of sweeping backlog/docs/generated content across the whole repository.
Acceptance Criteria
- #1
make prettyformats only the approved maintained source/config paths - #2 The allowlist is reusable for check/write flows instead of duplicating path logic
- #3 Verification shows the scoped formatting command targets the intended files without touching backlog or vendored content
Implementation Plan
- Inspect current Prettier config/ignore behavior and keep the broad repo-wide format command unchanged.
- Add a reusable scoped Prettier script that targets maintained source/config paths only.
- Update
make prettyto call the scoped script. - Verify the scoped command resolves only intended files and does not traverse backlog or vendor paths.
Implementation Notes
User approved the allowlist approach: keep repo-wide format intact, make make pretty use a maintained-path formatter scope.
Added scripts/prettier-scope.sh as the single allowlist for scoped Prettier paths and wired format:src / format:check:src to it.
Updated make pretty to call bun run format:src. Verified with make -n pretty and shell tracing that the helper only targets the maintained allowlist and does not traverse backlog/ or vendor/.
Excluded Makefile and .prettierignore from the allowlist after verification showed Prettier cannot infer parsers for them.
Final Summary
Scoped the repo's day-to-day formatting entrypoint without changing the existing broad repo-wide Prettier scripts. Added scripts/prettier-scope.sh as the shared allowlist for maintained source/config paths (.github, build, launcher, scripts, src, plus selected root JSON config files), added format:src and format:check:src in package.json, and updated make pretty to run the scoped formatter.
Verification: make -n pretty now resolves to bun run format:src. bash -n scripts/prettier-scope.sh passed, and shell-traced bash -x scripts/prettier-scope.sh --check confirmed the exact allowlist passed to Prettier. bun run format:check:src fails only because existing files inside the allowed source scope are not currently formatted; it no longer touches backlog/ or vendor/.