registry-language-server does not index BReg or Casework projects

Open
#1,247 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
rust
Domain
developer-experience, tooling

Research direction

Start with ProjectFamily and the existing Relay V2 and Evidence indexing paths, then trace how IndexedSymbol, IndexedLocation, and IndexedDiagnostic are produced. Compare registry.yaml and casework.yaml handling with the bregctl check and caseworkctl check entry points. Done means BReg and Casework expose the requested symbols, ranged diagnostics, and a shared mapping suitable for explain locations.

Written by the indexing model from the issue text.

Description

area:breg area:casework enhancement rust

Problem

registry-language-server indexes Relay V2 and Evidence projects. ProjectFamily has no BReg variant, so editing registry.yaml or casework.yaml gets no symbol index, no go-to-definition, no diagnostics with ranges.

This also means the only component in the tree that already knows how to map a construct to an IndexedLocation does not know about the two configuration formats people edit most.

Request

Add BReg (and Casework) as project families in the language server, producing IndexedSymbol entries for entities, fields, constraints, operations, actions, change-request types, hooks, and access profiles, with IndexedLocation ranges, and surfacing bregctl check / caseworkctl check findings as IndexedDiagnostic with ranges.

Relationship to source provenance

This overlaps with the request for source provenance in explain output. They can be solved together: whatever resolves a structural path to a file range for the language server can back a bregctl explain locations map, and vice versa. Solving either one first is fine; solving them with two independent implementations of the same mapping is the outcome to avoid.

Size

Larger than the other tooling requests and worth a separate decision on whether the editor experience for registry and casework configuration is something we want to own now.

Dominant language
Rust
Stars
2
Forks
0
Avg merge
3h 45m
Merged PRs (30d)
134

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.

More from registrystack/registry-stack

All issues in registrystack/registry-stack

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.