Skip to content

Improve diff formatting#25

Merged
leynos merged 3 commits intomainfrom
codex/adjust-diff-output-formatting
Jul 20, 2025
Merged

Improve diff formatting#25
leynos merged 3 commits intomainfrom
codex/adjust-diff-output-formatting

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 20, 2025

Summary

  • adjust comment diff lines to show a single line number
  • crop line numbers at four digits and add a | separator

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test
  • markdownlint README.md docs/GITHUB_TOKEN.md
  • nixie README.md docs/GITHUB_TOKEN.md

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

Summary by Sourcery

Enhancements:

  • Simplify comment diff output to display a single right-aligned line number (truncated to last four digits) followed by '|' and the line content

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 20, 2025

Reviewer's Guide

Refactors diff formatting in format_comment_diff by introducing a helper to crop and align line numbers to four digits and replacing the dual-number display with a single-number display separated by a '|' before the text.

File-Level Changes

Change Details Files
Add num_disp helper to crop and format line numbers
  • Implement num_disp to convert i32 to String with right-alignment
  • Trim numbers longer than four digits to their last four digits
src/main.rs
Refactor line rendering to use a single disp value and ' ' separator
  • Remove old_disp and new_disp variables in formatting loop
  • Determine disp from either old or new line number, defaulting to blank spaces
  • Write lines using "{disp}

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

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 20, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 34 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bfdce93 and 3fc1e90.

📒 Files selected for processing (1)
  • src/main.rs (3 hunks)

Summary by CodeRabbit

  • Refactor
    • Improved the display of line numbers in diff outputs by switching to a single right-aligned column with a pipe separator, making the output more readable.

Walkthrough

Introduce a new helper function num_disp within format_comment_diff to right-align and truncate line numbers to four characters. Change the diff output to display a single line number (preferring the new line number), followed by a pipe and the diff text, instead of showing both old and new line numbers side by side.

Changes

File(s) Change Summary
src/main.rs Add private helper num_disp for formatting line numbers; update diff output to single-column line number display with pipe separator; adjust logic for line number selection and formatting within format_comment_diff.

Poem

Four digits stand, aligned with pride,
Old and new, now unified.
A single column, pipe in tow,
Marches diff lines in a row.
Numbers trimmed, the code refined—
Display reborn, by logic designed!
🧮 |

✨ 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/adjust-diff-output-formatting

🪧 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 auto-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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/main.rs:564` </location>
<code_context>
-        let old_disp = o.map_or(String::from("    "), |n| format!("{n:>4}"));
-        let new_disp = n.map_or(String::from("    "), |n| format!("{n:>4}"));
-        writeln!(&mut out, "{old_disp} {new_disp} {text}")?;
+        let num = if let Some(num) = n {
+            *num
+        } else if let Some(num) = o {
</code_context>

<issue_to_address>
Consider collapsing the fallback logic for line number display into a one-liner using combinators.

Here’s a minimal tweak to collapse the fallback logic into a one‐liner and keep the same behavior:

```rust
for (o, n, text) in &lines[start..end] {
    // prefer new over old, or use four spaces if neither exists
    let disp = n
        .or(*o)
        .map(num_disp)
        .unwrap_or_else(|| "    ".to_string());

    writeln!(&mut out, "{disp}|{text}")?;
}
```

Specifically:

1. Replace the `if let` chain with `n.or(o).map(num_disp).unwrap_or_else(...)`.
2. This removes the manual branching and gives you the same single‐column display.
3. You still get the rightmost‐4‐chars formatting from `num_disp` and the `"    "` fallback.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/main.rs Outdated
let old_disp = o.map_or(String::from(" "), |n| format!("{n:>4}"));
let new_disp = n.map_or(String::from(" "), |n| format!("{n:>4}"));
writeln!(&mut out, "{old_disp} {new_disp} {text}")?;
let num = if let Some(num) = n {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (complexity): Consider collapsing the fallback logic for line number display into a one-liner using combinators.

Here’s a minimal tweak to collapse the fallback logic into a one‐liner and keep the same behavior:

for (o, n, text) in &lines[start..end] {
    // prefer new over old, or use four spaces if neither exists
    let disp = n
        .or(*o)
        .map(num_disp)
        .unwrap_or_else(|| "    ".to_string());

    writeln!(&mut out, "{disp}|{text}")?;
}

Specifically:

  1. Replace the if let chain with n.or(o).map(num_disp).unwrap_or_else(...).
  2. This removes the manual branching and gives you the same single‐column display.
  3. You still get the rightmost‐4‐chars formatting from num_disp and the " " fallback.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37d1e52 and d7c2866.

📒 Files selected for processing (1)
  • src/main.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

🔇 Additional comments (1)
src/main.rs (1)

564-576: Excellent improvement to diff readability.

The single-column line number display with pipe separator significantly improves readability compared to the previous two-column approach. The logic correctly prioritises new line numbers over old ones and handles edge cases appropriately.

Comment thread src/main.rs
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
src/main.rs (1)

516-523: Stop truncating line numbers; this confuses users
The helper keeps only the last four digits (e.g. 123452345). Users lose the real location. Either display the full number right-aligned, or accompany truncated output with an indicator (e.g. + prefix) so meaning is not lost.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d7c2866 and bfdce93.

📒 Files selected for processing (1)
  • src/main.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • AGENTS.md

⚙️ CodeRabbit Configuration File

Comment thread src/main.rs Outdated
Comment on lines +565 to +570
let disp = n
.or(*o)
.map(num_disp)
.unwrap_or_else(|| " ".to_string());

writeln!(&mut out, "{disp}|{text}")?;
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix compilation failure in line-number selection
n and o are &Option<i32> so the call to .or(*o) on n does not compile. Dereference or copy before using combinators.

-        let disp = n
-            .or(*o)
+        let disp = (*n)
+            .or(*o)
             .map(num_disp)
             .unwrap_or_else(|| "    ".to_string());
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
let disp = n
.or(*o)
.map(num_disp)
.unwrap_or_else(|| " ".to_string());
writeln!(&mut out, "{disp}|{text}")?;
let disp = (*n)
.or(*o)
.map(num_disp)
.unwrap_or_else(|| " ".to_string());
writeln!(&mut out, "{disp}|{text}")?;
🤖 Prompt for AI Agents
In src/main.rs around lines 565 to 570, the code attempts to call `.or(*o)` on
`n` where both `n` and `o` are `&Option<i32>`, causing a compilation error. To
fix this, dereference or clone the `Option<i32>` values before using `.or()`,
for example by using `(*n).or(*o)` or `n.cloned().or(o.cloned())` to combine the
options correctly.

@leynos leynos merged commit f4ed905 into main Jul 20, 2025
1 check passed
@leynos leynos deleted the codex/adjust-diff-output-formatting branch July 31, 2025 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant