microsoft/language-server-protocol

Link to navigate to a document at line X column Y in MD documentation (hover)

Open

#379 opened on Jan 18, 2018

View on GitHub
 (2 comments) (5 reactions) (0 assignees)HTML (956 forks)batch import
completionfeature-requesthelp wantedhover

Repository metrics

Stars
 (12,810 stars)
PR merge metrics
 (Avg merge 19h 29m) (12 merged PRs in 30d)

Description

Eclipse JDT documentation hovers have links to navigate to a document, line X column Y or open document and select a range in it. The link is a hyperlink with some special protocol. The URL handler for this protocol is registered and handles a click as navigate to source code at a position provided in the URL. Many LSP clients (VSCode, Atom and soon Eclipse) have support such URLs. These URL's are special for each client (vscode://, atom:// etc.). If LSP could define some universal format for such URLs (lsp://file:///Users/abv/project/src/Main.java?line=X&column=Y) then clients can convert this URL into client specific URL and provide the behaviour described above from LSP hovers.

Contributor guide

Research direction
Propose a universal LSP URL format for navigation links in hover documentation. Consider existing client specific schemes like vscode:// and atom://. Define the URL structure with parameters like file, line, column. Discuss with maintainers and implement support in the specification.
Tech stack
None
Domain
api
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Understanding of LSPProtocol design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40