setup-cpp/packages/setup-brew/src/install-pack.ts

Install all the tools required for building and testing C++/C projects.

import { join } from "path"
import { info, warning } from "ci-log"
import { execaSync } from "execa" // brew is not thread-safe
import which from "which"
import type { InstallationInfo } from "./InstallationInfo.js"
import type { BrewPackOptions } from "./install-pack-options.js"
import { getBrewBinDir, getBrewBinPath, setupBrew } from "./install.js"
import { brewPackInstallDir, brewPackNameAndVersion } from "./pack-install-dir.js"

/* eslint-disable require-atomic-updates */
let hasBrew = false

/** A function that installs a package using brew
 *
 * @param name The name of the package
 * @param version The version of the package (optional)
 * @param options The options for installing the package
 *
 * @returns The installation information
 */
export async function installBrewPack(
  name: string,
  version?: string,
  options: BrewPackOptions = {},
): Promise<InstallationInfo> {
  if (!("overwrite" in options)) {
    options.overwrite = true // default to true if not specified
  }
  if (options.cask === true) {
    options.overwrite = false // mutually exclusive with --overwrite
  }

  info(`Installing ${name} ${version ?? ""} via brew`)

  if (!hasBrew || which.sync("brew", { nothrow: true }) === null) {
    await setupBrew()
    hasBrew = true
  }

  const brewPath = getBrewBinPath()

  const args = [
    "install",
    brewPackNameAndVersion(name, version),
  ]

  // Add options to args
  for (const [key, value] of Object.entries(options)) {
    if (typeof value === "boolean" && value) {
      args.push(`--${key}`)
    } else if (typeof value === "string") {
      args.push(`--${key}`, value)
    }
  }

  // dry run to check if the package is already installed
  const dryRun = execaSync(brewPath, [...args, "--dry-run"], { stdio: "pipe" })
  const isAlreadyInstalled = dryRun.exitCode === 0
    && (new RegExp(`.*${name}.* is already installed and up-to-date.[\\s\\S]*`)).test(dryRun.stderr)

  if (isAlreadyInstalled) {
    // if the package is already installed and up-to-date, skip the installation
    info(`${name} ${version ?? ""} is already installed and up-to-date`)
  } else {
    // install the package if not already installed
    execaSync(brewPath, args, { stdio: "inherit" })
  }

  // get the installation directory
  const installDir = await brewPackInstallDir(name, version)
  if (installDir === undefined) {
    warning(`Failed to find installation directory for ${name} ${version}`)
    return { binDir: getBrewBinDir(), installDir: undefined }
  }

  return { installDir, binDir: join(installDir, "bin") }
}