-
Notifications
You must be signed in to change notification settings - Fork 30
fix(inbox): break signal summary sections onto separate lines #2317
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MattPua
wants to merge
2
commits into
main
Choose a base branch
from
cursor/signal-summary-section-line-breaks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+74
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
35 changes: 35 additions & 0 deletions
35
apps/code/src/renderer/features/inbox/utils/formatSignalReportSummaryMarkdown.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { formatSignalReportSummaryMarkdown } from "./formatSignalReportSummaryMarkdown"; | ||
|
|
||
| describe("formatSignalReportSummaryMarkdown", () => { | ||
| it.each([ | ||
| { | ||
| name: "puts section body text on a new line after the header", | ||
| input: | ||
| "**What's happening:** Error tracking issue keyed on `app:dashboard_query`.", | ||
| expected: | ||
| "**What's happening:**\n\nError tracking issue keyed on `app:dashboard_query`.", | ||
| }, | ||
| { | ||
| name: "separates consecutive section headers onto their own lines", | ||
| input: | ||
| "**What's happening:** Users hit rate limits. **Root cause:** All four rate limiters are contended. **How to resolve:** Reduce blocking.", | ||
| expected: | ||
| "**What's happening:**\n\nUsers hit rate limits.\n\n**Root cause:**\n\nAll four rate limiters are contended.\n\n**How to resolve:**\n\nReduce blocking.", | ||
| }, | ||
| { | ||
| name: "separates a section header from preceding intro text", | ||
| input: | ||
| "Users on busy orgs are hitting hard limits. **What's happening:** Error tracking issue.", | ||
| expected: | ||
| "Users on busy orgs are hitting hard limits.\n\n**What's happening:**\n\nError tracking issue.", | ||
| }, | ||
| { | ||
| name: "leaves content without section headers unchanged", | ||
| input: "Plain summary with no structured sections.", | ||
| expected: "Plain summary with no structured sections.", | ||
| }, | ||
| ])("$name", ({ input, expected }) => { | ||
| expect(formatSignalReportSummaryMarkdown(input)).toBe(expected); | ||
| }); | ||
| }); | ||
35 changes: 35 additions & 0 deletions
35
apps/code/src/renderer/features/inbox/utils/formatSignalReportSummaryMarkdown.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| const SIGNAL_SUMMARY_SECTION_HEADERS = [ | ||
| "What's happening", | ||
| "Root cause", | ||
| "How to resolve", | ||
| ] as const; | ||
|
|
||
| function escapeRegExp(value: string): string { | ||
| return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); | ||
| } | ||
|
|
||
| /** | ||
| * Inserts line breaks around signal report summary section headers so each | ||
| * label and its body render on separate lines (matches agent output like | ||
| * `**What's happening:** text`). | ||
| */ | ||
| export function formatSignalReportSummaryMarkdown(content: string): string { | ||
| let result = content; | ||
|
|
||
| for (const header of SIGNAL_SUMMARY_SECTION_HEADERS) { | ||
| const escaped = escapeRegExp(header); | ||
| const boldHeaderPattern = `\\*\\*${escaped}:\\*\\*`; | ||
|
|
||
| result = result.replace( | ||
| new RegExp(`([^\\n])\\s*(${boldHeaderPattern})`, "gi"), | ||
| "$1\n\n$2", | ||
| ); | ||
|
|
||
| result = result.replace( | ||
| new RegExp(`(${boldHeaderPattern})\\s+`, "gi"), | ||
| "$1\n\n", | ||
| ); | ||
| } | ||
|
|
||
| return result; | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.