x/tools/gopls: spurious errors from template files (umbrella issue)

[achamoux]

What version of Go, VS Code & VS Code Go extension are you using?

Version Information

• Run go version to get version of Go from the VS Code integrated terminal.
• Run gopls -v version to get version of Gopls from the VS Code integrated terminal.
• Run code -v or code-insiders -v to get version of VS Code or VS Code Insiders.
• Check your installed extensions to get the version of the VS Code Go extension
• Run Ctrl+Shift+P (Cmd+Shift+P on Mac OS) > Go: Locate Configured Go Tools command.

Share the Go related settings you have added/edited

Run Preferences: Open Settings (JSON) command to open your settings.json file.
Share all the settings with the go. or ["go"] or gopls prefixes.

Describe the bug

A clear and concise description of what the bug.
A clear and concise description of what you expected to happen.

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. See error

Screenshots or recordings

If applicable, add screenshots or recordings to help explain your problem.

I'm using Go 1.17 in Windows 10 64

[zeripath]

Development of Gitea is also affected by this. Is there any way of excluding linting of individual template files or even directories? We have some template files which aren't even intended to be go templates and it's even linting files within vendor and probably in node_modules.

---

Unfortunately:

"gopls": {
  "build.directoryFilters": ["-node_modules", "-nogopls/these/are/not/for/you"]
},

Is ignored by the template linter and disappointingly it seems like the only solution at present to prevent missing other more serious go errors is to simply turn off template linting through:

 "gopls": {
    "build.templateExtensions": [],
  },

[findleyr]

Hi, for now yes the best solution is to turn off template linting, as you have found. We will prioritize fixing this for the next release (both honoring the directoryFilters, and fixing the spurious 'empty buffer' errors)

CC @pjweinbgo

[findleyr]

And I should also add: apologies for the breakage.

[butuzov]

the other possible way is to disable template association using files.associations

"files.associations": {
    "path/*tmpl": "plaintext"
}

p.s. the templates in questions used for tests and intentionally empty, if that helps to triage the bug.

[hyangah]

cc @pjweinb

[findleyr]

Renamed this to be a parent issue tracking spurious errors from template files. Leaving it in vscode-go because I suspect there may be some vscode changes required as well.

[pjweinbgo]

Isn't this a gopls (rather than vscode-go) error?

…

On Tue, Jan 4, 2022 at 10:38 AM findleyr ***@***.***> wrote: Renamed this to be a parent issue tracking spurious errors from template files. — Reply to this email directly, view it on GitHub <https://github.com/golang/vscode-go/issues/1957#issuecomment-1004914437>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACL4QJESWOOAUXNJXONUWKLUUMH65ANCNFSM5KOROTBA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[findleyr]

@pjweinbgo yes the errors are coming from gopls. It intersects with vscode-go in the mutually conflicting configuration: files.associations and gopls' build.templateExtensions.

I think it's worth leaving this here to track the overarching problem of improving the resolution of template files in vscode, but don't feel strongly.

[gopherbot]

Change https://golang.org/cl/375874 mentions this issue: gopls: change the default value for templateExtensions to be empty

[gopherbot]

Change https://golang.org/cl/376037 mentions this issue: package.json: change go template file default to empty and rename language id

[gopherbot]

Change https://golang.org/cl/376854 mentions this issue: /internal/template: identify template files by the templateExtensions option

[gopherbot]

Change https://golang.org/cl/376854 mentions this issue: internal/template: identify template files by the templateExtensions option

[gopherbot]

Change https://golang.org/cl/378354 mentions this issue: internal/lsp: find templates based on file kind

[gopherbot]

Change https://golang.org/cl/378355 mentions this issue: internal/lsp/template: remove the skipTemplate guard