R/brew_cmd.R

In briandconnelly/homebrew: Install and Manage Packages using 'Homebrew'

#' Run a homebrew command
#'
#' `brew_cmd()` runs a given Homebrew command.
#' For more information about which additional arguments are supported for a
#' command, see [brew_help()].
#'
#' @param cmd The command to run (e.g., `install`)
#' @param args Additional arguments for the command
#' @param brew_cmd Optional: Location of `brew` command.
#' @param echo Whether to print output and error messages to the screen.
#' Defaults to `TRUE` for interactive sessions.
#' @param ... Additional arguments passed to [`processx::run()`]
#'
#' @return A list with components:
#' \describe{
#'   \item{`status`}{The exit status of the process. If this is `NA`, then the
#'                   process was killed and had no exit status.}
#'   \item{`stdout`}{The standard output of the command, in a character scalar.}
#'   \item{`stderr`}{The standard error of the command, in a character scalar.}
#'   \item{`timeout`}{Whether the process was killed because of a timeout.}
#' }
#' @export
#'
#' @examples
#' \dontrun{
#' brew_cmd("install", "unixodbc")
#' }
brew_cmd <- function(cmd,
                     args = character(),
                     brew_cmd = find_brew_command(),
                     echo = is_interactive(),
                     ...) {
  checkmate::assert_os(c("mac", "linux"))
  checkmate::assert_string(cmd, na.ok = FALSE)
  checkmate::assert_character(args, min.len = 0)
  checkmate::assert_file(brew_cmd, access = "x")
  checkmate::assert_flag(echo)

  check_brew_command(brew_cmd)
  ellipsis::check_dots_used()

  processx::run(
    command = brew_cmd,
    args = c(cmd, args),
    echo = echo,
    ...
  )
}

find_brew_command <- function() {
  unname(Sys.which("brew"))
}

check_brew_command <- function(brew_cmd) {
  if (nchar(brew_cmd) == 0) {
    cli::cli_abort("Could not find {.code brew} command")
  } else if (!fs::file_exists(brew_cmd)) {
    cli::cli_abort("Could not find {.code brew} command: {.path {brew_cmd}} does not exist")
  } else if (!fs::file_access(brew_cmd, mode = "execute")) {
    cli::cli_alert_warning("{.code brew} command {.path {brew_cmd}} is not executable")
  }
}


homebrew_commands <- function() {
  output <- brew_cmd(
    cmd = "commands",
    args = c("--quiet", "--include_aliases"),
    echo = FALSE
  )$stdout
  strsplit(output, "\n")[[1]]
}


is_homebrew_command <- function(cmd) {
  cmd %in% homebrew_commands()
}