Class VfkitDependencyManager

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

Hierarchy (View Summary)

BaseDependencyManager
- VfkitDependencyManager

Constructors

constructor

new VfkitDependencyManager(
    downloader: PackageDownloader,
    installationDirectory: string,
    osPlatform: Platform,
    osArch: string,
    vfkitVersion: string,
): VfkitDependencyManager
Parameters
- downloader: PackageDownloader
- installationDirectory: string
- osPlatform: Platform
- osArch: string
- vfkitVersion: string
Returns VfkitDependencyManager
Overrides BaseDependencyManager.constructor
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:23

Properties

`Protected`artifactFileName

artifactFileName: string

`Protected` `Readonly`artifactName

artifactName: string

`Protected`artifactVersion

artifactVersion: string

`Protected`checksum

checksum: 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`releaseBaseUrl

releaseBaseUrl: string

`Protected` `Readonly`requiredVersion

requiredVersion: string

`Protected` `Readonly`vfkitVersion

vfkitVersion: string

Methods

`Protected`getArch

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

`Protected`getArtifactName

getArtifactName(): string
Get the Vfkit artifact name based on version, OS, and architecture

Returns string
Overrides BaseDependencyManager.getArtifactName
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:60

`Protected`getChecksumURL

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

Returns string
Overrides BaseDependencyManager.getChecksumURL
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:166

`Protected`getDownloadURL

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

Returns string
Overrides BaseDependencyManager.getDownloadURL
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:154

getExecutablePath

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

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

getRequiredVersion

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

Returns string
Inherited from BaseDependencyManager.getRequiredVersion
- 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
Overrides BaseDependencyManager.getVerifyChecksum
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:53

getVersion

getVersion(executablePath: string): Promise<string>
Parameters
- executablePath: string
Returns Promise<string>
Overrides BaseDependencyManager.getVersion
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:64

install

install(temporaryDirectory?: string): Promise<boolean>
Install the tool
Parameters
- temporaryDirectory: string = ...
Returns Promise<boolean>
Inherited from BaseDependencyManager.install
- 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>
Inherited from BaseDependencyManager.installationMeetsRequirements
- Defined in src/core/dependency-managers/base-dependency-manager.ts:129

isInstalledLocally

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

Returns boolean
Inherited from BaseDependencyManager.isInstalledLocally
- 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>
Overrides BaseDependencyManager.preInstall
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:146

`Protected`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[]>
Overrides BaseDependencyManager.processDownloadedPackage
- Defined in src/core/dependency-managers/vfkit-dependency-manager.ts:162

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 BaseDependencyManager.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
Inherited from BaseDependencyManager.setupConfig
- 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>
Inherited from BaseDependencyManager.shouldInstall
- Defined in src/core/dependency-managers/base-dependency-manager.ts:173

uninstallLocal

uninstallLocal(): void
Uninstall the local version

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

Class VfkitDependencyManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VfkitDependencyManager

Properties

ProtectedartifactFileName

Protected ReadonlyartifactName

ProtectedartifactVersion

Protectedchecksum

Protected ReadonlychecksumURL

Protected ReadonlydownloadBaseUrl

Protected Readonlydownloader

Protected ReadonlydownloadURL

Protected ReadonlyexecutableName

ProtectedglobalExecutablePath

Protected ReadonlyinstallationDirectory

ProtectedlocalExecutablePath

Optionallogger

Protected ReadonlyosArch

Protected ReadonlyosPlatform

ProtectedreleaseBaseUrl

Protected ReadonlyrequiredVersion

Protected ReadonlyvfkitVersion

Methods

ProtectedgetArch

Returns string

ProtectedgetArtifactName

Returns string

ProtectedgetChecksumURL

Returns string

ProtectedgetDownloadURL

Returns string

getExecutablePath

Returns Promise<string>

getRequiredVersion

Returns string

getVerifyChecksum

Returns boolean

getVersion

Parameters

Returns Promise<string>

install

Parameters

Returns Promise<boolean>

installationMeetsRequirements

Parameters

Returns Promise<boolean>

isInstalledLocally

Returns boolean

ProtectedpreInstall

Returns Promise<void>

ProtectedprocessDownloadedPackage

Parameters

Returns Promise<string[]>

run

Parameters

Returns Promise<string[]>

setupConfig

Returns void

shouldInstall

Returns Promise<boolean>

uninstallLocal

Returns void

Settings

On This Page

`Protected`artifactFileName

`Protected` `Readonly`artifactName

`Protected`artifactVersion

`Protected`checksum

`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`releaseBaseUrl

`Protected` `Readonly`requiredVersion

`Protected` `Readonly`vfkitVersion

`Protected`getArch

`Protected`getArtifactName

`Protected`getChecksumURL

`Protected`getDownloadURL

`Protected`preInstall

`Protected`processDownloadedPackage