Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: avoid considering output panes as editors #771

Merged
merged 2 commits into from
Sep 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/clientHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,11 @@ export class ClientHandler {
return clients.get(this.clientName(document.toString()));
}

public clientSupportsCommand(cmdName: string, document?: vscode.Uri): boolean {
const commands = this.getClient(document).client.initializeResult.capabilities.executeCommandProvider?.commands;
return commands.includes(cmdName);
}

private clientName(folderName: string, workspaceFolders: readonly string[] = sortedWorkspaceFolders()): string {
folderName = normalizeFolderName(folderName);
const outerFolder = workspaceFolders.find((element) => folderName.startsWith(element));
Expand Down
70 changes: 36 additions & 34 deletions src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { ClientHandler, TerraformLanguageClient } from './clientHandler';
import { defaultVersionString, isValidVersionString, LanguageServerInstaller } from './languageServerInstaller';
import { ServerPath } from './serverPath';
import { SingleInstanceTimeout } from './utils';
import { config, prunedFolderNames } from './vscodeUtils';
import { config, getActiveTextEditor, prunedFolderNames } from './vscodeUtils';

const terraformStatus = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 0);

Expand Down Expand Up @@ -121,35 +121,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
await clientHandler.startClients(prunedFolderNames(event.added));
}
}),
vscode.window.onDidChangeActiveTextEditor(async (event: vscode.TextEditor | undefined) => {
// Make sure there's an open document in a folder
// Also check whether they're running a different language server
// TODO: Check initializationOptions for command presence instead of pathToBinary
if (event && vscode.workspace.workspaceFolders[0] && !lsPath.hasCustomBinPath()) {
const documentUri = event.document.uri;
const client = clientHandler.getClient(documentUri);
const moduleUri = Utils.dirname(documentUri);

if (client) {
try {
const response = await moduleCallers(client, moduleUri.toString());
if (response.moduleCallers.length === 0) {
const dirName = Utils.basename(moduleUri);
terraformStatus.text = `$(refresh) ${dirName}`;
terraformStatus.color = new vscode.ThemeColor('statusBar.foreground');
terraformStatus.tooltip = `Click to run terraform init`;
terraformStatus.command = 'terraform.initCurrent';
terraformStatus.show();
} else {
terraformStatus.hide();
}
} catch (err) {
vscode.window.showErrorMessage(err);
reporter.sendTelemetryException(err);
terraformStatus.hide();
}
}
}
vscode.window.onDidChangeVisibleTextEditors(async () => {
const textEditor = getActiveTextEditor();
await updateTerraformStatusBar(textEditor.document.uri);
}),
);

Expand All @@ -169,6 +143,34 @@ export function deactivate(): Promise<void[]> {
return clientHandler.stopClients();
}

async function updateTerraformStatusBar(documentUri: vscode.Uri) {
const initSupported = clientHandler.clientSupportsCommand('terraform-ls.terraform.init', documentUri);
if (initSupported) {
const client = clientHandler.getClient(documentUri);
const moduleUri = Utils.dirname(documentUri);

if (client) {
try {
const response = await moduleCallers(client, moduleUri.toString());
if (response.moduleCallers.length === 0) {
const dirName = Utils.basename(moduleUri);
terraformStatus.text = `$(refresh) ${dirName}`;
terraformStatus.color = new vscode.ThemeColor('statusBar.foreground');
terraformStatus.tooltip = `Click to run terraform init`;
terraformStatus.command = 'terraform.initCurrent';
terraformStatus.show();
} else {
terraformStatus.hide();
}
} catch (err) {
vscode.window.showErrorMessage(err);
reporter.sendTelemetryException(err);
terraformStatus.hide();
}
}
}
}

async function updateLanguageServer(clientHandler: ClientHandler, lsPath: ServerPath) {
console.log('Checking for language server updates...');
const hour = 1000 * 60 * 60;
Expand Down Expand Up @@ -241,11 +243,11 @@ async function terraformCommand(
languageServerExec = true,
clientHandler: ClientHandler,
): Promise<any> {
if (vscode.window.activeTextEditor) {
const documentUri = vscode.window.activeTextEditor.document.uri;
const languageClient = clientHandler.getClient(documentUri);
const textEditor = getActiveTextEditor();
if (textEditor) {
const languageClient = clientHandler.getClient(textEditor.document.uri);

const moduleUri = Utils.dirname(documentUri);
const moduleUri = Utils.dirname(textEditor.document.uri);
const response = await moduleCallers(languageClient, moduleUri.toString());

let selectedModule: string;
Expand Down
8 changes: 8 additions & 0 deletions src/vscodeUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ export function getWorkspaceFolder(folderName: string): vscode.WorkspaceFolder {
return vscode.workspace.getWorkspaceFolder(vscode.Uri.parse(folderName));
}

// getActiveTextEditor returns an active (visible and focused) TextEditor
// We intentionally do *not* use vscode.window.activeTextEditor here
// because it also contains Output panes which are considered editors
// see also https://github.com/microsoft/vscode/issues/58869
export function getActiveTextEditor(): vscode.TextEditor {
return vscode.window.visibleTextEditors.find((textEditor) => !!textEditor.viewColumn);
}

export function prunedFolderNames(
folders: readonly vscode.WorkspaceFolder[] = vscode.workspace.workspaceFolders,
): string[] {
Expand Down