rstudio / rstudio/helm

Feature request: JSON schema support for auto complete

Open
#379 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ci documentation
Dominant language
Markdown
Stars
46
Forks
40
Avg merge
4h 3m
Merged PRs (30d)
6

Description

It would be nice if the helm charts supported JSON schema so that you could get autocomplete and descriptions on IDEs that support JSON schema.

For example, starship ships with JSON schema support for its configuration file:

# starship.toml
"$schema" = 'https://starship.rs/config-schema.json'

We could do something similar with the Posit helm charts for the values.yaml files:

# yaml-language-server: $schema=https://helm.rstudio.com/config-schema.json

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 Posit Helm charts and their values.yaml files, then compare the Starship configuration schema example linked in the issue. Determine the schema scope and how it should be exposed for IDE use; done means the charts' values files provide usable JSON Schema autocomplete and descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, json, yaml
Domain
developer-experience, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.