gopls/hover: show named func type doc when hovering over func literal#634
Open
abhay1999 wants to merge 1 commit intogolang:masterfrom
Open
gopls/hover: show named func type doc when hovering over func literal#634abhay1999 wants to merge 1 commit intogolang:masterfrom
abhay1999 wants to merge 1 commit intogolang:masterfrom
Conversation
When a func literal is implicitly converted to a named function type
(e.g. fs.WalkDirFunc), hovering over its "func" keyword now shows the
documentation and signature of that named type, with a link to pkg.go.dev.
Previously, hovering over "func" in:
filepath.WalkDir(dir, func(path string, d fs.DirEntry, err error) error {
...
})
showed only the anonymous signature "func(path string, d fs.DirEntry,
err error) error". Now it shows the docs for fs.WalkDirFunc, which is
often the information the user actually wants.
Implementation:
- Detect the case in the hover switch: when cur.Node() is *ast.FuncType
and the cursor is at the "func" token and the parent is a *ast.FuncLit.
- Use typesutil.TypesFromContext to find the named function type the
literal must satisfy.
- Load the declaring package and build a hoverResult with the named
type's documentation, signature, and pkg.go.dev link.
- If no named type is found, fall back to the existing anonymous-type
hover behavior.
Add a marker test in hover/funclittype.txt covering both cases.
Fixes golang/go#76191
Contributor
|
This PR (HEAD: 82a1fea) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/764120. Important tips:
|
Contributor
|
Message from Gopher Robot: Patch Set 1: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/764120. |
Contributor
|
Message from Abhay Chaurasiya: Patch Set 1: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/764120. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When a func literal is implicitly converted to a named function type
(e.g. fs.WalkDirFunc), hovering over its "func" keyword now shows the
documentation and signature of that named type, with a link to
pkg.go.dev.
Previously, hovering over "func" in:
showed only the anonymous signature. Now it shows the docs for
fs.WalkDirFunc, which is often the information the user actually wants.
Implementation: when cur.Node() is *ast.FuncType with the cursor at the
"func" token and the parent is a *ast.FuncLit, the new hoverFuncLit
function calls typesutil.TypesFromContext to find the named function
type the literal must satisfy, loads the declaring package via
NarrowestDeclaringPackage, and returns a hoverResult with the named
type's documentation, signature, and pkg.go.dev link. If no named type
is found, it falls back to the existing anonymous-type hover behavior.
Note: FindByPos at a FuncLit's "func" token returns the inner
*ast.FuncType node (not *ast.FuncLit), so the code checks the parent
node to detect the FuncLit context.
A marker test is added in hover/funclittype.txt covering both the
named-type case and the fallback case.
Fixes golang/go#76191