quarto-dev / quarto-dev/quarto-cli

[FR] return all output files from `quarto inspect`

Open
#8,397 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Discussed in https://github.com/quarto-dev/quarto-cli/discussions/2378

Originally posted by wlandau September 9, 2022
The targets R package integrates with Quarto via tarchetypes::tar_quarto() for reproducible analysis pipelines. For reproducibility, targets hashes the input and output files from Quarto and uses the hashes to decide whether to run the Quarto document or project. To learn which input and output files to track, tar_quarto() digs through the output of quarto inspect and tries to figure out which input files Quarto needs and which output files Quarto will generate. It mostly works, but there are edge cases like https://github.com/ropensci/tarchetypes/discussions/102 and https://github.com/ropensci/tarchetypes/discussions/107 (mentioned in https://github.com/quarto-dev/quarto-r/issues/14) (and it is not blazing fast either). On the other hand, tarchetypes::tar_quarto() is not in a position to circumvent quarto inspect and manually emulate the internal decisions and behaviors of Quarto. So it would be extremely helpful if Quarto would straightforwardly list all its input and output file paths for a project or document.

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 linked discussion and the tar_quarto() integration context to understand the requested input and output reporting behavior. Done means quarto inspect straightforwardly lists all input and output file paths for a project or document, including the edge cases described in the linked discussions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, r
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.