Check that roxygen2 generates Rd files and NAMESPACE

Requested in #2

NAMESPACE

@@ -2,6 +2,7 @@
 
 export(check_cran)
 export(check_description)
+export(check_documentation)
 export(check_lintr)
 export(check_package)
 export(checklist)

R/check_documentation.R

@@ -0,0 +1,21 @@
+#' Check the documentation
+#' @inheritParams read_checklist
+#' @export
+check_documentation <- function(x = ".") {
+  if (!inherits(x, "Checklist") || !"checklist" %in% x$get_checked) {
+    x <- read_checklist(x = x)
+  }
+  rd_files <- c(
+    file.path(x$get_path, "NAMESPACE"),
+    list.files(
+      file.path(x$get_path, "man"), pattern = "Rd$", full.names = TRUE
+    )
+  )
+  start <- vapply(rd_files, readLines, character(1), n = 1)
+  ok <- grepl("roxygen2", start) & grepl("do not edit by hand", start)
+  doc_error <- sprintf(
+    "Documentation in %s not generated by `roxygen2`", rd_files[!ok]
+  )
+  x$add_error(doc_error, "documentation")
+  return(x)
+}

R/check_package.R

@@ -16,6 +16,9 @@ check_package <- function(x = ".", fail = !interactive()) {
   cat("Checking description\n")
   x <- check_description(x)
 
+  cat("Checking documentation\n")
+  x <- check_documentation(x)
+
   print(x)
   if (!x$fail) {
     cat("\nNo problems found. Good job!\n\n")

R/checklist_class.R

@@ -165,7 +165,9 @@ checklist <- R6Class(
     },
     #' @field fail A logical indicating if all checks passed.
     fail = function() {
-      required_checks <- c("checklist", "DESCRIPTION", "lintr", "R CMD check")
+      required_checks <- c(
+        "checklist", "DESCRIPTION", "lintr", "R CMD check", "documentation"
+      )
       stopifnot(all(private$checked %in% required_checks))
       errors <- vapply(private$errors, length, integer(1))
       any(!required_checks %in% private$checked) ||