quarto-dev / quarto-dev/quarto-cli

Feature request: Document writing to logfile + surface logfile info in a user-friendly way in various editors

Aperta
#7,154 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

diagnostics documentation enhancement
Lingua principale
JavaScript
Stelle
6k
Fork
458
Merge medio
1g 9h
PR unite (30g)
41

Descrizione

When working on, particularly, a large project, there is sometimes important information in the Quarto log that is easy to miss when rendering. For example, if rendering in RStudio with "Render Book", this information is printed in the Background Jobs pane, but it scrolls away quickly, and it's not trivial to find it in there, and definitely not easy to remember to do so.

It is possible to write to a logfile with

quarto render --log my-log-file.txt

In the short term, it would be good to:

  1. Document this, perhaps at https://quarto.org/docs/troubleshooting?
  2. Make it possible to request a log file via the project or document yaml, so one doesn't need to render with the CLI to get it.
  3. If possible, make what gets captured in the log file consistent between output formats. For example, if you have a Quarto book with an image embedded but the image file is missing, this doesn't get captured in the logfile when rendering to HTML (it's instead printed in the Background Jobs pane while previewing the book) but it is captured as an ERROR if rendering to PDF.

In the longer term (1.5?), it would be nice if editors like RStudio, VSCode, etc. could parse and surface this information in a warnings or similar pane.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Start with the existing quarto render --log my-log-file.txt behavior and the troubleshooting documentation. Then trace how project or document YAML could request a logfile and compare what is captured for HTML and PDF rendering, including missing images. Done means the requested logging behavior is documented and the captured information is consistent enough for the stated use cases.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
cli, documentation, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.