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

Usage with Multiple Schemas in a File?

Open
#1,082 2 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Summary

I'm doing something like this:

apiVersion: apps/v1
kind: Deployment
metadata:
  ...
spec:
  ...
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  ...
spec:
  ...

I'm using schema-companion.nvim to dynamically set the schema.

I'm wondering what I would need to change in there so that we have proper schema matching when there is the --- document separator in the YAML files? Currently, the schema is being applied to the whole file, and that's not what I want.

I don't want to have to put modelines everywhere as well.

Suggestions or clarifications would be great.

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 or tests are named; start by tracing schema selection and YAML document-boundary handling in the language server, then review how schema-companion.nvim supplies schemas. Done means separate documents divided by --- can receive their own matching schemas without requiring modelines.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, neovim, typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.