-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds a new view to the Puppet toolbar view container that shows the puppet modules listed in the Puppetfile in the current workspace. This also adds a new command and context menu that will open the Puppetfile at the line of the selected module in the view. This uses the `openTextDocument` VS Code API to open the Puppetfile without showing the file to the user. This initiates a `didOpen` notification which sends the content to the Language Server. If we opened the document and sent the content ourselves, a `didOpen` notitication is still sent, so it would result in sending the content twice.
- Loading branch information
Showing
4 changed files
with
192 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| import * as path from 'path'; | ||
| import { | ||
| commands, | ||
| Event, | ||
| EventEmitter, | ||
| ProviderResult, | ||
| ThemeIcon, | ||
| TreeDataProvider, | ||
| TreeItem, | ||
| TreeItemCollapsibleState, | ||
| Uri, | ||
| ViewColumn, | ||
| window, | ||
| workspace, | ||
| } from 'vscode'; | ||
| import { RequestType } from 'vscode-languageclient'; | ||
| import { ConnectionHandler } from '../handler'; | ||
| import { reporter } from '../telemetry'; | ||
|
|
||
| class PuppetfileDependencyItem extends TreeItem { | ||
| constructor( | ||
| public readonly name: string, | ||
| public readonly version: string, | ||
| public readonly start_line: number, | ||
| public readonly end_line: number, | ||
| public readonly collapsibleState: TreeItemCollapsibleState, | ||
| public readonly children?: Array<[string, PuppetfileDependencyItem]>, | ||
| ) { | ||
| super(name, collapsibleState); | ||
| if (children) { | ||
| this.iconPath = ThemeIcon.Folder; | ||
| } else { | ||
| this.iconPath = new ThemeIcon('package'); | ||
| } | ||
| } | ||
|
|
||
| get tooltip(): string { | ||
| return `${this.name}-${this.version}`; | ||
| } | ||
|
|
||
| get description(): string { | ||
| return this.version; | ||
| } | ||
| } | ||
|
|
||
| class PuppetfileDependency { | ||
| constructor( | ||
| public readonly name: string, | ||
| public readonly version: string, | ||
| public readonly start_line: number, | ||
| public readonly end_line: number, | ||
| ) { | ||
| // | ||
| } | ||
| } | ||
|
|
||
| interface PuppetfileDependencyResponse { | ||
| dependencies: PuppetfileDependency[]; | ||
| error: string[]; | ||
| } | ||
|
|
||
| export class PuppetfileProvider implements TreeDataProvider<PuppetfileDependencyItem> { | ||
| private _onDidChangeTreeData: EventEmitter<PuppetfileDependencyItem | undefined> = new EventEmitter< | ||
| PuppetfileDependencyItem | undefined | ||
| >(); | ||
| readonly onDidChangeTreeData: Event<PuppetfileDependencyItem | undefined>; | ||
|
|
||
| constructor(protected handler: ConnectionHandler) { | ||
| this.onDidChangeTreeData = this._onDidChangeTreeData.event; | ||
| commands.registerCommand('puppet.refreshPuppetfileDependencies', () => { | ||
| reporter.sendTelemetryEvent('puppet.refreshPuppetfileDependencies'); | ||
| this.refresh(); | ||
| }); | ||
| commands.registerCommand('puppet.goToPuppetfileDefinition', (puppetModule: PuppetfileDependencyItem) => { | ||
| reporter.sendTelemetryEvent('puppet.goToPuppetfileDefinition'); | ||
|
|
||
| const workspaceFolder = workspace.workspaceFolders[0].uri; | ||
| const puppetfile = path.join(workspaceFolder.fsPath, 'Puppetfile'); | ||
| workspace.openTextDocument(puppetfile).then((doc) => { | ||
| const line = doc.lineAt(+puppetModule.start_line); | ||
| window.showTextDocument(doc, { | ||
| preserveFocus: true, | ||
| preview: false, | ||
| selection: line.range, | ||
| viewColumn: ViewColumn.Active, | ||
| }); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| refresh(): void { | ||
| this._onDidChangeTreeData.fire(null); | ||
| } | ||
|
|
||
| getTreeItem(element: PuppetfileDependencyItem): TreeItem | Thenable<PuppetfileDependencyItem> { | ||
| return element; | ||
| } | ||
|
|
||
| getChildren(element?: PuppetfileDependencyItem): Promise<PuppetfileDependencyItem[]> { | ||
| if (element) { | ||
| return Promise.resolve(element.children.map((e) => e[1])); | ||
| } else { | ||
| return this.getPuppetfileDependenciesFromLanguageServer(); | ||
| } | ||
| } | ||
|
|
||
| private async getPuppetfileDependenciesFromLanguageServer(): Promise<PuppetfileDependencyItem[]> { | ||
| await this.handler.languageClient.onReady(); | ||
|
|
||
| const fileUri = Uri.file(path.join(workspace.workspaceFolders[0].uri.fsPath, 'Puppetfile')); | ||
| /* | ||
| We use openTextDocument here because we need to parse whether or not a user has opened a | ||
| Puppetfile or not. This triggers onDidOpen notification which sends the content of the Puppetfile | ||
| to the Puppet Language Server which caches the content for puppetfile-resolver to parse | ||
| */ | ||
| return workspace.openTextDocument(fileUri).then(async () => { | ||
| const results = await this.handler.languageClient.sendRequest( | ||
| new RequestType<never, PuppetfileDependencyResponse, void, void>('puppetfile/getDependencies'), | ||
| { | ||
| uri: fileUri.toString(), | ||
| }, | ||
| ); | ||
|
|
||
| reporter.sendTelemetryEvent('puppetfileView'); | ||
|
|
||
| if (results.error) { | ||
| window.showErrorMessage(`${results.error}`); | ||
| } | ||
|
|
||
| const list = results.dependencies.map((d) => { | ||
| return new PuppetfileDependencyItem(d.name, d.version, d.start_line, d.end_line, TreeItemCollapsibleState.None); | ||
| }); | ||
|
|
||
| return list; | ||
| }); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| getParent?(element: PuppetfileDependencyItem): ProviderResult<PuppetfileDependencyItem> { | ||
| throw new Error('Method not implemented.'); | ||
| } | ||
| } |