scalameta/metals

Clean constructor parameters for `Indexer` and `ScalaCli`

Open

#4,788 opened on Jan 1, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Scala (2,300 stars) (421 forks)batch import
good first issueimprovementtech debt

Description

Another follow up after https://github.com/scalameta/metals/pull/4776.

There's need to pass every constructor argument as a function in scala.meta.internal.metals.Indexer and scala.meta.internals.ScalaCli

  • Usually, replacing () =>, should be straighforward change, but sometimes () => was used to capture mutable state.
  • probably Indexerand ScalaCli aren't the only ones which can be refactored. Person doing this task can browse other classes (optional)

Contributor guide

Tech stack
scala
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Scala programmingFamiliarity with Metals internalsUnderstanding of mutable state patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the constructor parameters of Indexer and ScalaCli classes in scala.meta.internal.metals package. Identify which () => parameters can be replaced with direct values and which are capturing mutable state. For the latter, ensure the refactoring preserves correctness. Optionally, extend the refactoring to other similar classes in the codebase.