Preserve markdownlint directives when wrapping

[leynos]

Summary

• update wrap logic to keep markdownlint directives on a single line
• cover directive behaviour with integration tests

Testing

• make lint
• make test

---

https://chatgpt.com/codex/tasks/task_e_68888eec3afc8322a17eab06cba6d228

Summary by Sourcery

Preserve markdownlint directives on a single line during text wrapping and add tests to verify directive and comment wrapping behaviors

Enhancements:

• Special-case markdownlint directives in wrap_text to avoid breaking them across lines

Tests:

• Add test to ensure markdownlint directives remain unbroken when wrapping
• Add test to verify regular HTML comments wrap normally across lines

[sourcery-ai]

Reviewer's Guide

Extended wrap_text to detect and preserve markdownlint directives as standalone lines, and added integration tests to confirm this behavior alongside regular comment wrapping.

File-Level Changes

Change	Details	Files
Preserve markdownlint directives during wrapping	Trim lines and detect directives starting with “” Flush current paragraph buffer and clear indentation before emitting the directive Bypass normal wrapping logic for detected markdownlint directives	src/wrap.rs
Add tests for markdownlint directive preservation and comment wrapping	Introduce test_markdownlint_directive_not_broken to verify directives remain on one line Introduce test_regular_comment_wraps_normally to ensure standard comments still wrap	tests/wrap.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Summary by CodeRabbit

• Bug Fixes

  • Markdownlint directive comments are now preserved on their own line and are no longer wrapped or altered during text processing.

• Tests

  • Added tests to ensure markdownlint directive comments remain unwrapped and regular comments are wrapped as expected.

Walkthrough

Introduce a conditional in the wrap_text function to preserve markdownlint directive comments verbatim, ensuring they are not wrapped or altered. Add two tests: one to verify markdownlint directives remain unwrapped, and another to confirm regular HTML comments are wrapped as usual. No changes were made to exported or public entities.

Changes

Cohort / File(s)	Change Summary
Markdownlint Directive Preservation Logic src/wrap.rs	Add a conditional branch in wrap_text to detect and preserve markdownlint directive comments verbatim, flushing any current paragraph buffer and outputting the directive as-is.
Integration Tests for Comment Wrapping tests/wrap.rs	Add two tests: one ensuring markdownlint directives are not wrapped, and another confirming regular comments are wrapped normally.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related issues

• Refactor text wrapping and prefix logic to use textwrap and unicode-width crates #80: Both the PR and the issue involve altering the wrap_text function, with this PR adding special handling for markdownlint directive comments, which would be affected by a broader refactor as proposed in the issue.

Possibly related PRs

• Add URL wrapping regression test #77: Both PRs modify or test the wrap_text function, focusing on preserving special content types (markdownlint directives vs. URLs) during wrapping.
• Improve wrapping logic for hyphenated words #58: Both PRs alter the wrap_text function to handle specific wrapping cases, though for different content (markdownlint directives vs. hyphenated words).
• Add text wrapping to mdtablefix #32: This PR builds directly on the wrapping logic introduced in Add text wrapping to mdtablefix #32, extending it to handle markdownlint directive comments.

Poem

Preserve the lint, let comments fly,
Markdown rules pass safely by.
Directives untouched, the rest may wrap,
Each test ensures there’s no mishap.
In code and verse, let structure sing—
For tidy docs, this change we bring!
📝✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b8174d7 and e728d22.

📒 Files selected for processing (2)

• src/wrap.rs (1 hunks)
• tests/wrap.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Clippy warnings MUST be disallowed.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.
Use predicate functions for conditional criteria with more than two branches.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Use functions and composition. Avoid repetition by extracting reusable logic. Prefer generators or comprehensions, and declarative code to imperative repetition when readable.
Small, meaningful functions. Functions must be small, clear in purpose, single responsibility, and obey command/query segregation.
Name things precisely. Use clear, descriptive variable and function names. For booleans, prefer names with is, has, or should.
Structure log...

Files:

• tests/wrap.rs
• src/wrap.rs

---

⚙️ CodeRabbit Configuration File

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

• Adhere to single responsibility and CQRS

• Place function attributes after doc comments.

• Do not use return in single-line functions.

• Move conditionals with >2 branches into a predicate function.

• Avoid unsafe unless absolutely necessary.

• Every module must begin with a //! doc comment that explains the module's purpose and utility.

• Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar

• Lints must not be silenced except as a last resort.

  • #[allow] is forbidden.
  • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
  • No lint groups, no blanket or file-wide suppression.
  • Include FIXME: with link if a fix is expected.

• Use rstest fixtures for shared setup and to avoid repetition between tests.

• Replace duplicated tests with #[rstest(...)] parameterised cases.

• Prefer mockall for mocks/stubs.

• Prefer .expect() over .unwrap()

• Ensure that any API or behavioural changes are reflected in the documentation in docs/

• Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

• Files must not exceed 400 lines in length

  • Large modules must be decomposed
  • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
  • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

• tests/wrap.rs
• src/wrap.rs

🧬 Code Graph Analysis (1)

tests/wrap.rs (1)

src/process.rs (1)

• process_stream (206-214)

🔇 Additional comments (3)

src/wrap.rs (1)

375-382: Implement the markdownlint directive preservation correctly.

The implementation follows the established pattern used for other special cases in the function. The logic correctly identifies markdownlint directives by checking for the specific prefix and suffix, then preserves them verbatim by flushing the current paragraph buffer and outputting the line unchanged.

tests/wrap.rs (2)

478-487: Verify markdownlint directive preservation with comprehensive test coverage.

The test correctly validates that markdownlint directives remain unchanged during processing. The test case uses a realistic scenario with preceding text and asserts that the entire input is preserved unchanged.

---

489-509: Ensure regular comment wrapping remains unaffected.

The test effectively demonstrates that the new markdownlint directive logic doesn't interfere with normal HTML comment wrapping. The test uses a sufficiently long comment to trigger wrapping and verifies the expected multi-line output format.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/add-test-for-markdownlint-comment-directives

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

• Generalize the markdownlint directive detection (e.g. via a regex) to handle optional whitespace or variations like <!-- markdownlint-disable MD013 -->
• Extract the markdownlint directive check into a small helper to keep wrap_text focused and make future rule additions clearer

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Generalize the markdownlint directive detection (e.g. via a regex) to handle optional whitespace or variations like `<!--  markdownlint-disable MD013 -->`
- Extract the markdownlint directive check into a small helper to keep wrap_text focused and make future rule additions clearer

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[leynos]

Superseded by #129