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

Add option to specify schema validation severity level

Open
#668 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
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.

I am using monaco-editor and monaco-yaml. I need to configure the editor such that user input YAML is validated against a schema, with validation failures reported as errors to the user (as opposed to warnings).

Describe the solution you would like

The built-in JSON support of monaco-editor provides a configurable severity for schema validation failures (see here). I would suggest similar functionality for yaml-language-server. If this option is added, the monaco-yaml maintainer has expressed support for passing the option through: remcohaszing/monaco-yaml#149

Describe alternatives you have considered

@remcohaszing and I also discussed adding a hook into monaco-yaml to allow post-processing of warnings/errors, but this approach is more consistent with monaco-editor's built-in JSON support.

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

Start by comparing yaml-language-server's schema validation configuration with the linked Monaco JSON API, then trace how the option could be exposed to monaco-yaml via remcohaszing/monaco-yaml#149. Done means schema validation severity can be configured and passed through consistently, with the relevant behavior covered by the project's existing tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.