Implement clean_cache()

NAMESPACE

@@ -125,6 +125,7 @@ export(build_site)
 export(build_site_github_pages)
 export(build_tutorials)
 export(check_pkgdown)
+export(clean_cache)
 export(clean_site)
 export(data_template)
 export(deploy_site_github)

NEWS.md

@@ -1,5 +1,6 @@
 # pkgdown (development version)
 
+* New `clean_cache()` function removes the contents of the cache directory (#2718).
 * pkgdown now depends on R >= 4.0.0 (#2714)
 
 # pkgdown 2.1.0

R/clean.R

@@ -4,6 +4,7 @@
 #'
 #' @param quiet If `TRUE`, suppresses a message.
 #' @inheritParams build_site
+#' @rdname clean
 #' @export
 clean_site <- function(pkg = ".", quiet = FALSE) {
 
@@ -27,6 +28,30 @@
   invisible(TRUE)
 }
 
+#' Clean cache
+#'
+#' Delete all files in the pkgdown cache directory.
+#'
+#' @rdname clean
+#' @export
+clean_cache <- function(pkg = ".", quiet = FALSE) {
+
+  pkg <- as_pkgdown(pkg)
+  cache_path <- tools::R_user_dir("pkgdown", "cache")
+
+  if (dir_exists(cache_path)) {
+    if (!quiet) {
+      cli::cli_inform(
+        "Cleaning {.pkg {pkg$package}} cache files from {.path {cache_path}}"
+      )
+    }
+
+    dir_delete(cache_path)
+  }
+
+  invisible(TRUE)
+}
+
 check_dest_is_pkgdown <- function(pkg) {
   if (file_exists(path(pkg$dst_path, "pkgdown.yml"))) {
     return()
@@ -45,6 +70,6 @@
     character()
   } else {
     top_level <- dir_ls(pkg$dst_path)
-    top_level[!path_file(top_level) %in% c("CNAME", "dev")]  
+    top_level[!path_file(top_level) %in% c("CNAME", "dev")]
   }
 }