microsoft / microsoft/language-server-protocol

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

Open
#379 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

completion feature-request help wanted hover
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing the language-server-protocol specification and the client-specific vscode:// and atom:// schemes, then define what a universal lsp:// URL must contain and how clients should translate it; done means the proposal is specified well enough for clients to implement consistently.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.