Skip to content

docs: Use single quotes to avoid nested double quotes #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 3, 2025
+58 −44
Merged

docs: Use single quotes to avoid nested double quotes #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fcabe3
Use single quotes to avoid nested double quotes
jennybc Jul 15, 2025
e82ce8b
Convert the directory case too
jennybc Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions R/root.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,12 @@ has_file <- function(filepath, contents = NULL, n = -1L, fixed = FALSE) {
}))

desc <- paste0(
'contains a file "', filepath, '"',
"contains a file '", filepath, "'",
if (!is.null(contents)) {
paste0(
" with contents ",
if (!fixed) "matching ",
'"', contents, '"',
"'", contents, "'",
if (n >= 0L) paste0(" in the first ", format_lines(n))
)
}
Expand All @@ -232,7 +232,7 @@ has_dir <- function(filepath) {
dir.exists(testfile)
}))

desc <- paste0('contains a directory "', filepath, '"')
desc <- paste0("contains a directory '", filepath, "'")

root_criterion(testfun, desc)
}
Expand Down Expand Up @@ -273,12 +273,12 @@ has_file_pattern <- function(pattern, contents = NULL, n = -1L, fixed = FALSE) {
}))

desc <- paste0(
'contains a file matching "', pattern, '"',
"contains a file matching '", pattern, "'",
if (!is.null(contents)) {
paste0(
" with contents ",
if (!fixed) "matching ",
'"', contents, '"',
"'", contents, "'",
if (n >= 0L) paste0(" in the first ", format_lines(n))
)
}
Expand Down
85 changes: 46 additions & 39 deletions tests/testthat/_snaps/root.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,87 +3,87 @@
Code
format(is_r_package)
Output
[1] "Root criterion: contains a file \"DESCRIPTION\" with contents matching \"^Package: \""
[1] "Root criterion: contains a file 'DESCRIPTION' with contents matching '^Package: '"

---

Code
is_r_package
Output
Root criterion: contains a file "DESCRIPTION" with contents matching "^Package: "
Root criterion: contains a file 'DESCRIPTION' with contents matching '^Package: '

---

Code
is_vcs_root
Output
Root criterion: one of
- contains a directory ".git"
- contains a file ".git" with contents matching "^gitdir: "
- contains a directory ".svn"
- contains a directory '.git'
- contains a file '.git' with contents matching '^gitdir: '
- contains a directory '.svn'

---

Code
has_file("a", contents = "foo", fixed = TRUE)
Output
Root criterion: contains a file "a" with contents "foo"
Root criterion: contains a file 'a' with contents 'foo'

---

Code
has_file_pattern("a.*b", contents = "foo", fixed = TRUE)
Output
Root criterion: contains a file matching "a.*b" with contents "foo"
Root criterion: contains a file matching 'a.*b' with contents 'foo'

---

Code
criteria
Output
$is_rstudio_project
Root criterion: contains a file matching "[.]Rproj$" with contents matching "^Version: " in the first line
Root criterion: contains a file matching '[.]Rproj$' with contents matching '^Version: ' in the first line

$is_vscode_project
Root criterion: contains a directory ".vscode"
Root criterion: contains a directory '.vscode'

$is_r_package
Root criterion: contains a file "DESCRIPTION" with contents matching "^Package: "
Root criterion: contains a file 'DESCRIPTION' with contents matching '^Package: '

$is_remake_project
Root criterion: contains a file "remake.yml"
Root criterion: contains a file 'remake.yml'

$is_pkgdown_project
Root criterion: one of
- contains a file "_pkgdown.yml"
- contains a file "_pkgdown.yaml"
- contains a file "pkgdown/_pkgdown.yml"
- contains a file "pkgdown/_pkgdown.yaml"
- contains a file "inst/_pkgdown.yml"
- contains a file "inst/_pkgdown.yaml"
- contains a file '_pkgdown.yml'
- contains a file '_pkgdown.yaml'
- contains a file 'pkgdown/_pkgdown.yml'
- contains a file 'pkgdown/_pkgdown.yaml'
- contains a file 'inst/_pkgdown.yml'
- contains a file 'inst/_pkgdown.yaml'

$is_renv_project
Root criterion: contains a file "renv.lock" with contents matching ""Packages":\s*\{"
Root criterion: contains a file 'renv.lock' with contents matching '"Packages":\s*\{'

$is_projectile_project
Root criterion: contains a file ".projectile"
Root criterion: contains a file '.projectile'

$is_quarto_project
Root criterion: contains a file "_quarto.yml"
Root criterion: contains a file '_quarto.yml'

$is_git_root
Root criterion: one of
- contains a directory ".git"
- contains a file ".git" with contents matching "^gitdir: "
- contains a directory '.git'
- contains a file '.git' with contents matching '^gitdir: '

$is_svn_root
Root criterion: contains a directory ".svn"
Root criterion: contains a directory '.svn'

$is_vcs_root
Root criterion: one of
- contains a directory ".git"
- contains a file ".git" with contents matching "^gitdir: "
- contains a directory ".svn"
- contains a directory '.git'
- contains a file '.git' with contents matching '^gitdir: '
- contains a directory '.svn'

$is_testthat
Root criterion: directory name is "testthat" (also look in subdirectories: `tests/testthat`, `testthat`)
Expand All @@ -100,17 +100,17 @@
str(criteria)
Output
List of 13
$ is_rstudio_project : chr "Root criterion: contains a file matching \"[.]Rproj$\" with contents matching \"^Version: \" in the first line"
$ is_vscode_project : chr "Root criterion: contains a directory \".vscode\""
$ is_r_package : chr "Root criterion: contains a file \"DESCRIPTION\" with contents matching \"^Package: \""
$ is_remake_project : chr "Root criterion: contains a file \"remake.yml\""
$ is_pkgdown_project : chr [1:7] "Root criterion: one of" "- contains a file \"_pkgdown.yml\"" "- contains a file \"_pkgdown.yaml\"" "- contains a file \"pkgdown/_pkgdown.yml\"" ...
$ is_renv_project : chr "Root criterion: contains a file \"renv.lock\" with contents matching \"\"Packages\":\\s*\\{\""
$ is_projectile_project: chr "Root criterion: contains a file \".projectile\""
$ is_quarto_project : chr "Root criterion: contains a file \"_quarto.yml\""
$ is_git_root : chr [1:3] "Root criterion: one of" "- contains a directory \".git\"" "- contains a file \".git\" with contents matching \"^gitdir: \""
$ is_svn_root : chr "Root criterion: contains a directory \".svn\""
$ is_vcs_root : chr [1:4] "Root criterion: one of" "- contains a directory \".git\"" "- contains a file \".git\" with contents matching \"^gitdir: \"" "- contains a directory \".svn\""
$ is_rstudio_project : chr "Root criterion: contains a file matching '[.]Rproj$' with contents matching '^Version: ' in the first line"
$ is_vscode_project : chr "Root criterion: contains a directory '.vscode'"
$ is_r_package : chr "Root criterion: contains a file 'DESCRIPTION' with contents matching '^Package: '"
$ is_remake_project : chr "Root criterion: contains a file 'remake.yml'"
$ is_pkgdown_project : chr [1:7] "Root criterion: one of" "- contains a file '_pkgdown.yml'" "- contains a file '_pkgdown.yaml'" "- contains a file 'pkgdown/_pkgdown.yml'" ...
$ is_renv_project : chr "Root criterion: contains a file 'renv.lock' with contents matching '\"Packages\":\\s*\\{'"
$ is_projectile_project: chr "Root criterion: contains a file '.projectile'"
$ is_quarto_project : chr "Root criterion: contains a file '_quarto.yml'"
$ is_git_root : chr [1:3] "Root criterion: one of" "- contains a directory '.git'" "- contains a file '.git' with contents matching '^gitdir: '"
$ is_svn_root : chr "Root criterion: contains a directory '.svn'"
$ is_vcs_root : chr [1:4] "Root criterion: one of" "- contains a directory '.git'" "- contains a file '.git' with contents matching '^gitdir: '" "- contains a directory '.svn'"
$ is_testthat : chr "Root criterion: directory name is \"testthat\" (also look in subdirectories: `tests/testthat`, `testthat`)"
$ from_wd : chr "Root criterion: from current working directory"

Expand All @@ -120,6 +120,13 @@
comb_crit
Output
Root criterion: one of
- contains a file "DESCRIPTION" with contents matching "^Package: "
- contains a file matching "[.]Rproj$" with contents matching "^Version: " in the first line
- contains a file 'DESCRIPTION' with contents matching '^Package: '
- contains a file matching '[.]Rproj$' with contents matching '^Version: ' in the first line

# is_renv_project prints regex-friendly-ish text

Code
is_renv_project
Output
Root criterion: contains a file 'renv.lock' with contents matching '"Packages":\s*\{'

7 changes: 7 additions & 0 deletions tests/testthat/test-root.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,3 +308,10 @@ test_that("stops if depth reached", {
# Checks that search for root terminates for very deep hierarchies
expect_error(find_root_mocked(""), "Maximum search of [0-9]+ exceeded")
})

# The exact style of quoting here (double inside single as opposed to nested
# double quotes) makes generating the here docs *much less fiddly*.
# See https://github.com/r-lib/here/pull/130
test_that("is_renv_project prints regex-friendly-ish text", {
expect_snapshot(is_renv_project)
})