formatter: support goimports-reviser, passing in file path

[iacore]

vscode-go/extension/src/language/legacy/goFormat.ts

Lines 50 to 52 in 36d95e2

	if (formatTool === 'goimports' || formatTool === 'goreturns') {
	formatFlags.push('-srcdir', filename);
	}

    "go.formatTool": "custom",
    "go.formatFlags": [
        "-format",
        "-rm-unused",
        "FILENAME, supposedly",
    ],
    "go.alternateTools": {
        "customFormatter": "goimports-reviser",
    },

[ccoVeille]

I feel like I have a similar issue, I'm on v0.51.1

I have somehow the same setting except I'm using a custom golangci-lint binary.

I feel like something changed in the latest version. I wish I could format even if I'm using gopls.

Today, it started reporting me I had gopls.fortmatting.gofumpt=true and a custom formatter. Which may lead to format twice.

But now, I feel like it no longer format via go.formatTool.

I checked and found out the documentation somehow said go.formatflags is useless if gopls is used.

So it reports it would be formatted twice, but at same time that the go.formatflags won't be used. So it won't format twice.

I'm a bit lost with current situation.

Please note, I'm not even sure I was able to use go.formatTool=custom, my tool and flags with gopls on.

I might be wrong and my issue is not the same as yours. But I'm curious if you are using gopls and what version of vscode-go you are using.

[h9jiang]

Hi @ccoVeille

Thank you for reporting this, I recently made some changes to format tool but I hope I did not interrupt your current behavior.

Could you share the exact setting to me so I can take look?

The goal of my changes is to make sure formatTool are being executed.

The fact that extension is reporting you are formatting twice is because setting both formatTool and formatting from gopls is confusing to the extension. The extension don't know what is your true intention. Do you want to use gopls' gofumpt or do you want to use golangci-lint.

Also, thank you for using the latest version of the extension, it help a lot.

I'm trying to reproduce your issue by following instructions from golangci-lint doc. Please let me know if this is correct config. But from my local build, I can see the golangci-lint-v2 is being executed.

  "go.alternateTools": {
    "customFormatter": "golangci-lint-v2"
  },
  "go.formatTool": "custom",
  "go.formatFlags": [
    "fmt",
    "--stdin"
  ],

[h9jiang]

Hi @iacore

I have never tried to use goimports-reviser ever. But vscode does not provide the file path to formatter, the extension provide the file content to the formatter through stdin.

The formatter is suppose to return back the formatted content.

Then, the extension will apply the edits (diff between the current file content and the return file content to your editor)

Like golangci-lint, it need to run with flags like

  "go.formatFlags": [
    "fmt",
    "--stdin"
  ],

And you are reporting the right place, for some formatters, we did append src dir as flags. But in your case, we are not aware of goimports-reviser so there is no special logic handling for this formatter.

[ccoVeille]

Thanks for your detailed reply

Here were my settings

		"go.gopath": "~/go/",
		"go.lintTool": "golangci-lint-v2",
		"go.formatTool": "custom",
		"go.formatFlags": [
		 	"fmt", // .golangci.yaml enables gci, and gofumpt
		 	"--stdin"
		],
		"go.alternateTools": {
			"go": "/home/linuxbrew/.linuxbrew/bin/go",
			"golangci-lint-v2": "/home/redacted/go/bin/custom-gcl", // THIS file exists
			"customFormatter": "/home/redacted/go/bin/custom-gcl"  // THIS file exists
		},
		"gopls": {
			"verboseOutput": true,
			"ui.completion.usePlaceholders": true,
			"ui.semanticTokens": true,
			"formatting.gofumpt": true
		},

I removed "formatting.gofumpt": true because of the notification I got.

		"go.gopath": "~/go/",
		"go.lintTool": "golangci-lint-v2",
		"go.formatTool": "custom",
		"go.formatFlags": [
		 	"fmt", // .golangci.yaml enables gci, and gofumpt
		 	"--stdin"
		],
		"go.alternateTools": {
			"go": "/home/linuxbrew/.linuxbrew/bin/go",
			"golangci-lint-v2": "/home/redacted/go/bin/custom-gcl", // THIS file exists
			"customFormatter": "/home/redacted/go/bin/custom-gcl"  // THIS file exists
		},
		"gopls": {
			"verboseOutput": true,
			"ui.completion.usePlaceholders": true,
			"ui.semanticTokens": true,
		},

EDIT click to unfold I initially posted here about an issue with `customFormatter` setting, that I later moved to #3906

This morning I got a notification I didn't see until now, or simply missed.

Here is what I get:

/home/redacted/go/bin/custom-gcl is not found. Please make sure it is installed and available in the PATH /home/redacted/go/bin:REDACTED

I changed the setting and the one that is reported is the customFormatter, it would report the same for /bin/ls

I feel like customFormatter try to resolve a file from the PATH even if the provided path is absolute.
If I use the following setting, I don't get the warning about invalid path

		"go.alternateTools": {
			"go": "/home/linuxbrew/.linuxbrew/bin/go",
			"golangci-lint-v2": "/home/redacted/go/bin/custom-gcl", // THIS file exists
			"customFormatter": "custom-gcl"
		},

But I feel like it's a bug that might be related to something else, because it doesn't help me to format my files with golangci-lint

Please note, I also tried to use customFormatter: "golangci-lint-v2"

I don't know if it's a bug or expected to disallow absolute path in customFormatter

The discussion about this issue has been moved to #3906

Please note there is the tooltip I get for go.formatFlags it could be outdated, or not related, but it surprised me.

Flags to pass to format tool (e.g. ["-s"]). Not applicable when using the language server.

[ccoVeille]

As any good debug action, I feel like I face other bugs when trying to identify the one that causes issues.

I have created about the issue with invalid path #3906 issue, and edited my previous comment to make it clearer.

[h9jiang]

@ccoVeille , let me follow up on #3906.

[ccoVeille]

I solved my issues that were apparently a problem between keyboard and chair 😅

I marked my messages as off topic.

[ccoVeille]

For information, I checked goimports-reviser and there is an option

goimports-reviser -

It fails if the go.mod is not in the root dir but a subfolder, then you can use this

goimports-reviser - -project-name="github.com/your/project"

[ccoVeille]

@iacore could you confirm this solves your issue ?

    "go.formatTool": "custom",
    "go.formatFlags": [
        "-format",
        "-rm-unused",
        "-",
    ],
    "go.alternateTools": {
        "customFormatter": "goimports-reviser",
    },

[iacore]

no. it does nothing when i press "Format"

[ccoVeille]

I will step out here then.

Maybe @h9jiang can help you here

[h9jiang]

Hi iacore@

Thanks @ccoVeille , you are providing the right configs (flags) to allow goimports-reviser to accept stdin. But it turns out the extension is not passing the file content the same way as it is expecting.

I did some experiment with goimports-reviser and I think the problem here is how goimports-reviser is expecting stdin.

// They both works
~ cat x.go | goimports
~ cat x.go | goimports-reviser -

But the following way, goimports-reviser does not work

~ goimports
package main
....
(ctrl + D)
// output formatter go source

~ goimports-reviser -
no data on stdin

I think the extension is using the second approach. I'm thinking this is the problem.

There are three things we can do:

• Ask goimports-reviser to support stdin similar to goimports.
• Change how the extension pass the file content to stdin. (More investigation needed because we probably have a lot of formatter depending on this behavior)
• Add goimports-reviser to the special handling where @iacore mentioned in the first comment.

vscode-go/extension/src/language/legacy/goFormat.ts

I'm ok with the third option since we already have some special handling for other formatters. But seems like goimports-reviser need to run in the dir of the go.mod file. So some more code change maybe needed to support this.

workspace/foo goimports-reiver -output stdout main.go
Could not determine project name for path main.go: open go.mod: no such file or directory
workspace goimports-reiver -output stdout foo/main.go
// formatted go source

Some more code change is needed to find the right place for the root.

But since it support cat main.go | goimports-reviser there should be a way to work about this so it can run in any dir.

if you are willing to make the change, I'm happy to review your change.