From 59cc516dac839c63e34b04d8537a2d0a316a9155 Mon Sep 17 00:00:00 2001 From: Lionel Henry Date: Fri, 4 Jul 2025 10:55:56 +0200 Subject: [PATCH 1/4] Sort text edits by descending start position --- apps/vscode/src/providers/format.ts | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/apps/vscode/src/providers/format.ts b/apps/vscode/src/providers/format.ts index 92c078e5..263340d3 100644 --- a/apps/vscode/src/providers/format.ts +++ b/apps/vscode/src/providers/format.ts @@ -138,9 +138,13 @@ class FormatCellCommand implements Command { const edits = await formatActiveCell(editor, this.engine_); if (edits) { editor.edit((editBuilder) => { - edits.forEach((edit) => { - editBuilder.replace(edit.range, edit.newText); - }); + // Sort edits by descending start position to avoid range shifting issues + edits + .slice() + .sort((a, b) => b.range.start.compareTo(a.range.start)) + .forEach((edit) => { + editBuilder.replace(edit.range, edit.newText); + }); }); } else { window.showInformationMessage( @@ -204,15 +208,21 @@ async function formatActiveCell(editor: TextEditor, engine: MarkdownEngine) { } async function formatBlock(doc: TextDocument, block: TokenMath | TokenCodeBlock, language: EmbeddedLanguage) { + // Create virtual document containing the block const blockLines = lines(codeForExecutableLanguageBlock(block)); blockLines.push(""); const vdoc = virtualDocForCode(blockLines, language); + const edits = await executeFormatDocumentProvider( vdoc, doc, formattingOptions(doc.uri, vdoc.language) ); + if (edits) { + // Because we format with the block code copied in an empty virtual + // document, we need to adjust the ranges to match the edits to the block + // cell in the original file. const blockRange = new Range( new Position(block.range.start.line, block.range.start.character), new Position(block.range.end.line, block.range.end.character) From 189ab9be3c37586124fed82cc2de62c0ed06df86 Mon Sep 17 00:00:00 2001 From: Lionel Henry Date: Fri, 4 Jul 2025 12:24:26 +0200 Subject: [PATCH 2/4] Don't append lines to block code before formatting --- apps/vscode/src/providers/format.ts | 3 +-- packages/quarto-core/src/markdown/language.ts | 7 +++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/apps/vscode/src/providers/format.ts b/apps/vscode/src/providers/format.ts index 263340d3..51e53170 100644 --- a/apps/vscode/src/providers/format.ts +++ b/apps/vscode/src/providers/format.ts @@ -209,8 +209,7 @@ async function formatActiveCell(editor: TextEditor, engine: MarkdownEngine) { async function formatBlock(doc: TextDocument, block: TokenMath | TokenCodeBlock, language: EmbeddedLanguage) { // Create virtual document containing the block - const blockLines = lines(codeForExecutableLanguageBlock(block)); - blockLines.push(""); + const blockLines = lines(codeForExecutableLanguageBlock(block, false)); const vdoc = virtualDocForCode(blockLines, language); const edits = await executeFormatDocumentProvider( diff --git a/packages/quarto-core/src/markdown/language.ts b/packages/quarto-core/src/markdown/language.ts index ea3f88fe..201fc259 100644 --- a/packages/quarto-core/src/markdown/language.ts +++ b/packages/quarto-core/src/markdown/language.ts @@ -38,11 +38,14 @@ export function isExecutableLanguageBlock(token: Token) : token is TokenMath | T } } -export function codeForExecutableLanguageBlock(token: TokenMath | TokenCodeBlock) { +export function codeForExecutableLanguageBlock( + token: TokenMath | TokenCodeBlock, + appendNewline = true, +) { if (isMath(token)) { return token.data.text; } else if (isCodeBlock(token)) { - return token.data + "\n"; + return token.data + (appendNewline ? "\n" : ""); } else { return ""; } From 186ac618c5c2edb1bfe4a2baaa94342427633543 Mon Sep 17 00:00:00 2001 From: Lionel Henry Date: Fri, 4 Jul 2025 12:33:37 +0200 Subject: [PATCH 3/4] Don't apply partial edits --- apps/vscode/src/providers/format.ts | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/apps/vscode/src/providers/format.ts b/apps/vscode/src/providers/format.ts index 51e53170..c6a5eb84 100644 --- a/apps/vscode/src/providers/format.ts +++ b/apps/vscode/src/providers/format.ts @@ -233,8 +233,17 @@ async function formatBlock(doc: TextDocument, block: TokenMath | TokenCodeBlock, new Position(edit.range.end.line + block.range.start.line + 1, edit.range.end.character) ); return new TextEdit(range, edit.newText); - }) - .filter(edit => blockRange.contains(edit.range)); + }); + + // Bail if any edit is out of range. We used to filter these edits out but + // this could bork the cell. + if (edits.some(edit => !blockRange.contains(edit.range))) { + window.showInformationMessage( + "Formatting edits were out of range and could not be applied to the code cell." + ); + return []; + } + return adjustedEdits; } } From 873fcaba3a2966146a98468182afb1d0292287b5 Mon Sep 17 00:00:00 2001 From: elliot Date: Fri, 26 Sep 2025 16:04:52 -0400 Subject: [PATCH 4/4] Add cell-format test --- apps/vscode/src/test/examples/cell-format.qmd | 5 ++ apps/vscode/src/test/quartoDoc.test.ts | 64 +++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 apps/vscode/src/test/examples/cell-format.qmd diff --git a/apps/vscode/src/test/examples/cell-format.qmd b/apps/vscode/src/test/examples/cell-format.qmd new file mode 100644 index 00000000..c3fbd011 --- /dev/null +++ b/apps/vscode/src/test/examples/cell-format.qmd @@ -0,0 +1,5 @@ +See https://github.com/quarto-dev/quarto/issues/745 "Reformating R cell in VSCODE with air does not correctly close chunk." + +```{r} +list(foobar, foobar, foobar, foobar, foobar, foobar, foobar, foobar, foobar, foobar, foobar, foobar) +``` \ No newline at end of file diff --git a/apps/vscode/src/test/quartoDoc.test.ts b/apps/vscode/src/test/quartoDoc.test.ts index d4ca47aa..f456dae0 100644 --- a/apps/vscode/src/test/quartoDoc.test.ts +++ b/apps/vscode/src/test/quartoDoc.test.ts @@ -41,8 +41,72 @@ suite("Quarto basics", function () { roundtripSnapshotTest('capsule-leak.qmd'); roundtripSnapshotTest('attr-equals.qmd'); + + test("quarto.formatCell deals with formatters that do or don't add trailing newline consistently", async function () { + + async function testFormatter(filename: string, [line, character]: [number, number], format: (sourceText: string) => string) { + const { doc } = await openAndShowTextDocument(filename); + + const formattingEditProvider = vscode.languages.registerDocumentFormattingEditProvider( + { scheme: 'file', language: 'r' }, + createFormatterFromStringFunc(format) + ) + + setCursorPosition(line, character); + await wait(450); + await vscode.commands.executeCommand("quarto.formatCell"); + await wait(450) + + const result = doc.getText() + formattingEditProvider.dispose() + await vscode.commands.executeCommand("workbench.action.closeActiveEditor"); + + return result + } + + const newlineFormatterResult = await testFormatter( + "cell-format.qmd", + [3, 1], + (sourceText) => sourceText + 'FORMAT SUCCESS\n' + ) + const noopFormatterResult = await testFormatter( + "cell-format.qmd", + [3, 1], + (sourceText) => sourceText + 'FORMAT SUCCESS' + ) + + assert.ok(newlineFormatterResult.includes('FORMAT SUCCESS'), 'newlineFormatter failed') + assert.ok(noopFormatterResult.includes('FORMAT SUCCESS'), 'noopFormatter failed') + + assert.equal(newlineFormatterResult, noopFormatterResult) + }); + + suiteTeardown(() => { + vscode.window.showInformationMessage('All tests done!'); + }); }); +function createFormatterFromStringFunc(format: (sourceText: string) => string) { + return { + provideDocumentFormattingEdits(document: vscode.TextDocument): vscode.ProviderResult { + const fileStart = new vscode.Position(0, 0); + const fileEnd = document.lineAt(document.lineCount - 1).range.end; + + return [new vscode.TextEdit(new vscode.Range(fileStart, fileEnd), format(document.getText()))]; + } + } +} + +function setCursorPosition(line: number, character: number) { + const editor = vscode.window.activeTextEditor; + if (editor) { + const position = new vscode.Position(line, character); + const newSelection = new vscode.Selection(position, position); + editor.selection = newSelection; + editor.revealRange(newSelection, vscode.TextEditorRevealType.InCenter); // Optional: scroll to the new position + } +} + /** * * When the test is run on the dev's machine for the first time, saves the roundtripped file as a snapshot.