R/set-terminal.R

In csgillespie/rprofile: My Rprofile in a Handy R Package

#' Detects R terminal
#'
#' Return \code{TRUE} is terminal. But \code{FALSE} if the RStudio console.
#' The RStudio console doesn't require as much customisation as a standard console since
#' it is already pretty. But it does place limits on the prompt options (single line only).
#' @export
is_terminal = function() {
  (Sys.getenv("RSTUDIO") != "1" ||
     (Sys.getenv("RSTUDIO") == "1" && nzchar(Sys.getenv("RSTUDIO_TERM")))) &&
    !is_positron()
}

#' @rdname is_terminal
#' @export
is_positron = function() {
  Sys.getenv("POSITRON") == "1"
}

#' @param rdoc Should we load the rdoc package
#' @param colorout Should we load the colorout package
#' @param prettycode Should we load the prettycode package
#' @param cmd_prompt The prompt to use. A prompt from the `prompt` package
#' could also be passed.
#' @rdname is_terminal
#' @export
set_terminal = function(rdoc = TRUE,
                        colorout = TRUE,
                        prettycode = TRUE,
                        cmd_prompt = rprofile_prompt) {
  if (isTRUE(prettycode)) suppressMessages(prettycode::prettycode())
  if (isTRUE(rdoc)) {
    base::library("utils") # Needed for rdoc`?` to take precedence
    rdoc::use_rdoc()
  }

  if (isTRUE(colorout) && requireNamespace("colorout", quietly = TRUE)) {
    base::library("colorout")
  }
  # For some reason width is out on normal R terminals
  prompt::set_prompt(prompt::prompt_git)
}

#' @rdname is_terminal
#' @export
set_rstudio = function(prettycode = TRUE) {
  if (isTRUE(prettycode)) prettycode::prettycode()
  prompt::set_prompt(rprofile_prompt)
}

#' @rdname is_terminal
#' @export
set_positron = function(prettycode = TRUE) {
  if (isTRUE(prettycode)) suppressMessages(prettycode::prettycode())
  p = if (!prompt::is_git_dir()) "> " else paste0(prompt::git_branch(), " > ")
  prompt::set_prompt(p)
}