make fmt and make fmt-check cover Markdown with prettier #39

Closed
opened 2026-10-03 14:11:37 +02:00 by clawbot · 1 comment
Collaborator

The repo policy says Markdown is formatted with prettier, with four-space indents and proseWrap: always, and sneak's standing rule is that changed Markdown is formatted through make fmt. Here script/fmt runs only go fmt and script/fmt-check only gofmt -l, so nothing formats or checks README.md.

Work, on a branch cut from next after #38 has landed (both change script/bootstrap's surroundings and the README Entrypoints section), PR to next:

  • prettier pinned the way sneak/prompts does it: package.json with prettier as an exact-version dev dependency and a committed yarn.lock; .prettierrc with tabWidth: 4 and proseWrap: always.
  • script/bootstrap installs node and yarn at pinned versions the way the sneak/prompts script/bootstrap does (hash-verified nvm archive, never curl | sh) and installs the yarn dependencies.
  • script/fmt runs go fmt and then prettier --write on **/*.md; script/fmt-check runs the gofmt -l check and prettier --check on the same files, finding yarn the way the sneak/prompts script/fmt-check does.
  • .gitignore carries node_modules/.
  • Run make fmt once and commit what it changes in the Markdown files.
  • The README Entrypoints section says what fmt and fmt-check cover and that bootstrap installs node and yarn.

Definition of done

  • A Markdown line wider than 80 columns makes make fmt-check fail, and make fmt fixes it.
  • make check and script/cibuild pass on a fresh clone.

Model: opus-5-5

The repo policy says Markdown is formatted with prettier, with four-space indents and `proseWrap: always`, and sneak's standing rule is that changed Markdown is formatted through `make fmt`. Here `script/fmt` runs only `go fmt` and `script/fmt-check` only `gofmt -l`, so nothing formats or checks `README.md`. Work, on a branch cut from `next` after https://git.eeqj.de/sneak/keyfunc/issues/38 has landed (both change `script/bootstrap`'s surroundings and the README Entrypoints section), PR to `next`: - prettier pinned the way `sneak/prompts` does it: `package.json` with `prettier` as an exact-version dev dependency and a committed `yarn.lock`; `.prettierrc` with `tabWidth: 4` and `proseWrap: always`. - `script/bootstrap` installs node and yarn at pinned versions the way the `sneak/prompts` `script/bootstrap` does (hash-verified nvm archive, never `curl | sh`) and installs the yarn dependencies. - `script/fmt` runs `go fmt` and then prettier `--write` on `**/*.md`; `script/fmt-check` runs the `gofmt -l` check and prettier `--check` on the same files, finding yarn the way the `sneak/prompts` `script/fmt-check` does. - `.gitignore` carries `node_modules/`. - Run `make fmt` once and commit what it changes in the Markdown files. - The README Entrypoints section says what `fmt` and `fmt-check` cover and that bootstrap installs node and yarn. ## Definition of done - A Markdown line wider than 80 columns makes `make fmt-check` fail, and `make fmt` fixes it. - `make check` and `script/cibuild` pass on a fresh clone. Model: opus-5-5
clawbot self-assigned this 2026-10-03 14:11:37 +02:00
Author
Collaborator

Built in #45: make fmt and make fmt-check now cover the Markdown files with prettier (pinned in package.json and yarn.lock, configured in .prettierrc) as well as the Go source, script/bootstrap installs node and yarn at pinned versions, and README.md is formatted and describes the new coverage.

Model: opus-5-5

Built in https://git.eeqj.de/sneak/keyfunc/pulls/45: `make fmt` and `make fmt-check` now cover the Markdown files with prettier (pinned in `package.json` and `yarn.lock`, configured in `.prettierrc`) as well as the Go source, `script/bootstrap` installs node and yarn at pinned versions, and `README.md` is formatted and describes the new coverage. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/keyfunc#39