R/brew_info.R

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

#' @title Display information about a formula or cask
#' @description `brew_info()` displays detailed information about a formula or
#' cask.
#' @param package Name of one or more formulae or casks
#' @inheritDotParams brew_cmd
#' @return A list of lists. Each sub-list contains information about a package
#' or cask specified by the `package` argument.
#' @note System and package analytics can be retrieved with [`brew_analytics`]
#' @export
#' @examples
#' \dontrun{
#' # Get info about unixodbc package
#' brew_info("unixodbc")
#' }
brew_info <- function(package, ...) {
  checkmate::assert_character(
    package,
    min.chars = 1, min.len = 1, any.missing = FALSE
  )

  jsonlite::parse_json(
    brew_cmd("info", args = c("--json", package), ...)$stdout
  )
}