Notes after devtools::check due to missing .here in .Rbuildignore [BUG]

[ilyaZar]

Describe the bug
When running devtools::check(document = FALSE) for a Golem application generated with the RStudio project wizzard the created package template issues a note :

❯ checking for hidden files and directories ... NOTE
  Found the following hidden files and directories:
    .here

Note is present also after sourcing dev/01_start.R due to missing .here in .Rbuildignore meta file.

To Reproduce
Run devtools::check(document = FALSE) after creating a skeleton package from the RStudio Golem wizard.

Expected behavior
Probably unwanted behaviour that R CMD check or the devtools::check() produces notes (except for the missing License probably).

session info

─ Session info ─────────────────────────────────────────────────────────────────────
 setting  value
 version  R version 4.2.2 Patched (2022-11-10 r83330)
 os       Linux Mint 20
 system   x86_64, linux-gnu
 ui       RStudio
 language en_US
 collate  en_US.UTF-8
 ctype    en_US.UTF-8
 tz       Europe/Berlin
 date     2023-02-22
 rstudio  2022.07.2+576 Spotted Wakerobin (desktop)
 pandoc   NA

Additional context
Can be fixed by adding ^.here$ in inst/shinyexample/REMOVEME.Rbuildignore as per #994

[ALanguillaume]

Hi @ilyaZar,

This seems to be independent of the value of the document parameter. At least in my reprexes.

document = FALSE

dummy_dir <- tempfile(pattern = "dummy")
dir.create(dummy_dir)

withr::with_dir(dummy_dir, {
  dummy_golem_path <- file.path(dummy_dir, "reprex")
  golem::create_golem(dummy_golem_path, open = FALSE)
  devtools::check(
    pkg = dummy_golem_path,
    document = FALSE,
    quiet = TRUE
  )
})
#> ── Checking package name ───────────────────────────────────────────────────────
#> ✔ Valid package name
#> ── Creating dir ────────────────────────────────────────────────────────────────
#> ✔ Creating '/tmp/RtmpUha40H/dummy5ba46dd4eb25/reprex/'
#> ✔ Setting active project to '/tmp/RtmpUha40H/dummy5ba46dd4eb25/reprex'
#> ✔ Creating 'R/'
#> ✔ Writing a sentinel file '.here'
#> • Build robust paths within your project via `here::here()`
#> • Learn more at <https://here.r-lib.org>
#> ✔ Setting active project to '<no active project>'
#> ✔ Created package directory
#> ── Copying package skeleton ────────────────────────────────────────────────────
#> ✔ Copied app skeleton
#> ── Setting the default config ──────────────────────────────────────────────────
#> ✔ Configured app
#> ── Running project hook function ───────────────────────────────────────────────
#> ✔ All set
#> ✔ Setting active project to '/tmp/RtmpUha40H/dummy5ba46dd4eb25/reprex'
#> ── Done ────────────────────────────────────────────────────────────────────────
#> A new golem named reprex was created at /tmp/RtmpUha40H/dummy5ba46dd4eb25/reprex .
#> To continue working on your app, start editing the 01_start.R file.
#> ── R CMD check results ────────────────────────────────── reprex 0.0.0.9000 ────
#> Duration: 27s
#> 
#> ❯ checking DESCRIPTION meta-information ... WARNING
#>   Non-standard license specification:
#>     What license is it under?
#>   Standardizable: FALSE
#> 
#> ❯ checking for hidden files and directories ... NOTE
#>   Found the following hidden files and directories:
#>     .here
#>   These were most likely included in error. See section ‘Package
#>   structure’ in the ‘Writing R Extensions’ manual.
#> 
#> 0 errors ✔ | 1 warning ✖ | 1 note ✖
#> Error: R CMD check found WARNINGs

^{Created on 2023-03-01 with reprex v2.0.2}

document = TRUE

dummy_dir <- tempfile(pattern = "dummy")
dir.create(dummy_dir)

withr::with_dir(dummy_dir, {
  dummy_golem_path <- file.path(dummy_dir, "reprex")
  golem::create_golem(dummy_golem_path, open = FALSE)
  devtools::check(
    pkg = dummy_golem_path,
    document = TRUE,
    quiet = TRUE
  )
})
#> ── Checking package name ───────────────────────────────────────────────────────
#> ✔ Valid package name
#> ── Creating dir ────────────────────────────────────────────────────────────────
#> ✔ Creating '/tmp/RtmpRPtfNU/dummy63e171e1bad3/reprex/'
#> ✔ Setting active project to '/tmp/RtmpRPtfNU/dummy63e171e1bad3/reprex'
#> ✔ Creating 'R/'
#> ✔ Writing a sentinel file '.here'
#> • Build robust paths within your project via `here::here()`
#> • Learn more at <https://here.r-lib.org>
#> ✔ Setting active project to '<no active project>'
#> ✔ Created package directory
#> ── Copying package skeleton ────────────────────────────────────────────────────
#> ✔ Copied app skeleton
#> ── Setting the default config ──────────────────────────────────────────────────
#> ✔ Configured app
#> ── Running project hook function ───────────────────────────────────────────────
#> ✔ All set
#> ✔ Setting active project to '/tmp/RtmpRPtfNU/dummy63e171e1bad3/reprex'
#> ── Done ────────────────────────────────────────────────────────────────────────
#> A new golem named reprex was created at /tmp/RtmpRPtfNU/dummy63e171e1bad3/reprex .
#> To continue working on your app, start editing the 01_start.R file.
#> Setting `RoxygenNote` to "7.2.2"
#> ℹ Loading reprex
#> Writing 'run_app.Rd'
#> ── R CMD check results ────────────────────────────────── reprex 0.0.0.9000 ────
#> Duration: 30.1s
#> 
#> ❯ checking DESCRIPTION meta-information ... WARNING
#>   Non-standard license specification:
#>     What license is it under?
#>   Standardizable: FALSE
#> 
#> ❯ checking for hidden files and directories ... NOTE
#>   Found the following hidden files and directories:
#>     .here
#>   These were most likely included in error. See section ‘Package
#>   structure’ in the ‘Writing R Extensions’ manual.
#> 
#> 0 errors ✔ | 1 warning ✖ | 1 note ✖
#> Error: R CMD check found WARNINGs

^{Created on 2023-03-01 with reprex v0.0.0.9000}

usethis::use_build_ignore(".here") is used two times in inst/mantests/build.R.

golem/inst/mantests/build.R

Line 104 in 6934693

usethis::use_build_ignore(".here")

@ColinFay I am failing to see if the actual behaviour is okay or if we should indeed by default build ignore .here ?

[ilyaZar]

Sorry @ALanguillaume I realize I was not explaining well:

so the issue is with the RStudio Golem Wizzard. The wizzard invokes via the Binding: create_golem_gui (per the golem/inst/rstudio/templates/project/create_golem.dcf) a to call to create_golem() (which I think copies content from golem/inst/shinyexample/REMOVEME.Rbuildignore and replaces "REMOVEME." by the standard .Rbuildignore when creating the golem template example).

Now as the mantest/build.R is not invoked by the Wizzard (that file seems to be something internal but I might be mistaken...) the usethis::use_build_ignore(".here") calls are ignored.

You are absolutely right in that the document-parameter is irrelevant, I mentioned it though because if you "gui-click" on the "Check"-button of the "Build"-tab inside RStudio, then devtools::check(document = FALSE) is run but standard checks devtools::check() or the R CMD CHECK do not pass as well.

Edit: the issue is probably with any call to create_golem, not just the Wizzard binding crate_golem_gui (which is essentially a wrapper around create_golem) but I did not have the time to check it properly; in any case, adding .here should fix that as the metafile is altered directly.

Edit 2: after a closer look at the build.R I believe you can safely delete both calls to use_build_ignore (if you alter the metafile directly) and set_here only once (nothing is really happening in the in-between if-statement ...).

golem/inst/mantests/build.R

Lines 102 to 131 in 7a9debb

	here::set_here(temp_app)
	usethis::use_build_ignore(".here")
	if (Sys.getenv("GITHUB_BASE_REF") == "") {
	usethis::use_dev_package(
	"golem",
	remote = "github::ThinkR-open/golem@dev"
	)
	} else {
	usethis::use_dev_package(
	"golem",
	remote = sprintf(
	"github::ThinkR-open/golem@dev",
	Sys.getenv("GITHUB_BASE_REF")
	)
	)
	}
	cat(
	readLines("DESCRIPTION"),
	sep = "\n"
	)
	here::set_here(temp_app)
	usethis::use_build_ignore(".here")