fix: allow partial options for setup tools

aminya · aminya · commit 26bd7cda4515 · 2025-07-10T06:59:25.000-07:00
diff --git a/dist/legacy/setup-cpp.js b/dist/legacy/setup-cpp.js
diff --git a/dist/legacy/setup-cpp.js.map b/dist/legacy/setup-cpp.js.map
diff --git a/dist/modern/setup-cpp.mjs b/dist/modern/setup-cpp.mjs
diff --git a/dist/modern/setup-cpp.mjs.map b/dist/modern/setup-cpp.mjs.map
diff --git a/packages/setup-apt/src/nala.ts b/packages/setup-apt/src/nala.ts
@@ -11,7 +11,7 @@ import { qualifiedNeededAptPackage } from "./qualify-install.js"
 
 let binDir: string | undefined
 
-export async function setupNala(version?: string) {
+export async function setupNala({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   if (!hasAptGet()) {
     return undefined
   }
@@ -94,3 +94,7 @@ export function bashWithNala(script: string) {
   }
   return script
 }
+function isUbuntu() {
+  throw new Error("Function not implemented.")
+}
+
diff --git a/src/actions-input.ts b/src/actions-input.ts
@@ -0,0 +1,11 @@
+import { getInput } from "@actions/core"
+
+/** Get an object from github actions */
+
+export function maybeGetInput(key: string) {
+  const value = getInput(key.toLowerCase())
+  if (value !== "false" && value !== "") {
+    return value
+  }
+  return undefined // skip installation
+}
diff --git a/src/bazel/__tests__/bazel.test.ts b/src/bazel/__tests__/bazel.test.ts
@@ -11,7 +11,7 @@ describe("setup-bazel", () => {
     return
   }
   it("should setup bazel", async () => {
-    const installInfo = await setupBazel({ version: "", setupDir: "", arch: process.arch })
+    const installInfo = await setupBazel()
 
     await testBin("bazel", ["--version"], (installInfo as InstallationInfo | undefined)?.binDir)
   })
diff --git a/src/bazel/bazel.ts b/src/bazel/bazel.ts
@@ -9,7 +9,7 @@ import { isArch } from "../utils/env/isArch.js"
 import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 
-export async function setupBazel({ version }: SetupOptions) {
+export async function setupBazel({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   switch (process.platform) {
     case "win32": {
       // install bazelisk because it contains both
diff --git a/src/ccache/__tests__/ccache.test.ts b/src/ccache/__tests__/ccache.test.ts
@@ -5,7 +5,7 @@ import { setupCcache } from "../ccache.js"
 jest.setTimeout(300000)
 describe("setup-ccache", () => {
   it("should setup ccache", async () => {
-    const installInfo = await setupCcache({ version: "", setupDir: "", arch: process.arch })
+    const installInfo = await setupCcache()
 
     await testBin("ccache", ["--version"], (installInfo as InstallationInfo | undefined)?.binDir)
   })
diff --git a/src/ccache/ccache.ts b/src/ccache/ccache.ts
@@ -8,7 +8,7 @@ import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
 
-export async function setupCcache({ version }: SetupOptions) {
+export async function setupCcache({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   switch (process.platform) {
     case "win32": {
       return setupChocoPack("ccache", version)
diff --git a/src/cmakelang/__tests__/cmakelang.test.ts b/src/cmakelang/__tests__/cmakelang.test.ts
@@ -8,8 +8,6 @@ describe("setup-cmakelang", () => {
   it("should setup cmakelang", async () => {
     const installInfo = await setupCmakelang({
       version: getVersion("cmakelang", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
     await testBin("cmake-lint", ["--version"], installInfo.binDir)
     await testBin("cmake-format", ["--version"], installInfo.binDir)
diff --git a/src/cmakelang/cmakelang.ts b/src/cmakelang/cmakelang.ts
@@ -1,6 +1,6 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupCmakelang({ version }: SetupOptions) {
+export function setupCmakelang({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("cmakelang[YAML]", version)
 }
diff --git a/src/compilers.ts b/src/compilers.ts
@@ -5,10 +5,10 @@ import semverValid from "semver/functions/valid"
 import { setupGcc } from "./gcc/gcc.js"
 import { setupMingw } from "./gcc/mingw.js"
 import { activateGcovGCC, activateGcovLLVM } from "./gcovr/gcovr.js"
+import { getSuccessMessage } from "./installTool.js"
 import { setupAppleClang } from "./llvm/apple-clang.js"
 import { setupLLVM } from "./llvm/llvm.js"
 import { setupMSVC } from "./msvc/msvc.js"
-import { getSuccessMessage } from "./options.js"
 import { appleClangSetups, gccSetups, llvmSetups, mingwSetups, msvcSetups } from "./tool.js"
 import type { InstallationInfo } from "./utils/setup/setupBin.js"
 import { getVersion } from "./versions/versions.js"
diff --git a/src/conan/__tests__/conan.test.ts b/src/conan/__tests__/conan.test.ts
@@ -5,7 +5,7 @@ import { setupConan } from "../conan.js"
 jest.setTimeout(300000)
 describe("setup-conan", () => {
   it("should setup conan", async () => {
-    const installInfo = await setupConan({ version: getVersion("conan", "true"), setupDir: "", arch: process.arch })
+    const installInfo = await setupConan({ version: getVersion("conan", "true") })
 
     await testBin("conan", ["--version"], installInfo.binDir)
   })
diff --git a/src/conan/conan.ts b/src/conan/conan.ts
@@ -1,6 +1,6 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupConan({ version }: SetupOptions) {
+export function setupConan({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("conan", version)
 }
diff --git a/src/cppcheck/__tests__/cppcheck.test.ts b/src/cppcheck/__tests__/cppcheck.test.ts
@@ -9,8 +9,6 @@ describe("setup-cppcheck", () => {
     if (process.platform !== "win32") {
       const installInfo = await setupCppcheck({
         version: getVersion("cppcheck", undefined),
-        setupDir: "",
-        arch: process.arch,
       })
 
       await testBin("cppcheck", ["--version"], installInfo.binDir)
diff --git a/src/cppcheck/cppcheck.ts b/src/cppcheck/cppcheck.ts
@@ -10,7 +10,7 @@ import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
 
-export async function setupCppcheck({ version }: SetupOptions) {
+export async function setupCppcheck({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   switch (process.platform) {
     case "win32": {
       await setupChocoPack("cppcheck", version)
diff --git a/src/cpplint/__tests__/cpplint.test.ts b/src/cpplint/__tests__/cpplint.test.ts
@@ -8,8 +8,6 @@ describe("setup-cpplint", () => {
   it("should setup cpplint", async () => {
     const installInfo = await setupCpplint({
       version: getVersion("cpplint", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
     await testBin("cpplint", ["--version"], installInfo.binDir)
   })
diff --git a/src/cpplint/cpplint.ts b/src/cpplint/cpplint.ts
@@ -1,7 +1,7 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupCpplint({ version }: SetupOptions) {
+export function setupCpplint({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("cpplint", version, {
     pythonVersion: ">=3.8.0",
   })
diff --git a/src/doxygen/doxygen.ts b/src/doxygen/doxygen.ts
@@ -74,7 +74,7 @@ export async function setupDoxygen({ version, setupDir, arch }: SetupOptions) {
       )
       const binDir = await activateWinDoxygen()
       const installationInfo = { binDir }
-      await setupGraphviz({ version: getVersion("graphviz", undefined), setupDir, arch })
+      await setupGraphviz({ version: getVersion("graphviz", undefined) })
       return installationInfo
     }
     case "darwin": {
@@ -89,13 +89,13 @@ export async function setupDoxygen({ version, setupDir, arch }: SetupOptions) {
 
       // only install graphviz if the macOS version is greater than 11
       if (macosVersion()[0] > 11) {
-        await setupGraphviz({ version: getVersion("graphviz", undefined), setupDir, arch })
+        await setupGraphviz({ version: getVersion("graphviz", undefined) })
       }
       return installationInfo
     }
     case "linux": {
       const installationInfo = await setupLinuxDoxygen({ version, setupDir, arch })
-      await setupGraphviz({ version: getVersion("graphviz", undefined, await ubuntuVersion()), setupDir, arch })
+      await setupGraphviz({ version: getVersion("graphviz", undefined, await ubuntuVersion()) })
       return installationInfo
     }
     default: {
diff --git a/src/flawfinder/__tests__/flawfinder.test.ts b/src/flawfinder/__tests__/flawfinder.test.ts
@@ -8,8 +8,6 @@ describe("setup-flawfinder", () => {
   it("should setup flawfinder", async () => {
     const installInfo = await setupFlawfinder({
       version: getVersion("flawfinder", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
     await testBin("flawfinder", ["--version"], installInfo.binDir)
   })
diff --git a/src/flawfinder/flawfinder.ts b/src/flawfinder/flawfinder.ts
@@ -1,6 +1,6 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupFlawfinder({ version }: SetupOptions) {
+export function setupFlawfinder({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("flawfinder", version)
 }
diff --git a/src/gcovr/__tests__/gcovr.test.ts b/src/gcovr/__tests__/gcovr.test.ts
@@ -8,8 +8,6 @@ describe("setup-gcovr", () => {
   it("should setup gcovr", async () => {
     const installInfo = await setupGcovr({
       version: getVersion("gcovr", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
     await testBin("gcovr", ["--version"], installInfo.binDir)
   })
diff --git a/src/gcovr/gcovr.ts b/src/gcovr/gcovr.ts
@@ -6,7 +6,7 @@ import { rcOptions } from "../options.js"
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupGcovr({ version }: SetupOptions) {
+export function setupGcovr({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   if (hasAptGet() && (version === undefined || version === "")) {
     // use apt on Ubuntu/Debian if version is not specified
     return installAptPack([{ name: "gcovr", version }])
diff --git a/src/git/__tests__/git.test.ts b/src/git/__tests__/git.test.ts
@@ -5,7 +5,7 @@ import { setupGit } from "../git.js"
 jest.setTimeout(300000)
 describe("setup-git", () => {
   it("should setup git", async () => {
-    const installInfo = await setupGit({ version: "", setupDir: "", arch: process.arch })
+    const installInfo = await setupGit()
 
     await testBin("git", ["--version"], (installInfo as InstallationInfo | undefined)?.binDir)
   })
diff --git a/src/git/git.ts b/src/git/git.ts
@@ -14,7 +14,7 @@ import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
 
-export async function setupGit({ version }: SetupOptions) {
+export async function setupGit({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   const git = await which("git", { nothrow: true })
   if (git !== null) {
     info(`Git already installed at ${git}`)
diff --git a/src/graphviz/__tests__/graphviz.test.ts b/src/graphviz/__tests__/graphviz.test.ts
@@ -1,7 +1,7 @@
 import { macosVersion } from "../../utils/env/macos_version.js"
 import { ubuntuVersion } from "../../utils/env/ubuntu_version.js"
 import type { InstallationInfo } from "../../utils/setup/setupBin.js"
-import { cleanupTmpDir, setupTmpDir, testBin } from "../../utils/tests/test-helpers.js"
+import { cleanupTmpDir, testBin } from "../../utils/tests/test-helpers.js"
 import { getVersion } from "../../versions/versions.js"
 import { setupGraphviz } from "../graphviz.js"
 
@@ -12,16 +12,9 @@ describe("setup-graphviz", () => {
     return
   }
 
-  let directory: string
-  beforeAll(async () => {
-    directory = await setupTmpDir("graphviz")
-  })
-
   it("should setup graphviz", async () => {
     const installInfo = await setupGraphviz({
       version: getVersion("graphviz", undefined, await ubuntuVersion()),
-      setupDir: directory,
-      arch: process.arch,
     })
 
     await testBin("dot", ["-V"], (installInfo as InstallationInfo | undefined)?.binDir)
diff --git a/src/graphviz/graphviz.ts b/src/graphviz/graphviz.ts
@@ -11,7 +11,7 @@ import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
 
-export async function setupGraphviz({ version }: SetupOptions) {
+export async function setupGraphviz({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   switch (process.platform) {
     case "win32": {
       await setupChocoPack("graphviz", version)
diff --git a/src/installTool.ts b/src/installTool.ts
@@ -2,7 +2,7 @@ import { join } from "path"
 import { endGroup, startGroup } from "@actions/core"
 import { error } from "ci-log"
 import { setupBrew } from "setup-brew"
-import { getSuccessMessage, rcOptions } from "./options.js"
+import { rcOptions } from "./options.js"
 import { type ToolName, llvmTools, setups } from "./tool.js"
 import type { InstallationInfo } from "./utils/setup/setupBin.js"
 import { setupVCVarsall } from "./vcvarsall/vcvarsall.js"
@@ -66,3 +66,17 @@ async function installToolImpl(
   // preparing a report string
   successMessages.push(getSuccessMessage(tool, installationInfo))
 }
+
+export function getSuccessMessage(tool: string, installationInfo: InstallationInfo | undefined | void) {
+  let msg = `✅ ${tool} was installed successfully:`
+  if (installationInfo === undefined) {
+    return msg
+  }
+  if ("installDir" in installationInfo) {
+    msg += `\n- The installation directory is ${installationInfo.installDir}`
+  }
+  if (installationInfo.binDir !== "") {
+    msg += `\n- The binary directory is ${installationInfo.binDir}`
+  }
+  return msg
+}
diff --git a/src/lib.ts b/src/lib.ts
@@ -20,7 +20,6 @@ import { syncVersions } from "./versions/versions.js"
 // re-export for the setup-cpp CLI
 export { GITHUB_ACTIONS } from "ci-info"
 export * from "ci-log"
-export { maybeGetInput, type Opts } from "./options.js"
 export { type Inputs, inputs } from "./tool.js"
 
 /**
diff --git a/src/lizard/__tests__/lizard.test.ts b/src/lizard/__tests__/lizard.test.ts
@@ -8,8 +8,6 @@ describe("setup-lizard", () => {
   it("should setup lizard", async () => {
     const installInfo = await setupLizard({
       version: getVersion("lizard", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
     await testBin("lizard", ["--version"], installInfo.binDir)
   })
diff --git a/src/lizard/lizard.ts b/src/lizard/lizard.ts
@@ -1,6 +1,6 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupLizard({ version }: SetupOptions) {
+export function setupLizard({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("lizard", version)
 }
diff --git a/src/llvm/llvm.ts b/src/llvm/llvm.ts
@@ -56,7 +56,7 @@ async function setupLLVMOnly(
     return apkInstallInfo
   }
 
-  const brewInstallInfo = await trySetupLLVMBrew({ version, setupDir, arch })
+  const brewInstallInfo = await trySetupLLVMBrew({ version })
   if (brewInstallInfo !== undefined) {
     return brewInstallInfo
   }
diff --git a/src/llvm/llvm_brew_installer.ts b/src/llvm/llvm_brew_installer.ts
@@ -5,20 +5,20 @@ import { rcOptions } from "../options.ts"
 import type { SetupOptions } from "../setup-options.ts"
 import { majorLLVMVersion } from "./utils.ts"
 
-export async function trySetupLLVMBrew({ version, setupDir, arch }: SetupOptions) {
+export async function trySetupLLVMBrew({ version }: Pick<SetupOptions, "version">) {
   if (process.platform !== "darwin") {
     return Promise.resolve(undefined)
   }
 
   try {
-    return await setupLLVMBrew({ version, setupDir, arch })
+    return await setupLLVMBrew({ version })
   } catch (err) {
     info(`Failed to install llvm via brew: ${err}`)
     return undefined
   }
 }
 
-export async function setupLLVMBrew({ version }: SetupOptions) {
+export async function setupLLVMBrew({ version }: Pick<SetupOptions, "version">) {
   const majorVersion = majorLLVMVersion(version)
 
   // install llvm via brew if a bottle is available for it
diff --git a/src/make/__tests__/make.test.ts b/src/make/__tests__/make.test.ts
@@ -5,7 +5,7 @@ import { setupMake } from "../make.js"
 jest.setTimeout(300000)
 describe("setup-make", () => {
   it("should setup make", async () => {
-    const installInfo = await setupMake({ version: "", setupDir: "", arch: process.arch })
+    const installInfo = await setupMake()
 
     await testBin("make", ["--version"], (installInfo as InstallationInfo | undefined)?.binDir)
   })
diff --git a/src/make/make.ts b/src/make/make.ts
@@ -11,7 +11,7 @@ import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 import { setupDnfPack } from "../utils/setup/setupDnfPack.js"
 import { setupPacmanPack } from "../utils/setup/setupPacmanPack.js"
 
-export async function setupMake({ version }: SetupOptions) {
+export async function setupMake({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   switch (process.platform) {
     case "win32": {
       return setupChocoPack("make", version)
diff --git a/src/meson/__tests__/meson.test.ts b/src/meson/__tests__/meson.test.ts
@@ -8,8 +8,6 @@ describe("setup-meson", () => {
   it("should setup meson", async () => {
     const installInfo = await setupMeson({
       version: getVersion("meson", "true", await ubuntuVersion()),
-      setupDir: "",
-      arch: process.arch,
     })
 
     await testBin("meson", ["--version"], installInfo.binDir)
diff --git a/src/meson/meson.ts b/src/meson/meson.ts
@@ -1,6 +1,6 @@
 import type { SetupOptions } from "../setup-options.js"
 import { setupPipPack } from "../utils/setup/setupPipPack.js"
 
-export function setupMeson({ version }: SetupOptions) {
+export function setupMeson({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   return setupPipPack("meson", version)
 }
diff --git a/src/opencppcoverage/__tests__/opencppcoverage.test.ts b/src/opencppcoverage/__tests__/opencppcoverage.test.ts
@@ -8,7 +8,7 @@ describe("setup-OpenCppCoverage", () => {
     return
   }
   it("should setup OpenCppCoverage", async () => {
-    const installationInfo = await setupOpencppcoverage({ version: "", setupDir: "", arch: process.arch })
+    const installationInfo = await setupOpencppcoverage()
 
     await testBin("OpenCppCoverage", null, installationInfo?.binDir) // OpenCppCoverage exits with non-zero even with --help
   })
diff --git a/src/opencppcoverage/opencppcoverage.ts b/src/opencppcoverage/opencppcoverage.ts
@@ -3,7 +3,7 @@ import { rcOptions } from "../options.js"
 import type { SetupOptions } from "../setup-options.js"
 import { setupChocoPack } from "../utils/setup/setupChocoPack.js"
 
-export async function setupOpencppcoverage({ version }: SetupOptions) {
+export async function setupOpencppcoverage({ version }: Partial<Pick<SetupOptions, "version">> = {}) {
   if (process.platform !== "win32") {
     return
   }
diff --git a/src/options.ts b/src/options.ts
diff --git a/src/powershell/powershell.ts b/src/powershell/powershell.ts
diff --git a/src/sccache/__tests__/sccache.test.ts b/src/sccache/__tests__/sccache.test.ts
diff --git a/src/sccache/sccache.ts b/src/sccache/sccache.ts
diff --git a/src/setup-cpp.ts b/src/setup-cpp.ts
diff --git a/src/sevenzip/__tests__/sevenzip.test.ts b/src/sevenzip/__tests__/sevenzip.test.ts
diff --git a/src/sevenzip/sevenzip.ts b/src/sevenzip/sevenzip.ts
diff --git a/src/tool.ts b/src/tool.ts
diff --git a/src/utils/setup/extract.ts b/src/utils/setup/extract.ts
diff --git a/src/utils/setup/setupBin.ts b/src/utils/setup/setupBin.ts
diff --git a/src/vcpkg/vcpkg.ts b/src/vcpkg/vcpkg.ts

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import { qualifiedNeededAptPackage } from "./qualify-install.js"`
`11`	`11`
`12`	`12`	`let binDir: string \| undefined`
`13`	`13`
`14`		`-export async function setupNala(version?: string) {`
	`14`	`+export async function setupNala({ version }: Partial<Pick<SetupOptions, "version">> = {}) {`
`15`	`15`	`if (!hasAptGet()) {`
`16`	`16`	`return undefined`
`17`	`17`	`}`
`@@ -94,3 +94,7 @@ export function bashWithNala(script: string) {`
`94`	`94`	`}`
`95`	`95`	`return script`
`96`	`96`	`}`
	`97`	`+function isUbuntu() {`
	`98`	`+ throw new Error("Function not implemented.")`
	`99`	`+}`
	`100`	`+`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ describe("setup-bazel", () => {`
`11`	`11`	`return`
`12`	`12`	`}`
`13`	`13`	`it("should setup bazel", async () => {`
`14`		`- const installInfo = await setupBazel({ version: "", setupDir: "", arch: process.arch })`
	`14`	`+ const installInfo = await setupBazel()`
`15`	`15`
`16`	`16`	`await testBin("bazel", ["--version"], (installInfo as InstallationInfo \| undefined)?.binDir)`
`17`	`17`	`})`