microsoft / microsoft/language-server-protocol

Extending LSIF output with arbitrary metadata?

Open
#1,427 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I maintain a debugger that I am adding more source navigation capabilities to. One issue that I've run across is that the view of the source as described in the LSIF and the view of the source as described by a compiler in the debug info do not always match. In my case, embedding information about the version of the compiler into the LSIF would be sufficient to solve this problem.

It's unclear to me whether LSIF is supposed to be considered generally extensible (i.e. people can tack on whatever additional properties they want to any entry) or whether nothing that is not in the specification is supposed to appear. If the latter, would there be an objection to adding a spot for arbitrary key/value pairs on the Metadata node? e.g., in vaguely idl-ish syntax

partial interface MetaData {
  additionalInfo?: map<string, string>,
}

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

Start by reviewing the LSIF Metadata node definition and the specification's rules for extensions. Determine whether arbitrary key/value metadata is currently permitted; done means resolving that question and, if it is not permitted, defining whether the Metadata node should gain an additionalInfo map.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.