R/utils-yaml.R

In hadley/pkgdown: Make Static HTML Documentation for a Package

check_yaml_has <- function(missing, where, pkg, call = caller_env()) {
  if (length(missing) == 0) {
    return()
  }

  missing_components <- lapply(missing, function(x) c(where, x))
  msg_flds <- pkgdown_field(pkg, missing_components, fmt = FALSE, cfg = FALSE)

  cli::cli_abort(c(
    "Can't find {cli::qty(missing)} component{?s} {.field {msg_flds}}.",
    i = "Edit {pkgdown_config_href({pkg$src_path})} to define {cli::qty(missing)} {?it/them}."
    ),
    call = call
  )
}

yaml_character <- function(pkg, where) {
  x <- purrr::pluck(pkg$meta, !!!where)

  if (identical(x, list()) || is.null(x)) {
    character()
  } else if (is.character(x)) {
    x
  } else {
    fld <- pkgdown_field(pkg, where, fmt = TRUE)
    cli::cli_abort(
      paste0(fld, " must be a character vector."),
      call = caller_env()
    )
  }
}

pkgdown_field <- function(pkg, fields, cfg = FALSE, fmt = FALSE) {

  if (!is.list(fields)) fields <- list(fields)

  flds <- purrr::map_chr(fields, ~ paste0(.x, collapse = "."))
  if (fmt) {
    flds <- paste0("{.field ", flds, "}")
  }

  if (cfg) {
    if (fmt) {
      config_path <- cli::format_inline(pkgdown_config_href(pkg$src_path))
    } else {
      config_path <- pkgdown_config_relpath(pkg)
    }

    paste0(flds, " in ", config_path)
  } else {

    flds
  }
}

# print helper ------------------------------------------------------------

print_yaml <- function(x) {
  structure(x, class = "print_yaml")
}
#' @export
print.print_yaml <- function(x, ...) {
  cat(yaml::as.yaml(x), "\n", sep = "")
}

# IO ----------------------------------------------------------------------

write_yaml <- function(x, path) {
  write_lines(yaml::as.yaml(x), path = path)
}