Add comment-fmt, wire up CI check - #8
Merged
Merged
Conversation
Adds comment-fmt as a dev dependency and a CI job that runs --check, before any reformat. Expected to fail until the follow-up --write pass lands.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
Self-authored and self-published (Vilos92/comment-fmt), not a third-party dependency this policy guards against. Without this, CI's plain bun install --frozen-lockfile fails on every job, not just the new comment-fmt check, since a fresh release can't be installed at all until it clears 7 days.
Bulk --write pass. Two comments overflowed 110 columns: a single-line JSDoc expanded to the starred multi-line form, and a long // comment rewrapped across two lines. No mangles (ignore/disable/expect-error/ tables/box-drawing untouched).
Runs last in the staged pipeline, after vp check --fix: oxfmt re-indents comments as part of formatting the surrounding code, and comment-fmt's width math depends on the final indentation.
Fixes a case where a @tag's own description stayed at whatever uneven line breaks it was originally authored with even when the paragraph right above it needed rewrapping. No files in this repo were affected by the bug, so this is a dependency bump only. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W14jepHHRWgvVGxQf7dhMS
0.1.9/0.1.10 only changed --check/--diff's own output formatting; format()/wrap() reflow logic is unchanged since 0.1.8, so no source files are affected. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W14jepHHRWgvVGxQf7dhMS
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.
Summary
comment-fmtas a dev dependency and a CI job (comment-fmt) that runscomment-fmt --check.vp staged), at which point CI goes green.Test plan
bun run comment-fmt:checkfails, listingsrc/lib/project-search.tsandsrc/lib/slug-fuzzy.ts(matches the earlier proof-of-concept pass in chore: comment-fmt proof-of-concept reformat (temporary) #7)comment-fmtjob fails first, then passes after the reformat + hook-wiring commits