Merge pull request #79 from salim-b/add-is-pkgdown

- Add `is_pkgdown_project` root criterion looking for a `_pkgdown.yml`, `_pkgdown.yaml`, `pkgdown/_pkgdown.yml` and/or `inst/_pkgdown.yml` file (#79, @salim-b).

Author: krlmlr

NAMESPACE

@@ -25,6 +25,7 @@ export(has_file_pattern)
 export(is.root_criterion)
 export(is_drake_project)
 export(is_git_root)
+export(is_pkgdown_project)
 export(is_projectile_project)
 export(is_r_package)
 export(is_remake_project)

NEWS.md

@@ -1,6 +1,8 @@
-# rprojroot 2.0.2.9000 (2020-11-15)
+# rprojroot 2.0.2.9000 (2021-02-23)
 
-- Internal changes only.
+## Features
+
+-   Add `is_pkgdown_project` root criterion looking for a `_pkgdown.yml`, `_pkgdown.yaml`, `pkgdown/_pkgdown.yml` and/or `inst/_pkgdown.yml` file
 
 
 # rprojroot 2.0.2 (2020-11-15)

R/root.R

@@ -318,6 +318,9 @@ is_remake_project <- has_file("remake.yml")
 #' @export
 is_drake_project <- has_dir(".drake")
 
+#' @export
+is_pkgdown_project <- has_file("_pkgdown.yml") | has_file("_pkgdown.yaml") | has_file("pkgdown/_pkgdown.yml") | has_file("inst/_pkgdown.yml")
+
 #' @export
 is_projectile_project <- has_file(".projectile")
 
@@ -348,6 +351,7 @@ criteria <- structure(
     is_rstudio_project = is_rstudio_project,
     is_r_package = is_r_package,
     is_remake_project = is_remake_project,
+    is_pkgdown_project = is_pkgdown_project,
     is_projectile_project = is_projectile_project,
     is_git_root = is_git_root,
     is_svn_root = is_svn_root,
@@ -396,6 +400,14 @@ str.root_criteria <- function(object, ...) {
 #' @export
 "is_drake_project"
 
+#' @details
+#' `is_pkgdown_project` looks for a `_pkgdown.yml`, `_pkgdown.yaml`, `pkgdown/_pkgdown.yml` and/or `inst/_pkgdown.yml` file.
+#'
+#' @format NULL
+#' @rdname criteria
+#' @export
+"is_pkgdown_project"
+
 #' @details
 #' `is_projectile_project` looks for a `.projectile` file.
 #'

man/criteria.Rd

@@ -50,6 +50,13 @@
       $is_remake_project
       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 "inst/_pkgdown.yml"
+      
       $is_projectile_project
       Root criterion: contains a file ".projectile"
       
@@ -81,10 +88,11 @@
     Code
       str(criteria)
     Output
-      List of 9
+      List of 10
        $ is_rstudio_project   : chr "Root criterion: contains a file matching \"[.]Rproj$\" with contents matching \"^Version: \" in the first line"
        $ 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:5] "Root criterion: one of" "- contains a file \"_pkgdown.yml\"" "- contains a file \"_pkgdown.yaml\"" "- contains a file \"pkgdown/_pkgdown.yml\"" ...
        $ is_projectile_project: chr "Root criterion: contains a file \".projectile\""
        $ 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\""