quarto-dev / quarto-dev/quarto-cli

Epic: single source of truth for document/project information

Open
#8,700 10 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

A number of bugs in Quarto happen because different parts of the code are responsible for reasoning about a .qmd document. We should have a single source of truth on this, and that should be what drives the output of, for example,quarto inspect.

This is related (but simpler) to our Execution Planner, and solving this will make it easier to do the planner well.

  • #3185
  • #3157
  • #3053
  • #2216
  • #3766
  • #8675
  • #3663
  • #3510
  • #8563

Resolution of CLI parameters into metadata or pandoc args

  • #8591

format configuration

  • #4415

include shortcode resolution

  • #8779

See also:

  • #8702
  • partitionedMarkdownForInput and projectIndex should be direct responsibilities of ProjectContext.

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 with the quarto inspect entry point and the ProjectContext responsibilities mentioned in the issue. Review how partitionedMarkdownForInput and projectIndex are currently handled, then trace the linked subtasks to define the scope. Done means the listed document and project information has one authoritative source driving inspection output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.