quarto-dev / quarto-dev/quarto-cli

When quarto edits `.gitignore` in an R package, it should probably also check/modify `.Rbuildignore`

Aperta
#9,745 5 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@cscheid ci sta già lavorando.

Dal 22/5/2024.

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

Descrizione

Bug description

I've been playing with the use of quarto and the quarto extension to preview .[R]?md files in an R package. The most typical targets are:

  • NEWS.md
  • README.Rmd or README.md
  • vignettes/whatever.Rmd

quarto preview adds /.quarto/ to the local .gitignore, i.e. to the top-level .gitignore in the first 2 cases above and to vignettes/.gitignore in the last case. Related issue: #9744.

I think quarto also needs to add an entry to .Rbuildignore in this scenario, if a relevant entry isn't already there. If you don't, R CMD check shows:

N  checking for hidden files and directories ...
   Found the following hidden files and directories:
     .quarto
     vignettes/.quarto
   These were most likely included in error. See section ‘Package
   structure’ in the ‘Writing R Extensions’ manual.

Here's the entry you'd want to add to .Rbuildignore if it's not already present:

^\.quarto$

(I can also add something to usethis, so that this is pre-populated if usethis does the project setup, going forward, but that's more of a gesture of moral support than an actual fix.)

Steps to reproduce

No response

Expected behavior

No response

Actual behavior

No response

Your environment

No response

Quarto check output

No response

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.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.