More tidyverse-specific pkgdown setup

Closes #1408

Also added 'tidymodels' to the list of orgs for which we do some special URL set up, as they seem to have the same scheme as 'tidyverse' and 'r-lib'

Author: jennybc

DESCRIPTION

@@ -34,7 +34,7 @@ Imports:
     crayon,
     curl (>= 2.7),
     ellipsis,
-    desc (>= 1.3.0),
+    desc (>= 1.4.0),
     fs (>= 1.3.0),
     gert (>= 1.4.1),
     gh (>= 1.2.1),

NAMESPACE

@@ -189,6 +189,7 @@ export(use_tidy_github_actions)
 export(use_tidy_github_labels)
 export(use_tidy_issue_template)
 export(use_tidy_labels)
+export(use_tidy_pkgdown_github_pages)
 export(use_tidy_style)
 export(use_tidy_support)
 export(use_tidy_thanks)

R/description.R

@@ -2,13 +2,15 @@
 #'
 #' @description
 #'
+
 #' `use_description()` creates a `DESCRIPTION` file. Although mostly associated
 #' with R packages, a `DESCRIPTION` file can also be used to declare
-#' dependencies for a non-package projects. Within such a project,
+#' dependencies for a non-package project. Within such a project,
 #' `devtools::install_deps()` can then be used to install all the required
 #' packages. Note that, by default, `use_decription()` checks for a
 #' CRAN-compliant package name. You can turn this off with `check_name = FALSE`.
 #'
+
 #' usethis consults the following sources, in this order, to set `DESCRIPTION`
 #' fields:
 #' * `fields` argument of [create_package()] or [use_description()]
@@ -40,9 +42,9 @@
 #'
 #' @param fields A named list of fields to add to `DESCRIPTION`, potentially
 #'   overriding default values. See [use_description()] for how you can set
-#'   personalized defaults using package options
+#'   personalized defaults using package options.
 #' @param check_name Whether to check if the name is valid for CRAN and throw an
-#'   error if not
+#'   error if not.
 #' @param roxygen If `TRUE`, sets `RoxygenNote` to current roxygen2 version
 #' @seealso The [description chapter](https://r-pkgs.org/description.html)
 #'   of [R Packages](https://r-pkgs.org)
@@ -161,3 +163,63 @@ tidy_desc <- function(desc) {
   # Wrap in a try() so it always succeeds, even if user options are malformed
   try(desc$normalize(), silent = TRUE)
 }
+
+# 2021-10-10, while adding use_description_list(), I moved this helper here
+#
+# this helper feels out-of-sync with current usethis practices around active
+# project and how overwrite is handled
+#
+# I won't change use_description_field() now, but use_description_list() is
+# implemented differently, more in keeping with our current style
+use_description_field <- function(name,
+                                  value,
+                                  base_path = proj_get(),
+                                  overwrite = FALSE) {
+  # account for `value`s produced via `glue::glue()`
+  value <- as.character(value)
+  curr <- desc::desc_get(name, file = base_path)[[1]]
+  curr <- gsub("^\\s*|\\s*$", "", curr)
+
+  if (identical(curr, value)) {
+    return(invisible())
+  }
+
+  if (!is.na(curr) && !overwrite) {
+    ui_stop(
+      "{ui_field(name)} has a different value in DESCRIPTION. \\
+      Use {ui_code('overwrite = TRUE')} to overwrite."
+    )
+  }
+
+  ui_done("Setting {ui_field(name)} field in DESCRIPTION to {ui_value(value)}")
+  desc::desc_set(name, value, file = base_path)
+  invisible()
+}
+
+use_description_list <- function(key,
+                                 values,
+                                 append = TRUE,
+                                 desc = NULL) {
+  desc_provided <- !is.null(desc)
+  desc <- desc %||% desc::desc(file = proj_get())
+  check_string(key)
+  stopifnot(is.character(values))
+
+  if (append) {
+    values <- unique(c(desc$get_list(key, default = ""), values))
+  }
+  # formatting needs some improvements
+  # https://github.com/r-lib/desc/issues/117
+  desc$set_list(key, values, sep = ",\n")
+
+  if (desc_provided) {
+    return(invisible())
+  }
+
+  tf <- withr::local_tempfile(
+    pattern = glue("use_description_list-{project_name()}-{path_sanitize(key, '-')}")
+  )
+  desc$write(file = tf)
+  tf_contents <- read_utf8(tf)
+  write_over(proj_path("DESCRIPTION"), tf_contents)
+}

R/github-actions.R

@@ -213,9 +213,10 @@ use_github_action_pr_commands <- function(save_as = "pr-commands.yaml",
 #'     `roxygen2::roxygenise()` and update the PR, and `/style` to run
 #'     `styler::style_pkg()` and update the PR.
 #'
-#' This is how the tidyverse team checks its packages, but it is overkill for
-#' less widely used packages. Consider using the more streamlined workflows set
-#' up by [use_github_actions()] or [use_github_action_check_standard()].
+#'     This is how the tidyverse team checks its packages, but it is overkill
+#'     for less widely used packages. Consider using the more streamlined
+#'     workflows set up by [use_github_actions()] or
+#'     [use_github_action_check_standard()].
 #' @export
 #' @rdname tidyverse
 use_tidy_github_actions <- function() {

R/helpers.R

@@ -1,28 +1,3 @@
-use_description_field <- function(name,
-                                  value,
-                                  base_path = proj_get(),
-                                  overwrite = FALSE) {
-  # account for `value`s produced via `glue::glue()`
-  value <- as.character(value)
-  curr <- desc::desc_get(name, file = base_path)[[1]]
-  curr <- gsub("^\\s*|\\s*$", "", curr)
-
-  if (identical(curr, value)) {
-    return(invisible())
-  }
-
-  if (!is.na(curr) && !overwrite) {
-    ui_stop(
-      "{ui_field(name)} has a different value in DESCRIPTION. \\
-      Use {ui_code('overwrite = TRUE')} to overwrite."
-    )
-  }
-
-  ui_done("Setting {ui_field(name)} field in DESCRIPTION to {ui_value(value)}")
-  desc::desc_set(name, value, file = base_path)
-  invisible()
-}
-
 use_dependency <- function(package, type, min_version = NULL) {
   stopifnot(is_string(package))
   stopifnot(is_string(type))

R/pkgdown.R

@@ -11,6 +11,7 @@
 #' * `use_pkgdown_github_pages()`: implements the GitHub setup needed to
 #'   automatically publish your pkgdown site to GitHub pages:
 #'
+#'   - (first, it calls `use_pkgdown()`)
 #'   - [use_github_pages()] prepares to publish the pkgdown site from the
 #'     `github-pages` branch
 #'   - [`use_github_action("pkgdown")`][use_github_action()] configures a
@@ -65,6 +66,28 @@ use_pkgdown_github_pages <- function() {
   site_url <- sub("/$", "", site$html_url)
   site_url <- tidyverse_url(url = site_url, tr = tr)
   use_pkgdown_url(url = site_url, tr = tr)
+
+  if (tr$repo_owner %in% c("tidyverse", "tidymodels")) {
+    ui_done("
+      Adding {ui_value('tidyverse/tidytemplate')} to \\
+      {ui_field('Config/Needs/website')}")
+    use_description_list("Config/Needs/website", "tidyverse/tidytemplate")
+  }
+}
+
+#' @details
+#' * `use_tidy_pkgdown_github_pages()` is basically
+#'   [use_pkgdown_github_pages()], so does full pkgdown set up. Note that there
+#'   is special handling for packages owned by certain GitHub organizations, in
+#'   terms of anticipating the (eventual) site URL and the use of a pkgdown
+#'   template.
+#' @export
+#' @rdname tidyverse
+use_tidy_pkgdown_github_pages <- function() {
+  # the code that's conditional on the owning org is already in this function
+  # this "tidy" version exists because it feels right and is a good place to
+  # put docs
+  use_pkgdown_github_pages()
 }
 
 # helpers ----------------------------------------------------------------------
@@ -111,7 +134,8 @@ use_pkgdown_url <- function(url, tr = NULL) {
 
 tidyverse_url <- function(url, tr = NULL) {
   tr <- tr %||% target_repo(github_get = TRUE)
-  if (!is_interactive() || !tr$repo_owner %in% c("tidyverse", "r-lib")) {
+  if (!is_interactive() ||
+      !tr$repo_owner %in% c("tidyverse", "r-lib", "tidymodels")) {
     return(url)
   }
   custom_url <- glue("https://{tr$repo_name}.{tr$repo_owner}.org")