You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added -d, --show-diff to the suggest command to display the exact diff being analyzed, including truncation markers/notices when applicable.
Bug Fixes
Dry-run output and diff preview now share the same precomputed truncated diff; analysis uses the truncated diff when --show-diff is enabled (including streaming).
Truncation metadata is now consistently tracked for both streamed and non-streamed suggestion generation, driving verbose truncation warnings reliably.
Tests
Expanded end-to-end coverage for --show-diff across staged/unstaged and streamed cases with maxDiffSize truncation, validating stdout/stderr ordering and the diff sent for analysis.
It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.
Use the following commands to manage reviews:
@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.
Use the checkboxes below for quick actions:
▶️ Resume reviews
🔍 Trigger review
📝 Walkthrough
Walkthrough
Adds a -d, --show-diff flag to suggest. The command prints the analyzed diff when requested, reuses truncated diff data before dry-run handling, and tracks generation truncation separately. E2e tests cover staged truncation, unstaged diffs, and streamed output.
Changes
--show-diff flag for suggest command
Layer / File(s)
Summary
showDiff output and truncation flow src/commands/suggest.ts
Adds showDiff?: boolean, computes truncated diff data before dry-run handling, prints the diff preview and truncation notice when requested, and routes generation truncation through generatedTruncation for verbose and warning output.
precomputed truncation in LLM client src/llm/client.ts
Adds an optional precomputedTruncation parameter to generateSuggestions and generateSuggestionsStream, and uses it instead of recomputing truncation when present.
CLI flag registration and passthrough src/index.ts
Registers -d, --show-diff on the suggest subcommand and passes showDiff: Boolean(options.showDiff) into suggestCommand.
E2e coverage for staged and unstaged diffs tests/e2e/suggest-smoke.test.mjs
Adds suggest --show-diff e2e coverage for truncated staged diffs, unstaged diff content, streamed suggestions, and preserves existing test formatting updates.
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related issues
#87 (Add --show-diff flag to commit-echo suggest): Implements the --show-diff / -d flag, prints the analyzed diff with truncation notice, and covers staged, unstaged, and streamed diff behavior.
#70: Modifies suggest flow in src/index.ts and src/commands/suggest.ts, including truncation-related metadata handling and conditional CLI output.
Possibly related PRs
404-PF/commit-echo#93: Related suggestCommand work around diff truncation and dry-run output in the same command flow.
Suggested reviewers
404-Page-Found
Poem
🐰 The diff now hops into view,
With truncation crumbs and a --show-diff clue.
Staged or unstaged, the bunny can see,
What the LLM will munch, before tea.
🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name
Status
Explanation
Resolution
Docstring Coverage
⚠️ Warning
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.
Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name
Status
Explanation
Description Check
✅ Passed
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
✅ Passed
The title clearly and concisely describes the main change: adding a show-diff flag to suggest.
Linked Issues check
✅ Passed
The PR adds --show-diff/-d, prints the diff before generation, shows truncation markers, and covers staged and unstaged flows.
Out of Scope Changes check
✅ Passed
The changes stay focused on the show-diff feature and its test coverage, with no clear unrelated functional additions.
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.
Inner truncation shadows the outer one declared at Line 180.
The block-scoped let truncation here shadows the outer truncation from truncateDiff(...). They represent the same concept computed twice (once for --show-diff/--dry-run display, once from the LLM result), which is confusing and a common lint flag. Consider renaming the inner variable (e.g., genTruncation) for clarity.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/commands/suggest.ts` around lines 220 - 222, The inner truncation
declaration inside the while loop in suggest.ts shadows the outer truncation
from truncateDiff(...), which makes the flow confusing and trips linting. Rename
the loop-local variable in the suggestion generation path (for example, to
genTruncation) and update the corresponding uses in the loop so it is clear it
refers to the LLM-produced truncation info, not the earlier display truncation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@src/commands/suggest.ts`:
- Around line 220-222: The inner truncation declaration inside the while loop in
suggest.ts shadows the outer truncation from truncateDiff(...), which makes the
flow confusing and trips linting. Rename the loop-local variable in the
suggestion generation path (for example, to genTruncation) and update the
corresponding uses in the loop so it is clear it refers to the LLM-produced
truncation info, not the earlier display truncation.
ℹ️ Review info⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9429c7b0-5c6b-4c23-b2e9-bf45aa3c9823
📥 Commits
Reviewing files that changed from the base of the PR and between 16d363a and 3291511.
Patched the CodeRabbit finding in 58689eb by renaming the suggestion-generation truncation metadata so it no longer shadows the earlier display truncation value.\n\nValidated locally with:\n- npm test\n- npx prettier --check src/commands/suggest.ts\n- git diff --check
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/commands/suggest.ts`:
- Around line 203-211: The `generateSuggestionsStream` truncation behavior is
already aligned with the CLI preview, so the missing coverage is an e2e test for
`suggest.ts` when `options.showDiff` and `--stream` are both enabled. Add a test
in the existing CLI/e2e suite that exercises `suggest` with both flags, asserts
the “Diff being analyzed” output uses the truncated diff preview, and verifies
the streamed response still matches the same truncated payload produced by
`truncateDiff`/`config.maxDiffSize`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
Push a commit to this branch (recommended)
Create a new PR with the fixes
ℹ️ Review info⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 41295f00-0bed-4cc1-8037-423ff25064cb
📥 Commits
Reviewing files that changed from the base of the PR and between 16d363a and 58689eb.
Patched the latest CodeRabbit finding in 823d289 by adding e2e coverage for suggest --show-diff --stream --yes. The new test verifies the printed diff preview is truncated, the streaming request uses the same truncated payload, and the streamed suggestion still auto-selects correctly.
Validated locally with:
node --test tests\e2e\suggest-smoke.test.mjs
npm test -- tests\e2e\suggest-smoke.test.mjs -> 165 passed, 1 skipped
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
The current implementation is not up to standards due to high cyclomatic complexity and code duplication in src/commands/suggest.ts, which has been identified as a high-risk file. While the PR successfully introduces the --show-diff flag and its associated E2E tests, it introduces a logic inconsistency: the user is shown a truncated diff preview, but the actual request sent to the LLM still contains the raw, untruncated diff. Additionally, the new logic for truncation is executed unconditionally, impacting performance for large diffs even when the preview or dry-run modes are disabled. These structural and logical issues should be addressed to ensure maintainability and correctness.
About this PR
There is a systemic risk of divergence between what the user sees in the --show-diff preview and what is actually sent to the LLM provider. The truncation logic is currently duplicated or ignored during the final API calls, which can lead to unexpected token usage or provider-side errors that the user cannot see in the preview.
2 comments outside of the diffsrc/commands/suggest.ts
line 89 🔴 HIGH RISK
The suggestCommand function is becoming too complex (cyclomatic complexity: 18) and exceeds maintainability thresholds. This file is currently considered high-risk due to high complexity combined with low coverage. Refactor the function to extract Git change detection and LLM suggestion loops into private helper functions.
line 130 🟡 MEDIUM RISK
Suggestion: The configuration loading and API key validation logic is duplicated from src/commands/batch.ts. Extract this logic into a shared utility function in src/utils/config.ts to improve maintainability.
Test suggestions
Verify --show-diff prints the diff content to stdout for staged changes.
Verify truncation notice is displayed when the diff exceeds maxDiffSize.
Verify --show-diff works correctly with unstaged changes in auto-mode.
Verify the diff is printed before streaming suggestions begin.
The reason will be displayed to describe this comment to others. Learn more.
⚪ LOW RISK
Suggestion: Pass the pre-truncated truncatedDiff to generateSuggestionsStream instead of the raw diffResult.diff. This ensures the LLM receives exactly what was shown to the user in the preview.
The reason will be displayed to describe this comment to others. Learn more.
⚪ LOW RISK
Suggestion: The truncateDiff call is now performed unconditionally. Move this call so it only executes when options.dryRun or options.showDiff is true to avoid unnecessary memory allocation and CPU usage for large diffs in standard runs.
Addressed the current Codacy/CodeRabbit show-diff input feedback in e5a3f20.
The command now only precomputes the preview truncation for dry-run/show-diff, and --show-diff reuses that same preview payload for both normal and streaming generation so the displayed diff and analyzed diff stay aligned without adding work to the default path.
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
Don't feed the already-truncated preview back into generation.
Line 215 reuses preview!.diff, but both generateSuggestions() and generateSuggestionsStream() truncate their diff argument again. Because truncateDiff() can return a string slightly larger than maxDiffSize once it appends the marker, the second pass can rewrite the payload, so --show-diff no longer guarantees that the printed preview is the exact prompt sent to the LLM. It also makes generatedTruncation disappear in verbose/warning output whenever the pre-truncated preview happens to fit on the second pass.
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/commands/suggest.ts` at line 215, The `suggest.ts` flow is reusing
`preview!.diff` for `analysisDiff`, which means the already-truncated preview is
being truncated again inside `generateSuggestions()` and
`generateSuggestionsStream()`. Update the `options.showDiff` path so the exact
preview used for display is also the exact payload passed to generation, or skip
the second truncation when the diff is already a preview; keep the relevant
logic around `analysisDiff`, `truncateDiff`, and the `generateSuggestions*`
callers consistent so `--show-diff` matches the prompt and truncation warnings
remain accurate.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@src/commands/suggest.ts`:
- Line 215: The `suggest.ts` flow is reusing `preview!.diff` for `analysisDiff`,
which means the already-truncated preview is being truncated again inside
`generateSuggestions()` and `generateSuggestionsStream()`. Update the
`options.showDiff` path so the exact preview used for display is also the exact
payload passed to generation, or skip the second truncation when the diff is
already a preview; keep the relevant logic around `analysisDiff`,
`truncateDiff`, and the `generateSuggestions*` callers consistent so
`--show-diff` matches the prompt and truncation warnings remain accurate.
ℹ️ Review info⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3784788b-490b-4337-a197-dab34e373ca6
📥 Commits
Reviewing files that changed from the base of the PR and between 58689eb and e5a3f20.
Use .js extensions for all local imports in ESM TypeScript source files, and use import type for type-only imports.
Files:
src/commands/suggest.ts
src/{commands/suggest.ts,providers/sse.ts}
📄 CodeRabbit inference engine (AGENTS.md)
Support streaming suggestions via SSE parsing, enabled by the --stream flag on the suggest command.
Files:
src/commands/suggest.ts
tests/**/*.mjs
📄 CodeRabbit inference engine (AGENTS.md)
tests/**/*.mjs: Use Node.js built-in node:test (not Jest or Mocha) for test files under tests/.
Some tests may skip on Windows when platform-specific mock logic is involved.
Files:
tests/e2e/suggest-smoke.test.mjs
tests/e2e/**/*.mjs
📄 CodeRabbit inference engine (AGENTS.md)
End-to-end tests under tests/e2e/ should create real temporary Git repositories and local HTTP servers.
Addressed the current CodeRabbit duplicate-truncation finding in 31a244b.
--show-diff now passes the already computed preview/truncation metadata into both normal and streaming suggestion generation, so the diff printed under Diff being analyzed is the exact diff used in the prompt without a second truncation pass. The branch was also rebased onto current main to clear the conflict state.
Validation:
npm test -- tests\e2e\suggest-smoke.test.mjs -> 212 passed, 1 skipped
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@tests/e2e/suggest-smoke.test.mjs`:
- Around line 627-638: The unstaged suggest smoke test only checks for the
presence of +updated, so it can miss divergences between the displayed diff and
the prompt content. Update the test around the suggest CLI flow in
suggest-smoke.test.mjs to capture and compare the full diff text from the
preview and the prompt, using the same pattern as the staged/streaming
assertions with extractPromptDiff(...) and extractShownDiff(stdout). Keep the
existing checks, but add a strict equality assertion to verify the shown diff
exactly matches the prompt diff for the unstaged path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
Push a commit to this branch (recommended)
Create a new PR with the fixes
ℹ️ Review info⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: d45af5be-52e6-4200-ac14-ef2d842af0ba
📥 Commits
Reviewing files that changed from the base of the PR and between 58689eb and 31a244b.
Use .js extensions for all local imports in ESM TypeScript source files, and use import type for type-only imports.
Files:
src/index.ts
src/llm/client.ts
src/commands/suggest.ts
src/{history/store.ts,llm/**/*.ts}
📄 CodeRabbit inference engine (AGENTS.md)
Analyze recent commits in buildProfile() and inject the learned style profile into the system prompt as style guidance.
Files:
src/llm/client.ts
src/{commands/suggest.ts,providers/sse.ts}
📄 CodeRabbit inference engine (AGENTS.md)
Support streaming suggestions via SSE parsing, enabled by the --stream flag on the suggest command.
Files:
src/commands/suggest.ts
tests/**/*.mjs
📄 CodeRabbit inference engine (AGENTS.md)
tests/**/*.mjs: Use Node.js built-in node:test (not Jest or Mocha) for test files under tests/.
Some tests may skip on Windows when platform-specific mock logic is involved.
Files:
tests/e2e/suggest-smoke.test.mjs
tests/e2e/**/*.mjs
📄 CodeRabbit inference engine (AGENTS.md)
End-to-end tests under tests/e2e/ should create real temporary Git repositories and local HTTP servers.
Files:
tests/e2e/suggest-smoke.test.mjs
🔇 Additional comments (3)
src/commands/suggest.ts (1)
101-101: LGTM!
Also applies to: 180-183, 204-216, 226-226, 243-252, 290-292, 304-308, 410-410, 481-481
src/llm/client.ts (1)
1-6: LGTM!
Also applies to: 8-21, 23-34, 41-52, 73-74, 90-90, 102-104, 118-124, 143-143, 153-168, 172-177
Assert full preview/prompt equivalence for the unstaged path.
This case only proves both outputs contain +updated. It would still pass if the shown diff and the actual prompt diverged elsewhere, which is the main contract this flag is trying to protect. Please mirror the staged/streaming checks here with a full extractPromptDiff(...) === extractShownDiff(stdout) assertion.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@tests/e2e/suggest-smoke.test.mjs` around lines 627 - 638, The unstaged
suggest smoke test only checks for the presence of +updated, so it can miss
divergences between the displayed diff and the prompt content. Update the test
around the suggest CLI flow in suggest-smoke.test.mjs to capture and compare the
full diff text from the preview and the prompt, using the same pattern as the
staged/streaming assertions with extractPromptDiff(...) and
extractShownDiff(stdout). Keep the existing checks, but add a strict equality
assertion to verify the shown diff exactly matches the prompt diff for the
unstaged path.
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
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.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
Peter7896
force-pushed
the
peter7896/show-diff-flag
branch
from
Summary
--show-diff/-dtocommit-echo suggestso users can see the exact diff content being sent to the LLMCloses #87
Testing
npm testSummary by CodeRabbit
-d, --show-diffto thesuggestcommand to display the exact diff being analyzed, including truncation markers/notices when applicable.--show-diffis enabled (including streaming).--show-diffacross staged/unstaged and streamed cases withmaxDiffSizetruncation, validating stdout/stderr ordering and the diff sent for analysis.