Class MakerPKG

Hierarchy (view full)

Constructors

constructor

Properties

config defaultPlatforms name platformsToMakeOn? requiredExternalBinaries

Accessors

platforms

Methods

clone ensureDirectory ensureExternalBinariesExist ensureFile externalBinariesExist isInstalled isSupportedOnCurrentPlatform isValidTargetPlatform make normalizeWindowsVersion prepareConfig

Constructors

constructor

  • new MakerPKG(configOrConfigFetcher?, platformsToMakeOn?): MakerPKG

  • Parameters

    • Optional configOrConfigFetcher: MakerPKGConfig | ((arch) => MakerPKGConfig)

      Either a configuration object for this maker or a simple method that returns such a configuration for a given target architecture

    • Optional platformsToMakeOn: string[]

      If you want this maker to run on platforms different from defaultPlatforms you can provide those platforms here

    Returns MakerPKG

Properties

config

config: MakerPKGConfig

defaultPlatforms

defaultPlatforms: string[] = ...

name

name: string = 'pkg'

Protected Optional platformsToMakeOn

platformsToMakeOn?: string[]

If you want this maker to run on platforms different from defaultPlatforms you can provide those platforms here

requiredExternalBinaries

requiredExternalBinaries: string[]

Accessors

platforms

  • get platforms(): string[]

  • Returns string[]

Methods

clone

ensureDirectory

  • ensureDirectory(dir): Promise<void>

  • Ensures the directory exists and is forced to be empty.

    I.e. If the directory already exists it is deleted and recreated, this is a destructive operation

    Parameters

    • dir: string

    Returns Promise<void>

ensureExternalBinariesExist

  • ensureExternalBinariesExist(): void

  • Throws an error if any of the binaries don't exist.

    Returns void

ensureFile

  • ensureFile(file): Promise<void>

  • Ensures the path to the file exists and the file does not exist

    I.e. If the file already exists it is deleted and the path created

    Parameters

    • file: string

    Returns Promise<void>

externalBinariesExist

  • externalBinariesExist(): boolean

  • Checks if the specified binaries exist, which are required for the maker to be used.

    Returns boolean

isInstalled

  • isInstalled(module): boolean

  • Checks if the given module is installed, used for testing if optional dependencies are installed or not

    Parameters

    • module: string

    Returns boolean

isSupportedOnCurrentPlatform

  • isSupportedOnCurrentPlatform(): boolean

  • Makers must implement this method and return true or false indicating whether this maker can be run on the current platform. Normally this is just a process.platform check but it can be a deeper check for dependencies like fake-root or other required external build tools.

    If the issue is a missing dependency you should log out a HELPFUL error message telling the developer exactly what is missing and if possible how to get it.

    Returns boolean

Private isValidTargetPlatform

  • isValidTargetPlatform(platform): platform is "darwin" | "mas"

  • Parameters

    • platform: string

    Returns platform is "darwin" | "mas"

make

  • make(__namedParameters): Promise<string[]>

  • Makers must implement this method and return an array of absolute paths to the artifacts generated by your maker

    Parameters

    Returns Promise<string[]>

normalizeWindowsVersion

  • normalizeWindowsVersion(version): string

  • Normalize the given semver-formatted version to a 4-part dot delimited version number without prerelease information for use in Windows apps.

    Parameters

    • version: string

    Returns string

prepareConfig

  • prepareConfig(targetArch): Promise<void>

  • Parameters

    • targetArch: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorconfigdefaultPlatformsnameplatformsToMakeOnrequiredExternalBinariesplatformscloneensureDirectoryensureExternalBinariesExistensureFileexternalBinariesExistisInstalledisSupportedOnCurrentPlatformisValidTargetPlatformmakenormalizeWindowsVersionprepareConfig