Document `.quarto-source.yml` as a format other tools can rely on

Open
#1,177 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
json, rust
Domain
documentation

Research direction

Start by reading the SourceRecord struct and the user guide line that describes .quarto-source.yml; the issue does not give their file paths. Document each field, version handling, preservation of unknown keys, and the specified hash rules, then add a JSON Schema beside the specification. Done means another tool can follow the documented contract and validate records against the schema.

Written by the indexing model from the issue text.

Description

Description
Context

q2 add writes .quarto-source.yml next to each extension.
Today the format lives in the SourceRecord struct and one line of the user guide.

Other tools can work with the same file.
The development version of Quarto Wizard, the VS Code extension for Quarto extensions, already writes it in the q2 format, so that an extension installed by one tool can be updated by the other.
To follow the format, it has to read the q2 source.

Proposal

Publish a short specification of the record, with a JSON Schema next to it.
It would cover:

  • each field and what it means;
  • the schema version policy: what bumps it, and what a reader does with a newer one;
  • the rule for keys a tool doesn't know: kept as they are on rewrite;
  • the hash rules: sha256 of the bytes of each file as they are on disk, / paths relative to the extension folder, the record itself left out.
Why

Without a written contract, every other tool has to guess, and a change in q2 can break it without notice.
The two following come from that gap:

Benefits

People using q2 can mix tools on one project: install from the command line, update from the editor, or the other way round.
Local edit detection keeps working whichever tool wrote the record.
Tools such as Quarto Wizard can validate against the published schema and follow its changes.
A future official q2 extension for Positron and VS Code could rely on the same specification.
A future q2 update gets a stable base too.

Dominant language
Rust
Stars
302
Forks
22
Avg merge
5h 2m
Merged PRs (30d)
213

Getting set up

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.

More from quarto-dev/q2

All issues in quarto-dev/q2

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.