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

Support for hash URLs in `yaml.schemas` VS Code settings | ex: `my.schema.yaml#properties/someProp`

Open
#754 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug
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.
# yaml-language-server: $schema=../boat.schema.yaml#properties/someFeatures

#properties/someFeatures works.

"yaml.schemas": {
    "content/boats/boat.schema.yaml#properties/someFeatures": [
      "content/boats/*/some-features.yaml"
    ]
}

#properties/someFeatures doesn't seems to work?

Describe the solution you would like

Hash schema URLs working in global workspace VS Code settings

Describe alternatives you have considered

Splitting properties in sub-files schema; but generate too much noise.
OR
putting # yaml-language-server: $schema=... everywhere it's needed (noisy, too).

Additional context

Working on this experiment:
https://github.com/JulianCataldo/content-components

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 reproducing the two examples from issue #754 in VS Code: the inline $schema URL and the hash URL in the global workspace yaml.schemas setting. Trace the YAML language server's schema-settings handling, then verify that hash fragments work in workspace settings while the existing inline form continues to work.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.