R/check_lesson.R

In carpentries/sandpaper: Create and Curate Carpentries Lessons

#' [deprecated] Check the lesson structure for errors
#'
#' This function is now deprecated in favour of [validate_lesson()].
#'
#' @param path the path to your lesson
#' @param quiet if quiet (default TRUE) then no info messages printed to stdout
#'
#' @return `TRUE` (invisibly) if the lesson is cromulent, otherwise, it will
#'   error with a list of things to fix.
#'
#' @export
#' @examples
#'
#' # Everything should work out of the box
#' tmp <- tempfile()
#' create_lesson(tmp, open = FALSE, rmd = FALSE)
#' check_lesson(tmp)
#'
#' # if things do not work, then an error is thrown with information about
#' # what has failed you
#' unlink(file.path(tmp, ".gitignore"))
#' unlink(file.path(tmp, "site"), recursive = TRUE)
#' try(check_lesson(tmp))
#'
#' unlink(tmp)
#' @importFrom assertthat validate_that
#' @keywords internal
check_lesson <- function(path = ".", quiet = TRUE) {

  x      <- fs::dir_info(path, all = TRUE)
  files  <- fs::path_file(x$path)
  # gitingore
  g      <- fs::path(path, ".gitignore")
  theirs <- if (fs::file_exists(g)) readLines(g) else character(0)
  theirs <- theirs[!grepl("^([#].+?|)$", trimws(theirs))]

  not_overview <- (get_config(path)$overview %||% FALSE)

  if (!not_overview && !quiet) {
    cli::cli_alert_info("This is an overview lesson - skipping episode checks")
  }

  # Validation -----------------------------------------------------------------

  # Validators are stored in validators.R
  checklist <- list(
    validate_that(check_dir(path, "learners")),
    validate_that(check_dir(path, ".git")),
    validate_that(check_gitignore(theirs)),
    validate_that(check_exists(path, "README.md"))
  )

  if (not_overview) {
    checklist <- c(
      checklist,
      validate_that(check_dir(path, "episodes"))
      # if rebuilding, why check these?
      # validate_that(check_dir(path, "site")),
      # validate_that(check_exists(path, fs::path("site", "README.md")))
    )
  }

  # Reporting ------------------------------------------------------------------
  report_validation(
    checklist,
    "There were errors with the lesson structure."
  )
}

check_site_rendered <- function(path = ".", quiet = TRUE) {
  # create site folder if it doesn't exist
  if (!fs::dir_exists(path_site(path))) {
    if (!quiet) {
        cli::cli_alert_info("Creating site folder")
    }
    fs::dir_create(path_site(path))
  }

  path <- path_site(path)
  list(
    site        = validate_that(check_dir(path, ".")),
    built       = validate_that(check_dir(path, "built")),
    readme      = validate_that(check_exists(path, "README.md")),
    config      = validate_that(check_exists(path, "_pkgdown.yaml")),
    description = validate_that(check_exists(path, "DESCRIPTION"))
  )
}