dense-analysis / dense-analysis/ale

LSP - add `documentHighlight` feature

Open
#2,716 0 comments 0 reactions 0 assignees View on GitHub
enhancement LSP
Dominant language
Vim Script
Stars
14k
Forks
1.5k
Avg merge
17h 49m
Merged PRs (30d)
1

Description

Document Highlights Request

The document highlight request is sent from the client to the server to resolve a document highlights for a given text document position. For programming languages this usually highlights all references to the symbol scoped to this file. However we kept ‘textDocument/documentHighlight’ and ‘textDocument/references’ separate requests since the first one is allowed to be more fuzzy. Symbol matches usually have a DocumentHighlightKind of Read or Write whereas fuzzy or textual matches use Textas the kind.

https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight

Contributor guide

Open the contributing guide

Research direction

Start by reading ALE's existing Language Server Protocol request handling and the linked documentHighlight specification. Compare the proposed request with the project's existing reference-related behavior, then identify the relevant implementation and test entry points. Done means ALE supports textDocument/documentHighlight and returns the expected read, write, or textual highlights.

Written by the indexing model from the issue text.

Assessment

Tech stack
vim
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.