Class BaseDependencyManager`Abstract`

Base class for dependency managers that download and manage CLI tools Common functionality for downloading, checking versions, and managing executables

Hierarchy (View Summary)

ShellRunner
- BaseDependencyManager

Constructors

`Protected`constructor

new BaseDependencyManager(
    downloader: PackageDownloader,
    installationDirectory: string,
    osPlatform: Platform,
    osArch: string,
    requiredVersion: string,
    executableName: string,
    downloadBaseUrl: string,
): BaseDependencyManager
Parameters
- downloader: PackageDownloader
- installationDirectory: string
- osPlatform: Platform
- osArch: string
- requiredVersion: string
- executableName: string
- downloadBaseUrl: string
Returns BaseDependencyManager
Overrides ShellRunner.constructor
- Defined in src/core/dependency-managers/base-dependency-manager.ts:28

Properties

`Protected` `Readonly`artifactName

artifactName: string

`Protected` `Readonly`checksumURL

checksumURL: string

`Protected` `Readonly`downloadBaseUrl

downloadBaseUrl: string

`Protected` `Readonly`downloader

downloader: PackageDownloader

`Protected` `Readonly`downloadURL

downloadURL: string

`Protected` `Readonly`executableName

executableName: string

`Protected`globalExecutablePath

globalExecutablePath: string = ''

`Protected` `Readonly`installationDirectory

installationDirectory: string

`Protected`localExecutablePath

localExecutablePath: string

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`osArch

osArch: string

`Protected` `Readonly`osPlatform

osPlatform: string

`Protected` `Readonly`requiredVersion

requiredVersion: string

Methods

`Protected`getArch

getArch(): string
Returns string
- Defined in src/core/dependency-managers/base-dependency-manager.ts:58

`Protected` `Abstract`getArtifactName

getArtifactName(): string
Child classes must implement this to generate the correct artifact name based on version, platform, and architecture

Returns string
- Defined in src/core/dependency-managers/base-dependency-manager.ts:72

`Protected` `Abstract`getChecksumURL

getChecksumURL(): string
Get the checksum URL for the executable

Returns string
- Defined in src/core/dependency-managers/base-dependency-manager.ts:82

`Protected` `Abstract`getDownloadURL

getDownloadURL(): string
Get the download URL for the executable

Returns string
- Defined in src/core/dependency-managers/base-dependency-manager.ts:77

getExecutablePath

getExecutablePath(): Promise<string>
Get the path to the executable (global or local)

Returns Promise<string>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:95

getRequiredVersion

getRequiredVersion(): string
Get the tool's required version

Returns string
- Defined in src/core/dependency-managers/base-dependency-manager.ts:246

getVerifyChecksum

getVerifyChecksum(): boolean
Determine if checksum verification should be performed Child classes can override this if needed

Returns boolean
- Defined in src/core/dependency-managers/base-dependency-manager.ts:181

`Abstract`getVersion

getVersion(executablePath: string): Promise<string>
Parameters
- executablePath: string
Returns Promise<string>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:84

install

install(temporaryDirectory?: string): Promise<boolean>
Install the tool
Parameters
- temporaryDirectory: string = ...
Returns Promise<boolean>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:188

installationMeetsRequirements

installationMeetsRequirements(path: string): Promise<boolean>
Check if the given installation meets version requirements
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:129

isInstalledLocally

isInstalledLocally(): boolean
Check if the tool is installed locally

Returns boolean
- Defined in src/core/dependency-managers/base-dependency-manager.ts:151

`Protected`preInstall

preInstall(): Promise<void>
Hook for any pre-installation steps

Returns Promise<void>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:167

`Protected` `Abstract`processDownloadedPackage

processDownloadedPackage(
packageFilePath: string,
temporaryDirectory: string,
): Promise<string[]>
Handle any post-download processing before copying to destination Child classes can override this for custom extraction or processing
Parameters
- packageFilePath: string
- temporaryDirectory: string
Returns Promise<string[]>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:90

run

run(
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
Returns Promise<string[]>
Inherited from ShellRunner.run
- Defined in src/core/shell-runner.ts:17

setupConfig

setupConfig(): void
Hook for setting up any configuration after installation Child classes can override this if needed

Returns void
- Defined in src/core/dependency-managers/base-dependency-manager.ts:254

shouldInstall

shouldInstall(): Promise<boolean>
Hook to determine if installation should proceed Child classes can override this for custom logic

Returns Promise<boolean>
- Defined in src/core/dependency-managers/base-dependency-manager.ts:173

uninstallLocal

uninstallLocal(): void
Uninstall the local version

Returns void
- Defined in src/core/dependency-managers/base-dependency-manager.ts:158

Class BaseDependencyManagerAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns BaseDependencyManager

Properties

Protected ReadonlyartifactName

Protected ReadonlychecksumURL

Protected ReadonlydownloadBaseUrl

Protected Readonlydownloader

Protected ReadonlydownloadURL

Protected ReadonlyexecutableName

ProtectedglobalExecutablePath

Protected ReadonlyinstallationDirectory

ProtectedlocalExecutablePath

Optionallogger

Protected ReadonlyosArch

Protected ReadonlyosPlatform

Protected ReadonlyrequiredVersion

Methods

ProtectedgetArch

Returns string

Protected AbstractgetArtifactName

Returns string

Protected AbstractgetChecksumURL

Returns string

Protected AbstractgetDownloadURL

Returns string

getExecutablePath

Returns Promise<string>

getRequiredVersion

Returns string

getVerifyChecksum

Returns boolean

AbstractgetVersion

Parameters

Returns Promise<string>

install

Parameters

Returns Promise<boolean>

installationMeetsRequirements

Parameters

Returns Promise<boolean>

isInstalledLocally

Returns boolean

ProtectedpreInstall

Returns Promise<void>

Protected AbstractprocessDownloadedPackage

Parameters

Returns Promise<string[]>

run

Parameters

Returns Promise<string[]>

setupConfig

Returns void

shouldInstall

Returns Promise<boolean>

uninstallLocal

Returns void

Settings

On This Page

Class BaseDependencyManager`Abstract`

`Protected`constructor

`Protected` `Readonly`artifactName

`Protected` `Readonly`checksumURL

`Protected` `Readonly`downloadBaseUrl

`Protected` `Readonly`downloader

`Protected` `Readonly`downloadURL

`Protected` `Readonly`executableName

`Protected`globalExecutablePath

`Protected` `Readonly`installationDirectory

`Protected`localExecutablePath

`Optional`logger

`Protected` `Readonly`osArch

`Protected` `Readonly`osPlatform

`Protected` `Readonly`requiredVersion

`Protected`getArch

`Protected` `Abstract`getArtifactName

`Protected` `Abstract`getChecksumURL

`Protected` `Abstract`getDownloadURL

`Abstract`getVersion

`Protected`preInstall

`Protected` `Abstract`processDownloadedPackage