extension/src/goLint: adding golangci-lint-v2 to lintTool

This change adds support for golangci-lint v2 to the extension.
golangci-lint deleted some flags this extension used during the update, so v1 and v2 must be handled differently.

Fixes #3732

Change-Id: I4bb1ec4e6d806227254d7f5de9bbdc00cde1afa6
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/660415
Reviewed-by: Dmitri Shuralyov <[email protected]>
kokoro-CI: kokoro <[email protected]>
Reviewed-by: Hongxiang Jiang <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: logica0419

CHANGELOG.md

@@ -9,6 +9,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 * Introduced quick pick separator in command `Go: Choose Go Environment` showing
 diff between options locally discovered and options available for download.
+* Added support for golangci-lint v2 ([Issue 3732](https://github.com/golang/vscode-go/issues/3732))
+  * Added a new lint tool, `golangci-lint-v2`. It's added as an installable tool, so you can install it via the `Go: Install/Update Tools` command.
+  * You can switch v1 and v2 per workspace by using `golangci-lint` and `golangci-lint-v2` option. You must keep the `golangci-lint` executable version on your machine to v1 for that.
+  * You can also use `golangci-lint` executable updated to v2. Just keep using the `golangci-lint` option for that.
+  * Looking for a way to format your code with golangci-lint v2 on VS Code? Check the [golangci-lint documentation](https://golangci-lint.run/welcome/integrations/#visual-studio-code).
 
 ### Fixes
 

docs/settings.md

@@ -362,7 +362,7 @@ Default: `"package"`
 ### `go.lintTool`
 
 Specifies Lint tool name.<br/>
-Allowed Options: `staticcheck`, `golint`, `golangci-lint`, `revive`
+Allowed Options: `staticcheck`, `golint`, `golangci-lint`, `golangci-lint-v2`, `revive`
 
 Default: `"staticcheck"`
 ### `go.logging.level (deprecated)`

extension/package.json

@@ -1174,6 +1174,7 @@
             "staticcheck",
             "golint",
             "golangci-lint",
+            "golangci-lint-v2",
             "revive"
           ]
         },

extension/src/goInstallTools.ts

@@ -221,15 +221,21 @@ export async function installTools(
 	}
 	outputChannel.appendLine(envMsg);
 
+	let installingPath = '';
 	let installingMsg = `Installing ${missing.length} ${missing.length > 1 ? 'tools' : 'tool'} at `;
 	if (envForTools['GOBIN']) {
+		installingPath = envForTools['GOBIN'];
 		installingMsg += `the configured GOBIN: ${envForTools['GOBIN']}`;
 	} else {
 		const p = toolsGopath
 			?.split(path.delimiter)
 			.map((e) => path.join(e, 'bin'))
 			.join(path.delimiter);
 		installingMsg += `${p}`;
+
+		if (p) {
+			installingPath = p;
+		}
 	}
 
 	outputChannel.appendLine(installingMsg);
@@ -246,13 +252,33 @@ export async function installTools(
 	const failures: { tool: ToolAtVersion; reason: string }[] = [];
 	const tm = options?.toolsManager ?? defaultToolsManager;
 	for (const tool of missing) {
+		// v2, v3... of the tools are installed with the same name as v1,
+		// but must be able to co-exist with other major versions in the GOBIN.
+		// Thus, we install it in a tmp directory and copy it to the GOBIN.
+		// See detail: golang/vscode-go#3732
+		if (tool.name.match('-v\\d+$')) {
+			envForTools['GOBIN'] = path.join(installingPath, 'tmp');
+		}
+
 		const failed = await tm.installTool(tool, goForInstall, envForTools);
 		if (failed) {
 			failures.push({ tool, reason: failed });
 		} else if (tool.name === 'gopls' && !skipRestartGopls) {
 			// Restart the language server if a new binary has been installed.
 			vscode.commands.executeCommand('go.languageserver.restart', RestartReason.INSTALLATION);
 		}
+
+		if (tool.name.match('-v\\d+$')) {
+			// grep the tool name without version.
+			const toolName = tool.name.match('^(?<tool>.+)-v\\d+$')?.groups?.tool;
+			if (!toolName) {
+				failures.push({ tool, reason: 'failed to grep tool name with regex' });
+				continue;
+			}
+
+			fs.copyFileSync(path.join(installingPath, 'tmp', toolName), path.join(installingPath, tool.name));
+			fs.rmdirSync(path.join(installingPath, 'tmp'), { recursive: true });
+		}
 	}
 
 	// Report detailed information about any failures.

extension/src/goLint.ts

@@ -10,7 +10,8 @@ import { getGoConfig, getGoplsConfig } from './config';
 import { toolExecutionEnvironment } from './goEnv';
 import { diagnosticsStatusBarItem, outputChannel } from './goStatus';
 import { goplsStaticcheckEnabled } from './goTools';
-import { getWorkspaceFolderPath, handleDiagnosticErrors, ICheckResult, resolvePath, runTool } from './util';
+import { inspectGoToolVersion } from './goInstallTools';
+import { getBinPath, getWorkspaceFolderPath, handleDiagnosticErrors, ICheckResult, resolvePath, runTool } from './util';
 
 /**
  * Runs linter on the current file, package or workspace.
@@ -63,7 +64,7 @@ export function lintCode(scope?: string): CommandFactory {
  * @param goConfig Configuration for the Go extension.
  * @param scope Scope in which to run the linter.
  */
-export function goLint(
+export async function goLint(
 	fileUri: vscode.Uri | undefined,
 	goConfig: vscode.WorkspaceConfiguration,
 	goplsConfig: vscode.WorkspaceConfiguration,
@@ -112,24 +113,60 @@ export function goLint(
 		}
 		args.push(flag);
 	});
-	if (lintTool === 'golangci-lint') {
+	if (lintTool.startsWith('golangci-lint')) {
+		let version: number;
+		if (lintTool === 'golangci-lint-v2') {
+			version = 2;
+		} else {
+			const { moduleVersion } = await inspectGoToolVersion(getBinPath(lintTool));
+			// if moduleVersion is undefined, treat it as version=1
+			// if moduleVersion is higher than v1 (v2, v3...), treat it as version=2
+			!moduleVersion || moduleVersion.startsWith('v1') ? (version = 1) : (version = 2);
+		}
+
+		// append common flags
 		if (args.indexOf('run') === -1) {
 			args.unshift('run');
 		}
-		if (args.indexOf('--print-issued-lines=false') === -1) {
-			// print only file:number:column
-			args.push('--print-issued-lines=false');
-		}
-		if (args.indexOf('--out-format=colored-line-number') === -1) {
-			// print file:number:column.
-			// Explicit override in case .golangci.yml calls for a format we don't understand
-			args.push('--out-format=colored-line-number');
-		}
-		if (args.indexOf('--issues-exit-code=') === -1) {
+		if (args.indexOf('--issues-exit-code=0') === -1) {
 			// adds an explicit no-error-code return argument, to avoid npm error
 			// message detection logic. See golang/vscode-go/issues/411
 			args.push('--issues-exit-code=0');
 		}
+		switch (version) {
+			case 1: // append golangci-lint v1 flags
+				if (args.indexOf('--print-issued-lines=false') === -1) {
+					// print only file:number:column
+					args.push('--print-issued-lines=false');
+				}
+				if (args.indexOf('--out-format=colored-line-number') === -1) {
+					// print file:number:column.
+					// Explicit override in case .golangci.yml calls for a format we don't understand
+					args.push('--out-format=colored-line-number');
+				}
+				break;
+
+			case 2: // append golangci-lint v2 flags
+				if (args.indexOf('--output.text.print-issued-lines=false') === -1) {
+					// print only file:number:column
+					args.push('--output.text.print-issued-lines=false');
+				}
+				if (args.indexOf('--show-stats=false') === -1) {
+					// print only file:number:column
+					args.push('--show-stats=false');
+				}
+				if (args.indexOf('--output.text.path=stdout') === -1) {
+					// print file:number:column.
+					// Explicit override in case .golangci.yml calls for a format we don't understand
+					args.push('--output.text.path=stdout');
+				}
+				if (args.indexOf('--output.text.colors=true') === -1) {
+					// print file:number:column.
+					// Explicit override in case .golangci.yml calls for a format we don't understand
+					args.push('--output.text.colors=true');
+				}
+				break;
+		}
 	}
 
 	if (scope === 'workspace' && currentWorkspace) {

extension/src/goTools.ts

@@ -156,7 +156,9 @@ export function getConfiguredTools(goConfig: { [key: string]: any }, goplsConfig
 	if (goConfig['lintTool'] !== 'staticcheck' || !goplsStaticheckEnabled) {
 		maybeAddTool(goConfig['lintTool']);
 	}
-	return tools;
+
+	// Remove duplicates since tools like golangci-lint v2 are both linter and formatter
+	return tools.filter((v, i, self) => self.indexOf(v) === i);
 }
 
 export function goplsStaticcheckEnabled(

extension/src/goToolsInformation.ts

@@ -85,6 +85,15 @@ export const allToolsInformation: { [key: string]: Tool } = {
 		description: 'Linter',
 		minimumGoVersion: semver.coerce('1.20')
 	},
+	'golangci-lint-v2': {
+		name: 'golangci-lint-v2',
+		importPath: 'github.com/golangci/golangci-lint/v2/cmd/golangci-lint',
+		modulePath: 'github.com/golangci/golangci-lint/v2',
+		replacedByGopls: false,
+		isImportant: true,
+		description: 'Linter',
+		minimumGoVersion: semver.coerce('1.23')
+	},
 	'revive': {
 		name: 'revive',
 		importPath: 'github.com/mgechev/revive',

extension/tools/allTools.ts.in

@@ -83,6 +83,15 @@ export const allToolsInformation: { [key: string]: Tool } = {
 		description: 'Linter',
 		minimumGoVersion: semver.coerce('1.20')
 	},
+	'golangci-lint-v2': {
+		name: 'golangci-lint-v2',
+		importPath: 'github.com/golangci/golangci-lint/v2/cmd/golangci-lint',
+		modulePath: 'github.com/golangci/golangci-lint/v2',
+		replacedByGopls: false,
+		isImportant: true,
+		description: 'Linter',
+		minimumGoVersion: semver.coerce('1.23')
+	},
 	'revive': {
 		name: 'revive',
 		importPath: 'github.com/mgechev/revive',