Skip to content

Feat context-help: prioritize textExpression when present and open preview; fallback to preview-only when empty #59

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 5, 2025
Merged

Feat context-help: prioritize textExpression when present and open preview; fallback to preview-only when empty #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 102 additions & 39 deletions src/ccs/commands/contextHelp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,13 @@ export async function resolveContextExpression(): Promise<void> {
const data = response ?? {};

if (typeof data === "string") {
await handleContextHelpDocumentationContent(data);
const { previewContent, textExpression } = extractEmbeddedContextExpression(data);

if (textExpression && textExpression.trim()) {
await applyResolvedTextExpression(editor, document, selection, contextInfo, contextExpression, textExpression);
}

await handleContextHelpDocumentationContent(previewContent);
return;
}

Expand All @@ -49,43 +55,14 @@ export async function resolveContextExpression(): Promise<void> {
}

if (isSuccessfulTextExpression(data)) {
const hasGifCommand = /--gif\b/i.test(contextExpression);
let normalizedTextExpression = data.textExpression.replace(/\r?\n/g, "\n");
let gifUri: vscode.Uri | undefined;

if (hasGifCommand) {
const extracted = extractGifUri(normalizedTextExpression);
normalizedTextExpression = extracted.textWithoutGifUri;
gifUri = extracted.gifUri;
}

if (!hasGifCommand) {
const eol = document.eol === vscode.EndOfLine.CRLF ? "\r\n" : "\n";
const textExpression = normalizedTextExpression.replace(/\r?\n/g, eol);
const formattedTextExpression = textExpression;

let rangeToReplace: vscode.Range;
if (selection.isEmpty) {
const fallbackLine = document.lineAt(selection.active.line);
rangeToReplace = fallbackLine.range;
} else {
const start = document.lineAt(selection.start.line).range.start;
const replacementEnd = contextInfo.replacementEnd ?? document.lineAt(selection.end.line).range.end;
rangeToReplace = new vscode.Range(start, replacementEnd);
}

await editor.edit((editBuilder) => {
editBuilder.replace(rangeToReplace, formattedTextExpression);
});
}

if (gifUri) {
try {
await showGifInWebview(gifUri);
} catch (error) {
handleError(error, "Failed to open GIF from context expression.");
}
}
await applyResolvedTextExpression(
editor,
document,
selection,
contextInfo,
contextExpression,
data.textExpression
);
return;
}

Expand Down Expand Up @@ -159,8 +136,56 @@ function extractGifUri(text: string): {
return { textWithoutGifUri: processedLines.join("\n"), gifUri };
}

async function applyResolvedTextExpression(
editor: vscode.TextEditor,
document: vscode.TextDocument,
selection: vscode.Selection,
contextInfo: ContextExpressionInfo,
contextExpression: string,
rawTextExpression: string
): Promise<void> {
const hasGifCommand = /--gif\b/i.test(contextExpression);
let normalizedTextExpression = rawTextExpression.replace(/\r?\n/g, "\n");
let gifUri: vscode.Uri | undefined;

if (hasGifCommand) {
const extracted = extractGifUri(normalizedTextExpression);
normalizedTextExpression = extracted.textWithoutGifUri;
gifUri = extracted.gifUri;
}

if (!hasGifCommand) {
const eol = document.eol === vscode.EndOfLine.CRLF ? "\r\n" : "\n";
const textExpression = normalizedTextExpression.replace(/\r?\n/g, eol);
const formattedTextExpression = textExpression;

let rangeToReplace: vscode.Range;
if (selection.isEmpty) {
const fallbackLine = document.lineAt(selection.active.line);
rangeToReplace = fallbackLine.range;
} else {
const start = document.lineAt(selection.start.line).range.start;
const replacementEnd = contextInfo.replacementEnd ?? document.lineAt(selection.end.line).range.end;
rangeToReplace = new vscode.Range(start, replacementEnd);
}

await editor.edit((editBuilder) => {
editBuilder.replace(rangeToReplace, formattedTextExpression);
});
}

if (gifUri) {
try {
await showGifInWebview(gifUri);
} catch (error) {
handleError(error, "Failed to open GIF from context expression.");
}
}
}

async function handleContextHelpDocumentationContent(rawContent: string): Promise<void> {
const sanitizedContent = sanitizeContextHelpContent(rawContent);
const { previewContent } = extractEmbeddedContextExpression(rawContent);
const sanitizedContent = sanitizeContextHelpContent(previewContent);

if (!sanitizedContent.trim()) {
void vscode.window.showInformationMessage("A ajuda de contexto não retornou nenhum conteúdo.");
Expand All @@ -176,6 +201,44 @@ async function handleContextHelpDocumentationContent(rawContent: string): Promis
await showContextHelpPreview(sanitizedContent);
}

function extractEmbeddedContextExpression(content: string): {
previewContent: string;
textExpression?: string;
} {
const jsonPattern = /\{[\s\S]*\}\s*$/;
const match = jsonPattern.exec(content);
if (!match || match.index === undefined) {
return { previewContent: content };
}

const previewWithoutJson = content.slice(0, match.index).replace(/\s+$/, "");
const jsonText = content.slice(match.index).trim();

try {
const parsed = JSON.parse(jsonText);
if (!isRecord(parsed)) {
return { previewContent: previewWithoutJson };
}

const { status, textExpression } = parsed as ResolveContextExpressionResponse;
if (typeof status !== "string" || status.toLowerCase() !== "success") {
return { previewContent: previewWithoutJson };
}

if (typeof textExpression !== "string") {
return { previewContent: previewWithoutJson };
}

if (!textExpression.trim()) {
return { previewContent: previewWithoutJson };
}

return { previewContent: previewWithoutJson, textExpression };
} catch (_error) {
return { previewContent: content };
Comment on lines +204 to +238
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Nov 5, 2025

Choose a reason for hiding this comment

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

P1 Badge Make trailing JSON extraction ignore braces in documentation body

The new extractEmbeddedContextExpression looks for the trailing JSON block with /\{[\s\S]*\}\s*$/ and uses the first match returned by exec. Because the pattern is greedy and starts at the first { in the string, any documentation text that contains curly braces before the appended JSON causes jsonText to include the entire body plus the JSON footer. Parsing then fails and the function returns the original string, so the embedded textExpression is never applied and the raw JSON remains visible in the preview. This regression occurs whenever the documentation itself includes braces (e.g. code samples). The extractor should target the last JSON object explicitly (e.g. by searching for the last { after the final newline) instead of the first {.

Useful? React with 👍 / 👎.

}
}

function sanitizeContextHelpContent(content: string): string {
let sanitized = content.replace(/\{"status":"success","textExpression":""\}\s*$/i, "");

Expand Down