Shopify / Shopify/ruby-lsp

Migrate to configuration file to `.ruby-lsp.json`

Open
#2,156 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We had originally considered changing .index.yml to be .ruby-lsp.yml so that additional could be supported.

However from looking at other language server implementations, the preferred approach for this kind of things seems instead be to pass any configuration as part of the initialization options.

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

Read the discussion around PR 1434 and compare the existing .index.yml idea with the proposed .ruby-lsp.json configuration and language-server initialization options. Define the migration scope and verify that configuration is passed through initialization options instead of the prior file approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.