script/fmt and script/fmt-check dropped Markdown formatting #19
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The canonical scripts-to-rule-them-all templates in the
promptsrepo run prettier over Markdown:script/fmt:yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap alwaysscript/fmt-check: the same with--checksfdupes replaced both bodies with gofmt only (
script/fmt:9isgofmt -s -w .;script/fmt-check:10-15isgofmt -s -l .). Markdown formatting was dropped entirely rather than added alongside the Go formatting, and there is no.prettierrcor.prettierignorein the repo.Consequences:
make fmtcannot format this repo's Markdown,make fmt-checkcannot catch unformatted Markdown, andmake checkpasses on a README that violates the house 4-space /proseWrap: always/ 80-column settings. Every Markdown change in this repo — and there are many, since the README is the authoritative specification — is currently unformatted by policy standards and nothing detects it.Definition of done
.prettierrcand.prettierignoreare copied verbatim from thepromptsrepo root (.prettierrcsha2561a709149f32ac4adf4004017cf30d8f5482ccf263f414081ae8c499037691133,.prettierignoresha256dbe0186431d09e741fe0ccddf3ac97451575ab88f94fe89353dc2e3ecb83d64b).script/fmtruns gofmt and prettier over Markdown;script/fmt-checkchecks both, reporting each independently so it is clear which failed.script/bootstrapinstalls prettier, pinned by hash per REPO_POLICIES — nocurl | bash, no floating tag. Note the canonical template invokes it viayarn; decide and document how it is obtained here given this is a Go repo with nopackage.json, and keep the pinning rule intact.make fmt-check, or the Markdown check is placed where CI genuinely runs it — do not let the check exist only on developer machines.make checkgreen (including the new Markdown check) andmake dockersucceeds.