From cea3dc25f8b26f046582a50c80f6493c02bef1d4 Mon Sep 17 00:00:00 2001 From: Catarina Gamboa Date: Tue, 17 Nov 2026 16:58:01 +0000 Subject: [PATCH 1/5] Study build 0.1.3: Origin and Locations folded like the hints, showView can open folds (the tour opens the hints), a click on an error card shows the error in the code, Expected and Found as code in the hover (liquidjava.hover.formattedMessage) Co-Authored-By: Claude Fable 5.1 --- client/package.json | 9 +++- client/src/services/hover.ts | 25 ++++++++- client/src/services/webview.ts | 28 +++++++--- client/src/webview/script.ts | 47 ++++++++++++---- client/src/webview/styles.ts | 7 ++- .../views/diagnostics/diagnostics.spec.ts | 6 ++- .../src/webview/views/diagnostics/errors.ts | 7 +-- .../src/webview/views/diagnostics/warnings.ts | 7 +-- client/src/webview/views/sections.ts | 54 ++++++++++++++----- 9 files changed, 150 insertions(+), 40 deletions(-) diff --git a/client/package.json b/client/package.json index 776f7b1..50bcba3 100644 --- a/client/package.json +++ b/client/package.json @@ -2,7 +2,7 @@ "name": "liquid-java", "displayName": "LiquidJava", "description": "Extending Java with Liquid Types", - "version": "0.1.2", + "version": "0.1.3", "publisher": "AlcidesFonseca", "repository": { "type": "git", @@ -70,10 +70,15 @@ "default": true, "description": "Show the details of an error in the editor hover under its message: the origin notes, the counterexample and the hints. When off, the hover shows the message alone and the details are in the LiquidJava view, where the hints stay closed until opened." }, + "liquidjava.hover.formattedMessage": { + "type": "boolean", + "default": false, + "description": "Under the plain message of an error, show Expected and Found as code in the editor hover. Meant for user studies." + }, "liquidjava.usageLog": { "type": "string", "default": "", - "description": "Path of a JSON Lines file to which the extension appends what is used in the LiquidJava view: tabs, hints opened, Found steps, locations, state machine, copies. Empty: nothing is written. Meant for user studies." + "description": "Path of a JSON Lines file to which the extension appends what is used in the LiquidJava view: tabs, hints, origin and locations opened, Found steps, state machine, copies, clicks on an error card. Empty: nothing is written. Meant for user studies." } } }, diff --git a/client/src/services/hover.ts b/client/src/services/hover.ts index e495d8d..99b5b4e 100644 --- a/client/src/services/hover.ts +++ b/client/src/services/hover.ts @@ -31,7 +31,8 @@ export function registerHover() { } } - const contents = [hoverContent, ...getHoveredDiagnostics(document, position)].filter(content => content.value.length > 0); + const contents = [hoverContent, ...getFormattedMessages(document, position), ...getHoveredDiagnostics(document, position)] + .filter(content => content.value.length > 0); if (contents.length === 0) return null; return new vscode.Hover(contents); } @@ -57,6 +58,28 @@ function getHoveredDiagnostics(document: vscode.TextDocument, position: vscode.P .map(markdown => new vscode.MarkdownString(markdown)); } +/** + * The message of each LiquidJava error at a position, formatted: Expected and Found as inline code on their own + * lines, under the plain line VS Code shows from the Problems entry ("Refinement Error: found A but expected B"). + * Only when liquidjava.hover.formattedMessage is on (user studies: the hover reads like the view) + */ +function getFormattedMessages(document: vscode.TextDocument, position: vscode.Position): vscode.MarkdownString[] { + if (!vscode.workspace.getConfiguration().get('liquidjava.hover.formattedMessage', false)) return []; + return vscode.languages.getDiagnostics(document.uri) + .filter(diagnostic => diagnostic.source === 'liquidjava' && diagnostic.range.contains(position)) + .map(diagnostic => formatPlainMessage(diagnostic.message)) + .filter((markdown): markdown is string => markdown !== null) + .map(markdown => new vscode.MarkdownString(markdown)); +} + +// "Kind: found A but expected B" -> Expected B, Found A, each as code; null for any other shape +export function formatPlainMessage(message: string): string | null { + const match = /^[^:]+: found ([\s\S]+) but expected ([\s\S]+)$/.exec(message.trim()); + if (!match) return null; + const code = (text: string) => `\`${text.replace(/`/g, '')}\``; + return `**Expected** ${code(match[2])}\n\n**Found** ${code(match[1])}`; +} + // liquidjava.hover.showDetails: off keeps the origin notes, the counterexample and the hints in the view only (user // studies). liquidjava.hover.showHints, its name in 0.1.1, still counts when a settings file sets it to false function showDetailsInHover(): boolean { diff --git a/client/src/services/webview.ts b/client/src/services/webview.ts index d275097..268d81d 100644 --- a/client/src/services/webview.ts +++ b/client/src/services/webview.ts @@ -2,7 +2,10 @@ import * as vscode from "vscode"; import { LiquidJavaWebviewProvider } from "../webview/provider"; import { extension } from "../state"; import type { DiagnosticRevealTarget } from "../types/diagnostics"; -import type { NavTab } from "../webview/views/sections"; +import type { FoldKind, NavTab } from "../webview/views/sections"; + +/** What liquidjava.showView may do besides opening the view: openFolds opens the named folds (hints, origin, locations) */ +export type ShowViewOptions = { openFolds?: FoldKind[] }; import { logUsage } from "./usage-log"; /** @@ -13,6 +16,12 @@ export function registerWebview(context: vscode.ExtensionContext) { extension.webview = new LiquidJavaWebviewProvider(context.extensionUri); let pendingDiagnosticReveal: { diagnostic: DiagnosticRevealTarget, tab?: NavTab } | undefined; let pendingTab: NavTab | undefined; + let pendingFolds: FoldKind[] | undefined; + const openFolds = (kinds: FoldKind[] | undefined, visible: boolean | undefined) => { + if (!kinds || kinds.length === 0) return; + if (visible) extension.webview?.sendMessage({ type: "openFolds", kinds }); + else pendingFolds = kinds; + }; // webview provider context.subscriptions.push( @@ -24,14 +33,16 @@ export function registerWebview(context: vscode.ExtensionContext) { // shows the diagnostic in the Verification tab, or a state error in the State Machine tab when tab is 'fsm'; // without a diagnostic, opens the tab, if one is given. from names the caller in the usage log: the code // lenses above an error (the default), or another extension - vscode.commands.registerCommand("liquidjava.showView", async (diagnostic?: DiagnosticRevealTarget, tab?: NavTab, from = 'code-lens') => { + vscode.commands.registerCommand("liquidjava.showView", async (diagnostic?: DiagnosticRevealTarget, tab?: NavTab, from = 'code-lens', options: ShowViewOptions = {}) => { const isVisible = extension.webview?.isVisible(); await vscode.commands.executeCommand("liquidJavaView.focus"); if (!diagnostic) { - if (!tab) return; - logUsage('tab', { tab, from }); - if (isVisible) extension.webview?.sendMessage({ type: "selectTab", tab }); - else pendingTab = tab; + if (tab) { + logUsage('tab', { tab, from }); + if (isVisible) extension.webview?.sendMessage({ type: "selectTab", tab }); + else pendingTab = tab; + } + openFolds(options.openFolds, isVisible); return; } // the code lenses above an error: its title opens the Verification tab, "Show in state machine" the State Machine tab @@ -42,6 +53,7 @@ export function registerWebview(context: vscode.ExtensionContext) { } else { pendingDiagnosticReveal = { diagnostic, tab }; } + openFolds(options.openFolds, isVisible); }) ); // listen for messages from the webview @@ -61,6 +73,10 @@ export function registerWebview(context: vscode.ExtensionContext) { extension.webview?.sendMessage({ type: "selectTab", tab: pendingTab }); pendingTab = undefined; } + if (pendingFolds) { + extension.webview?.sendMessage({ type: "openFolds", kinds: pendingFolds }); + pendingFolds = undefined; + } } }) ); diff --git a/client/src/webview/script.ts b/client/src/webview/script.ts index 87503b5..92bbcda 100644 --- a/client/src/webview/script.ts +++ b/client/src/webview/script.ts @@ -8,7 +8,7 @@ import type { LJDiagnostic, RefinementMismatchError, StateRefinementError } from import type { Range } from "../types/context"; import type { LJStateMachine } from "../types/fsm"; import type { ExtensionStatus } from "../state"; -import { setHintOpen, type NavTab } from "./views/sections"; +import { setFoldOpen, type FoldKind, type NavTab } from "./views/sections"; import { copyDiagnosticToClipboard, getCurrentFileErrorCount, getDisplayDiagnostics, renderDiagnosticsView } from "./views/diagnostics/diagnostics"; import type { LJContext } from "../types/context"; import { ContextSectionState, renderContextView } from "./views/context/context"; @@ -62,21 +62,34 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) // on click // toggle does not bubble, so it is caught on its way down. A render of an open
fires it too, so only a - // toggle right after the summary was clicked or keyed counts as the user opening or closing the hints - let hintToggleByUser = false; - const markHintToggle = (e: Event) => { if ((e.target as Element).closest?.('.hint-summary')) hintToggleByUser = true; }; - root.addEventListener('click', markHintToggle, true); - root.addEventListener('keydown', markHintToggle, true); + // toggle right after the summary was clicked or keyed counts as the user opening or closing a fold (hints, origin, + // locations); the usage event carries the fold's kind + let foldToggleByUser = false; + const markFoldToggle = (e: Event) => { if ((e.target as Element).closest?.('.hint-summary, .fold-summary')) foldToggleByUser = true; }; + root.addEventListener('click', markFoldToggle, true); + root.addEventListener('keydown', markFoldToggle, true); root.addEventListener('toggle', (e: Event) => { const details = e.target as HTMLDetailsElement; - const key = details.getAttribute?.('data-hint-key'); + const key = details.getAttribute?.('data-fold-key'); + const kind = (details.getAttribute?.('data-fold-kind') ?? 'hints') as FoldKind; if (key !== null && key !== undefined) { - setHintOpen(key, details.open); - if (hintToggleByUser) usage('hints', { open: details.open, error: key }); + setFoldOpen(kind, key, details.open); + if (foldToggleByUser) usage(kind, { open: details.open, error: key }); } - hintToggleByUser = false; + foldToggleByUser = false; }, true); + // opens every fold of the given kinds in the current render, without counting as a use (the tour does this) + const openFolds = (kinds: FoldKind[]) => { + for (const details of Array.from(root.querySelectorAll('details[data-fold-kind]'))) { + const kind = details.getAttribute('data-fold-kind') as FoldKind; + const key = details.getAttribute('data-fold-key'); + if (!kinds.includes(kind) || key === null) continue; + setFoldOpen(kind, key, true); + details.open = true; + } + }; + root.addEventListener('click', (e: MouseEvent) => { const target = e.target instanceof Element ? e.target : null; if (!target) return; @@ -344,6 +357,17 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) copyDiagnosticToClipboard(diagnosticCopyBtn, getDisplayDiagnostics(diagnostics || [], showAllDiagnostics, currentFile)); return; } + + // a click on the card of an error, outside its buttons, links and folds, shows the error in the code + const errorItem = target.closest?.('.error-item'); + if (errorItem && !target.closest('button, a, details')) { + const revealTarget = getDiagnosticRevealTargetFromKey(errorItem.getAttribute('data-diagnostic-target')); + if (!revealTarget) return; + usage('reveal-code', { file: revealTarget.file, line: revealTarget.position.lineStart + 1 }); + const { lineStart, colStart } = revealTarget.position; + vscode.postMessage({ type: 'openFile', filePath: revealTarget.file, line: lineStart, character: colStart, highlightRange: revealTarget.position }); + return; + } }); // navigate context variables with the keyboard @@ -426,6 +450,9 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) if (tab !== selectedTab) { selectedTab = tab; updateView(); } break; } + case 'openFolds': // the liquidjava.showView command with openFolds in its options + openFolds(msg.kinds as FoldKind[]); + break; case 'revealDiagnostic': { const revealTarget = msg.diagnostic as DiagnosticRevealTarget; const stateError = msg.tab === 'fsm' ? findStateErrorAt(revealTarget) : undefined; diff --git a/client/src/webview/styles.ts b/client/src/webview/styles.ts index 88ddb27..41cef31 100644 --- a/client/src/webview/styles.ts +++ b/client/src/webview/styles.ts @@ -221,13 +221,16 @@ export function getStyles(): string { gap: 0.25rem; margin-left: auto; } - .hint-summary { + .hint-summary, .fold-summary { font-weight: bold; cursor: pointer; } - .hint-section[open] .hint-summary { + .hint-section[open] .hint-summary, .fold-section[open] .fold-summary { margin-bottom: 0.25rem; } + .fold-body .message-note { + margin: 0; + } .hint-body { padding: 0.5rem; background-color: var(--vscode-editor-background); diff --git a/client/src/webview/views/diagnostics/diagnostics.spec.ts b/client/src/webview/views/diagnostics/diagnostics.spec.ts index 2466fcf..bd056b6 100644 --- a/client/src/webview/views/diagnostics/diagnostics.spec.ts +++ b/client/src/webview/views/diagnostics/diagnostics.spec.ts @@ -98,7 +98,11 @@ describe('diagnostics view', () => { const link = document.querySelector('.message-note a.location-link'); expect(link?.textContent).toBe('line 134'); expect([link?.getAttribute('data-file'), link?.getAttribute('data-line')]).toEqual(['/workspace/Reader.java', '133']); - expect(text('.message-note')).toBe('Origin: line 134, new BufferedInputStream(stream) makes markState(b) == unmarked'); + // the note sits in a fold titled Origin, closed until opened, so its own "Origin:" prefix is not repeated + expect(text('.message-note')).toBe('line 134, new BufferedInputStream(stream) makes markState(b) == unmarked'); + const origin = document.querySelector('details.fold-origin'); + expect(origin?.open).toBe(false); + expect(origin?.querySelector('summary')?.textContent).toBe('Origin'); expect(Array.from(document.querySelectorAll('.lj-code')).map(code => code.textContent)) .toEqual(['new BufferedInputStream(stream)', 'markState(b) == unmarked', "b.f('`')", 'sl9 = "x@1"']); expect(document.querySelector('.lj-code sub.lj-line-tag')?.getAttribute('title')).toBe('s at line 9'); diff --git a/client/src/webview/views/diagnostics/errors.ts b/client/src/webview/views/diagnostics/errors.ts index 93a1a1f..792f404 100644 --- a/client/src/webview/views/diagnostics/errors.ts +++ b/client/src/webview/views/diagnostics/errors.ts @@ -77,9 +77,10 @@ export function renderError(error: LJError, actions = ''): string { const message = error.type === 'refinement-error' || error.type === 'state-refinement-error' ? error.customMessage : error.message; const header = renderDiagnosticHeader(error.title, message || '', actions); const content = (errorContentRenderers[error.type] as (error: LJError) => string)?.(error) || ''; - const notes = renderMessageNotes(error); - const hint = renderHints(error.hints, getDiagnosticKey(error), error.references); - const location = renderLocation(error); + const key = getDiagnosticKey(error); + const notes = renderMessageNotes(error, key); + const hint = renderHints(error.hints, key, error.references); + const location = renderLocation(error, key); return /*html*/`${header}${content}${notes}${hint}${location}`; } diff --git a/client/src/webview/views/diagnostics/warnings.ts b/client/src/webview/views/diagnostics/warnings.ts index 9c46d49..7bbeb9f 100644 --- a/client/src/webview/views/diagnostics/warnings.ts +++ b/client/src/webview/views/diagnostics/warnings.ts @@ -34,8 +34,9 @@ const warningContentRenderers: WarningContentRenderers = { export function renderWarning(warning: LJWarning, actions = ''): string { const header = renderDiagnosticHeader(warning.title, warning.message, actions); const content = (warningContentRenderers[warning.type] as (warning: LJWarning) => string)?.(warning) || ''; - const notes = renderMessageNotes(warning); - const hint = renderHints(warning.hints, getDiagnosticKey(warning), warning.references); - const location = renderLocation(warning); + const key = getDiagnosticKey(warning); + const notes = renderMessageNotes(warning, key); + const hint = renderHints(warning.hints, key, warning.references); + const location = renderLocation(warning, key); return /*html*/`${header}${content}${notes}${hint}${location}`; } diff --git a/client/src/webview/views/sections.ts b/client/src/webview/views/sections.ts index da35aa4..8187f7b 100644 --- a/client/src/webview/views/sections.ts +++ b/client/src/webview/views/sections.ts @@ -23,12 +23,38 @@ export const renderSection = (title: string, body: string): string => /*html*/ export const renderExpressionSection = (title: string, expression: string): string => /*html*/ renderCustomSection(title, renderHighlightedExpression(expression)); -// hints the user opened, kept open when the diagnostics are rendered again -const openHints = new Set(); +// the folds the user opened (hints, origin, locations), kept open when the diagnostics are rendered again +export type FoldKind = 'hints' | 'origin' | 'locations'; +const openFolds = new Set(); + +export function setFoldOpen(kind: FoldKind, key: string, open: boolean) { + if (open) openFolds.add(`${kind}:${key}`); + else openFolds.delete(`${kind}:${key}`); +} + +export function isFoldOpen(kind: FoldKind, key: string | undefined): boolean { + return key !== undefined && openFolds.has(`${kind}:${key}`); +} export function setHintOpen(key: string, open: boolean) { - if (open) openHints.add(key); - else openHints.delete(key); + setFoldOpen('hints', key, open); +} + +/** + * Renders a section closed until the user opens it, like the hints: the origin notes and the locations of an error + * @param kind names the fold in the usage log + * @param title the summary line + * @param body the content + * @param key identifies the diagnostic, so an opened fold stays open after a new verification + */ +export function renderFold(kind: FoldKind, title: string, body: string, key?: string): string { + const open = isFoldOpen(kind, key); + return /*html*/` +
+ ${title} +
${body}
+
+ `; } /** @@ -40,9 +66,9 @@ export function setHintOpen(key: string, open: boolean) { export function renderHints(hints: LJHint[] | undefined, key?: string, references: LJSourceReference[] = []): string { const { shown, options, notes } = groupHints(hints); if (shown.length === 0) return ''; - const open = key !== undefined && openHints.has(key); + const open = isFoldOpen('hints', key); return /*html*/` -
+
${shown.length === 1 ? 'Hint' : 'Hints'}
${options.length > 0 ? /*html*/` @@ -62,12 +88,16 @@ function renderHintMessage(hint: LJHint, references: LJSourceReference[]): strin } /** - * Renders the notes under the message of a diagnostic, such as where a value comes from, with their links + * Renders the notes under the message of a diagnostic, such as where a value comes from, with their links, in a fold + * titled Origin that is closed until opened (the view shows Expected and Found first) + * @param key identifies the diagnostic, so an opened fold stays open after a new verification */ -export function renderMessageNotes(diagnostic: LJDiagnostic): string { +export function renderMessageNotes(diagnostic: LJDiagnostic, key?: string): string { if (diagnostic.messageNotes.length === 0) return ''; - return /*html*/`
${diagnostic.messageNotes - .map(note => `

${renderMessageText(note, diagnostic.references)}

`).join('')}
`; + const notes = diagnostic.messageNotes + // the fold's title says Origin, so the note's own prefix goes; after rendering, since the references' offsets count from the full text + .map(note => `

${renderMessageText(note, diagnostic.references).replace(/^Origin:\s*/, '')}

`).join(''); + return renderFold('origin', 'Origin', `
${notes}
`, key); } export const renderToggleSection = (title: string, targetId: string, isExpanded: boolean = true): string => /*html*/` @@ -90,7 +120,7 @@ export function renderDiagnosticDataAttributes(diagnostic: LJDiagnostic): string return target ? `data-diagnostic-target="${getDiagnosticRevealTargetKey(target)}"` : ""; } -export const renderLocation = (diagnostic: LJDiagnostic): string => { +export const renderLocation = (diagnostic: LJDiagnostic, key?: string): string => { const positions: SourcePosition[] = []; if (diagnostic.position && diagnostic.file) positions.push(diagnostic.position); @@ -106,7 +136,7 @@ export const renderLocation = (diagnostic: LJDiagnostic): string => { // the notes explain the declarations, so they are shown only under their links const notes = declarationPositions.length > 0 ? declaration?.declarationNotes ?? [] : []; const noteLines = notes.map(note => `${renderMessageText(note)}`).join(""); - return renderCustomSection(title, /*html*/`
${links}${noteLines}
`); + return renderFold('locations', title, /*html*/`
${links}${noteLines}
`, key); }; export function renderVariableHighlightButton(variable: LJVariable): string { From 8a46e356cf173dc66175fa94bdb5f9033caa2825 Mon Sep 17 00:00:00 2001 From: Catarina Gamboa Date: Tue, 17 Nov 2026 17:08:21 +0000 Subject: [PATCH 2/5] Formatted hover message: both shapes the server writes (found/expected, expected/could not prove), with a spec Co-Authored-By: Claude Fable 5.1 --- client/src/services/hover.ts | 10 +-------- .../src/utils/message-markdown.plain.spec.ts | 21 +++++++++++++++++++ client/src/utils/message-markdown.ts | 15 +++++++++++++ 3 files changed, 37 insertions(+), 9 deletions(-) create mode 100644 client/src/utils/message-markdown.plain.spec.ts diff --git a/client/src/services/hover.ts b/client/src/services/hover.ts index 99b5b4e..cf7ae9d 100644 --- a/client/src/services/hover.ts +++ b/client/src/services/hover.ts @@ -6,7 +6,7 @@ import { getOriginalVariableName, normalizeFilePath } from '../utils/utils'; import { definitionMatchesClass, getDefinitions } from './definition'; import { isExtensionRunning } from '../extension'; import type { SourcePosition } from '../types/diagnostics'; -import { formatDiagnosticMarkdown } from '../utils/message-markdown'; +import { formatDiagnosticMarkdown, formatPlainMessage } from '../utils/message-markdown'; /** * Initializes hover provider for LiquidJava diagnostics @@ -72,14 +72,6 @@ function getFormattedMessages(document: vscode.TextDocument, position: vscode.Po .map(markdown => new vscode.MarkdownString(markdown)); } -// "Kind: found A but expected B" -> Expected B, Found A, each as code; null for any other shape -export function formatPlainMessage(message: string): string | null { - const match = /^[^:]+: found ([\s\S]+) but expected ([\s\S]+)$/.exec(message.trim()); - if (!match) return null; - const code = (text: string) => `\`${text.replace(/`/g, '')}\``; - return `**Expected** ${code(match[2])}\n\n**Found** ${code(match[1])}`; -} - // liquidjava.hover.showDetails: off keeps the origin notes, the counterexample and the hints in the view only (user // studies). liquidjava.hover.showHints, its name in 0.1.1, still counts when a settings file sets it to false function showDetailsInHover(): boolean { diff --git a/client/src/utils/message-markdown.plain.spec.ts b/client/src/utils/message-markdown.plain.spec.ts new file mode 100644 index 0000000..e5aeb24 --- /dev/null +++ b/client/src/utils/message-markdown.plain.spec.ts @@ -0,0 +1,21 @@ +import { describe, expect, it } from "vitest"; +import { formatPlainMessage } from "./message-markdown"; + +describe("formatPlainMessage", () => { + it("formats found and expected as code, Expected first", () => { + expect(formatPlainMessage("State Refinement Error: found empty(kettle) but expected filled(kettle)")) + .toBe("**Expected** `filled(kettle)`\n\n**Found** `empty(kettle)`"); + }); + it("keeps a found with a but inside it whole", () => { + expect(formatPlainMessage("Refinement Error: found a > 0 && b == 1 but expected a > 0 && b > 1")) + .toBe("**Expected** `a > 0 && b > 1`\n\n**Found** `a > 0 && b == 1`"); + }); + it("says what is known when nothing proves the expectation", () => { + expect(formatPlainMessage("Refinement Error: expected timeout >= 0 but could not prove it")) + .toBe("**Expected** `timeout >= 0`\n\n**Found** nothing here that proves it"); + }); + it("leaves other messages alone", () => { + expect(formatPlainMessage("Refinement Error")).toBeNull(); + expect(formatPlainMessage("Java: cannot find symbol")).toBeNull(); + }); +}); diff --git a/client/src/utils/message-markdown.ts b/client/src/utils/message-markdown.ts index b663b05..fd090ea 100644 --- a/client/src/utils/message-markdown.ts +++ b/client/src/utils/message-markdown.ts @@ -72,3 +72,18 @@ function formatInlineCode(code: string): string { function escapeMarkdown(text: string): string { return text.replace(/[!-/:-@[-`{-~]/g, "\\$&"); } + +/** + * The plain one-line message of an error, as the Problems entry shows it, formatted for the hover: Expected and Found + * as inline code on their own lines. The two shapes the server writes are "Kind: found A but expected B" and + * "Kind: expected B but could not prove it" (nothing known at that point proves B) + * @returns the markdown, or null for any other text + */ +export function formatPlainMessage(message: string): string | null { + const text = message.trim(); + const found = /^[^:]+: found ([\s\S]+) but expected ([\s\S]+)$/.exec(text); + if (found) return `**Expected** ${formatInlineCode(found[2])}\n\n**Found** ${formatInlineCode(found[1])}`; + const unproven = /^[^:]+: expected ([\s\S]+) but could not prove it$/.exec(text); + if (unproven) return `**Expected** ${formatInlineCode(unproven[1])}\n\n**Found** nothing here that proves it`; + return null; +} From 2f84212d96b1db7c3a8d8137e84b26e552920e36 Mon Sep 17 00:00:00 2001 From: Catarina Gamboa Date: Tue, 17 Nov 2026 20:15:47 +0000 Subject: [PATCH 3/5] A fold request made while the view is loading opens the folds on the next render with diagnostics (Codex, #205) Co-Authored-By: Claude Fable 5.1 --- client/src/webview/script.spec.ts | 15 +++++++++++++++ client/src/webview/script.ts | 7 ++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/client/src/webview/script.spec.ts b/client/src/webview/script.spec.ts index 688cede..82f0dbd 100644 --- a/client/src/webview/script.spec.ts +++ b/client/src/webview/script.spec.ts @@ -200,6 +200,21 @@ describe('webview script', () => { ]); }); + it('opens the requested folds on the next render when asked while loading (the tour asks for the hints)', () => { + receive({ type: 'openFolds', kinds: ['hints'] }); // the initial view is loading: nothing to open yet + showDiagnostics([{ ...diagnostic(currentFile, 'State error'), hints: [{ kind: 'general', message: 'Call `open()` first' }] }]); + const hints = root.querySelector('details[data-fold-kind="hints"]'); + expect(hints!.open, 'the hints open once the diagnostics are rendered').toBe(true); + expect(root.querySelector('details[data-fold-kind="origin"]')?.open ?? false).toBe(false); + expect(postMessage.mock.calls.filter(([m]) => (m as { action?: string }).action === 'hints')).toEqual([]); + + // the request is spent: another error's hints render closed + const another = diagnostic(currentFile, 'Another error'); + another.position = { ...another.position, lineStart: another.position.lineStart + 5, lineEnd: another.position.lineEnd + 5 }; + showDiagnostics([{ ...another, hints: [{ kind: 'general', message: 'Call `close()` first' }] }]); + expect(root.querySelector('details[data-fold-kind="hints"]')!.open).toBe(false); + }); + it('opens a tab on a selectTab message (the liquidjava.showView command with a tab and no diagnostic)', () => { showDiagnostics([diagnostic(currentFile, 'Current error')]); receive({ type: 'fsm', sms: [stateMachine] }); diff --git a/client/src/webview/script.ts b/client/src/webview/script.ts index 92bbcda..4225d8e 100644 --- a/client/src/webview/script.ts +++ b/client/src/webview/script.ts @@ -79,8 +79,12 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) foldToggleByUser = false; }, true); - // opens every fold of the given kinds in the current render, without counting as a use (the tour does this) + // opens every fold of the given kinds in the current render, without counting as a use (the tour does this). A + // request made while the view is loading, or before any diagnostics arrived, waits for the next render that has them + let requestedFolds: FoldKind[] | undefined; const openFolds = (kinds: FoldKind[]) => { + if (status === 'loading' || !diagnostics) { requestedFolds = kinds; return; } + requestedFolds = undefined; for (const details of Array.from(root.querySelectorAll('details[data-fold-kind]'))) { const kind = details.getAttribute('data-fold-kind') as FoldKind; const key = details.getAttribute('data-fold-key'); @@ -486,6 +490,7 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) root.innerHTML = diagnostics ? renderDiagnosticsView(diagnostics, showAllDiagnostics, currentFile, badges) : renderLoading(); + if (requestedFolds && diagnostics) openFolds(requestedFolds); break; case 'fsm': { const { error: shownError, index: shownIndex } = getShownStateError(stateErrors); From d795392a6e73c6314cdf8feedcda549034dff065 Mon Sep 17 00:00:00 2001 From: Catarina Gamboa Date: Tue, 17 Nov 2026 20:18:09 +0000 Subject: [PATCH 4/5] Say why a fold request that finds no folds is dropped (Codex round 2, #205) Co-Authored-By: Claude Fable 5.1 --- client/src/webview/script.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client/src/webview/script.ts b/client/src/webview/script.ts index 4225d8e..930a438 100644 --- a/client/src/webview/script.ts +++ b/client/src/webview/script.ts @@ -80,7 +80,8 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) }, true); // opens every fold of the given kinds in the current render, without counting as a use (the tour does this). A - // request made while the view is loading, or before any diagnostics arrived, waits for the next render that has them + // request made while the view is loading, or before any diagnostics arrived, waits for the next render that has them. + // A request that finds no such folds in that render is dropped: it must never open a later error's folds unasked let requestedFolds: FoldKind[] | undefined; const openFolds = (kinds: FoldKind[]) => { if (status === 'loading' || !diagnostics) { requestedFolds = kinds; return; } From 06e1c2741bb5d97aa376f6b231c5e29bffa5da8a Mon Sep 17 00:00:00 2001 From: Catarina Gamboa Date: Tue, 17 Nov 2026 20:21:51 +0000 Subject: [PATCH 5/5] A click that ends a text selection in an error card keeps the selection instead of opening the file (Codex round 3, #205) Co-Authored-By: Claude Fable 5.1 --- client/src/webview/script.spec.ts | 17 +++++++++++++++++ client/src/webview/script.ts | 4 +++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/client/src/webview/script.spec.ts b/client/src/webview/script.spec.ts index 82f0dbd..d81c849 100644 --- a/client/src/webview/script.spec.ts +++ b/client/src/webview/script.spec.ts @@ -215,6 +215,23 @@ describe('webview script', () => { expect(root.querySelector('details[data-fold-kind="hints"]')!.open).toBe(false); }); + it('shows the error in the code on a click on its card, except after a text selection', () => { + showDiagnostics([diagnostic(currentFile, 'State error')]); + postMessage.mockClear(); + const card = root.querySelector('.error-item'); + expect(card).not.toBeNull(); + const text = card!.querySelector('h3') ?? card!; + + dom.window.getSelection()!.selectAllChildren(text); // a drag over the message, then its click + text.click(); + expect(postMessage.mock.calls.filter(([m]) => (m as { type: string }).type === 'openFile')).toEqual([]); + + dom.window.getSelection()!.removeAllRanges(); + text.click(); + expect(postMessage.mock.calls).toContainEqual([{ type: 'usage', action: 'reveal-code', file: currentFile, line: position.lineStart + 1 }]); + expect(postMessage.mock.calls.filter(([m]) => (m as { type: string }).type === 'openFile')).toHaveLength(1); + }); + it('opens a tab on a selectTab message (the liquidjava.showView command with a tab and no diagnostic)', () => { showDiagnostics([diagnostic(currentFile, 'Current error')]); receive({ type: 'fsm', sms: [stateMachine] }); diff --git a/client/src/webview/script.ts b/client/src/webview/script.ts index 930a438..0d972de 100644 --- a/client/src/webview/script.ts +++ b/client/src/webview/script.ts @@ -363,9 +363,11 @@ export function getScript(vscode: VSCodeApi, document: Document, window: Window) return; } - // a click on the card of an error, outside its buttons, links and folds, shows the error in the code + // a click on the card of an error, outside its buttons, links and folds, shows the error in the code. A drag that + // selects text in the card ends with a click too: that one keeps the selection and does not open the file const errorItem = target.closest?.('.error-item'); if (errorItem && !target.closest('button, a, details')) { + if (window.getSelection?.()?.isCollapsed === false) return; const revealTarget = getDiagnosticRevealTargetFromKey(errorItem.getAttribute('data-diagnostic-target')); if (!revealTarget) return; usage('reveal-code', { file: revealTarget.file, line: revealTarget.position.lineStart + 1 });