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

support for embedded languages

Open
#1,210 1 comment 0 reactions 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

It would be great if the schemas could define values as being from a given language so that it gets syntax highlighted accordingly.

For instance, SQL database migrations specified in yaml files would gain a lot by having SQL colorized !
There is the yaml-embedded-languages, but it isn't aware of what the yaml file is about, it just colorizes based on a comment. I feel it would be cleaner if the schema provided this information. I am not sure of how this would be accomplished, however...

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

Investigate how schemas are represented and how the language server currently selects syntax highlighting for embedded values. Define how a schema could identify an embedded language, using SQL in YAML migrations as the example, and verify that the selected language is highlighted without relying on comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql, yaml
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.