microsoft / microsoft/lsif-node

Moniker schema versioning

Open
#46 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
TypeScript
Stars
198
Forks
40
Avg merge
3d 7h
Merged PRs (30d)
1

Description

As the languages evolve and/or exporter defects are fixed, we may end up in situations where we want to revise the schema used for monikers. LSIF exporters can trivially achieve that by appending a version number to Moniker.scheme value.

Changing the moniker schema would render old LSIF dumps incompatible (unlinkable) with newer LSIF dumps though.

Should then the moniker schema version be a high level concept that is advertised in LSIF metadata so tools can detect mismatches more effectively?

(Note that #10 discussed similar but actually different question about embedding the source code package version in the moniker.)

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 LSIF metadata and Moniker.scheme concepts, along with the related discussion in #10. Done means reaching and documenting a decision on whether schema versions belong in metadata and how mismatches should be detected.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
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.