Fix PR description card showing escaped markdown for inline code, strong, and emphasis (#7805)

* Initial plan

* Add optional simple markdown support to PlainTextRenderer for inline code

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Add strong and em formatting support to PlainTextRenderer when allowSimpleMarkdown is true

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Fixes

* Fix tests

* Fix tests

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

src/github/copilotRemoteAgent.ts

@@ -528,7 +528,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 		}
 
 		if (pr && (_version && _version === 2)) { /* version 2 means caller knows how to render this */
-			const plaintextBody = marked.parse(pr.body, { renderer: new PlainTextRenderer(), smartypants: true }).trim();
+			const plaintextBody = marked.parse(pr.body, { renderer: new PlainTextRenderer(true), smartypants: true }).trim();
 
 			return {
 				uri: webviewUri.toString(),

src/github/copilotRemoteAgent/chatSessionContentBuilder.ts

@@ -76,7 +76,7 @@ export class ChatSessionContentBuilder {
 				// if this is the first response, then also add the PR card
 				if (sessionIndex === 0) {
 					const uri = await toOpenPullRequestWebviewUri({ owner: pullRequest.remote.owner, repo: pullRequest.remote.repositoryName, pullRequestNumber: pullRequest.number });
-					const plaintextBody = marked.parse(pullRequest.body, { renderer: new PlainTextRenderer(), smartypants: true }).trim();
+					const plaintextBody = marked.parse(pullRequest.body, { renderer: new PlainTextRenderer(true), smartypants: true }).trim();
 
 					const card = new vscode.ChatResponsePullRequestPart(uri, pullRequest.title, plaintextBody, pullRequest.author.specialDisplayName ?? pullRequest.author.login, `#${pullRequest.number}`);
 					const cardTurn = new vscode.ChatResponseTurn2([card], {}, COPILOT_SWE_AGENT);

src/github/markdownUtils.ts

@@ -237,6 +237,13 @@ export async function issueMarkdown(
 }
 
 export class PlainTextRenderer extends marked.Renderer {
+	private allowSimpleMarkdown: boolean;
+
+	constructor(allowSimpleMarkdown: boolean = false) {
+		super();
+		this.allowSimpleMarkdown = allowSimpleMarkdown;
+	}
+
 	override code(code: string, _infostring: string | undefined): string {
 		return code;
 	}
@@ -286,6 +293,9 @@ export class PlainTextRenderer extends marked.Renderer {
 		return text;
 	}
 	override codespan(code: string): string {
+		if (this.allowSimpleMarkdown) {
+			return `\`${code}\``;
+		}
 		return `\\\`${code}\\\``;
 	}
 	override br(): string {

src/lm/tools/copilotRemoteAgentTool.ts

@@ -122,7 +122,7 @@ export class CopilotRemoteAgentTool implements vscode.LanguageModelTool<CopilotR
 		let lmResult: (vscode.LanguageModelTextPart | vscode.LanguageModelDataPart)[] = [new vscode.LanguageModelTextPart(result.llmDetails)];
 		const pr = await targetRepo.fm.resolvePullRequest(targetRepo.owner, targetRepo.repo, result.number);
 		if (pr) {
-			const plaintextBody = marked.parse(pr.body, { renderer: new PlainTextRenderer(), smartypants: true }).trim();
+			const plaintextBody = marked.parse(pr.body, { renderer: new PlainTextRenderer(true), smartypants: true }).trim();
 			const preferredRendering = {
 				uri: (await toOpenPullRequestWebviewUri({ owner: pr.githubRepository.remote.owner, repo: pr.githubRepository.remote.repositoryName, pullRequestNumber: pr.number })).toString(),
 				title: pr.title,

src/test/github/markdownUtils.test.ts

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as assert from 'assert';
+import * as marked from 'marked';
+import { PlainTextRenderer } from '../../github/markdownUtils';
+import { describe, it } from 'mocha';
+
+describe('PlainTextRenderer', () => {
+	it('should escape inline code by default', () => {
+		const renderer = new PlainTextRenderer();
+		const result = marked.parse('rename the `Foo` class', { renderer, smartypants: true });
+		assert.strictEqual(result.trim(), 'rename the \\`Foo\\` class');
+	});
+
+	it('should preserve inline code when allowSimpleMarkdown is true', () => {
+		const renderer = new PlainTextRenderer(true);
+		const result = marked.parse('rename the `Foo` class', { renderer, smartypants: true });
+		assert.strictEqual(result.trim(), 'rename the `Foo` class');
+	});
+
+	it('should handle multiple inline code spans', () => {
+		const renderer = new PlainTextRenderer(true);
+		const result = marked.parse('rename the `Foo` class to `Bar`', { renderer, smartypants: true });
+		assert.strictEqual(result.trim(), 'rename the `Foo` class to `Bar`');
+	});
+
+	it('should still escape when allowSimpleMarkdown is false', () => {
+		const renderer = new PlainTextRenderer(false);
+		const result = marked.parse('rename the `Foo` class to `Bar`', { renderer, smartypants: true });
+		assert.strictEqual(result.trim(), 'rename the \\`Foo\\` class to \\`Bar\\`');
+	});
+
+	it('should strip all formatting by default', () => {
+		const renderer = new PlainTextRenderer(false);
+		const result = marked.parse('rename the `Foo` class to **`Bar`** and make it *italic*', { renderer, smartypants: true });
+		assert.strictEqual(result.trim(), 'rename the \\`Foo\\` class to \\`Bar\\` and make it italic');
+	});
+});