| /* eslint-disable no-case-declarations */ |
| /*--------------------------------------------------------- |
| * Copyright (C) Microsoft Corporation. All rights reserved. |
| * Modification copyright 2020 The Go Authors. All rights reserved. |
| * Licensed under the MIT License. See LICENSE in the project root for license information. |
| *--------------------------------------------------------*/ |
| |
| 'use strict'; |
| |
| import path = require('path'); |
| import vscode = require('vscode'); |
| import { getGoConfig } from './config'; |
| import { formatGoVersion, GoEnvironmentOption, terminalCreationListener } from './goEnvironmentStatus'; |
| import { |
| buildLanguageServerConfig, |
| getLocalGoplsVersion, |
| languageServerIsRunning, |
| serverOutputChannel |
| } from './goLanguageServer'; |
| import { isGoFile } from './goMode'; |
| import { getModFolderPath, isModSupported } from './goModules'; |
| import { allToolsInformation } from './goTools'; |
| import { getGoVersion } from './util'; |
| |
| export const outputChannel = vscode.window.createOutputChannel('Go'); |
| |
| export const diagnosticsStatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left); |
| |
| // statusbar item for switching the Go environment |
| export let goEnvStatusbarItem: vscode.StatusBarItem; |
| |
| let modulePath: string; |
| export const languageServerIcon = '$(zap)'; |
| export const languageServerErrorIcon = '$(warning)'; |
| |
| export function updateGoStatusBar(editor: vscode.TextEditor) { |
| // Only update the module path if we are in a Go file. |
| // This allows the user to open output windows without losing |
| // the go.mod information in the status bar. |
| if (!!editor && isGoFile(editor.document)) { |
| isModSupported(editor.document.uri).then((isMod) => { |
| if (isMod) { |
| getModFolderPath(editor.document.uri).then((p) => (modulePath = p)); |
| } else { |
| modulePath = ''; |
| } |
| }); |
| } |
| } |
| |
| export async function expandGoStatusBar() { |
| const options = [ |
| { label: 'Locate Configured Go Tools', description: 'display go env' }, |
| { label: 'Choose Go Environment' } |
| ]; |
| |
| // Get the gopls configuration |
| const goConfig = getGoConfig(); |
| const cfg = buildLanguageServerConfig(goConfig); |
| if (languageServerIsRunning && cfg.serverName === 'gopls') { |
| const goplsVersion = await getLocalGoplsVersion(cfg); |
| options.push({ label: `${languageServerIcon}Open 'gopls' trace`, description: `${goplsVersion}` }); |
| } |
| if (!languageServerIsRunning && !cfg.serverName && goConfig['useLanguageServer'] === true) { |
| options.push({ |
| label: 'Install Go Language Server', |
| description: `${languageServerErrorIcon}'gopls' is required but missing` |
| }); |
| } |
| |
| // If modules is enabled, add link to mod file |
| if (modulePath) { |
| options.push({ label: "Open 'go.mod'", description: path.join(modulePath, 'go.mod') }); |
| } |
| |
| vscode.window.showQuickPick(options).then((item) => { |
| if (item) { |
| switch (item.label) { |
| case 'Locate Configured Go Tools': |
| vscode.commands.executeCommand('go.locate.tools'); |
| break; |
| case 'Choose Go Environment': |
| vscode.commands.executeCommand('go.environment.choose'); |
| break; |
| case `${languageServerIcon}Open 'gopls' trace`: |
| if (serverOutputChannel) { |
| serverOutputChannel.show(); |
| } |
| break; |
| case 'Install Go Language Server': |
| vscode.commands.executeCommand('go.tools.install', [allToolsInformation['gopls']]); |
| break; |
| case "Open 'go.mod'": |
| const openPath = vscode.Uri.file(item.description); |
| vscode.workspace.openTextDocument(openPath).then((doc) => { |
| vscode.window.showTextDocument(doc); |
| }); |
| break; |
| } |
| } |
| }); |
| } |
| |
| /** |
| * Initialize the status bar item with current Go binary |
| */ |
| export async function initGoStatusBar() { |
| if (!goEnvStatusbarItem) { |
| goEnvStatusbarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 50); |
| } |
| // set Go version and command |
| const version = await getGoVersion(); |
| const goOption = new GoEnvironmentOption(version.binaryPath, formatGoVersion(version)); |
| |
| goEnvStatusbarItem.text = goOption.label; |
| goEnvStatusbarItem.command = 'go.environment.status'; |
| |
| // Add an icon to indicate that the 'gopls' server is running. |
| // Assume if it is configured it is already running, since the |
| // icon will be updated on an attempt to start. |
| const goConfig = getGoConfig(); |
| updateLanguageServerIconGoStatusBar(languageServerIsRunning, goConfig['useLanguageServer'] === true); |
| |
| showGoStatusBar(); |
| } |
| |
| export function updateLanguageServerIconGoStatusBar(started: boolean, enabled: boolean) { |
| if (!goEnvStatusbarItem) { |
| return; |
| } |
| |
| // Split the existing goEnvStatusbarItem.text into the version string part and |
| // the gopls icon part. |
| let text = goEnvStatusbarItem.text; |
| let icon = ''; |
| if (text.endsWith(languageServerIcon)) { |
| text = text.substring(0, text.length - languageServerIcon.length); |
| } else if (text.endsWith(languageServerErrorIcon)) { |
| text = text.substring(0, text.length - languageServerErrorIcon.length); |
| } |
| |
| if (started && enabled) { |
| icon = languageServerIcon; |
| } else if (!started && enabled) { |
| icon = languageServerErrorIcon; |
| } |
| |
| goEnvStatusbarItem.text = text + icon; |
| } |
| |
| /** |
| * disable the Go status bar items |
| */ |
| export function disposeGoStatusBar() { |
| if (goEnvStatusbarItem) { |
| goEnvStatusbarItem.dispose(); |
| } |
| if (terminalCreationListener) { |
| terminalCreationListener.dispose(); |
| } |
| removeGoStatus(); |
| } |
| |
| /** |
| * Show the Go statusbar items on the statusbar |
| */ |
| export function showGoStatusBar() { |
| if (goEnvStatusbarItem) { |
| goEnvStatusbarItem.show(); |
| } |
| } |
| |
| // status bar item to show warning messages such as missing analysis tools. |
| let statusBarEntry: vscode.StatusBarItem; |
| |
| export function removeGoStatus() { |
| if (statusBarEntry) { |
| statusBarEntry.dispose(); |
| statusBarEntry = undefined; |
| } |
| } |
| |
| export function addGoStatus(message: string, command: string, tooltip?: string) { |
| if (!statusBarEntry) { |
| statusBarEntry = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, Number.MIN_VALUE); |
| } |
| statusBarEntry.text = `$(alert) ${message}`; |
| statusBarEntry.command = command; |
| statusBarEntry.tooltip = tooltip; |
| statusBarEntry.show(); |
| } |