inst/hooks/exported/parsable-roxygen.R

In lorenzwalthert/precommit: Pre-Commit Hooks

#!/usr/bin/env Rscript

"Check whether roxygen comments within files are valid
Usage:
  parsable-roxygen [--eval] <files>...

Options:
  --eval  Evaluate file contents after parsing - this is required if `@eval` tags must be evaluated

" -> doc

arguments <- precommit::precommit_docopt(doc)

if (packageVersion("roxygen2") < package_version("7.3.0")) {
  rlang::abort("You need at least version 7.3.0 of {roxygen2} to run this hook.")
}

out <- lapply(arguments$files, function(path) {
  tryCatch(
    # Capture any messages from roxygen2:::warn_roxy()
    msg <- capture.output(
      roxygen2::parse_file(
        path,
        env = if (isTRUE(arguments$eval)) {
          roxygen2::env_file(path)
        } else {
          NULL
        }
      ),
      type = "message"
    ),

    # In case we encounter a more general file parsing problem
    error = function(e) {
      cat(c("File ", path, " is not parsable. Full context:\n"))
      stop(conditionMessage(e), call. = FALSE)
    }
  )

  if (length(msg) > 0) {
    cat(c("Roxygen commentary in file ", path, " is not parsable. Full context:\n"))
    stop(paste0(msg, collapse = "\n"), call. = FALSE)
  }
})