src/goStatus: add go.work to status bar quickpick

This adds an item to go to the go.work file if available.

Updates #2032

Change-Id: Ib521cc0ea648d84ac34223d55ebcd881b43800cd
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/386214
Trust: Suzy Mueller <[email protected]>
Run-TryBot: Suzy Mueller <[email protected]>
Trust: Hyang-Ah Hana Kim <[email protected]>
Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
TryBot-Result: kokoro <[email protected]>

Author: suzmue

src/goModules.ts

@@ -19,25 +19,24 @@ import { getBinPath, getGoVersion, getModuleCache, getWorkspaceFolderPath } from
 import { envPath, fixDriveCasingInWindows, getCurrentGoRoot } from './utils/pathUtils';
 export let GO111MODULE: string;
 
-async function runGoModEnv(folderPath: string): Promise<string> {
+export async function runGoEnv(folderPath: string, envvars: string[]): Promise<any> {
 	const goExecutable = getBinPath('go');
 	if (!goExecutable) {
 		console.warn(
 			`Failed to run "go env GOMOD" to find mod file as the "go" binary cannot be found in either GOROOT(${getCurrentGoRoot()}) or PATH(${envPath})`
 		);
-		return;
+		return {};
 	}
 	const env = toolExecutionEnvironment();
 	GO111MODULE = env['GO111MODULE'];
 	return new Promise((resolve) => {
-		cp.execFile(goExecutable, ['env', 'GOMOD'], { cwd: folderPath, env }, (err, stdout) => {
+		const args = ['env', '-json'].concat(envvars);
+		cp.execFile(goExecutable, args, { cwd: folderPath, env }, (err, stdout) => {
 			if (err) {
-				console.warn(`Error when running go env GOMOD: ${err}`);
-				return resolve('');
+				console.warn(`Error when running go env ${args}: ${err}`);
+				return resolve({});
 			}
-			const [goMod] = stdout.split('\n');
-			if (goMod === '/dev/null' || goMod === 'NUL') resolve('');
-			else resolve(goMod);
+			resolve(JSON.parse(stdout));
 		});
 	});
 }
@@ -65,7 +64,9 @@ export async function getModFolderPath(fileuri: vscode.Uri, isDir?: boolean): Pr
 		return;
 	}
 
-	let goModEnvResult = await runGoModEnv(pkgPath);
+	const goModEnvJSON = await runGoEnv(pkgPath, ['GOMOD']);
+	let goModEnvResult =
+		goModEnvJSON['GOMOD'] === '/dev/null' || goModEnvJSON['GOMOD'] === 'NUL' ? '' : goModEnvJSON['GOMOD'];
 	if (goModEnvResult) {
 		goModEnvResult = path.dirname(goModEnvResult);
 		const goConfig = getGoConfig(fileuri);

src/goStatus.ts

@@ -18,7 +18,7 @@ import {
 	serverOutputChannel
 } from './goLanguageServer';
 import { isGoFile } from './goMode';
-import { getModFolderPath, isModSupported } from './goModules';
+import { isModSupported, runGoEnv } from './goModules';
 import { allToolsInformation } from './goToolsInformation';
 import { getGoVersion } from './util';
 
@@ -34,22 +34,26 @@ diagnosticsStatusBarItem.name = STATUS_BAR_ITEM_NAME;
 // statusbar item for switching the Go environment
 export let goEnvStatusbarItem: vscode.StatusBarItem;
 
-let modulePath: string;
+let gomod: string;
+let gowork: string;
 export const languageServerIcon = '$(zap)';
 export const languageServerErrorIcon = '$(warning)';
 
-export function updateGoStatusBar(editor: vscode.TextEditor) {
+export async 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 = '';
-			}
-		});
+		const isMod = await isModSupported(editor.document.uri);
+		if (isMod) {
+			runGoEnv(path.dirname(editor.document.uri.fsPath), ['GOMOD', 'GOWORK']).then((p) => {
+				gomod = p['GOMOD'] === '/dev/null' || p['GOMOD'] === 'NUL' ? '' : p['GOMOD'];
+				gowork = p['GOWORK'];
+			});
+		} else {
+			gomod = '';
+			gowork = '';
+		}
 	}
 }
 
@@ -74,8 +78,12 @@ export async function expandGoStatusBar() {
 	}
 
 	// If modules is enabled, add link to mod file
-	if (modulePath) {
-		options.push({ label: "Open 'go.mod'", description: path.join(modulePath, 'go.mod') });
+	if (gomod) {
+		options.push({ label: "Open 'go.mod'", description: gomod });
+	}
+
+	if (gowork) {
+		options.push({ label: "Open 'go.work'", description: gowork });
 	}
 
 	vscode.window.showQuickPick(options).then((item) => {
@@ -95,6 +103,7 @@ export async function expandGoStatusBar() {
 				case 'Install Go Language Server':
 					vscode.commands.executeCommand('go.tools.install', [allToolsInformation['gopls']]);
 					break;
+				case "Open 'go.work'":
 				case "Open 'go.mod'":
 					const openPath = vscode.Uri.file(item.description);
 					vscode.workspace.openTextDocument(openPath).then((doc) => {