Skip to content

Consolidate unique examples document helpers #1015

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

Open
seeM wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Consolidate unique examples document helpers #1015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
519d591
use disposable store
seeM Jun 18, 2026
58487d0
use the existing unique example function in diagnostics tests
seeM Jun 18, 2026
116d111
nit: use uris
seeM Jun 18, 2026
efc2102
fix failing tests
seeM Jun 18, 2026
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
134 changes: 60 additions & 74 deletions apps/vscode/src/test/code-cell-symbols.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as vscode from "vscode";
import * as assert from "assert";
import { openUniqueExampleDocument, wait } from "./test-utils";
import { openAndShowUniqueExamplesDocument, wait } from "./test-utils";
import { DisposableStore } from "core";

/**
* Creates a fake document symbol provider that returns DocumentSymbol[] for virtual docs.
Expand Down Expand Up @@ -69,6 +70,8 @@ function flattenSymbolNames(symbols: vscode.DocumentSymbol[]): string[] {
}

suite("Code Cell Symbols", function () {
const disposables = new DisposableStore();

setup(async function () {
await vscode.workspace
.getConfiguration("quarto")
Expand All @@ -77,6 +80,7 @@ suite("Code Cell Symbols", function () {
});

teardown(async function () {
disposables.clear();
await vscode.workspace
.getConfiguration("quarto")
.update("symbols.showCodeCellsInOutline", undefined);
Expand All @@ -102,106 +106,88 @@ suite("Code Cell Symbols", function () {

// Register BEFORE opening the document
// Use both scheme and language like the formatting tests
const provider = vscode.languages.registerDocumentSymbolProvider(
disposables.add(vscode.languages.registerDocumentSymbolProvider(
{ scheme: "file", pattern: "**/.vdoc.*" },
createFakeDocumentSymbolProvider(fakeSymbols)
);
));
await wait(100);

const { doc, cleanup } = await openUniqueExampleDocument("format/basics.qmd");
try {
await wait(800);
const { doc } = await openAndShowUniqueExamplesDocument("format/basics.qmd", disposables);
await wait(800);

const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);
const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);

const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("my_function"),
`Expected 'my_function' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("my_variable"),
`Expected 'my_variable' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' in symbols, got: ${names.join(", ")}`
);
} finally {
provider.dispose();
await vscode.commands.executeCommand("workbench.action.closeActiveEditor");
cleanup();
}
const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("my_function"),
`Expected 'my_function' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("my_variable"),
`Expected 'my_variable' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' in symbols, got: ${names.join(", ")}`
);
});

test("handles SymbolInformation[] from embedded provider", async function () {
const symbolNames = ["info_function", "info_class"];

// Register BEFORE opening the document
const provider = vscode.languages.registerDocumentSymbolProvider(
disposables.add(vscode.languages.registerDocumentSymbolProvider(
{ scheme: "file", pattern: "**/.vdoc.*" },
createFakeSymbolInformationProvider(symbolNames)
);
));
await wait(100);

const { doc, cleanup } = await openUniqueExampleDocument("format/basics.qmd");
try {
await wait(800);
const { doc } = await openAndShowUniqueExamplesDocument("format/basics.qmd", disposables);
await wait(800);

const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);
const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);

const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("info_function"),
`Expected 'info_function' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("info_class"),
`Expected 'info_class' in symbols, got: ${names.join(", ")}`
);
} finally {
provider.dispose();
await vscode.commands.executeCommand("workbench.action.closeActiveEditor");
cleanup();
}
const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("info_function"),
`Expected 'info_function' in symbols, got: ${names.join(", ")}`
);
assert.ok(
names.includes("info_class"),
`Expected 'info_class' in symbols, got: ${names.join(", ")}`
);
});

test("handles undefined from embedded provider without error", async function () {
// Register BEFORE opening the document
const provider = vscode.languages.registerDocumentSymbolProvider(
disposables.add(vscode.languages.registerDocumentSymbolProvider(
{ scheme: "file", pattern: "**/.vdoc.*" },
createUndefinedSymbolProvider()
);
));
await wait(100);

const { doc, cleanup } = await openUniqueExampleDocument("format/basics.qmd");
try {
await wait(800);
const { doc } = await openAndShowUniqueExamplesDocument("format/basics.qmd", disposables);
await wait(800);

const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);
const symbols = await vscode.commands.executeCommand<vscode.DocumentSymbol[]>(
"vscode.executeDocumentSymbolProvider",
doc.uri
);

const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' to still appear even when embedded provider returns undefined, got: ${names.join(", ")}`
);
} finally {
provider.dispose();
await vscode.commands.executeCommand("workbench.action.closeActiveEditor");
cleanup();
}
const names = flattenSymbolNames(symbols);
assert.ok(
names.includes("(code cell)"),
`Expected '(code cell)' to still appear even when embedded provider returns undefined, got: ${names.join(", ")}`
);
});
});
Loading
Loading