Add file linking and autocomplete for _quarto.yml file using vscode extension

apps/vscode/package.json

@@ -1258,6 +1258,20 @@
           "default": false,
           "markdownDescription": "Write markdown links as references rather than inline. Reference links are written to the location specified in `#quarto.visualEditor.markdownReferences#`."
         },
+        "quarto.yaml.documentLinks.enabled": {
+          "order": 45,
+          "scope": "window",
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable clickable file links in `_quarto.yml` files."
+        },
+        "quarto.yaml.filepathCompletions.enabled": {
+          "order": 46,
+          "scope": "window",
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable file path autocomplete in `_quarto.yml` files."
+        },
         "quarto.zotero.library": {
           "order": 50,
           "scope": "window",

apps/vscode/src/main.ts

@@ -42,6 +42,8 @@ import { activateDiagram } from "./providers/diagram/diagram";
 import { activateCodeFormatting } from "./providers/format";
 import { activateOptionEnterProvider } from "./providers/option";
 import { activateBackgroundHighlighter } from "./providers/background";
+import { activateYamlLinks } from "./providers/yaml-links";
+import { activateYamlFilepathCompletions } from "./providers/yaml-filepath-completions";
 import { activateContextKeySetter } from "./providers/context-keys";
 import { CommandManager } from "./core/command";
 import { createQuartoExtensionApi, QuartoExtensionApi } from "./api";
@@ -168,6 +170,12 @@ export async function activate(context: vscode.ExtensionContext): Promise<Quarto
   // background highlighter
   activateBackgroundHighlighter(context, engine);
 
+  // yaml document links
+  activateYamlLinks(context);
+
+  // yaml filepath completions
+  activateYamlFilepathCompletions(context);
+
   // context setter
   activateContextKeySetter(context, engine);
 

apps/vscode/src/providers/yaml-filepath-completions.ts

@@ -0,0 +1,125 @@
+/*
+ * yaml-filepath-completions.ts
+ *
+ * Copyright (C) 2022 by Posit Software, PBC
+ *
+ * Unless you have received this program directly from Posit Software pursuant
+ * to the terms of a commercial license agreement with Posit Software, then
+ * this program is licensed to you under the terms of version 3 of the
+ * GNU Affero General Public License. This program is distributed WITHOUT
+ * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
+ * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
+ *
+ */
+
+import * as path from "path";
+
+import { glob } from "glob";
+
+import {
+  CancellationToken,
+  CompletionContext,
+  CompletionItem,
+  CompletionItemKind,
+  CompletionItemProvider,
+  ExtensionContext,
+  languages,
+  Position,
+  Range,
+  TextDocument,
+  workspace,
+} from "vscode";
+
+import { isQuartoYaml } from "../core/doc";
+
+const FILE_EXTENSIONS = ['qmd', 'scss', 'css', 'html', 'js', 'bib', 'tex', 'md'];
+const IGNORE_PATTERNS = ['.git', 'node_modules', '_site', '_freeze', '.quarto'];
+
+export function activateYamlFilepathCompletions(context: ExtensionContext) {
+  const config = workspace.getConfiguration("quarto");
+
+  if (config.get<boolean>("yaml.filepathCompletions.enabled", true)) {
+    context.subscriptions.push(
+      languages.registerCompletionItemProvider(
+        { language: "yaml", scheme: "file" },
+        new QuartoYamlFilepathCompletionProvider(),
+        "/", "." // Trigger on path separators
+      )
+    );
+  }
+}
+
+class QuartoYamlFilepathCompletionProvider implements CompletionItemProvider {
+  async provideCompletionItems(
+    document: TextDocument,
+    position: Position,
+    _token: CancellationToken,
+    _context: CompletionContext
+  ): Promise<CompletionItem[]> {
+    if (!isQuartoYaml(document)) {
+      return [];
+    }
+
+    const line = document.lineAt(position).text;
+    const linePrefix = line.substring(0, position.character);
+
+    // Only provide completions after ': ' or '- '
+    if (!this.shouldProvideCompletions(linePrefix)) {
+      return [];
+    }
+
+    const documentDir = path.dirname(document.uri.fsPath);
+    const projectFiles = await getProjectFiles(documentDir);
+
+    // Get current input to filter completions
+    const currentInput = this.getCurrentInput(linePrefix);
+
+    return projectFiles
+      .filter(file => file.toLowerCase().includes(currentInput.toLowerCase()))
+      .map(file => {
+        const item = new CompletionItem(file, CompletionItemKind.File);
+        item.detail = "Quarto project file";
+        item.insertText = file;
+
+        // If there's existing input, replace it
+        if (currentInput) {
+          const startPos = position.character - currentInput.length;
+          item.range = new Range(
+            new Position(position.line, startPos),
+            position
+          );
+        }
+
+        return item;
+      });
+  }
+
+  private shouldProvideCompletions(linePrefix: string): boolean {
+    // Check if we're in a position where file path completions make sense
+    // After ': ' for key-value pairs or after '- ' for list items
+    return /(?::\s+|^\s*-\s+)\S*$/.test(linePrefix);
+  }
+
+  private getCurrentInput(linePrefix: string): string {
+    // Extract the current partial input after ': ' or '- '
+    const match = linePrefix.match(/(?::\s+|^\s*-\s+)(\S*)$/);
+    return match ? match[1] : "";
+  }
+}
+
+async function getProjectFiles(projectDir: string): Promise<string[]> {
+  const extensionPattern = `**/*.{${FILE_EXTENSIONS.join(',')}}`;
+
+  try {
+    const files = await glob(extensionPattern, {
+      cwd: projectDir,
+      ignore: IGNORE_PATTERNS.map(p => `**/${p}/**`),
+      nodir: true,
+    });
+
+    return files.sort();
+  } catch {
+    return [];
+  }
+}

apps/vscode/src/providers/yaml-links.ts

@@ -0,0 +1,117 @@
+/*
+ * yaml-links.ts
+ *
+ * Copyright (C) 2022 by Posit Software, PBC
+ *
+ * Unless you have received this program directly from Posit Software pursuant
+ * to the terms of a commercial license agreement with Posit Software, then
+ * this program is licensed to you under the terms of version 3 of the
+ * GNU Affero General Public License. This program is distributed WITHOUT
+ * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
+ * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
+ *
+ */
+
+import path from "node:path";
+import fs from "node:fs";
+
+import {
+  CancellationToken,
+  DocumentLink,
+  DocumentLinkProvider,
+  ExtensionContext,
+  languages,
+  Position,
+  Range,
+  TextDocument,
+  Uri,
+  workspace,
+} from "vscode";
+
+import { isQuartoYaml } from "../core/doc";
+
+const FILE_EXTENSIONS = ['qmd', 'scss', 'css', 'html', 'js', 'bib', 'tex', 'md'];
+const IGNORE_PATTERNS = ['.git', 'node_modules', '_site', '_freeze', '.quarto'];
+
+export function activateYamlLinks(context: ExtensionContext) {
+  const config = workspace.getConfiguration("quarto");
+
+  if (config.get<boolean>("yaml.documentLinks.enabled", true)) {
+    context.subscriptions.push(
+      languages.registerDocumentLinkProvider(
+        { language: "yaml", scheme: "file" },
+        new QuartoYamlLinkProvider()
+      )
+    );
+  }
+}
+
+class QuartoYamlLinkProvider implements DocumentLinkProvider {
+  provideDocumentLinks(
+    document: TextDocument,
+    _token: CancellationToken
+  ): DocumentLink[] {
+    if (!isQuartoYaml(document)) {
+      return [];
+    }
+
+    const links: DocumentLink[] = [];
+    const text = document.getText();
+    const lines = text.split('\n');
+    const documentDir = path.dirname(document.uri.fsPath);
+
+    for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+      const line = lines[lineIndex];
+      const lineLinks = this.findLinksInLine(line, lineIndex, documentDir);
+      links.push(...lineLinks);
+    }
+
+    return links;
+  }
+
+  private findLinksInLine(
+    line: string,
+    lineIndex: number,
+    documentDir: string
+  ): DocumentLink[] {
+    const links: DocumentLink[] = [];
+
+    // Match file paths in YAML values
+    // Pattern: looks for paths after ': ' or '- ' that end with known extensions
+    const extensionPattern = FILE_EXTENSIONS.join('|');
+    const regex = new RegExp(
+      `(?:^\\s*-\\s*|:\\s*)([\\w./-]+\\.(?:${extensionPattern}))`,
+      'gi'
+    );
+
+    let match;
+    while ((match = regex.exec(line)) !== null) {
+      const filePath = match[1];
+      const startIndex = match.index + match[0].length - filePath.length;
+      const endIndex = startIndex + filePath.length;
+
+      // Resolve the full path
+      const fullPath = path.isAbsolute(filePath)
+        ? filePath
+        : path.resolve(documentDir, filePath);
+
+      // Check if the file exists
+      if (fs.existsSync(fullPath)) {
+        const range = new Range(
+          new Position(lineIndex, startIndex),
+          new Position(lineIndex, endIndex)
+        );
+
+        const link = new DocumentLink(
+          range,
+          Uri.file(fullPath)
+        );
+        link.tooltip = `Open ${filePath}`;
+        links.push(link);
+      }
+    }
+
+    return links;
+  }
+}