Skip to content

Conversation

@alexakreizinger
Copy link
Member

@alexakreizinger alexakreizinger commented Dec 17, 2025

turns out the changes I made in #2303 were a little too dramatic... 😅 so this PR scales things down a bit.

  • it ONLY catches things at the start of a newline, with or without a > in front of it.
  • the offending word always needs a colon after it.
  • simplified the regex to be more specific about how it checks for asterisks and underscores.
  • (bonus: checks for plurals in certain words like 'note')

Summary by CodeRabbit

  • Bug Fixes
    • Improved hint block recognition to support case variations, plural forms, and optional formatting styles for better flexibility in documentation parsing.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
@alexakreizinger alexakreizinger requested review from a team as code owners December 17, 2025 18:31
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 17, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The Vale styles configuration for FluentBit's hint detection patterns has been updated to replace explicit, singular token patterns with unified, case-insensitive regex patterns that support optional emphasis (bold/italic/underline), plural forms, and flexible block quote anchoring.

Changes

Cohort / File(s) Change Summary
Vale style pattern generalization
vale-styles/FluentBit/Hints.yml
Replaced fixed, line-anchored token patterns for notes, cautions, warnings, dangers, important, info, hints, tips, and success with broadened, case-insensitive regex patterns. New patterns support optional bold/italic/underline markup, plural/singular variants, and flexible anchoring to line start or block quote indicator (^> |^), enabling more flexible hint block recognition.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Verify that new case-insensitive regex patterns correctly match intended hint block triggers without introducing false positives
  • Ensure plural and singular variants are properly recognized across all hint types
  • Test optional emphasis markup (bold/italic/underline) patterns in YAML syntax context
  • Confirm backward compatibility with existing hint blocks in documentation

Possibly related PRs

  • expand hint-related tests #2303 — Parallel modification to the same Vale style file expanding regex patterns for note/hint/warning token detection with optional emphasis and pluralization support.

Suggested labels

4.2.1

Suggested reviewers

  • cosmo0920

Poem

🐰 Patterns so rigid, now dance with flair,
Notes, hints, and warnings floating through air,
Bold, italic, plural—take any form,
Vale's style rules now flex as the norm!
Blockquotes and brackets, all welcome today,

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch alexakreizinger/sc-158233/add-more-vale-tests-in-fluent-to-catch-note2

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f393266 and 0b6906d.

📒 Files selected for processing (1)
  • vale-styles/FluentBit/Hints.yml (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@alexakreizinger alexakreizinger merged commit 199ccdf into master Dec 17, 2025
5 of 6 checks passed
@alexakreizinger alexakreizinger deleted the alexakreizinger/sc-158233/add-more-vale-tests-in-fluent-to-catch-note2 branch December 17, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants