make fmt does not format Markdown, so the org prettier settings are unenforced here #215

Open
opened 2026-08-20 06:05:22 +02:00 by clawbot · 0 comments
Collaborator

Found while landing #210.

script/fmt is gofmt -s -w . plus goimports, and there is no prettier config anywhere in the tree. Org policy is that Markdown changes are formatted with the repo's own settings (prettier, 4-space tabs, proseWrap: always) and that unformatted Markdown is never committed — but nothing in this repo enforces that.

The practical effect: make fmt and make fmt-check both pass on any Markdown, however it is wrapped. They pass vacuously. The 162-line README section added by #210 was hand-wrapped to the file's existing 72-column width and checked by eye, which is exactly the manual step the formatter is supposed to remove.

Definition of done:

  • a prettier config in the tree matching the org settings (4-space tabs, proseWrap: always)
  • script/fmt formats Markdown as well as Go; script/fmt-check fails on unformatted Markdown
  • prettier is pinned and runs in Docker like the other linting, not off whatever is on the host
  • the existing Markdown in the tree is reformatted in the same commit, so the check starts green
  • confirm the resulting wrap width does not reflow every existing file into a large unrelated diff; if it does, say so on this issue before committing it
Found while landing https://git.eeqj.de/sneak/webhooker/issues/210. `script/fmt` is `gofmt -s -w .` plus `goimports`, and there is no prettier config anywhere in the tree. Org policy is that Markdown changes are formatted with the repo's own settings (prettier, 4-space tabs, `proseWrap: always`) and that unformatted Markdown is never committed — but nothing in this repo enforces that. The practical effect: `make fmt` and `make fmt-check` both pass on any Markdown, however it is wrapped. They pass vacuously. The 162-line README section added by https://git.eeqj.de/sneak/webhooker/issues/210 was hand-wrapped to the file's existing 72-column width and checked by eye, which is exactly the manual step the formatter is supposed to remove. Definition of done: - a prettier config in the tree matching the org settings (4-space tabs, `proseWrap: always`) - `script/fmt` formats Markdown as well as Go; `script/fmt-check` fails on unformatted Markdown - prettier is pinned and runs in Docker like the other linting, not off whatever is on the host - the existing Markdown in the tree is reformatted in the same commit, so the check starts green - confirm the resulting wrap width does not reflow every existing file into a large unrelated diff; if it does, say so on this issue before committing it
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/webhooker#215