style: reformat with air (#2865)

`usethis::use_air()` and skips for readability

Author: jayhesselberth

.Rbuildignore

@@ -24,3 +24,5 @@
 ^vignettes/articles/\.quarto$
 ^vignettes/articles/*_files$
 ^vignettes/articles$
+^\.vscode$
+^[\.]?air\.toml$

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "Posit.air-vscode"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[r]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "Posit.air-vscode"
+    }
+}

R/build-404.R

@@ -6,14 +6,19 @@ build_404 <- function(pkg = ".") {
 
   if (!file_exists(page_md)) {
     render_page(
-      pkg, "title-body",
+      pkg,
+      "title-body",
       data = list(
         pagetitle = tr_("Page not found (404)"),
         body = tr_("Content not found. Please use links in the navbar.")
       ),
       path = "404.html"
     )
-    update_html(path_abs("404.html", start = pkg$dst_path), tweak_link_absolute, pkg = pkg)
+    update_html(
+      path_abs("404.html", start = pkg$dst_path),
+      tweak_link_absolute,
+      pkg = pkg
+    )
   }
 
   invisible()

R/build-article.R

@@ -7,14 +7,16 @@
 #'   `TRUE`, ensures that every article is build in a fresh environment, but
 #'   you may want to set it to `FALSE` to make debugging easier.
 #' @param pandoc_args Pass additional arguments to pandoc. Used for testing.
-build_article <- function(name,
-                          pkg = ".",
-                          lazy = FALSE,
-                          seed = 1014L,
-                          new_process = TRUE,
-                          pandoc_args = character(),
-                          override = list(),
-                          quiet = TRUE) {
+build_article <- function(
+  name,
+  pkg = ".",
+  lazy = FALSE,
+  seed = 1014L,
+  new_process = TRUE,
+  pandoc_args = character(),
+  override = list(),
+  quiet = TRUE
+) {
   pkg <- section_init(pkg, "articles", override = override)
 
   # Look up in pkg vignette data - this allows convenient automatic
@@ -49,35 +51,47 @@ build_article <- function(name,
       new_process = new_process,
       pandoc_args = pandoc_args,
       quiet = quiet
-    )  
+    )
   } else {
     build_quarto_articles(pkg = pkg, article = name, quiet = quiet)
   }
 }
 
-build_rmarkdown_article <- function(pkg,
-                                    input_file,
-                                    input_path,
-                                    output_file,
-                                    output_path,
-                                    depth,
-                                    seed = NULL,
-                                    new_process = TRUE,
-                                    pandoc_args = character(),
-                                    quiet = TRUE,
-                                    call = caller_env() ) {
+build_rmarkdown_article <- function(
+  pkg,
+  input_file,
+  input_path,
+  output_file,
+  output_path,
+  depth,
+  seed = NULL,
+  new_process = TRUE,
+  pandoc_args = character(),
+  quiet = TRUE,
+  call = caller_env()
+) {
   cli::cli_inform("Reading {src_path(input_file)}")
   digest <- file_digest(output_path)
 
   data <- data_article(pkg, input_file, call = call)
   if (data$as_is) {
     if (identical(data$ext, "html")) {
-      setup <- rmarkdown_setup_custom(pkg, input_path, depth = depth, data = data)
+      setup <- rmarkdown_setup_custom(
+        pkg,
+        input_path,
+        depth = depth,
+        data = data
+      )
     } else {
       setup <- list(format = NULL, options = NULL)
     }
   } else {
-    setup <- rmarkdown_setup_pkgdown(pkg, depth = depth, data = data, pandoc_args = pandoc_args)
+    setup <- rmarkdown_setup_pkgdown(
+      pkg,
+      depth = depth,
+      data = data,
+      pandoc_args = pandoc_args
+    )
   }
 
   local_envvar_pkgdown(pkg)
@@ -127,7 +141,6 @@ build_rmarkdown_article <- function(pkg,
   }
 
   invisible(path)
-
 }
 
 
@@ -136,7 +149,7 @@ data_article <- function(pkg, input, call = caller_env()) {
 
   opengraph <- check_open_graph(pkg, yaml$opengraph, input, call = call)
   opengraph$description <- opengraph$description %||% yaml$description
-  
+
   list(
     opengraph = opengraph,
     pagetitle = escape_html(yaml$title),
@@ -148,19 +161,21 @@ data_article <- function(pkg, input, call = caller_env()) {
   )
 }
 
-rmarkdown_setup_custom <- function(pkg,
-                                   input_path,
-                                   depth = 1L,
-                                   data = list(),
-                                   env = caller_env()) {
+rmarkdown_setup_custom <- function(
+  pkg,
+  input_path,
+  depth = 1L,
+  data = list(),
+  env = caller_env()
+) {
   template <- rmarkdown_template(pkg, depth = depth, data = data, env = env)
 
   # Override defaults & values supplied in metadata
   options <- list(
     template = template,
     self_contained = FALSE
   )
-  
+
   output <- rmarkdown::default_output_format(input_path)
   if (output$name != "rmarkdown::html_vignette") {
     # Force to NULL unless overridden by user
@@ -170,12 +185,13 @@ rmarkdown_setup_custom <- function(pkg,
   list(format = NULL, options = options)
 }
 
-rmarkdown_setup_pkgdown <- function(pkg,
-                                    depth = 1L,
-                                    data = list(),
-                                    pandoc_args = character(),
-                                    env = caller_env()) {
-
+rmarkdown_setup_pkgdown <- function(
+  pkg,
+  depth = 1L,
+  data = list(),
+  pandoc_args = character(),
+  env = caller_env()
+) {
   template <- rmarkdown_template(pkg, depth = depth, data = data, env = env)
 
   format <- rmarkdown::html_document(
@@ -187,7 +203,10 @@ rmarkdown_setup_pkgdown <- function(pkg,
     extra_dependencies = bs_theme_deps_suppress(),
     pandoc_args = pandoc_args
   )
-  format$knitr$opts_chunk <- fig_opts_chunk(pkg$figures, format$knitr$opts_chunk)
+  format$knitr$opts_chunk <- fig_opts_chunk(
+    pkg$figures,
+    format$knitr$opts_chunk
+  )
 
   width <- config_pluck_number_whole(pkg, "code.width", default = 80)
   old_pre <- format$pre_knit
@@ -202,7 +221,12 @@ rmarkdown_setup_pkgdown <- function(pkg,
 }
 
 # Generates pandoc template by rendering templates/content-article.html
-rmarkdown_template <- function(pkg, data = list(), depth = 1L, env = caller_env()) {
+rmarkdown_template <- function(
+  pkg,
+  data = list(),
+  depth = 1L,
+  env = caller_env()
+) {
   path <- withr::local_tempfile(
     pattern = "pkgdown-rmd-template-",
     fileext = ".html",

R/build-articles.R

@@ -92,12 +92,12 @@
 #' in the articles index. You can suppress such warnings by listing the
 #' affected articles in a section with `title: internal` (case sensitive);
 #' this section will not be displayed on the index page.
-#' 
+#'
 #' ## External articles
 #'
-#' You can link to arbitrary additional articles by adding an 
+#' You can link to arbitrary additional articles by adding an
 #' `external-articles` entry to `_pkgdown.yml`. It should contain an array
-#' of objects with fields `name`, `title`, `href`, and `description`. 
+#' of objects with fields `name`, `title`, `href`, and `description`.
 #'
 #' ```yaml
 #' external-articles:
@@ -106,7 +106,7 @@
 #'   description: Improve model performance in imbalanced data sets through undersampling or oversampling.
 #'   href: https://www.tidymodels.org/learn/models/sub-sampling/
 #' ```
-#' 
+#'
 #' If you've defined a custom articles index, you'll need to include the name
 #' in one of the `contents` fields.
 #'
@@ -193,12 +193,14 @@
 #'   freshly generated section in browser.
 #' @export
 #' @order 1
-build_articles <- function(pkg = ".",
-                           quiet = TRUE,
-                           lazy = TRUE,
-                           seed = 1014L,
-                           override = list(),
-                           preview = FALSE) {
+build_articles <- function(
+  pkg = ".",
+  quiet = TRUE,
+  lazy = TRUE,
+  seed = 1014L,
+  override = list(),
+  preview = FALSE
+) {
   pkg <- section_init(pkg, "articles", override = override)
   check_bool(quiet)
   check_bool(lazy)
@@ -297,7 +299,11 @@ data_articles <- function(pkg = ".", is_index = FALSE, call = caller_env()) {
   external <- config_pluck_external_articles(pkg, call = call)
   articles <- rbind(internal, external)
 
-  articles$description <- lapply(articles$description, markdown_text_block, pkg = pkg)
+  articles$description <- lapply(
+    articles$description,
+    markdown_text_block,
+    pkg = pkg
+  )
 
   # Hack data structure so we can use select_topics()
   articles$alias <- as.list(articles$name)
@@ -359,7 +365,13 @@ config_pluck_external_articles <- function(pkg, call = caller_env()) {
   )
 }
 
-data_articles_index_section <- function(section, index, articles, pkg, call = caller_env()) {
+data_articles_index_section <- function(
+  section,
+  index,
+  articles,
+  pkg,
+  call = caller_env()
+) {
   config_check_list(
     section,
     error_path = paste0("articles[", index, "]"),

R/build-favicons.R

@@ -87,12 +87,21 @@ build_favicons <- function(pkg = ".", overwrite = FALSE) {
   resp <- httr2::req_perform(req, tmp)
 
   withCallingHandlers(
-    paths <- utils::unzip(tmp, exdir = path(pkg$src_path, "pkgdown", "favicon")),
+    paths <- utils::unzip(
+      tmp,
+      exdir = path(pkg$src_path, "pkgdown", "favicon")
+    ),
     warning = function(e) {
-      cli::cli_abort("Your logo file couldn't be processed and may be corrupt.", parent = e)
+      cli::cli_abort(
+        "Your logo file couldn't be processed and may be corrupt.",
+        parent = e
+      )
     },
     error = function(e) {
-      cli::cli_abort("Your logo file couldn't be processed and may be corrupt.", parent = e)
+      cli::cli_abort(
+        "Your logo file couldn't be processed and may be corrupt.",
+        parent = e
+      )
     }
   )
   cli::cli_inform(c("v" = "Added {.path {sort(path_file(paths))}}."))

R/build-footer.R

@@ -3,13 +3,22 @@ data_footer <- function(pkg = ".", call = caller_env()) {
 
   config_pluck_list(pkg, "footer", call = call)
   meta_components <- config_pluck_list(pkg, "footer.components", call = call)
-  components <- modify_list(footnote_components(pkg, call = call), meta_components)
+  components <- modify_list(
+    footnote_components(pkg, call = call),
+    meta_components
+  )
 
   meta_structure <- config_pluck_list(pkg, "footer.structure", call = call)
   structure <- modify_list(footnote_structure(), meta_structure)
 
-  left <- markdown_text_block(pkg, paste0(components[structure$left], collapse = " "))
-  right <- markdown_text_block(pkg, paste0(components[structure$right], collapse = " "))
+  left <- markdown_text_block(
+    pkg,
+    paste0(components[structure$left], collapse = " ")
+  )
+  right <- markdown_text_block(
+    pkg,
+    paste0(components[structure$right], collapse = " ")
+  )
 
   list(left = left, right = right)
 }

R/build-github.R

@@ -16,20 +16,28 @@
 #' @inheritParams deploy_to_branch
 #' @param dest_dir Directory to build site in.
 #' @export
-build_site_github_pages <- function(pkg = ".",
-                                    ...,
-                                    dest_dir = "docs",
-                                    clean = TRUE,
-                                    install = FALSE,
-                                    new_process = FALSE) {
- pkg <- as_pkgdown(pkg, override = list(destination = dest_dir))
+build_site_github_pages <- function(
+  pkg = ".",
+  ...,
+  dest_dir = "docs",
+  clean = TRUE,
+  install = FALSE,
+  new_process = FALSE
+) {
+  pkg <- as_pkgdown(pkg, override = list(destination = dest_dir))
 
   if (clean) {
     cli::cli_rule("Cleaning files from old site")
     clean_site(pkg)
   }
 
-  build_site(pkg, preview = FALSE, install = install, new_process = new_process, ...)
+  build_site(
+    pkg,
+    preview = FALSE,
+    install = install,
+    new_process = new_process,
+    ...
+  )
   build_github_pages(pkg)
 
   invisible()
@@ -53,12 +61,10 @@ build_github_pages <- function(pkg = ".") {
 }
 
 cname_url <- function(url) {
-  if (is.null(url))
-    return(NULL)
+  if (is.null(url)) return(NULL)
 
   pieces <- xml2::url_parse(url)
-  if (!pieces$path %in% c("", "/"))
-    return(NULL)
+  if (!pieces$path %in% c("", "/")) return(NULL)
 
   pieces$server
 }