feat: introduce setup-brew package

biome.jsonc

@@ -8,6 +8,7 @@
       "dev/cpp_vcpkg_project/**/*",
       "**/.venv/",
       "**/.*cache/",
+      "coverage/",
       "**/coverage/"
     ],
     "ignoreUnknown": true

jest.config.ts → jest.config.mjs

@@ -1,6 +1,7 @@
-import type { Config } from "jest"
-
-const jestConfig: Config = {
+/**
+ * @type {import('jest').Config}
+ */
+const jestConfig = {
   testMatch: ["**/*.test.ts"],
   testEnvironment: "node",
   extensionsToTreatAsEsm: [".ts", ".tsx", ".jsx"],

package.json

@@ -32,11 +32,13 @@
     "build.babel": "babel ./dist --out-dir dist --plugins @upleveled/babel-plugin-remove-node-prefix --plugins @babel/plugin-transform-private-methods --compact --no-babelrc --source-maps true",
     "build.modern": "shx cp -r ./dist/actions/* ./dist/modern",
     "bump": "ncu -u -x numerous,execa,prettier,@types/node,eslint,@types/eslint && pnpm update && pnpx typesync && pnpm run clean",
-    "clean": "shx rm -rf ./dist ./exe ./.parcel-cache && shx mkdir -p ./dist/legacy ./dist/actions ./dist/modern ",
+    "clean": "shx rm -rf ./dist ./packages/*/dist ./exe ./.parcel-cache && shx mkdir -p ./dist/legacy ./dist/actions ./dist/modern ",
     "copy.matchers": "run-p copy.matchers.legacy copy.matchers.actions",
     "copy.matchers.legacy": "shx cp ./src/gcc/gcc_matcher.json ./dist/legacy/ && shx cp ./src/msvc/msvc_matcher.json ./dist/legacy/ && shx cp ./src/python/python_matcher.json ./dist/legacy/ && shx cp ./src/llvm/llvm_matcher.json ./dist/legacy/",
     "copy.matchers.actions": "shx cp ./src/gcc/gcc_matcher.json ./dist/actions/ && shx cp ./src/msvc/msvc_matcher.json ./dist/actions/ && shx cp ./src/python/python_matcher.json ./dist/actions/ && shx cp ./src/llvm/llvm_matcher.json ./dist/actions/",
-    "dev": "cross-env NODE_ENV=development parcel watch",
+    "dev.parcel": "cross-env NODE_ENV=development parcel watch",
+    "dev.packages": "turbo dev",
+    "dev": "run-p dev.packages dev.parcel",
     "docs": "shx rm -rf packages/*/README.md && pnpm -r exec readme --path ../../dev/readme/template.md -y && pnpm -r exec ts-readme",
     "format": "run-s lint.dprint",
     "lint": "turbo lint && run-p --aggregate-output --continue-on-error lint.**",
@@ -52,7 +54,7 @@
     "test.lint.root.eslint": "eslint ./{src,dev}/**/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/",
     "test.lint.biome": "biome check",
     "test.lint.dprint": "dprint check",
-    "test": "jest --runInBand --forceExit --coverage",
+    "test": "turbo test && jest --runInBand --forceExit --coverage",
     "build.docker-ci": "node ./dev/docker/ci/docker-ci.mjs"
   },
   "devDependencies": {
@@ -114,6 +116,7 @@
     "retry-as-promised": "^7.0.4",
     "semver": "7.6.3",
     "setup-python": "github:aminya/setup-python#a783db655c6e40317e2c0c96f9d162d9c9f4a751",
+    "setup-brew": "workspace:*",
     "shx": "0.3.4",
     "simple-update-notifier": "^2.0.0",
     "terser-config-atomic": "^1.0.0",
@@ -157,6 +160,7 @@
     "retry-as-promised",
     "semver",
     "setup-apt",
+    "setup-brew",
     "setup-python",
     "simple-update-notifier",
     "time-delta",

packages/ci-log/README.md

@@ -1,6 +1,8 @@
 <h1 align="center">ci-log</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="https://www.npmjs.com/package/ci-log" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/ci-log.svg">
+  </a>
   <a href="#" target="_blank">
     <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
   </a>

packages/ci-log/package.json

@@ -8,8 +8,10 @@
   "author": "Amin Yahyaabadi",
   "main": "./dist/index.js",
   "source": "./src/index.ts",
+  "type": "module",
   "scripts": {
     "build": "tsc --pretty",
+    "dev": "tsc --watch --pretty",
     "lint.tsc": "tsc --noEmit --pretty",
     "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
     "prepublishOnly": "pnpm run build"

packages/envosman/README.md

@@ -1,6 +1,8 @@
 <h1 align="center">envosman</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="https://www.npmjs.com/package/envosman" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/envosman.svg">
+  </a>
   <img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" />
   <a href="#" target="_blank">
     <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
@@ -23,6 +25,8 @@ npm install --save envosman
 
 ### `RcOptions` (type)
 
+Options for adding an rc file
+
 ### `sourceRCInRc` (variable)
 
 handles adding conditions to source rc file from .bashrc and .profile
@@ -48,6 +52,8 @@ Escape a string for use in a shell command
 
 ### `AddEnvOptions` (type)
 
+The options for adding an environment variable
+
 ### `addEnv` (function)
 
 Add an environment variable.
@@ -62,6 +68,10 @@ This function is cross-platforms and works in all the local or CI systems.
 
 **returns:** Promise<void>
 
+### `AddPathOptions` (type)
+
+The options for adding a PATH variable
+
 ### `addPath` (function)
 
 Add a path to the PATH environment variable.

packages/envosman/package.json

@@ -8,8 +8,10 @@
   "author": "Amin Yahyaabadi",
   "main": "./dist/index.js",
   "source": "./src/index.ts",
+  "type": "module",
   "scripts": {
     "build": "tsc --pretty",
+    "dev": "tsc --watch --pretty",
     "lint.tsc": "tsc --noEmit --pretty",
     "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
     "prepublishOnly": "pnpm run build"

packages/envosman/src/add-path.ts

@@ -10,7 +10,7 @@ const { appendFile } = promises
 /**
  * The options for adding a PATH variable
  */
-type AddPathOptions = {
+export type AddPathOptions = {
   /**
    * The path to the RC file that the PATH variables should be added to.
    */

packages/envosman/src/index.ts

@@ -1,3 +1,3 @@
-export { addEnv } from "./add-env.js"
-export { addPath } from "./add-path.js"
+export { addEnv, AddEnvOptions } from "./add-env.js"
+export { addPath, AddPathOptions } from "./add-path.js"
 export { finalizeRC, sourceRCInRc as sourceRC } from "./rc-file.js"

packages/exec-powershell/README.md

@@ -1,6 +1,8 @@
 <h1 align="center">exec-powershell</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="https://www.npmjs.com/package/exec-powershell" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/exec-powershell.svg">
+  </a>
   <a href="#" target="_blank">
     <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
   </a>

packages/exec-powershell/package.json

@@ -8,8 +8,10 @@
   "author": "Amin Yahyaabadi",
   "main": "./dist/index.js",
   "source": "./src/index.ts",
+  "type": "module",
   "scripts": {
     "build": "tsc --pretty",
+    "dev": "tsc --watch --pretty",
     "lint.tsc": "tsc --noEmit --pretty",
     "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
     "prepublishOnly": "pnpm run build"

packages/setup-apt/README.md

@@ -1,6 +1,8 @@
 <h1 align="center">setup-apt</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="https://www.npmjs.com/package/setup-apt" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/setup-apt.svg">
+  </a>
   <img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" />
   <a href="#" target="_blank">
     <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />

packages/setup-apt/package.json

@@ -8,8 +8,10 @@
   "author": "Amin Yahyaabadi",
   "main": "./dist/index.js",
   "source": "./src/index.ts",
+  "type": "module",
   "scripts": {
     "build": "tsc --pretty",
+    "dev": "tsc --watch --pretty",
     "lint.tsc": "tsc --noEmit --pretty",
     "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
     "prepublishOnly": "pnpm run build"

packages/setup-brew/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.eslintrc.json"
+}

packages/setup-brew/README.md

@@ -0,0 +1,65 @@
+<h1 align="center">setup-brew</h1>
+<p>
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" />
+  <a href="#" target="_blank">
+    <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
+  </a>
+</p>
+
+> Setup brew and brew packages
+
+## Install
+
+```sh
+npm install --save setup-brew
+```
+
+## Usage
+
+<!-- INSERT GENERATED DOCS START -->
+
+### `InstallationInfo` (type)
+
+The information about an installation result
+
+### `SetupBrewOptions` (type)
+
+### `setupBrew` (function)
+
+**Parameters:**
+
+- options (`SetupBrewOptions`)
+
+**returns:** Promise<InstallationInfo>
+
+### `getBrewBinDir` (function)
+
+Get the path where brew is installed
+
+**returns:** "/opt/homebrew/bin/" | "/usr/local/bin/" | "/home/linuxbrew/.linuxbrew/bin/"
+
+### `BrewPackOptions` (type)
+
+### `installBrewPack` (function)
+
+A function that installs a package using brew
+
+**Parameters:**
+
+- name (`string`)
+- version (`string`)
+- givenOptions (`BrewPackOptions`)
+
+**returns:** Promise<InstallationInfo>
+
+<!-- INSERT GENERATED DOCS END -->
+
+## 🤝 Contributing
+
+You can sponsor my work here:
+
+https://github.com/sponsors/aminya
+
+Pull requests, issues and feature requests are welcome.
+See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).

packages/setup-brew/__tests__/brew.test.ts

@@ -0,0 +1,45 @@
+import { join } from "path"
+import spawn from "cross-spawn"
+import { pathExists } from "path-exists"
+import { addExeExt } from "patha"
+import which from "which"
+import { setupBrew } from "../src/index.js"
+
+jest.setTimeout(300000)
+describe("setup-brew", () => {
+  if (process.platform === "win32") {
+    it.skip("should setup brew", () => {})
+    return
+  }
+  it("should setup brew", async () => {
+    const installInfo = await setupBrew()
+    await testBin("brew", ["--version"], installInfo?.binDir)
+  })
+})
+
+async function testBin(
+  name: string,
+  args: string[] | null = ["--version"],
+  binDir: string | undefined = undefined,
+) {
+  try {
+    let bin = name
+    if (typeof binDir === "string") {
+      console.log(`Testing the existence of ${binDir}`)
+      expect(binDir).toBeDefined()
+      expect(binDir).not.toHaveLength(0)
+      expect(await pathExists(binDir)).toBeTruthy()
+      bin = join(binDir, addExeExt(name))
+    }
+
+    if (args !== null) {
+      console.log(`Running ${bin} ${args.join(" ")}`)
+      const { status } = spawn.sync(bin, args, { stdio: "inherit" })
+      expect(status).toBe(0)
+    }
+
+    expect((await which(name, { nothrow: true }))?.includes(bin))
+  } catch (err) {
+    throw new Error(`Failed to test bin ${name}: ${err}`)
+  }
+}

packages/setup-brew/__tests__/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["**/*.ts"]
+}

packages/setup-brew/jest.config.mjs

@@ -0,0 +1,2 @@
+import jestConfig from "../../jest.config.mjs"
+export default jestConfig

packages/setup-brew/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "setup-brew",
+  "version": "1.0.0",
+  "description": "Setup brew and brew packages",
+  "repository": "https://github.com/aminya/setup-cpp",
+  "homepage": "https://github.com/aminya/setup-cpp/tree/master/packages/setup-brew",
+  "license": "Apache-2.0",
+  "author": "Amin Yahyaabadi",
+  "main": "./dist/index.js",
+  "source": "./src/index.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc --pretty",
+    "dev": "tsc --watch --pretty",
+    "lint.tsc": "tsc --noEmit --pretty",
+    "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
+    "prepublishOnly": "pnpm run build",
+    "test": "jest --coverage"
+  },
+  "dependencies": {
+    "@types/node": "^12",
+    "ci-log": "workspace:*",
+    "envosman": "workspace:*",
+    "which": "4.0.0",
+    "execa": "^7.2.0",
+    "setup-apt": "workspace:*",
+    "node-downloader-helper": "2.1.9"
+  },
+  "devDependencies": {
+    "path-exists": "5.0.0",
+    "patha": "0.4.1"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "keywords": [
+    "setup",
+    "brew",
+    "install",
+    "brew-install",
+    "cask",
+    "formula",
+    "package",
+    "setup-brew",
+    "repositories",
+    "macos",
+    "homebrew",
+    "linuxbrew",
+    "osx",
+    "linux",
+    "ubuntu"
+  ]
+}

packages/setup-brew/src/InstallationInfo.ts

@@ -0,0 +1,12 @@
+/**
+ * The information about an installation result
+ */
+
+export type InstallationInfo = {
+  /** The install dir of the package (Defaults to `undefined`) */
+  installDir?: string
+  /** The bin dir of the package (Defaults to `/usr/bin`) */
+  binDir: string
+  /** The bin path of the package (Defaults to `undefined`) */
+  bin?: string
+}

packages/setup-brew/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./install-pack.js"
+export * from "./install.js"