tools: track tools/tooling updates to support generics #50558

findleyr · 2022-01-11T23:24:52Z

Many tools and libraries that operate on Go code need to be updated to support generics. In most cases, this requires handling of the new constructs introduced in go/ast and go/types.

This is a tracking issue for the status of this support. It is based on #24661, which did the same for modules, though I added several tools/packages, and removed any that have been archived or that don't work directly with Go code.

It is not the case that every tool listed here needs updates to support generics -- many will require no changes. However, any tool that interacts with Go code might need to be updated, and probably needs additional tests.

Issue #50447 tracks adding a transitional API + user guide that should make it easier to get started updating third-party tools.

How to Help

Suggest additions to the list below. This list is certainly incomplete. Any tool or library that operates on Go code is a candidate for updating.
Comment if you're aware of the status of generics support in any of the items below, and I'll update accordingly (or update this comment yourself if you can).
Try building any of the tools below with Go 1.18, and test them on generic Go code. Comment with your findings.
Send a PR to update any of the tools below to support generics (this will probably be easier once x/exp/typeparams: a new module with a transitional API for tools #50447 is resolved).

List of tools / packages

The text was updated successfully, but these errors were encountered:

mvdan · 2022-01-12T15:47:27Z

I think the gogrep entry is a bit confusing :) The link doesn't point to a Go analysis tool, and the linked issue is about support for modules. Also, note that the actual repo has been archived, so I think we can just omit it entirely, unless there's a healthy fork somewhere.

For gofumpt, I think it already supports type parameters (https://github.com/mvdan/gofumpt/blob/ba9bdf90c2757f830763edbfb9ab401a50012fa8/testdata/scripts/typeparams.txt), so we can probably mark it as done unless there's a specific bug or missing feature you can point me to.

findleyr · 2022-01-12T15:54:54Z

I think the gogrep entry is a bit confusing :)

Whoops! I started with the list from #24661, and missed that link. I removed the gogrep item, and marked gofumpt as done. Thanks!

mvdan · 2022-01-12T16:01:08Z

In terms of the other tools, you already mentioend #50447, and I think #48525 also deserves a mention as a blocker. Some static analysis tools, like unparam or staticcheck, depend on SSA.

thepudds · 2022-01-12T17:30:23Z

Hi @findleyr One thing that might be helpful is a pointer to a body of generic Go code to test against?

For example, I've pitched in a bit on dvyukov/go-fuzz, and I've confirmed that a hello world generic target seems to work, but I suspect more complicated examples might have problems. A while ago, I pulled together a small set of generics examples, but probably not representative enough, and it might be helpful to have a pointer here to a good set of examples.

Also, in case you haven't already seen this, there is a list of ~80 utilities here in golangci/golangci-lint#2438 (comment) with some high-level status for generics support, including red X's for "known to panic on generic code".

nevkontakte · 2022-01-12T18:54:10Z

gopherjs/gopherjs#1013 is the specific issue that tracks Generics support in GopherJS.

zephyrtronium · 2022-01-15T14:59:43Z

@thepudds

Hi @findleyr One thing that might be helpful is a pointer to a body of generic Go code to test against?

The test cases in test/typeparam might be useful for that.

findleyr · 2022-01-21T01:14:31Z

@thepudds thank you! Sorry for the slow turnaround: I will incorporate that list along with what I know about x/tools analyzers.

Regarding a corpus of generic code: @zephyrtronium's suggestion of test/typeparam is good. I also sometimes use go/types/testdata/examples. But the point stands: I think we should perhaps consider including a small corpus in the soon-to-be-created x/exp/typeparams module.

ipfans · 2022-03-20T01:00:07Z

Due to golangci-lint v1.45.0 being released, I think its status is now supported.

findleyr · 2022-03-21T13:41:08Z

Thanks @ipfans -- I updated to note that golangci-lint has partial generics support.

mvdan · 2022-04-24T10:30:16Z

Regarding a corpus of generic code: @zephyrtronium's suggestion of test/typeparam is good. I also sometimes use go/types/testdata/examples. But the point stands: I think we should perhaps consider including a small corpus in the soon-to-be-created x/exp/typeparams module.

I was wondering what's the current status of this, if it has evolved :) I tried using go/types/testdata/examples, but it contains some /* ERROR ... */ lines, presumably failing to typecheck on purpose - so it's no good as-is as a generic code corpus for tools. I also found https://github.com/golang/exp/tree/master/typeparams/example, though it seems to be a collection of example tools, so it's not quite what I'm after either.

mvdan · 2022-04-24T10:32:46Z

To give some more context: I'm after hundreds of lines of Go code, not thousands or tens of thousands, because that code will need to be copied to each of the modules for the tools which I need to ensure don't panic on e.g. unexpected go/ast nodes for generic code. I imagine that one wouldn't need that much code to represent most syntax and typechecking edge cases :)

gopherbot · 2022-04-28T22:55:18Z

Change https://go.dev/cl/402254 mentions this issue: go.mod: update to golang.org/x/text v0.1.10

findleyr · 2022-04-28T23:16:33Z

@mvdan

I was wondering what's the current status of this, if it has evolved :)

No status change as far as I know, sorry. I think we'd welcome an addition to x/exp/typeparams. Perhaps the corpus should be available as an importable package within that module? Would that work for your purposes, or would you more likely make a copy?

I tried using go/types/testdata/examples, but it contains some /* ERROR ... */ lines, presumably failing to typecheck on purpose

Yes, those comments denote expected errors.

so it's no good as-is as a generic code corpus for tools.

That depends on whether you want to test your tool in the presence of errors, I suppose, but your point stands. I think a good starting point for a corpus may be to filter out those error cases.

go get -u golang.org/x/tools go mod tidy For golang/go#50558 Fixes golang/go#52552 Change-Id: I233aa90922fc23800563fd05beb4be6f7e87cf5b Reviewed-on: https://go-review.googlesource.com/c/text/+/402254 Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> Reviewed-by: Ian Lance Taylor <iant@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com>

zchee · 2022-04-29T00:00:14Z

@findleyr very nits, but goa/goagen link url is now https://github.com/golang/go/issues/github.com/goadesign/goa/goagen.

findleyr · 2022-04-29T18:30:11Z

@findleyr very nits, but goa/goagen link url is now https://github.com/golang/go/issues/github.com/goadesign/goa/goagen.

Thanks. That URL doesn't look right (it starts with github.com/golang...), but I updated the goagen URL based on a Google search. Please let me know if it's still not right.

zchee · 2022-04-30T00:23:39Z

@findleyr Thanks for fix.

But, I'm not familiar with goa, but goa seems to already released v3 using v3 default branch. Also gen move to subcommand.

https://github.com/goadesign/goa#2-implement

So, I think correct URL is just:
https://github.com/goadesign/goa

go get -u golang.org/x/tools go mod tidy For golang/go#50558 Fixes golang/go#52552 Change-Id: I233aa90922fc23800563fd05beb4be6f7e87cf5b Reviewed-on: https://go-review.googlesource.com/c/text/+/402254 Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> Reviewed-by: Ian Lance Taylor <iant@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com>

seankhliao added the umbrella label Jan 12, 2022

findleyr added the Tools This label describes issues relating to any tools in the x/tools repository. label Jan 12, 2022

cristaloleg mentioned this issue Jan 12, 2022

Support generics for Go 1.18 go-critic/go-critic#1193

Closed

suzmue mentioned this issue Jan 14, 2022

Generic function support cweill/gotests#165

Open

ldez mentioned this issue Jan 14, 2022

go1.18 support golangci/golangci-lint#2438

Merged

heschi added the NeedsFix The path to resolution is known, but the work has not been done. label Jan 20, 2022

hyangah mentioned this issue Jan 31, 2022

📌 Go1.18 Support Status golang/vscode-go#2043

Closed

bobg mentioned this issue Feb 3, 2022

proposal: go/types: export term/termlist logic #50963

Closed

This was referenced Feb 6, 2022

cmd/vet: audit / update vet analyzer handling of generic code #48704

Closed

x/tools/go/analysis/passes/{nilness,unusedwrite,buildssa}: some go vet analyzers don't work with generics. #51038

Closed

ldez mentioned this issue Mar 17, 2022

Support of generics golangci/golangci-lint#2649

Closed

13 tasks

This was referenced Apr 28, 2022

x/text/cmd/gotext: dependency of x/tools is too old for Go 1.18 #52552

Closed

x/text/cmd/gotext: gotext does not work with generics #52553

Closed

shoenig mentioned this issue May 12, 2022

build: update dependencies hashicorp/go-hclog#111

Merged

seankhliao added this to the Backlog milestone Aug 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tools: track tools/tooling updates to support generics #50558

tools: track tools/tooling updates to support generics #50558

findleyr commented Jan 11, 2022 •

edited

Loading

mvdan commented Jan 12, 2022

findleyr commented Jan 12, 2022

mvdan commented Jan 12, 2022

thepudds commented Jan 12, 2022 •

edited

Loading

nevkontakte commented Jan 12, 2022

zephyrtronium commented Jan 15, 2022

findleyr commented Jan 21, 2022

ipfans commented Mar 20, 2022

findleyr commented Mar 21, 2022

mvdan commented Apr 24, 2022

mvdan commented Apr 24, 2022

gopherbot commented Apr 28, 2022

findleyr commented Apr 28, 2022

zchee commented Apr 29, 2022

findleyr commented Apr 29, 2022

zchee commented Apr 30, 2022 •

edited

Loading

tools: track tools/tooling updates to support generics #50558

tools: track tools/tooling updates to support generics #50558

Comments

findleyr commented Jan 11, 2022 • edited Loading

How to Help

List of tools / packages

mvdan commented Jan 12, 2022

findleyr commented Jan 12, 2022

mvdan commented Jan 12, 2022

thepudds commented Jan 12, 2022 • edited Loading

nevkontakte commented Jan 12, 2022

zephyrtronium commented Jan 15, 2022

findleyr commented Jan 21, 2022

ipfans commented Mar 20, 2022

findleyr commented Mar 21, 2022

mvdan commented Apr 24, 2022

mvdan commented Apr 24, 2022

gopherbot commented Apr 28, 2022

findleyr commented Apr 28, 2022

zchee commented Apr 29, 2022

findleyr commented Apr 29, 2022

zchee commented Apr 30, 2022 • edited Loading

findleyr commented Jan 11, 2022 •

edited

Loading

thepudds commented Jan 12, 2022 •

edited

Loading

zchee commented Apr 30, 2022 •

edited

Loading