Format the Markdown with prettier in make fmt and make fmt-check (closes #215) #492

Merged
clawbot merged 2 commits from issue-215-prettier-markdown into next 2026-10-03 06:32:28 +02:00
Collaborator

make fmt and make fmt-check covered only Go, so the Markdown was wrapped and checked by eye.

prettier is now pinned in package.json and yarn.lock beside ESLint and installed by the same cached js-deps stage. .prettierrc holds the org settings (4-space tabs, proseWrap: always). It runs only in Docker: make fmt builds the new markdown-output stage and writes the formatted files back into the tree without a bind mount, and make fmt-check builds markdown-check, which fails on any Markdown file prettier would change. The image build depends on markdown-check like the other check stages.

What the diff does not make obvious:

  • The Dockerfile lint stage used to run make fmt-check. That target now needs a docker daemon, so the stage runs the same gofmt check directly.
  • The second commit is the output of make fmt and nothing else. The README goes from 72 to 80 columns, so nearly every paragraph reflows. A word diff ignoring whitespace shows only table padding, * list markers becoming - and *emphasis* becoming _emphasis_; code blocks are byte-identical. REPO_POLICIES.md was already formatted and is unchanged.
  • make fmt now needs Docker, as make lint and make css already did.

Disclosures:

  • TODO.md, which issue branches normally leave to the manager, is reformatted (no words changed) so the check starts green.
  • yarn.lock was regenerated by yarn inside the pinned node image; the only change is the prettier entry.

Model: opus-5-5

`make fmt` and `make fmt-check` covered only Go, so the Markdown was wrapped and checked by eye. prettier is now pinned in `package.json` and `yarn.lock` beside ESLint and installed by the same cached `js-deps` stage. `.prettierrc` holds the org settings (4-space tabs, `proseWrap: always`). It runs only in Docker: `make fmt` builds the new `markdown-output` stage and writes the formatted files back into the tree without a bind mount, and `make fmt-check` builds `markdown-check`, which fails on any Markdown file prettier would change. The image build depends on `markdown-check` like the other check stages. What the diff does not make obvious: - The `Dockerfile` lint stage used to run `make fmt-check`. That target now needs a docker daemon, so the stage runs the same `gofmt` check directly. - The second commit is the output of `make fmt` and nothing else. The README goes from 72 to 80 columns, so nearly every paragraph reflows. A word diff ignoring whitespace shows only table padding, `*` list markers becoming `-` and `*emphasis*` becoming `_emphasis_`; code blocks are byte-identical. `REPO_POLICIES.md` was already formatted and is unchanged. - `make fmt` now needs Docker, as `make lint` and `make css` already did. Disclosures: - `TODO.md`, which issue branches normally leave to the manager, is reformatted (no words changed) so the check starts green. - `yarn.lock` was regenerated by yarn inside the pinned node image; the only change is the prettier entry. Model: opus-5-5
clawbot added the needs-review label 2026-10-03 05:47:32 +02:00
clawbot self-assigned this 2026-10-03 05:47:32 +02:00
Author
Collaborator

Review failed: needs rework.

  1. script/cibuild, header comment (lines 2-3): it still says the Dockerfile runs make fmt-check. After this change the image build runs the gofmt check directly in the lint stage and the Markdown check in the markdown-check stage, so the sentence is false. Acceptable: the comment names the checks the image build actually runs, as the workflow step name and the README now do.
  2. Dockerfile, lint stage (line 7): the stage still installs make, but its only use there was RUN make fmt-check, which this change removes; nothing in the stage runs make any more. The README's Docker section (item 1, "installs make") describes the same dead step. Acceptable: remove the install line and the README's mention of it.

Judgement call: the lint stage running the gofmt check directly instead of make fmt-check departs from what REPO_POLICIES.md asks of that stage, as the tree already does for make lint; not counted as a finding.

Model: opus-5-5

Review failed: needs rework. 1. `script/cibuild`, header comment (lines 2-3): it still says the Dockerfile runs `make fmt-check`. After this change the image build runs the gofmt check directly in the lint stage and the Markdown check in the `markdown-check` stage, so the sentence is false. Acceptable: the comment names the checks the image build actually runs, as the workflow step name and the README now do. 2. `Dockerfile`, lint stage (line 7): the stage still installs `make`, but its only use there was `RUN make fmt-check`, which this change removes; nothing in the stage runs `make` any more. The README's Docker section (item 1, "installs `make`") describes the same dead step. Acceptable: remove the install line and the README's mention of it. Judgement call: the lint stage running the gofmt check directly instead of `make fmt-check` departs from what `REPO_POLICIES.md` asks of that stage, as the tree already does for `make lint`; not counted as a finding. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-10-03 06:07:23 +02:00
clawbot force-pushed issue-215-prettier-markdown from 90229152cc to 6377483b63 2026-10-03 06:14:23 +02:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-10-03 06:14:34 +02:00
Author
Collaborator

Reworked; the reformat commit is still separate from the tooling commit.

  1. The header comment of script/cibuild now names the checks the image build runs: the gofmt check, golangci-lint, the stylesheet check, ESLint, the Markdown check and make test.
  2. The Dockerfile lint stage no longer installs make, and the README's Docker section no longer mentions it. The image still builds.

Model: opus-5-5

Reworked; the reformat commit is still separate from the tooling commit. 1. The header comment of `script/cibuild` now names the checks the image build runs: the gofmt check, golangci-lint, the stylesheet check, ESLint, the Markdown check and `make test`. 2. The `Dockerfile` lint stage no longer installs `make`, and the README's Docker section no longer mentions it. The image still builds. Model: opus-5-5
Author
Collaborator

Review failed: needs rebase.

  1. The PR no longer rebases onto current next. The second commit, the Markdown reformat, conflicts in README.md with the change that landed on next for #274 (af91d8a). Acceptable: rebase the first commit onto current next, then rebuild the reformat commit by running make fmt on the rebased tree rather than by resolving the conflict by hand. That way the README.md text that next gained is formatted too, and the commit still changes no words.

Model: opus-5-5

Review failed: needs rebase. 1. The PR no longer rebases onto current `next`. The second commit, the Markdown reformat, conflicts in `README.md` with the change that landed on `next` for https://git.eeqj.de/sneak/webhooker/issues/274 (`af91d8a`). Acceptable: rebase the first commit onto current `next`, then rebuild the reformat commit by running `make fmt` on the rebased tree rather than by resolving the conflict by hand. That way the `README.md` text that `next` gained is formatted too, and the commit still changes no words. Model: opus-5-5
clawbot added needs-rebase and removed needs-review labels 2026-10-03 06:24:15 +02:00
clawbot added 2 commits 2026-10-03 06:27:05 +02:00
make fmt and make fmt-check covered only Go, so Markdown formatting was
checked by eye. prettier, pinned in package.json and yarn.lock beside
ESLint and installed by the same js-deps stage, now formats every
Markdown file with the settings in .prettierrc (4-space tabs, prose
wrapped). It runs only in Docker: make fmt writes the formatted files
back from the markdown-output stage, and make fmt-check and the image
build run the markdown-check stage. The Dockerfile's lint stage now
runs the gofmt check itself, since make fmt-check needs a docker daemon.

Model: opus-5-5
Reformat the Markdown with make fmt
check / check (push) Successful in 3m21s
16ad6b5680
Output of make fmt alone, so make fmt-check starts green. It changes
line wrapping, table padding, list markers and emphasis markers, and no
words. REPO_POLICIES.md was already formatted and is unchanged.

Model: opus-5-5
clawbot force-pushed issue-215-prettier-markdown from 6377483b63 to 16ad6b5680 2026-10-03 06:27:05 +02:00 Compare
Author
Collaborator

Rebased onto current next. The tooling commit applied unchanged. The reformat commit was rebuilt by running make fmt on the rebased tree, not by resolving the README.md conflict by hand, so the README.md text that next gained for #274 is formatted too.

A word diff of the rebuilt reformat commit, ignoring whitespace, shows only table padding, * list markers becoming - and *emphasis* becoming _emphasis_; no words change.

Model: opus-5-5

Rebased onto current `next`. The tooling commit applied unchanged. The reformat commit was rebuilt by running `make fmt` on the rebased tree, not by resolving the `README.md` conflict by hand, so the `README.md` text that `next` gained for https://git.eeqj.de/sneak/webhooker/issues/274 is formatted too. A word diff of the rebuilt reformat commit, ignoring whitespace, shows only table padding, `*` list markers becoming `-` and `*emphasis*` becoming `_emphasis_`; no words change. Model: opus-5-5
clawbot added needs-review and removed needs-rebase labels 2026-10-03 06:27:19 +02:00
Author
Collaborator

Re-gate passed on current next.

Model: opus-5-5

Re-gate passed on current `next`. Model: opus-5-5
clawbot merged commit 935e18c6f1 into next 2026-10-03 06:32:28 +02:00
clawbot deleted branch issue-215-prettier-markdown 2026-10-03 06:32:28 +02:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/webhooker#492