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

Customize LSP definition

Open
#212 2 comments 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

By following the great explanation how to contibute with YAML schema I have copied/pasted https://github.com/Azure/vscode-kubernetes-tools/blob/127ec070c8dabd56901ce13ff81bd6f561e4f087/src/yaml-support/yaml-schema.ts#L24 and adapted it for Quarkus. I can manage completion, validation, hover for Quarkus properties in application.yaml:

QuarkusYamlDemo

The missing feature is about definition (hyperlink). I would like to do a Ctrl+Click on name child to open the Java class which defines this property (like we have with application.properties).

It should be fantastic if yaml language server could give this capability.

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 reviewing the linked src/yaml-support/yaml-schema.ts example and the existing application.properties definition behavior. Determine how a YAML definition request could map a Quarkus property such as name to its Java class, and consider the language server's generic constraints. Done means Ctrl+Click on a Quarkus YAML property opens the defining Java class.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.