Cell diagnostics

apps/vscode/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.133.0
 
+- Added diagnostics (i.e. squiggly underlines) to code cells in qmds (<https://github.com/quarto-dev/quarto/pull/980>)
 - Added custom pair colorization and highlighting for divs in qmds (<https://github.com/quarto-dev/quarto/pull/973>).
 
 

apps/vscode/build.ts

@@ -19,7 +19,7 @@ import * as glob from "glob";
 const args = process.argv;
 const dev = args[2] === "dev";
 const test = args[2] === "test";
-const testFiles = glob.sync("src/test/*.ts");
+const testFiles = glob.sync("src/test/{*.ts,fixtures/*.ts,utils/*.ts}");
 
 const testBuildOptions = {
   entryPoints: testFiles,

apps/vscode/package.json

@@ -1003,6 +1003,20 @@
           "default": true,
           "markdownDescription": "Show parameter help when editing function calls."
         },
+        "quarto.cells.diagnostics.enabled": {
+          "order": 25,
+          "scope": "window",
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable diagnostics (linting) for code blocks from language servers."
+        },
+        "quarto.cells.diagnostics.debounceDelay": {
+          "order": 26,
+          "scope": "window",
+          "type": "number",
+          "default": 500,
+          "markdownDescription": "Delay in milliseconds before updating diagnostics after document changes."
+        },
         "quarto.cells.background.enabled": {
           "type": "boolean",
           "description": "Enable coloring the background of executable code cells.",
@@ -1049,7 +1063,7 @@
           "markdownDescription": "Millisecond delay between background color updates."
         },
         "quarto.cells.useReticulate": {
-          "order": 25,
+          "order": 27,
           "scope": "window",
           "type": "boolean",
           "default": true,

apps/vscode/src/lsp/client.ts

@@ -24,7 +24,6 @@ import {
   Definition,
   LogOutputChannel,
   Uri,
-  Diagnostic,
   window,
   ColorThemeKind
 } from "vscode";
@@ -49,7 +48,6 @@ import {
   ProvideHoverSignature,
   ProvideSignatureHelpSignature,
   State,
-  HandleDiagnosticsSignature
 } from "vscode-languageclient";
 import { MarkdownEngine } from "../markdown/engine";
 import {
@@ -58,7 +56,6 @@ import {
   virtualDoc,
   withVirtualDocUri,
 } from "../vdoc/vdoc";
-import { isVirtualDoc } from "../vdoc/vdoc-tempfile";
 import { activateVirtualDocEmbeddedContent } from "../vdoc/vdoc-content";
 import { vdocCompletions } from "../vdoc/vdoc-completion";
 
@@ -79,7 +76,7 @@ export async function activateLsp(
   context: ExtensionContext,
   quartoContext: QuartoContext,
   engine: MarkdownEngine,
-  outputChannel: LogOutputChannel
+  outputChannel: LogOutputChannel,
 ) {
 
   // The server is implemented in node
@@ -105,7 +102,6 @@ export async function activateLsp(
   const config = workspace.getConfiguration("quarto");
   activateVirtualDocEmbeddedContent();
   const middleware: Middleware = {
-    handleDiagnostics: createDiagnosticFilter(),
     provideCompletionItem: embeddedCodeCompletionProvider(engine),
     provideDefinition: embeddedGoToDefinitionProvider(engine),
     provideDocumentFormattingEdits: embeddedDocumentFormattingProvider(engine),
@@ -363,21 +359,3 @@ function isWithinYamlComment(doc: TextDocument, pos: Position) {
   const line = doc.lineAt(pos.line).text;
   return !!line.match(/^\s*#\s*\| /);
 }
-
-/**
- * Creates a diagnostic handler middleware that filters out diagnostics from virtual documents
- *
- * @returns A handler function for the middleware
- */
-export function createDiagnosticFilter() {
-  return (uri: Uri, diagnostics: Diagnostic[], next: HandleDiagnosticsSignature) => {
-    // If this is not a virtual document, pass through all diagnostics
-    if (!isVirtualDoc(uri)) {
-      next(uri, diagnostics);
-      return;
-    }
-
-    // For virtual documents, filter out all diagnostics
-    next(uri, []);
-  };
-}

apps/vscode/src/main.ts

@@ -19,6 +19,7 @@ import { tryAcquirePositronApi } from "@posit-dev/positron";
 import { MarkdownEngine } from "./markdown/engine";
 import { kQuartoDocSelector } from "./core/doc";
 import { activateLsp, deactivate as deactivateLsp } from "./lsp/client";
+import { activateEmbeddedDiagnostics, type EmbeddedDiagnosticsService } from "./providers/diagnostics";
 import { cellCommands } from "./providers/cell/commands";
 import { quartoCellExecuteCodeLensProvider } from "./providers/cell/codelens";
 import { activateQuartoAssistPanel } from "./providers/assist/panel";
@@ -51,6 +52,8 @@ import { activateDivBracketDecorations } from "./providers/div-brackets";
 import { CommandManager } from "./core/command";
 import { createQuartoExtensionApi, QuartoExtensionApi } from "./api";
 
+let embeddedDiagnostics: EmbeddedDiagnosticsService | undefined;
+
 /**
  * Entry point for the entire extension! This initializes the LSP, quartoContext, extension host, and more...
  */
@@ -118,6 +121,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<Quarto
     // deno config
     activateDenoConfig(context, engine);
 
+    // embedded diagnostics
+    embeddedDiagnostics = activateEmbeddedDiagnostics(engine, outputChannel);
+    context.subscriptions.push(embeddedDiagnostics);
+
     // lsp
     const lspClient = await activateLsp(context, quartoContext, engine, outputChannel);
 
@@ -283,5 +290,6 @@ function registerQuartoPathConfigListener(context: vscode.ExtensionContext, outp
 }
 
 export async function deactivate() {
+  await embeddedDiagnostics?.deactivate();
   return deactivateLsp();
 }