feat: add os-env package for managing path, env, rc files

Author: aminya

dist/actions/setup-cpp.js

@@ -74,6 +74,7 @@
     "admina": "^1.0.1",
     "caxa": "^3.0.1",
     "ci-info": "^4.0.0",
+    "os-env": "workspace:*",
     "ci-log": "workspace:*",
     "cross-env": "7.0.3",
     "cross-spawn": "^7.0.3",
@@ -128,6 +129,7 @@
     "admina",
     "ci-info",
     "ci-log",
+    "os-env",
     "escape-path-with-spaces",
     "escape-quotes",
     "escape-string-regexp",

dist/actions/setup-cpp.js.map

@@ -0,0 +1,42 @@
+{
+  "name": "os-env",
+  "version": "1.0.0",
+  "description": "Manage environment variables, PATH, and rc files",
+  "homepage": "https://github.com/aminya/setup-cpp",
+  "license": "Apache-2.0",
+  "author": "Amin Yahyaabadi",
+  "main": "./dist/index.js",
+  "source": "./src/index.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1",
+    "@types/node": "^12",
+    "admina": "^1.0.1",
+    "ci-info": "^4.0.0",
+    "escape-path-with-spaces": "^1.0.2",
+    "escape-quotes": "^1.0.2",
+    "micro-memoize": "^4.1.2",
+    "path-exists": "^5.0.0",
+    "ci-log": "workspace:*",
+    "exec-powershell": "workspace:*",
+    "untildify-user": "workspace:*"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "keywords": [
+    "env",
+    "path",
+    "dotenv",
+    "rc",
+    "addEnv",
+    "addPath",
+    "setEnv",
+    "linux",
+    "windows",
+    "unix",
+    "macos"
+  ]
+}

dist/legacy/setup-cpp.js

@@ -0,0 +1,94 @@
+import { promises } from "fs"
+import { exportVariable as ghExportVariable } from "@actions/core"
+import { GITHUB_ACTIONS } from "ci-info"
+import { error, info } from "ci-log"
+import { execPowershell } from "exec-powershell"
+import { untildifyUser } from "untildify-user"
+import { sourceRC } from "./rc-file.js"
+import { escapeString } from "./utils.js"
+const { appendFile } = promises
+
+export type AddEnvOptions = {
+  /** If true, the value will be escaped with quotes and spaces will be escaped with backslash */
+  shouldEscapeSpace: boolean
+  /** If true, the variable will be only added if it is not defined */
+  shouldAddOnlyIfNotDefined: boolean
+  /**
+   * The path to the RC file that the env variables should be added to.
+   */
+  rcPath: string
+}
+/**
+ * Add an environment variable.
+ *
+ * This function is cross-platforms and works in all the local or CI systems.
+ */
+
+export async function addEnv(
+  name: string,
+  valGiven: string | undefined,
+  givenOptions: Partial<AddEnvOptions> = {},
+) {
+  const options = {
+    shouldEscapeSpace: false,
+    shouldAddOnlyIfNotDefined: false,
+    rcPath: untildifyUser(".bashrc"),
+    ...givenOptions,
+  }
+
+  const val = escapeString(valGiven ?? "", options.shouldEscapeSpace)
+  try {
+    if (GITHUB_ACTIONS) {
+      try {
+        if (options.shouldAddOnlyIfNotDefined) {
+          if (process.env[name] !== undefined) {
+            info(`Environment variable ${name} is already defined. Skipping.`)
+            return
+          }
+        }
+        ghExportVariable(name, val)
+      } catch (err) {
+        error(err as Error)
+        await addEnvSystem(name, val, options)
+      }
+    } else {
+      await addEnvSystem(name, val, options)
+    }
+  } catch (err) {
+    error(`${err}\nFailed to export environment variable ${name}=${val}. You should add it manually.`)
+  }
+}
+
+async function addEnvSystem(name: string, valGiven: string | undefined, options: AddEnvOptions) {
+  const val = valGiven ?? ""
+  switch (process.platform) {
+    case "win32": {
+      if (options.shouldAddOnlyIfNotDefined) {
+        if (process.env[name] !== undefined) {
+          info(`Environment variable ${name} is already defined. Skipping.`)
+          return
+        }
+      }
+      // We do not use `execaSync(`setx PATH "${path};%PATH%"`)` because of its character limit
+      await execPowershell(`[Environment]::SetEnvironmentVariable('${name}', '${val}', "User")`)
+      info(`${name}='${val}' was set in the environment.`)
+      return
+    }
+    case "linux":
+    case "darwin": {
+      await sourceRC(options.rcPath)
+      if (options.shouldAddOnlyIfNotDefined) {
+        await appendFile(options.rcPath, `\nif [ -z "\${${name}}" ]; then export ${name}="${val}"; fi\n`)
+        info(`if not defined ${name} then ${name}="${val}" was added to "${options.rcPath}`)
+      } else {
+        await appendFile(options.rcPath, `\nexport ${name}="${val}"\n`)
+        info(`${name}="${val}" was added to "${options.rcPath}`)
+      }
+      return
+    }
+    default: {
+      // fall through shell path modification
+    }
+  }
+  process.env[name] = val
+}

dist/legacy/setup-cpp.js.map

@@ -0,0 +1,79 @@
+import { promises } from "fs"
+import { delimiter } from "path"
+import { addPath as ghAddPath } from "@actions/core"
+import { GITHUB_ACTIONS } from "ci-info"
+import { error, info } from "ci-log"
+import { execPowershell } from "exec-powershell"
+import { untildifyUser } from "untildify-user"
+import { sourceRC } from "./rc-file.js"
+const { appendFile } = promises
+
+type AddPathOptions = {
+  /**
+   * The path to the RC file that the PATH variables should be added to.
+   */
+  rcPath: string
+}
+/**
+ * Add a path to the PATH environment variable.
+ *
+ * This function is cross-platforms and works in all the local or CI systems.
+ */
+
+export async function addPath(path: string, givenOptions: Partial<AddPathOptions> = {}) {
+  const options = { rcPath: untildifyUser(".bashrc"), ...givenOptions }
+
+  if (isIgnoredPath(path)) {
+    return
+  }
+
+  process.env.PATH = `${path}${delimiter}${process.env.PATH}`
+  try {
+    if (GITHUB_ACTIONS) {
+      try {
+        ghAddPath(path)
+      } catch (err) {
+        error(err as Error)
+        await addPathSystem(path, options.rcPath)
+      }
+    } else {
+      await addPathSystem(path, options.rcPath)
+    }
+  } catch (err) {
+    error(`${err}\nFailed to add ${path} to the percistent PATH. You should add it manually.`)
+  }
+}
+
+async function addPathSystem(path: string, rcPath: string) {
+  switch (process.platform) {
+    case "win32": {
+      // We do not use `execaSync(`setx PATH "${path};%PATH%"`)` because of its character limit and also because %PATH% is different for user and system
+      await execPowershell(
+        `$USER_PATH=([Environment]::GetEnvironmentVariable("PATH", "User")); [Environment]::SetEnvironmentVariable("PATH", "${path};$USER_PATH", "User")`,
+      )
+      info(`"${path}" was added to the PATH.`)
+      return
+    }
+    case "linux":
+    case "darwin": {
+      await sourceRC(rcPath)
+      await appendFile(rcPath, `\nexport PATH="${path}:$PATH"\n`)
+      info(`"${path}" was added to "${rcPath}"`)
+      return
+    }
+    default: {
+      return
+    }
+  }
+}
+
+const ignoredPaths = [/\/usr\/bin\/?/, /\/usr\/local\/bin\/?/]
+
+/** Skip adding /usr/bin to PATH if it is already there */
+function isIgnoredPath(path: string) {
+  if (ignoredPaths.some((checkedPath) => checkedPath.test(path))) {
+    const paths = process.env.PATH?.split(delimiter) ?? []
+    return paths.includes(path)
+  }
+  return false
+}