feat!: add guard and source RC options for os-env

Author: aminya

dist/actions/setup-cpp.js

@@ -3,8 +3,7 @@ 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 { defaultRcPath, sourceRCInRc } from "./rc-file.js"
 import { escapeString } from "./utils.js"
 const { appendFile } = promises
 
@@ -17,6 +16,8 @@ export type AddEnvOptions = {
    * The path to the RC file that the env variables should be added to.
    */
   rcPath: string
+  /** Provide a name (your tool) to add a variable guard for sourcing your rc file */
+  guard?: string
 }
 /**
  * Add an environment variable.
@@ -32,7 +33,7 @@ export async function addEnv(
   const options = {
     shouldEscapeSpace: false,
     shouldAddOnlyIfNotDefined: false,
-    rcPath: untildifyUser(".bashrc"),
+    rcPath: defaultRcPath,
     ...givenOptions,
   }
 
@@ -76,7 +77,7 @@ async function addEnvSystem(name: string, valGiven: string | undefined, options:
     }
     case "linux":
     case "darwin": {
-      await sourceRC(options.rcPath)
+      await sourceRCInRc(options)
       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}`)

dist/actions/setup-cpp.js.map

@@ -4,15 +4,16 @@ 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"
+import { defaultRcPath, sourceRCInRc } 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
+  /** Provide a name (your tool) to add a variable guard for sourcing your rc file */
+  guard?: string
 }
 /**
  * Add a path to the PATH environment variable.
@@ -21,7 +22,7 @@ type AddPathOptions = {
  */
 
 export async function addPath(path: string, givenOptions: Partial<AddPathOptions> = {}) {
-  const options = { rcPath: untildifyUser(".bashrc"), ...givenOptions }
+  const options = { rcPath: defaultRcPath, ...givenOptions }
 
   if (isIgnoredPath(path)) {
     return
@@ -34,17 +35,17 @@ export async function addPath(path: string, givenOptions: Partial<AddPathOptions
         ghAddPath(path)
       } catch (err) {
         error(err as Error)
-        await addPathSystem(path, options.rcPath)
+        await addPathSystem(path, options)
       }
     } else {
-      await addPathSystem(path, options.rcPath)
+      await addPathSystem(path, options)
     }
   } catch (err) {
     error(`${err}\nFailed to add ${path} to the percistent PATH. You should add it manually.`)
   }
 }
 
-async function addPathSystem(path: string, rcPath: string) {
+async function addPathSystem(path: string, options: AddPathOptions) {
   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
@@ -56,9 +57,9 @@ async function addPathSystem(path: string, rcPath: string) {
     }
     case "linux":
     case "darwin": {
-      await sourceRC(rcPath)
-      await appendFile(rcPath, `\nexport PATH="${path}:$PATH"\n`)
-      info(`"${path}" was added to "${rcPath}"`)
+      await sourceRCInRc(options)
+      await appendFile(options.rcPath, `\nexport PATH="${path}:$PATH"\n`)
+      info(`"${path}" was added to "${options.rcPath}"`)
       return
     }
     default: {

dist/legacy/setup-cpp.js

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

dist/legacy/setup-cpp.js.map

@@ -6,15 +6,26 @@ import { pathExists } from "path-exists"
 import { untildifyUser } from "untildify-user"
 const { appendFile, readFile, writeFile } = promises
 
-async function sourceRC_raw(rcPath: string) {
-  const sourceRcString =
-    `\n# source .cpprc if SOURCE_CPPRC is not set to 0\nif [[ "$SOURCE_CPPRC" != 0 && -f "${rcPath}" ]]; then source "${rcPath}"; fi\n`
+export const defaultRcPath = untildifyUser("~/.bashrc")
+
+export type RcOptions = {
+  /** The path to the RC file that the env variables should be added to. */
+  rcPath: string
+
+  /** Provide a name (your tool) to add a variable guard for sourcing your rc file */
+  guard?: string
+}
+
+async function sourceRCInRc_(options: RcOptions) {
+  const sourceRcString = options.guard === undefined
+    ? `source "${options.rcPath}"`
+    : `# ${options.guard}\nif [[ "$SOURCE_${options.guard.toUpperCase()}RC" != 0 && -f "${options.rcPath}" ]]; then source "${options.rcPath}"; fi`
 
   try {
     await Promise.all([
-      addRCHeader(rcPath),
-      sourceRcInProfile(sourceRcString),
-      sourceRCInBashrc(sourceRcString),
+      addRCHeader(options),
+      addSourceToTargetRc(sourceRcString, untildifyUser("~/.bashrc")),
+      addSourceToTargetRc(sourceRcString, untildifyUser("~/.profile")),
     ])
   } catch (err) {
     warning(`Failed to add ${sourceRcString} to .profile or .bashrc. You should add it manually: ${err}`)
@@ -24,52 +35,42 @@ async function sourceRC_raw(rcPath: string) {
 /**
  * handles adding conditions to source rc file from .bashrc and .profile
  */
-export const sourceRC = memoize(sourceRC_raw, { isPromise: true })
+export const sourceRCInRc = memoize(sourceRCInRc_, { isPromise: true })
 
-async function addRCHeader(rcPath: string) {
-  // a variable that prevents source_cpprc from being called from .bashrc and .profile
-  const rcHeader = "# Automatically Generated by os-env\nexport SOURCE_CPPRC=0"
+async function addRCHeader(options: RcOptions) {
+  // a variable that prevents source rc from being called from .bashrc and .profile
+  const rcHeader = options.guard === undefined
+    ? "# Automatically Generated by os-env"
+    : `# Automatically Generated by os-env ${options.guard}\nexport SOURCE_${options.guard.toUpperCase()}RC=0`
 
-  if (await pathExists(rcPath)) {
-    const rcContent = await readFile(rcPath, "utf8")
+  if (await pathExists(options.rcPath)) {
+    const rcContent = await readFile(options.rcPath, "utf8")
     if (!rcContent.includes(rcHeader)) {
       // already executed setupCppInProfile
-      await appendFile(rcPath, `\n${rcHeader}\n`)
-      info(`Added ${rcHeader} to ${rcPath}`)
+      await appendFile(options.rcPath, `\n${rcHeader}\n`)
+      info(`Added ${rcHeader} to ${options.rcPath}`)
     }
   }
 }
 
-async function sourceRCInBashrc(sourceRcString: string) {
-  const bashrcPath = untildifyUser("~/.bashrc")
-  if (await pathExists(bashrcPath)) {
-    const bashrcContent = await readFile(bashrcPath, "utf-8")
+async function addSourceToTargetRc(sourceRcString: string, targetRcPath: string) {
+  if (await pathExists(targetRcPath)) {
+    const bashrcContent = await readFile(targetRcPath, "utf-8")
     if (!bashrcContent.includes(sourceRcString)) {
-      await appendFile(bashrcPath, sourceRcString)
-      info(`${sourceRcString} was added to ${bashrcPath}`)
-    }
-  }
-}
-
-async function sourceRcInProfile(sourceRcString: string) {
-  const profilePath = untildifyUser("~/.profile")
-  if (await pathExists(profilePath)) {
-    const profileContent = await readFile(profilePath, "utf-8")
-    if (!profileContent.includes(sourceRcString)) {
-      await appendFile(profilePath, sourceRcString)
-      info(`${sourceRcString} was added to ${profilePath}`)
+      await appendFile(targetRcPath, sourceRcString)
+      info(`${sourceRcString} was added to ${targetRcPath}`)
     }
   }
 }
 
-export async function finalizeRC(rcPath: string) {
-  if (await pathExists(rcPath)) {
-    const entries = (await readFile(rcPath, "utf-8")).split("\n")
+export async function finalizeRC(rcOptions: RcOptions) {
+  if (await pathExists(rcOptions.rcPath)) {
+    const entries = (await readFile(rcOptions.rcPath, "utf-8")).split("\n")
 
     const uniqueEntries = [...new Set(entries.reverse())].reverse() // remove duplicates, keeping the latest entry
 
-    await writeFile(rcPath, uniqueEntries.join("\n"))
+    await writeFile(rcOptions.rcPath, uniqueEntries.join("\n"))
 
-    await grantUserWriteAccess(rcPath)
+    await grantUserWriteAccess(rcOptions.rcPath)
   }
 }

dist/modern/setup-cpp.js

@@ -6,7 +6,7 @@ import { readFile } from "fs/promises"
 import { addPath } from "os-env"
 import { dirname } from "patha"
 import which from "which"
-import { rcPath } from "../cli-options"
+import { rcOptions } from "../cli-options"
 
 /* eslint-disable require-atomic-updates */
 let binDir: string | undefined
@@ -48,7 +48,7 @@ export async function setupBrew(_version: string, _setupDir: string, _arch: stri
   })
 
   binDir = getBrewPath()
-  await addPath(binDir, { rcPath })
+  await addPath(binDir, rcOptions)
 
   return { binDir }
 }

dist/modern/setup-cpp.js.map

@@ -3,7 +3,7 @@ import { addPath } from "os-env"
 import { pathExists } from "path-exists"
 import { dirname } from "patha"
 import which from "which"
-import { rcPath } from "../cli-options"
+import { rcOptions } from "../cli-options"
 import type { InstallationInfo } from "../utils/setup/setupBin"
 
 /* eslint-disable require-atomic-updates */
@@ -55,7 +55,7 @@ export async function setupChocolatey(
   )
 
   const chocoPath = `${process.env.ALLUSERSPROFILE}\\chocolatey\\bin`
-  await addPath(chocoPath, { rcPath })
+  await addPath(chocoPath, rcOptions)
 
   const maybeChoco = which.sync("choco", { nothrow: true })
   if (maybeChoco !== null) {

packages/os-env/src/add-env.ts

@@ -73,4 +73,7 @@ export function getSuccessMessage(tool: string, installationInfo: InstallationIn
   return msg
 }
 
-export const rcPath = untildifyUser("~/.cpprc")
+export const rcOptions = {
+  rcPath: untildifyUser(".cpprc"),
+  guard: "cpp",
+}

packages/os-env/src/add-path.ts

@@ -3,7 +3,7 @@ import { endGroup, notice, startGroup } from "@actions/core"
 import { error, info } from "ci-log"
 import { addEnv } from "os-env"
 import semverValid from "semver/functions/valid"
-import { getSuccessMessage } from "./cli-options"
+import { getSuccessMessage, rcOptions } from "./cli-options"
 import { setupGcc, setupMingw } from "./gcc/gcc"
 import { activateGcovGCC, activateGcovLLVM } from "./gcovr/gcovr"
 import { setupLLVM } from "./llvm/llvm"
@@ -69,7 +69,7 @@ export async function installCompiler(
 
         if (hasLLVM) {
           // remove back the added CPPFLAGS of LLVM that include the LLVM headers
-          await addEnv("CPPFLAGS", "")
+          await addEnv("CPPFLAGS", "", rcOptions)
         }
 
         await activateGcovGCC(gccVersion)
@@ -92,7 +92,7 @@ export async function installCompiler(
 
         if (hasLLVM) {
           // remove the CPPFLAGS of LLVM that include the LLVM headers
-          await addEnv("CPPFLAGS", "")
+          await addEnv("CPPFLAGS", "", rcOptions)
         }
 
         successMessages.push(getSuccessMessage("msvc", installationInfo))
@@ -101,7 +101,7 @@ export async function installCompiler(
       case "appleclang":
       case "applellvm": {
         notice("Assuming apple-clang is already installed")
-        await Promise.all([addEnv("CC", "clang"), addEnv("CXX", "clang++")])
+        await Promise.all([addEnv("CC", "clang", rcOptions), addEnv("CXX", "clang++", rcOptions)])
         successMessages.push(getSuccessMessage("apple-clang", undefined))
         break
       }

packages/os-env/src/index.ts

@@ -1,5 +1,5 @@
 import { addPath } from "os-env"
-import { rcPath } from "../cli-options"
+import { rcOptions } from "../cli-options"
 import { hasDnf } from "../utils/env/hasDnf"
 import { isArch } from "../utils/env/isArch"
 import { isUbuntu } from "../utils/env/isUbuntu"
@@ -38,6 +38,6 @@ export async function setupCppcheck(version: string | undefined, _setupDir: stri
 
 async function activateWinCppcheck() {
   const binDir = "C:/Program Files/Cppcheck"
-  await addPath(binDir, { rcPath })
+  await addPath(binDir, rcOptions)
   return binDir
 }

packages/os-env/src/rc-file.ts

@@ -12,7 +12,7 @@ import { getVersion } from "../versions/versions"
 
 import { pathExists } from "path-exists"
 import retry from "retry-as-promised"
-import { rcPath } from "../cli-options"
+import { rcOptions } from "../cli-options"
 import { hasDnf } from "../utils/env/hasDnf"
 import { isArch } from "../utils/env/isArch"
 import { isUbuntu } from "../utils/env/isUbuntu"
@@ -139,7 +139,7 @@ async function activateWinDoxygen() {
         // eslint-disable-next-line no-await-in-loop
         if (await pathExists(join(binDir, "doxygen.exe"))) {
           // eslint-disable-next-line no-await-in-loop
-          await addPath(binDir, { rcPath })
+          await addPath(binDir, rcOptions)
           return binDir
         }
       }