Skip to content

Add rumdl as Markdown linter - #107

Merged
ThoSap merged 2 commits into
mainfrom
add-rumdl-markdown-lint
Nov 16, 2026
Merged

ThoSap merged 2 commits into
mainfrom
add-rumdl-markdown-lint

Conversation

@ThoSap

@ThoSap ThoSap commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Why

The Markdown files of the project had no lint check. rumdl, a fast Markdown linter, now checks them locally and in CI, the same as in backoffice-api.

What changed

make lint runs rumdl, the pre-commit hook runs make lint before its Java compile, and a new checks job in CI runs rumdl. make lint-fix fixes the Markdown files, the README lists rumdl as a prerequisite and shows how to enable the hook and run the linters, and the README passes the check. .gitignore skips Claude Code worktrees in .claude/worktrees/, so rumdl check . and make lint-fix do not walk into the checkouts of other branches.

Review notes

  • make lint runs every linter of the project. Here that is only rumdl: the project has no Checkstyle or Spotless, and Error Prone and NullAway run inside compileJava, so the compile step stays in the hook after make lint. A later linter such as Spotless also goes into make lint.
  • The fix target is lint-fix, because make reads a colon as the end of a target name. It uses rumdl check --fix . and not rumdl fmt .: both apply the same fixes, but only check --fix fails when a problem remains that rumdl cannot fix.
  • The pre-commit hook runs rumdl on the whole working tree, not only on the staged files: rumdl is fast, and this PR fixes all existing Markdown files.
  • The test workflow had no job for lint checks, so a new checks job runs rumdl, instead of a step in each of the four PostgreSQL test jobs. The test jobs do not wait for it.
  • The rumdl step does not pin the rumdl version: a new release can fail the build, but rumdl fmt fixes most problems in one small commit, and a pinned version needs regular updates.
Risk: low, assessed at 88d65fb
  • Every changed file had a full review, with a second opinion from GPT, and no finding is open.
  • Nothing is left for the reviewer, and no file is must-review.
  • The repository has no freshness Action, so the label was set without it: a later push does not remove it.

Assisted-by: Claude:claude-opus-5-5
@ThoSap ThoSap self-assigned this Nov 16, 2026
@ThoSap ThoSap added the risk:low Self-reviewed, nothing asks for a human: merge on green CI label Nov 16, 2026
@ThoSap ThoSap changed the title Add rumdl as Markdown linter Add rumdl as Markdown linter Nov 16, 2026
@ThoSap
ThoSap merged commit 996b11a into main Nov 16, 2026
5 checks passed
@ThoSap
ThoSap deleted the add-rumdl-markdown-lint branch November 16, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:low Self-reviewed, nothing asks for a human: merge on green CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant