Hide diagnostics from virtual documents

Author: juliasilge

apps/vscode/package.json

@@ -1045,6 +1045,13 @@
           "default": true,
           "markdownDescription": "Use reticulate to execute Python cells within Knitr engine documents."
         },
+        "quarto.vdoc.hideDiagnostics": {
+          "order": 26,
+          "scope": "window",
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Hide diagnostics (problems) reported for internal virtual document files. These are temporary files used to provide language features in code blocks."
+        },
         "quarto.mathjax.scale": {
           "order": 15,
           "scope": "window",

apps/vscode/src/lsp/client.ts

@@ -23,7 +23,8 @@ import {
   LocationLink,
   Definition,
   LogOutputChannel,
-  Uri
+  Uri,
+  Diagnostic
 } from "vscode";
 import {
   LanguageClient,
@@ -46,13 +47,15 @@ import {
   ProvideHoverSignature,
   ProvideSignatureHelpSignature,
   State,
+  HandleDiagnosticsSignature
 } from "vscode-languageclient";
 import { MarkdownEngine } from "../markdown/engine";
 import {
   adjustedPosition,
   unadjustedRange,
   virtualDoc,
   withVirtualDocUri,
+  isVirtualDoc,
 } from "../vdoc/vdoc";
 import { activateVirtualDocEmbeddedContent } from "../vdoc/vdoc-content";
 import { vdocCompletions } from "../vdoc/vdoc-completion";
@@ -112,6 +115,9 @@ export async function activateLsp(
   if (config.get("cells.signatureHelp.enabled", true)) {
     middleware.provideSignatureHelp = embeddedSignatureHelpProvider(engine);
   }
+  if (config.get("vdoc.hideDiagnostics", true)) {
+    middleware.handleDiagnostics = createDiagnosticFilter();
+  }
   extensionHost().registerStatementRangeProvider(engine);
   extensionHost().registerHelpTopicProvider(engine);
 
@@ -338,3 +344,22 @@ 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
+ *
+ * @param enabled Whether filtering is enabled
+ * @returns A handler function for the middleware
+ */
+function createDiagnosticFilter() {
+  return (uri: Uri, diagnostics: Diagnostic[], next: HandleDiagnosticsSignature) => {
+    // If filtering is disabled or 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/vdoc/vdoc.ts

@@ -15,6 +15,7 @@
 
 import { Position, TextDocument, Uri, Range } from "vscode";
 import { Token, isExecutableLanguageBlock, languageBlockAtPosition, languageNameFromBlock } from "quarto-core";
+import * as path from "path";
 
 import { isQuartoDoc } from "../core/doc";
 import { MarkdownEngine } from "../markdown/engine";
@@ -53,6 +54,17 @@ export async function virtualDoc(
   }
 }
 
+export function isVirtualDoc(uri: Uri): boolean {
+  // Check for tempfile virtual docs
+  if (uri.scheme === "file") {
+    const filename = path.basename(uri.fsPath);
+    // Virtual docs have a specific filename pattern .vdoc.[uuid].[extension]
+    return filename.startsWith(".vdoc.") && filename.split(".").length > 3;
+  }
+
+  return false;
+}
+
 export function virtualDocForBlock(document: TextDocument, block: Token, language: EmbeddedLanguage) {
   const lines = linesForLanguage(document, language);
   fillLinesFromBlock(lines, document, block);