feat: extend schema providers to metadata-files included YAML (#348)

Author: mcanouil

CHANGELOG.md

@@ -7,6 +7,7 @@
 - feat: support a v2 extension schema vocabulary at `https://m.canouil.dev/quarto-wizard/assets/schema/v2/extension-schema.json`. v2 uses JSON Schema canonical names exclusively (`minimum`, `maximum`, `multipleOf`, `additionalProperties`, `propertyNames`, `dependentRequired`, `contentEncoding`, `contentMediaType`, `replaceWith`, ...), drops `pattern-exact` in favour of `^...$` anchors in the pattern itself, and lets shortcode entries declare a parent-level `required: [name1, ...]` array. v1 schemas keep working under the v1 URI; the runtime dispatches on the instance `$schema` URI.
 - feat: extend the v1 schema vocabulary with new optional field properties: `title`, `examples`, `format`, `null` type, `multiple-of`, `additional-properties`, `property-names`, `dependent-required`, `content-encoding`, `content-media-type`. `completion.type: directory` is now recognised alongside `file` / `color` / ... .
 - feat: `$schema:` completion in `_schema.yml` offers both the v1 and v2 URIs (v2 preferred).
+- feat: extend schema completion, diagnostics, and hover to YAML files included via `metadata-files:`. Secondary configuration files declared in `_quarto.yml`, `_metadata.yml`, or `.qmd` front-matter now receive the same IntelliSense as canonical Quarto config files.
 
 ### Bug Fixes
 

src/providers/registerYamlProviders.ts

@@ -8,7 +8,8 @@ import { SchemaDiagnosticsProvider } from "./schemaDiagnosticsProvider";
 import { SchemaDefinitionCompletionProvider, SCHEMA_DEFINITION_SELECTOR } from "./schemaDefinitionCompletionProvider";
 import { logMessage } from "../utils/log";
 import { invalidateWorkspaceSchemaIndex } from "../utils/workspaceSchemaIndex";
-import { findOwningProjectRootSync } from "../utils/projectRootsRegistry";
+import { findOwningProjectRoot, findOwningProjectRootSync } from "../utils/projectRootsRegistry";
+import { invalidateMetadataFiles, isQmdFile, refreshSource } from "../utils/metadataFilesRegistry";
 
 /**
  * Register YAML completion and diagnostics providers for Quarto
@@ -70,5 +71,86 @@ export function registerYamlProviders(context: vscode.ExtensionContext, schemaCa
 	context.subscriptions.push(schemaWatcher.onDidDelete(invalidateAndRevalidate));
 	context.subscriptions.push(schemaWatcher);
 
+	const applyMetadataChange = (owningRoot: string) => {
+		invalidateWorkspaceSchemaIndex(owningRoot);
+		diagnosticsProvider.revalidateAll();
+	};
+
+	// Watch Quarto config sources for changes in `metadata-files:` entries.
+	const metadataSourceWatcher = vscode.workspace.createFileSystemWatcher("**/_{quarto,metadata}.{yml,yaml}");
+	const refreshMetadataSource = async (uri: vscode.Uri) => {
+		if (uri.scheme !== "file") {
+			return;
+		}
+		const owningRoot = findOwningProjectRootSync(uri.fsPath);
+		if (!owningRoot) {
+			return;
+		}
+		const changed = await refreshSource(owningRoot, uri.fsPath);
+		if (!changed) {
+			return;
+		}
+		applyMetadataChange(owningRoot);
+		logMessage(`Metadata-files registry refreshed for ${uri.fsPath}.`, "debug");
+	};
+	context.subscriptions.push(metadataSourceWatcher.onDidChange(refreshMetadataSource));
+	context.subscriptions.push(metadataSourceWatcher.onDidCreate(refreshMetadataSource));
+	context.subscriptions.push(metadataSourceWatcher.onDidDelete(refreshMetadataSource));
+	context.subscriptions.push(metadataSourceWatcher);
+
+	// `.qmd` front-matter can also list metadata-files; refresh on save/open.
+	// Uses the async project-root lookup so first-open during activation succeeds
+	// before tree-view discovery has populated the sync snapshot.
+	const refreshQmdSource = async (document: vscode.TextDocument): Promise<string | undefined> => {
+		if (document.uri.scheme !== "file") {
+			return undefined;
+		}
+		if (document.languageId !== "quarto" && !isQmdFile(document.fileName)) {
+			return undefined;
+		}
+		const owningRoot = await findOwningProjectRoot(document.uri);
+		if (!owningRoot) {
+			return undefined;
+		}
+		const changed = await refreshSource(owningRoot, document.uri.fsPath);
+		return changed ? owningRoot : undefined;
+	};
+	const refreshQmdAndInvalidate = async (document: vscode.TextDocument) => {
+		const changedRoot = await refreshQmdSource(document);
+		if (changedRoot) {
+			applyMetadataChange(changedRoot);
+		}
+	};
+	context.subscriptions.push(vscode.workspace.onDidSaveTextDocument(refreshQmdAndInvalidate));
+	context.subscriptions.push(vscode.workspace.onDidOpenTextDocument(refreshQmdAndInvalidate));
+
+	// Prime the registry from already-open .qmd documents in one batched pass:
+	// invalidate each affected root once instead of N times.
+	const primeOpenQmdDocuments = async () => {
+		const results = await Promise.all(vscode.workspace.textDocuments.map(refreshQmdSource));
+		const changedRoots = new Set<string>();
+		for (const root of results) {
+			if (root) {
+				changedRoots.add(root);
+			}
+		}
+		for (const root of changedRoots) {
+			invalidateWorkspaceSchemaIndex(root);
+		}
+		if (changedRoots.size > 0) {
+			diagnosticsProvider.revalidateAll();
+		}
+	};
+	primeOpenQmdDocuments().catch((error) =>
+		logMessage(`Failed to prime metadata-files registry: ${String(error)}.`, "warn"),
+	);
+
+	// Workspace folder changes can invalidate project-root identity; rebuild lazily.
+	context.subscriptions.push(
+		vscode.workspace.onDidChangeWorkspaceFolders(() => {
+			invalidateMetadataFiles();
+		}),
+	);
+
 	logMessage("YAML completion, hover, and diagnostics providers registered.", "debug");
 }

src/providers/yamlCompletionProvider.ts

@@ -7,6 +7,7 @@ import { isFilePathDescriptor, buildFilePathCompletions } from "../utils/filePat
 import { hasCompletableValues } from "../utils/schemaDocumentation";
 import { getWorkspaceSchemaIndex } from "../utils/workspaceSchemaIndex";
 import { findOwningProjectRoot } from "../utils/projectRootsRegistry";
+import { isRelevantYaml } from "../utils/metadataFilesRegistry";
 import { logMessage } from "../utils/log";
 
 /**
@@ -21,6 +22,10 @@ export class YamlCompletionProvider implements vscode.CompletionItemProvider {
 		position: vscode.Position,
 	): Promise<vscode.CompletionItem[] | undefined> {
 		try {
+			if (!isRelevantYaml(document)) {
+				return undefined;
+			}
+
 			const lines = document.getText().split("\n");
 			const languageId = document.languageId;
 
@@ -409,10 +414,12 @@ export class YamlCompletionProvider implements vscode.CompletionItemProvider {
 }
 
 /**
- * File patterns for YAML documents that may contain Quarto configuration.
+ * Document selector for schema-driven YAML providers.  Targets `.qmd` files
+ * and any YAML file; per-document relevance (canonical `_quarto.*`/
+ * `_metadata.*` filenames or `metadata-files:` registered paths) is enforced
+ * inside each provider via {@link isRelevantYaml}.
  */
 export const YAML_DOCUMENT_SELECTOR: vscode.DocumentSelector = [
-	{ language: "yaml", pattern: "**/_quarto.{yml,yaml}" },
-	{ language: "yaml", pattern: "**/_metadata.{yml,yaml}" },
+	{ language: "yaml", scheme: "file" },
 	{ language: "quarto", pattern: "**/*.qmd" },
 ];

src/providers/yamlDiagnosticsProvider.ts

@@ -8,6 +8,7 @@ import { logMessage } from "../utils/log";
 import { debounce } from "../utils/debounce";
 import { getWorkspaceSchemaIndex } from "../utils/workspaceSchemaIndex";
 import { findOwningProjectRoot } from "../utils/projectRootsRegistry";
+import { isRelevantYaml } from "../utils/metadataFilesRegistry";
 
 /**
  * Validate a single value against a field descriptor, returning error messages.
@@ -180,19 +181,7 @@ export class YamlDiagnosticsProvider implements vscode.Disposable {
 	}
 
 	private isRelevantDocument(document: vscode.TextDocument): boolean {
-		const fileName = document.fileName;
-		if (document.languageId === "quarto" || fileName.endsWith(".qmd")) {
-			return true;
-		}
-		if (document.languageId === "yaml") {
-			return (
-				fileName.endsWith("_quarto.yml") ||
-				fileName.endsWith("_quarto.yaml") ||
-				fileName.endsWith("_metadata.yml") ||
-				fileName.endsWith("_metadata.yaml")
-			);
-		}
-		return false;
+		return isRelevantYaml(document);
 	}
 
 	private async validateDocument(document: vscode.TextDocument): Promise<void> {

src/providers/yamlHoverProvider.ts

@@ -6,6 +6,7 @@ import { getYamlKeyPath, isInYamlRegion } from "../utils/yamlPosition";
 import { logMessage } from "../utils/log";
 import { getWorkspaceSchemaIndex } from "../utils/workspaceSchemaIndex";
 import { findOwningProjectRoot } from "../utils/projectRootsRegistry";
+import { isRelevantYaml } from "../utils/metadataFilesRegistry";
 
 /**
  * Provides hover information for Quarto extension options
@@ -16,6 +17,10 @@ export class YamlHoverProvider implements vscode.HoverProvider {
 
 	async provideHover(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.Hover | null> {
 		try {
+			if (!isRelevantYaml(document)) {
+				return null;
+			}
+
 			const lines = document.getText().split("\n");
 			const languageId = document.languageId;