Skip to content

refactor: trim comments in the adapters, common and toolbox config - #29

Merged
ttncode merged 5 commits into
mainfrom
refactor/non-shell-comments
Sep 16, 2026
Merged

ttncode merged 5 commits into
mainfrom
refactor/non-shell-comments

Conversation

@ttncode

@ttncode ttncode commented Sep 16, 2026

Copy link
Copy Markdown
Owner

What this changes

PR 5 of 5 (spec: docs/superpowers/specs/2026-09-16-clean-shell-and-comments-design.md). It covers comments in the tracked files that are not shell: adapter overlays, common/, service compose fragments, root mise.toml, lefthook.yml and .github/workflows.

  • Comment lines went from 578 to 265 across 63 files. Removed: history, incident anecdotes, internal task provenance, marketing prose, and multi-line restatements.
  • Kept: the one-line why a client developer would otherwise undo (pins, security reasons, platform workarounds), splice anchors, parser directives and tool pragmas.
  • Only comments changed; no code did.

How it was verified

  • Lint: mise run lint passes.
  • Tests:
    • mise run test-runner: 265/265.
    • tests/new-laravel-api.bats, tests/new-laravel-inertia.bats, tests/new-nextjs.bats: 24/24.
    • After fix round 1, new-nestjs, new-flask and service bats: 63/63.
  • Generated projects: both passed mise run checklist, and their API/web images built. The two were --api flask --web nextjs --db postgres --cache redis and --api nestjs --db mongodb.
  • Byte-identity: every @ANCHOR@ token and # syntax= line is identical in position before and after.

Checklist

  • mise run lint passes
  • mise run test-runner passes
  • New behaviour has a test that fails without the change
  • Docs that describe changed behaviour were updated in the same commit
  • No unrelated changes

iam-truongtrungnghia added 5 commits September 16, 2026 23:31
…hs.mjs

Two comments cited this toolbox's own "task 6/9/11" development history,
which a client developer reading their generated project has no context
for. Keep the rationale, drop the provenance.
…one-line why

Drop history, anecdotes and restatement from the adapter overlays and the
service compose fragments; keep the pins, platform workarounds and security
reasons a client developer would otherwise undo. Comment text only.
…ne why

Drop toolbox-internal provenance and prose from files copied into every
generated project. Comment text only; the docs mise.toml sentence the tour
cites is kept byte-identical.
Drop incident tallies, timings and journal prose from mise.toml,
lefthook.yml, .gitignore and the workflows. Comment text only.
Restore the driver-written database variables note in each .env.example,
the deliberate :lint duplicate in both laravel mise.toml files and the
.gitignore rooting hazard; drop a readiness comment that was false for
--db none projects. Comment text only.
@ttncode
ttncode merged commit b4a72f7 into main Sep 16, 2026
21 checks passed
@ttncode
ttncode deleted the refactor/non-shell-comments branch September 16, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant