redhat-developer / redhat-developer/yaml-language-server
Support different schema for sub-value
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 352
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 11
Description
Is your enhancement related to a problem? Please describe.
Some resources, I'm talking mainly about https://fluxcd.io/flux/components/helm/helmreleases/, have a field, in this case .spec.values, that are tagged as object but in reality have a different schema, which is dynamic and dependant on other fields
Describe the solution you would like
Some way to inject the correct schema like with the # yaml-language-server: $schema= modeline
Describe alternatives you have considered
Manually getting the schema and injecting the correct schema at .spec.values, but that sounds very hard and very easy to break
Additional context
I in no way mean that this language-server should support the fetching of the correct schema via kubernetes. But this way the clients could implement this
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the language server's existing $schema modeline handling and schema validation flow. Define an extension point that lets clients supply a schema for a nested field such as .spec.values, without fetching schemas from Kubernetes; done means dynamic sub-values can be validated against the client-provided schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- devtools, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100