R/highlight.R

In tidyverse/reprex: Prepare Reproducible Example Code via the Clipboard

reprex_highlight <- function(rout_file, reprex_file, arg_string = NULL) {
  arg_string <- arg_string %||% highlight_args()
  cmd <- paste0(
    "highlight ",
    " -i ", shQuote(rout_file),
    " --out-format=rtf --no-trailing-nl --encoding=UTF-8",
    arg_string,
    " -o ", shQuote(reprex_file)
  )
  if (is_windows()) {
    res <- shell(cmd)
  } else {
    res <- system(cmd)
  }
  if (res > 0) {
    # I am OK with a non-exported function appearing in this error.
    # This whole feature is "use at your own risk".
    cli::cli_abort(
      "Call to the {.pkg highlight} command line tool was unsuccessful."
    )
  }
  res
}

rtf_requires_highlight <- function(venue) {
  if (venue == "rtf" && !highlight_found()) {
    # I am OK with a non-exported function appearing in this error.
    # This whole feature is "use at your own risk".
    cli::cli_abort(c(
      "The {.pkg highlight} command line tool doesn't appear to be installed.",
      '{.code venue = "rtf"} is only supported if R can find {.pkg highlight}.'
    ))
  }
  invisible(venue)
}

highlight_found <- function() Sys.which("highlight") != ""

highlight_args <- function() {
  hl_style  <-         getOption("reprex.highlight.hl_style", "darkbone")
  font      <- shQuote(getOption("reprex.highlight.font", "Courier Regular"))
  font_size <-         getOption("reprex.highlight.font_size", 50)
  other     <-         getOption("reprex.highlight.other", "")

  paste0(
    " --style ",     hl_style,
    " --font ",      font,
    " --font-size ", font_size,
    " ", other
  )
}