electron builder.Interface.WindowsConfiguration
Electron-Builder / electron-builder / WindowsConfiguration
继承自¶
属性¶
appId?¶
readonlyoptionalappId:null|string
应用程序 ID。用于 MacOS 的 CFBundleIdentifier 和 Windows 的 应用程序用户模型 ID (仅限 NSIS 目标,不支持 Squirrel.Windows)。 强烈建议显式设置 ID。
默认值¶
com.electron.${name}
继承自¶
PlatformSpecificBuildOptions.appId
artifactName?¶
readonlyoptionalartifactName:null|string
artifact 文件名模板。默认为 ${productName}-${version}.${ext}(某些目标可能具有其他默认值,请参阅相应的选项)。
继承自¶
PlatformSpecificBuildOptions.artifactName
asar?¶
readonlyoptionalasar:null|boolean|AsarOptions
是否使用 Electron 的归档格式 将应用程序的源代码打包到归档文件中。
必须解包的 Node 模块将自动检测,您无需显式设置 asarUnpack - 如果这不起作用,请提交 issue。
默认值¶
true
继承自¶
PlatformSpecificBuildOptions.asar
asarUnpack?¶
readonlyoptionalasarUnpack:null|string|string[]
相对于应用程序目录的 glob 模式,指定在创建 asar 归档时要解包的文件。
继承自¶
PlatformSpecificBuildOptions.asarUnpack
azureSignOptions?¶
readonlyoptionalazureSignOptions:null|WindowsAzureSigningConfiguration
使用 Azure 受信任签名(beta 版)的选项。不能与 signtoolOptions 结合使用,签名将默认为 Azure 受信任签名
compression?¶
readonlyoptionalcompression:null|CompressionLevel
压缩级别。 如果您想快速测试构建,store 可以显着减少构建时间。 maximum 不会导致明显的尺寸差异,但会增加构建时间。
默认值¶
normal
继承自¶
PlatformSpecificBuildOptions.compression
cscKeyPassword?¶
optionalcscKeyPassword:null|string
继承自¶
PlatformSpecificBuildOptions.cscKeyPassword
cscLink?¶
optionalcscLink:null|string
继承自¶
PlatformSpecificBuildOptions.cscLink
defaultArch?¶
readonlyoptionaldefaultArch:string
继承自¶
PlatformSpecificBuildOptions.defaultArch
detectUpdateChannel?¶
readonlyoptionaldetectUpdateChannel:boolean
是否从应用程序版本预发布组件推断更新通道。 例如,如果版本 0.12.1-alpha.1,通道将设置为 alpha。 否则为 latest。 这 *不* 适用于 github 发布,github 发布将 永远不会自动检测更新通道。
默认值¶
true
继承自¶
PlatformSpecificBuildOptions.detectUpdateChannel
disableDefaultIgnoredFiles?¶
optionaldisableDefaultIgnoredFiles:null|boolean
是否排除所有默认忽略的文件 (https://builder.electron.js.cn/contents#files) 和选项。 默认为 false。
默认值¶
false
继承自¶
PlatformSpecificBuildOptions.disableDefaultIgnoredFiles
electronLanguages?¶
readonlyoptionalelectronLanguages:string|string[]
要保留的 electron 语言环境。 默认情况下,所有 Electron 语言环境都按原样使用。
继承自¶
PlatformSpecificBuildOptions.electronLanguages
electronUpdaterCompatibility?¶
readonlyoptionalelectronUpdaterCompatibility:null|string
electron-updater 兼容性 semver 范围。
继承自¶
PlatformSpecificBuildOptions.electronUpdaterCompatibility
executableName?¶
readonlyoptionalexecutableName:null|string
可执行文件名。 默认为 productName。
继承自¶
PlatformSpecificBuildOptions.executableName
extraFiles?¶
optionalextraFiles:null|string|FileSet| (string|FileSet)[]
与 extraResources 相同,但复制到应用程序的内容目录(MacOS 为 Contents,Linux 和 Windows 为根目录)。
继承自¶
PlatformSpecificBuildOptions.extraFiles
extraResources?¶
optionalextraResources:null|string|FileSet| (string|FileSet)[]
相对于项目目录的 glob 模式,指定后,将匹配的文件或目录直接复制到应用程序的 resources 目录(MacOS 为 Contents/Resources,Linux 和 Windows 为 resources)。
文件模式(以及对 from 和 to 字段的支持)与 files 相同。
继承自¶
PlatformSpecificBuildOptions.extraResources
fileAssociations?¶
readonlyoptionalfileAssociations:FileAssociation|FileAssociation[]
文件关联。
继承自¶
PlatformSpecificBuildOptions.fileAssociations
files?¶
optionalfiles:null|string|FileSet| (string|FileSet)[]
相对于应用程序目录的 glob 模式,指定在复制文件以创建包时要包含的文件。
默认为
[
"**/*",
"!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme}",
"!**/node_modules/*/{test,__tests__,tests,powered-test,example,examples}",
"!**/node_modules/*.d.ts",
"!**/node_modules/.bin",
"!**/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}",
"!.editorconfig",
"!**/._*",
"!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}",
"!**/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}",
"!**/{appveyor.yml,.travis.yml,circle.yml}",
"!**/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}"
]
在任何情况下都不会复制开发依赖项。 您无需显式忽略它。 默认情况下不忽略隐藏文件,但所有应该忽略的文件默认情况下都会被忽略。
如果您的某些模式不是忽略的(即不是以 ! 开头),则默认模式 **/* 不会添加到您的自定义模式中。 在任何情况下,package.json 和 **/node_modules/**/*(仅复制生产依赖项)都会添加到您的自定义模式中。 在任何情况下都会添加所有默认忽略项 — 如果您配置了自己的模式,则无需重复它。
可以在平台选项中指定(例如在 mac 中)。
您还可以通过使用 FileSet 对象而不是简单的 glob 模式来指定自定义源目录和目标目录。
[
{
"from": "path/to/source",
"to": "path/to/destination",
"filter": ["**/*", "!foo/*.js"]
}
]
您也可以在 from 和 to 字段中使用 文件宏。 from 和 to 可以是文件,您可以利用此功能在打包时重命名文件。
继承自¶
PlatformSpecificBuildOptions.files
forceCodeSigning?¶
readonlyoptionalforceCodeSigning:boolean
如果应用程序未进行代码签名,是否失败。
继承自¶
PlatformSpecificBuildOptions.forceCodeSigning
generateUpdatesFilesForAllChannels?¶
readonlyoptionalgenerateUpdatesFilesForAllChannels:boolean
请参阅 使用通道构建和发布。
默认值¶
false
继承自¶
PlatformSpecificBuildOptions.generateUpdatesFilesForAllChannels
icon?¶
readonlyoptionalicon:null|string
应用程序图标的路径。
默认值¶
build/icon.ico
覆盖¶
PlatformSpecificBuildOptions.icon
legalTrademarks?¶
readonlyoptionallegalTrademarks:null|string
商标和注册商标。
protocols?¶
URL 协议方案。
继承自¶
PlatformSpecificBuildOptions.protocols
publish?¶
optionalpublish:Publish
发布者配置。 有关更多信息,请参阅自动更新。
继承自¶
PlatformSpecificBuildOptions.publish
releaseInfo?¶
readonlyoptionalreleaseInfo:ReleaseInfo
发布信息。 旨在用于命令行
-c.releaseInfo.releaseNotes="new features"
继承自¶
PlatformSpecificBuildOptions.releaseInfo
requestedExecutionLevel?¶
readonlyoptionalrequestedExecutionLevel:null|RequestedExecutionLevel
应用程序请求执行的安全级别。 不能按目标指定,仅允许在 win 中指定。
默认值¶
asInvoker
signAndEditExecutable?¶
readonlyoptionalsignAndEditExecutable:boolean
是否签名并将元数据添加到可执行文件。 高级选项。
默认值¶
true
signExts?¶
readonlyoptionalsignExts:null|string[]
也要签名的显式文件扩展名。 高级选项。
参见¶
https://github.com/electron-userland/electron-builder/issues/7329
默认值¶
null
signtoolOptions?¶
readonlyoptionalsigntoolOptions:null|WindowsSigntoolConfiguration
用于 signtool.exe 的选项。 不能与 azureSignOptions 结合使用,签名将默认为 Azure 受信任签名
target?¶
readonlyoptionaltarget:TargetConfigType
目标包类型:nsis、nsis-web (Web 安装程序)、portable ([portable]./nsis.md#portable) 无需安装的应用程序)、appx、msi、msi-wrapped、squirrel、7z、zip、tar.xz、tar.lz、tar.gz、tar.bz2、dir 列表。 AppX 包只能在 Windows 10 上构建。
要使用 Squirrel.Windows,请安装 electron-builder-squirrel-windows 依赖项。
默认值¶
nsis
覆盖¶
PlatformSpecificBuildOptions.target
verifyUpdateCodeSignature?¶
readonlyoptionalverifyUpdateCodeSignature:boolean
是否在安装前验证可用更新的签名。 发布者名称 将用于签名验证。
默认值¶
true