|
| 1 | +//===----------------------------------------------------------------------===// |
| 2 | +// |
| 3 | +// This source file is part of the VS Code Swift open source project |
| 4 | +// |
| 5 | +// Copyright (c) 2025 the VS Code Swift project authors |
| 6 | +// Licensed under Apache License v2.0 |
| 7 | +// |
| 8 | +// See LICENSE.txt for license information |
| 9 | +// See CONTRIBUTORS.txt for the list of VS Code Swift project authors |
| 10 | +// |
| 11 | +// SPDX-License-Identifier: Apache-2.0 |
| 12 | +// |
| 13 | +//===----------------------------------------------------------------------===// |
| 14 | +import * as vscode from "vscode"; |
| 15 | + |
| 16 | +import { FolderContext } from "../FolderContext"; |
| 17 | +import { FolderOperation, WorkspaceContext } from "../WorkspaceContext"; |
| 18 | +import { LSPPlaygroundsDiscovery, Playground } from "./LSPPlaygroundsDiscovery"; |
| 19 | + |
| 20 | +export { Playground }; |
| 21 | + |
| 22 | +export interface PlaygroundChangeEvent { |
| 23 | + uri: string; |
| 24 | + playgrounds: Playground[]; |
| 25 | +} |
| 26 | + |
| 27 | +/** |
| 28 | + * Uses document symbol request to keep a running copy of all the test methods |
| 29 | + * in a file. When a file is saved it checks to see if any new methods have been |
| 30 | + * added, or if any methods have been removed and edits the test items based on |
| 31 | + * these results. |
| 32 | + */ |
| 33 | +export class PlaygroundProvider implements vscode.Disposable { |
| 34 | + private fetchPromise: Promise<Playground[]> | undefined; |
| 35 | + private documentPlaygrounds: Map<string, Playground[]> = new Map(); |
| 36 | + private didChangePlaygroundsEmitter: vscode.EventEmitter<PlaygroundChangeEvent> = |
| 37 | + new vscode.EventEmitter(); |
| 38 | + |
| 39 | + constructor(private folderContext: FolderContext) {} |
| 40 | + |
| 41 | + private get lspPlaygroundDiscovery(): LSPPlaygroundsDiscovery { |
| 42 | + return new LSPPlaygroundsDiscovery(this.folderContext.languageClientManager); |
| 43 | + } |
| 44 | + |
| 45 | + /** |
| 46 | + * Create folder observer that creates a PlaygroundProvider when a folder is added and |
| 47 | + * discovers available playgrounds when the folder is in focus |
| 48 | + * @param workspaceContext Workspace context for extension |
| 49 | + * @returns Observer disposable |
| 50 | + */ |
| 51 | + public static observeFolders(workspaceContext: WorkspaceContext): vscode.Disposable { |
| 52 | + return workspaceContext.onDidChangeFolders(({ folder, operation }) => { |
| 53 | + switch (operation) { |
| 54 | + case FolderOperation.add: |
| 55 | + case FolderOperation.packageUpdated: |
| 56 | + if (folder) { |
| 57 | + void this.setupPlaygroundProviderForFolder(folder); |
| 58 | + } |
| 59 | + break; |
| 60 | + } |
| 61 | + }); |
| 62 | + } |
| 63 | + |
| 64 | + private static async setupPlaygroundProviderForFolder(folder: FolderContext) { |
| 65 | + if (!folder.hasPlaygroundProvider()) { |
| 66 | + folder.addPlaygroundProvider(); |
| 67 | + } |
| 68 | + await folder.refreshPlaygroundProvider(); |
| 69 | + } |
| 70 | + |
| 71 | + /** |
| 72 | + * Fetch the full list of playgrounds |
| 73 | + */ |
| 74 | + async getWorkspacePlaygrounds(): Promise<Playground[]> { |
| 75 | + if (this.fetchPromise) { |
| 76 | + return await this.fetchPromise; |
| 77 | + } |
| 78 | + return Array.from(this.documentPlaygrounds.values()).flatMap(v => v); |
| 79 | + } |
| 80 | + |
| 81 | + onDocumentCodeLens( |
| 82 | + document: vscode.TextDocument, |
| 83 | + codeLens: vscode.CodeLens[] | null | undefined |
| 84 | + ) { |
| 85 | + const playgrounds: Playground[] = ( |
| 86 | + codeLens?.map(c => (c.command?.arguments ?? [])[0]) ?? [] |
| 87 | + ) |
| 88 | + .filter(p => !!p) |
| 89 | + // Convert from LSP TextDocumentPlayground to Playground |
| 90 | + .map(p => ({ |
| 91 | + ...p, |
| 92 | + range: undefined, |
| 93 | + location: new vscode.Location(document.uri, p.range), |
| 94 | + })); |
| 95 | + const uri = document.uri.toString(); |
| 96 | + if (playgrounds.length > 0) { |
| 97 | + this.documentPlaygrounds.set(uri, playgrounds); |
| 98 | + this.didChangePlaygroundsEmitter.fire({ uri, playgrounds }); |
| 99 | + } else { |
| 100 | + if (this.documentPlaygrounds.delete(uri)) { |
| 101 | + this.didChangePlaygroundsEmitter.fire({ uri, playgrounds: [] }); |
| 102 | + } |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + onDidChangePlaygrounds: vscode.Event<PlaygroundChangeEvent> = |
| 107 | + this.didChangePlaygroundsEmitter.event; |
| 108 | + |
| 109 | + async fetch() { |
| 110 | + this.fetchPromise = this.lspPlaygroundDiscovery.getWorkspacePlaygrounds(); |
| 111 | + const playgrounds = await this.fetchPromise; |
| 112 | + this.documentPlaygrounds.clear(); |
| 113 | + for (const playground of playgrounds) { |
| 114 | + const uri = playground.location.uri; |
| 115 | + this.documentPlaygrounds.set( |
| 116 | + uri, |
| 117 | + (this.documentPlaygrounds.get(uri) ?? []).concat(playground) |
| 118 | + ); |
| 119 | + } |
| 120 | + this.fetchPromise = undefined; |
| 121 | + } |
| 122 | + |
| 123 | + dispose() { |
| 124 | + this.documentPlaygrounds.clear(); |
| 125 | + } |
| 126 | +} |
0 commit comments