Class MakerAppImage

An AppImage maker for Electron Forge.

See Readme.md file distributed in subproject's root dir for more information and documentation of supported env variables. See JSDoc/TSDoc/TypeDoc documentation (this ones!) for supported configuration options.

Example

{
  name: "@reforged/maker-appimage",
  config: {
    options: {
      // Package name.
      name: "example-app",
      // Executable name.
      bin: "app",
      // Human-friendly name of the application.
      productName: "Example Electron Application",
      // `GenericName` in generated `.desktop` file.
      genericName: "Example application",
      // Path to application's icon.
      icon: "/path/to/icon.png",
      // Desktop file to be used instead of the configuration above.
      desktopFile: "/path/to/example-app.desktop",
      // Release of `AppImage/AppImageKit`, either number or "continuous".
      AppImageKitRelease: "continuous",
      // Support parsing Arch Linux '*_flags.conf' file.
      flagsFile: "true"
    }
  }
}

Hierarchy (View Summary)

Constructors

constructor

Properties

config defaultPlatforms isSupportedOnCurrentPlatform name platformsToMakeOn? requiredExternalBinaries

Accessors

platforms

Methods

clone ensureDirectory ensureExternalBinariesExist ensureFile externalBinariesExist isInstalled make normalizeWindowsVersion prepareConfig

Constructors

constructor

  • new MakerAppImage(
        configOrConfigFetcher?:
            | MakerAppImageConfig
            | (arch: string) => MakerAppImageConfig,
        platformsToMakeOn?: string[],
    ): MakerAppImage

  • Parameters

    • OptionalconfigOrConfigFetcher: MakerAppImageConfig | (arch: string) => MakerAppImageConfig

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

    • OptionalplatformsToMakeOn: string[]

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

    Returns MakerAppImage

Properties

config

config: MakerAppImageConfig

defaultPlatforms

defaultPlatforms: ["linux"] = ...

isSupportedOnCurrentPlatform

isSupportedOnCurrentPlatform: () => true = ...

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.

name

name: "AppImage" = ...

Protected OptionalplatformsToMakeOn

platformsToMakeOn?: string[]

requiredExternalBinaries

requiredExternalBinaries: ["mksquashfs"] = ...

Accessors

platforms

  • get platforms(): string[]

  • Returns string[]

Methods

clone

ensureDirectory

  • ensureDirectory(dir: string): 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: string): 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: string): boolean

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

    Parameters

    • module: string

    Returns boolean

make

  • make(
        __namedParameters: MakerMeta,
        ...vendorExt: unknown[],
    ): Promise<[AppImagePath: string]>

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

    Parameters

    • __namedParameters: MakerMeta
    • ...vendorExt: unknown[]

    Returns Promise<[AppImagePath: string]>

normalizeWindowsVersion

  • normalizeWindowsVersion(version: string): 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: string): Promise<void>

  • Parameters

    • targetArch: string

    Returns Promise<void>

Settings

On This Page

Constructors
Properties
Accessors
Methods