quarto-dev / quarto-dev/quarto-cli

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

Offen
#9,745 5 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@cscheid arbeitet bereits daran.

Seit 22.5.2024.

enhancement
Vorherrschende Sprache
JavaScript
Sterne
6k
Forks
458
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
41

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.