app builder lib.Interface.CommonConfiguration

Electron-Builder / app-builder-lib / CommonConfiguration

配置选项

继承自¶

配置

属性¶

apk?¶

readonly optional apk: null | LinuxTargetSpecificOptions

appId?¶

readonly optional appId: null | string

应用程序 ID。用作 CFBundleIdentifier for MacOS 和作为 Application User Model ID for Windows (仅限 NSIS 目标，不支持 Squirrel.Windows)。强烈建议设置显式 ID。

默认¶

com.electron.${name}

appImage?¶

readonly optional appImage: null | AppImageOptions

AppImage 选项。

appx?¶

readonly optional appx: null | AppXOptions

buildDependenciesFromSource?¶

optional buildDependenciesFromSource: boolean

是否从源代码构建应用程序原生依赖项。

默认¶

false

buildNumber?¶

readonly optional buildNumber: null | string

构建号。映射到 Linux 上使用 FPM 构建的 --iteration 标志。如果未定义，则将回退到 BUILD_NUMBER 或 TRAVIS_BUILD_NUMBER 或 APPVEYOR_BUILD_NUMBER 或 CIRCLE_BUILD_NUM 或 BUILD_BUILDNUMBER 或 CI_PIPELINE_IID 环境变量。

buildVersion?¶

readonly optional buildVersion: null | string

构建版本。映射到 macOS 上的 CFBundleVersion 和 Windows 上的 FileVersion 元数据属性。默认为 version。如果未定义 buildVersion 且定义了 buildNumber（或其中一个 buildNumber 环境变量），它将用作构建版本 (version.buildNumber)。

copyright?¶

readonly optional copyright: null | string

应用程序的人类可读版权行。

默认¶

Copyright © year ${author}

deb?¶

readonly optional deb: null | DebOptions

Debian 软件包选项。

directories?¶

readonly optional directories: null | MetadataDirectories

构建资源的目录

dmg?¶

readonly optional dmg: null | DmgOptions

macOS DMG 选项。

downloadAlternateFFmpeg?¶

readonly optional downloadAlternateFFmpeg: boolean

是否从 Electron 的发布资产下载备用 FFmpeg 库，并在签名之前替换默认的 FFmpeg 库

electronFuses?¶

readonly optional electronFuses: null | FuseOptionsV1

传递给 @electron/fuses 的选项参考：https://github.com/electron/fuses

extraMetadata?¶

readonly optional extraMetadata: any

将属性注入到 package.json。

flatpak?¶

readonly optional flatpak: null | FlatpakOptions

Flatpak 选项。

forceCodeSigning?¶

readonly optional forceCodeSigning: boolean

如果应用程序未签名是否失败（以防止在代码签名配置不正确时出现未签名的应用程序）。

默认¶

false

freebsd?¶

readonly optional freebsd: null | LinuxTargetSpecificOptions

includePdb?¶

readonly optional includePdb: boolean

是否包含 PDB 文件。

默认¶

false

linux?¶

readonly optional linux: null | LinuxConfiguration

与如何构建 Linux 目标相关的选项。

mac?¶

readonly optional mac: null | MacConfiguration

与如何构建 macOS 目标相关的选项。

mas?¶

readonly optional mas: null | MasConfiguration

MAS (Mac Application Store) 选项。

masDev?¶

readonly optional masDev: null | MasConfiguration

MAS（Mac 应用程序商店）开发选项（mas-dev 目标）。

nativeRebuilder?¶

readonly optional nativeRebuilder: null | "legacy" | "sequential" | "parallel"

使用旧版 app-builder 二进制文件安装原生依赖项，或在顺序或并行编译模式下使用 @electron/rebuild。

默认¶

sequential

nodeGypRebuild?¶

readonly optional nodeGypRebuild: boolean

是否在开始打包应用程序之前执行 node-gyp rebuild。

不要使用 npm（也不要使用 .npmrc）来配置 electron 标头。请改用 electron-builder node-gyp-rebuild。

默认¶

false

npmArgs?¶

readonly optional npmArgs: null | string | string[]

安装应用程序原生依赖项时要使用的其他命令行参数。

npmRebuild?¶

readonly optional npmRebuild: boolean

是否在开始打包应用程序之前重建原生依赖项。

默认¶

true

nsis?¶

readonly optional nsis: null | NsisOptions

nsisWeb?¶

readonly optional nsisWeb: null | NsisWebOptions

p5p?¶

readonly optional p5p: null | LinuxTargetSpecificOptions

pacman?¶

readonly optional pacman: null | LinuxTargetSpecificOptions

pkg?¶

readonly optional pkg: null | PkgOptions

macOS PKG 选项。

portable?¶

readonly optional portable: null | PortableOptions

productName?¶

readonly optional productName: null | string

与 name 相同，但允许您为可执行文件指定产品名称，其中包含空格和 name 属性中不允许的其他特殊字符。如果在 build 配置中未指定，则使用 package.json 顶层定义的 productName 属性。如果在 package.json 顶层未指定，则使用 name 属性。

removePackageKeywords?¶

readonly optional removePackageKeywords: boolean

是否从 package.json 文件中删除 keywords 字段。

默认¶

true

removePackageScripts?¶

readonly optional removePackageScripts: boolean

是否从 package.json 文件中删除 scripts 字段。

默认¶

true

rpm?¶

readonly optional rpm: null | LinuxTargetSpecificOptions

snap?¶

readonly optional snap: null | SnapOptions

Snap 选项。

squirrelWindows?¶

readonly optional squirrelWindows: null | SquirrelWindowsOptions

win?¶

readonly optional win: null | WindowsConfiguration

与如何构建 Windows 目标相关的选项。