Shopify / Shopify/ruby-lsp

Output index in lsif format

Open
#1,050 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help-wanted pinned
Dominant language
Ruby
Stars
2k
Forks
281
Avg merge
2h 14m
Merged PRs (30d)
6

Description

I have checked that this feature is not already implemented
  • This feature does not exist
Use case

Lots of tools online use the lsif file format to provide "smart" features related to a codebase. One of them is navigating around the codebase by clicking on class names in SCM tools (like GitLab). This project generates an index internally, used for navigating though the codebase, but it's not dumped to a file, and it doesn't use the lsif format.

Description

The index that ruby-lsp generates is dumped into a lsif file that I can use with other tools.

Implementation

No response

Contributor guide

Open the contributing guide

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 locating how ruby-lsp builds its internal index and by reviewing the LSIF format requirements. Done means the generated index can be dumped to an LSIF file for use by external code-navigation tools.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
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.