Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the broken references codelens #2509

Closed
3 tasks done
hyangah opened this issue Oct 24, 2022 · 2 comments
Closed
3 tasks done

Remove the broken references codelens #2509

hyangah opened this issue Oct 24, 2022 · 2 comments
Assignees
Milestone

Comments

@hyangah
Copy link
Contributor

hyangah commented Oct 24, 2022

The references codelens in go.enableCodeLens was a feature that intended to show the number of references for each function/method. This feature was coming from a tool called guru. Unfortunately, the tool is unmaintained and does not support Go Modules. As a result, this feature remained broken for Go modules users (#1643 #1781).

We didn't actively remove this setting until now because we couldn't easily tell whether the relatively low frequency of the related bug reports indicates this feature is still working for some users, or because only few number of users use this feature (this codelens is disabled by default). Go Modules had been on by default since Go 1.16 and Go Developer Survey 2020 results already showed near-universal adoption for Go Modules. Recently we came to the realization that this feature probably won't offer the best possible user experience for users who don't use Go Modules. As noted in microsoft/vscode-go#933 which added this feature, guru had a known scalability issue in handling this.

Leaving this broken feature listed in our user documentation and confusing users will do more harm than good.

In the upcomping release (v0.36.0), we are going to hide this feature from our extension settings and documentation. Note that we won't remove the code for this feature right now. If you are relying on this feature now, the codelens will still appear, but the extension will prompt a deprecation warning message.

In Jan 2023, we will remove the feature from the extension code base to reduce the complexity of our code base.

VS Code offers alternatives like "Find All References" and "Go To References".

Screen Shot 2022-10-24 at 5 57 58 PM

We understand they don't completely replace the convenience of the references codelens. There is an open feature request in gopls (golang/go#40862). If you believe this is critical for your development workflow, please support this feature request by upvoting it.

Tasks

@gopherbot gopherbot added this to the Untriaged milestone Oct 24, 2022
@hyangah hyangah modified the milestones: Untriaged, v0.36.0 Oct 25, 2022
@gopherbot
Copy link
Collaborator

Change https://go.dev/cl/444416 mentions this issue: vscode-go: remove the 'references' codelens

gopherbot pushed a commit that referenced this issue Oct 25, 2022
The 'references' codelens depends on the guru application,
which is no longer supported.

For #2509

Change-Id: I55b99002c71dc4020d700bbf9263b5810aa1ef72
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/444416
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
Run-TryBot: Peter Weinberger <pjw@google.com>
@gopherbot
Copy link
Collaborator

Change https://go.dev/cl/445935 mentions this issue: src/goMain: show warning message about go.enableCodeLens.references

gopherbot pushed a commit that referenced this issue Oct 28, 2022
Also remove the warning message about old go.languageServerExperimentalFeature.documentLink.
The seeting was gone long ago.

Updates #2509

Change-Id: I49127f9d6fab3a8dfc5a6bf7e1b361a23deef43a
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/445935
TryBot-Result: kokoro <noreply+kokoro@google.com>
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
@hyangah hyangah closed this as completed Nov 1, 2022
@golang golang locked and limited conversation to collaborators Nov 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants