redhat-developer / redhat-developer/yaml-language-server

External lookups for value completion?

Open
#679 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
TypeScript
Stars
1.5k
Forks
352
Avg merge
2d 7h
Merged PRs (30d)
11

Description

Summary

For a research project, I am trying to understand if I could use yaml-language-server to support external lookup scenarios? Given the following yaml document:

object:
  propertyA: ValueA

What I want to accomplish is to have the language server suggest allowed values based on the /object/propertyA path. The problem with this is that these values change frequently. So coding them into the schema as an enum is probably not the best solution.
My idea would be to call an external service for a given path and get a list of allowed values in response.

Alternatively, I could regenerate the JSON schemas on central changes and let the language server reload them periodically via HTTP?

Any hint very appreciated!

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

No source files, tests, or entry points are named. Start by locating the value-completion and schema-loading entry points, then investigate the two proposed approaches: external values for a YAML path or periodic HTTP schema reload. Done should be a documented, decided scope with clear behavior for the supported approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, yaml
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.