quarto-dev / quarto-dev/quarto

expose yaml schema store

Open
#195 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
645
Forks
62
Avg merge
17h 42m
Merged PRs (30d)
13

Description

Over in the quarto neovim integration I am now close to introducing a feature that allows for code completion etc. in all the embedded languages i.e. not just code chunks but also raw html and yaml: https://github.com/jmbuhr/otter.nvim/pull/39 (It's very exciting!)

In order for the yaml completion to be useful, I would need a schema of possible yaml keys. I found https://github.com/quarto-dev/quarto-cli/tree/main/src/resources/schema, but this is split across many files. Ideally it would be something along the lines of what https://www.schemastore.org/json/, which are often used for the yaml language server https://github.com/redhat-developer/yaml-language-server#using-yamlschemas-settings

Contributor guide

No contributing guide indexed for this repository

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

Review the split schema files under quarto-cli/src/resources/schema and compare their structure with SchemaStore and the yaml-language-server usage described in the issue. Determine how Quarto could expose a consolidated schema for YAML completion; done means the schema is available in a format those integrations can consume.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.