Repository navigation
Add rumdl as Markdown linter - #107
Merged
Merged
Conversation
Assisted-by: Claude:claude-opus-5-5
Assisted-by: Claude:claude-opus-5-5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 lintruns rumdl, the pre-commit hook runsmake lintbefore its Java compile, and a newchecksjob in CI runs rumdl.make lint-fixfixes 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..gitignoreskips Claude Code worktrees in.claude/worktrees/, sorumdl check .andmake lint-fixdo not walk into the checkouts of other branches.Review notes
make lintruns every linter of the project. Here that is only rumdl: the project has no Checkstyle or Spotless, and Error Prone and NullAway run insidecompileJava, so the compile step stays in the hook aftermake lint. A later linter such as Spotless also goes intomake lint.lint-fix, because make reads a colon as the end of a target name. It usesrumdl check --fix .and notrumdl fmt .: both apply the same fixes, but onlycheck --fixfails when a problem remains that rumdl cannot fix.checksjob runs rumdl, instead of a step in each of the four PostgreSQL test jobs. The test jobs do not wait for it.rumdl fmtfixes most problems in one small commit, and a pinned version needs regular updates.Risk: low, assessed at 88d65fb