golang/go

x/tools/gopls: support LocationLink for relevant requests

Open

#40,195 opened on Jul 13, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
FeatureRequestToolsgoplshelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When requesting textDocument/definition gopls returns a Location.

This FR is about supporting returning a LocationLink instead for clients that support it (a client capability).

Rationale: some editors/plugins can use this to support previewing the entire function on hover. See https://github.com/neovim/neovim/issues/12218 and https://github.com/neovim/neovim/pull/12368 for an in-depth description.

In terms of other language servers that do this, it looks like rust-analyzer does it as well.

All (current) LSP actions that can return LocationLink's:

  • textDocument/declaration
  • textDocument/definition
  • textDocument/typeDefinition

Contributor guide

Research direction
Implement LocationLink support in gopls. Modify definition.go and related handlers to check client capabilities for LocationLink and return LocationLink instead of Location when supported. Study the LSP specification for LocationLink and existing implementations like rust analyzer.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoLSP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30