Shopify / Shopify/ruby-lsp

Add project-based index caching to speed up initial load of index

Open
#1,040 1 comment 4 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

This feature is VS Code specific
  • VS Code specific
Use case

My workflow involves switching between projects when I want to work in another repo/folder, as opposed to keeping them all open in separate VSCode windows. I find this consumes less resources and helps me maintain focus. Adding some initial caching to the ruby-lsp indices could help me start navigating 5+ seconds quicker when I switch projects.

Description

I would imagine that upon finishing indexing the project, you could, based on configuration, store the index in some file representation in the project folder (or elswhere).

When opening the project from then on, the latest index could be immediately supplied to ruby-lsp to offer finding definitions and other features as soon as the project loads. In the meantime, the index could be rebuilt and refreshed in the background, and set as the active index once ready.

Implementation

Suggested above, but I suppose the main limitation is if you can persist and feed indices to ruby-lsp easily.

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

Start by tracing how ruby-lsp builds and exposes project indices when a VS Code project opens; the issue does not name files or tests. Investigate whether indices can be persisted and restored using project configuration, then define done as serving a cached index immediately while rebuilding and replacing it in the background.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby, vscode
Domain
devtools, performance
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.