electron-builder打包的细致介绍
开发electron客户端程序,打包是绕不开的问题。下面就我在工作中的经历乃至当前对electron-builder
的理解来分享一些心得。
根本概念
官网的定义
A complete solution to package and build a ready for distribution Electron app for macOS, Windows and Linux with “auto update” support out of the box.关于electron和electron-builder的根基部分这篇文章就跳过了,有乐趣的话可以看这篇文章
怎样使用
builder的使用和配置都是很简便的
builder配置有两种方式
package.json中直接配置使用(比力常用,我们下面着重来讲这个)
指定electron-builder.yml文件
demo地址会在文章末尾给出(demo项目中electron使用得是V2.0.7版本,当前更高得是2.0.8版本)。
下面是一个简便的package.js中带注释的配置
根基配置
"build": { // 这里是electron-builder的配置 "productName":"xxxx",//项目名 这也是生成的exe文件的前缀名 "appId": "com.xxx.xxxxx",//包名 "copyright":"xxxx",//版权 信息 "directories": { // 输出文件夹 "output": "build" }, // windows相关的配置 "win": { "icon": "xxx/icon.ico"//图标途径 } }
在配置文件中参加以上的文件之后就可以打包出来简便的<font clolor="red">文件夹</font>,文件夹必定不是我们想要的东西。下一步我们来连续讲别的配置。
打包目标准配置置
要打包成安置程序的话我们有两种方式,
使用NSIS工具对我们的文件夹再停止一次打包,打包成exe
通过electron-builder的nsis直接打包成exe,配置如下
"win": { // 更换build下选项 "icon": "build/icons/aims.ico", "target": [ { "target": "nsis" // 我们要的目标安置包 } ] },
其他平台配置
"dmg": { // macOSdmg "contents": [ ... ] }, "mac": { // mac "icon": "build/icons/icon.icns" }, "linux": { // linux "icon": "build/icons" }
nsis配置
这个要具体的讲一下,这个nsis的配置指的是安置历程的配置,其实还是很重要的,假如不配置nsis那么利用程序就会主动的安置在C盘。没有会员选中的余地,这样必定是不可的
关于nsis的配置是在build中nsis这个选项中停止配置,下面是部分nsis配置
"nsis": { "oneClick": false, // 可否一键安置 "allowElevation": true, // 同意恳求晋升。 假如为false,则会员必需使用晋升的权限从新启动安置程序。 "allowToChangeInstallationDirectory": true, // 同意修改安置名目 "installerIcon": "./build/icons/aaa.ico",// 安置图标 "uninstallerIcon": "./build/icons/bbb.ico",//卸载图标 "installerHeaderIcon": "./build/icons/aaa.ico", // 安置时头部图标 "createDesktopShortcut": true, // 创立桌面图标 "createStartMenuShortcut": true,// 创立开端菜单图标 "shortcutName": "xxxx", // 图标名称 "include": "build/script/installer.nsh", // 包括的自定义nsis足本 这个关于构建需求严厉得安置历程相当有用。 "script" : "build/script/installer.nsh" // NSIS足本的途径,用于自定义安置程序。 默许为build / installer.nsi },
关于include
和 script
到底选中哪一个 ?
在对个性化安置历程需求并不复杂,只是需要修改一下安置位置,卸载提醒等等的简便操纵倡议使用include
配置,假如你需要炫酷的安置历程,倡议使用script
停止完全自定义。
NSIS
关于处置安置包这种东西,功效非常的强大。但是学习起来并不比一门高级说话要容易。其中的神秘还要各位大佬自行摸索
这里上一些学习资源
NSIS初级篇
NSIS 打包足本根基
示例足本
NSIS论坛
关于操纵系统的配置
主如果windows中64和32位的配置
CLI参数
electron-builder --ia32 // 32位 electron-builder // 64位(默许)
nsis中配置
"win": { "icon": "build/icons/aims.ico", "target": [ { "target": "nsis", "arch": [ // 这个意思是打出来32 bit + 64 bit的包,但是要留意:这样打包出来的安置包体积比力大,所以倡议直接打32的安置包。 "x64", "ia32" ] } ] }
更新配置
下面这个是给更新用的配置,主如果为了生成lastest.yaml
配置文件
"publish": [ { "provider": "generic", // 效劳器供给商 也可以是GitHub等等 "url": "http://xxxxx/" // 效劳器地址 } ],
完全配置
根本上可用的完全的配置
"build": { "productName":"xxxx",//项目名 这也是生成的exe文件的前缀名 "appId": "com.leon.xxxxx",//包名 "copyright":"xxxx",//版权 信息 "directories": { // 输出文件夹 "output": "build" }, "nsis": { "oneClick": false, // 可否一键安置 "allowElevation": true, // 同意恳求晋升。 假如为false,则会员必需使用晋升的权限从新启动安置程序。 "allowToChangeInstallationDirectory": true, // 同意修改安置名目 "installerIcon": "./build/icons/aaa.ico",// 安置图标 "uninstallerIcon": "./build/icons/bbb.ico",//卸载图标 "installerHeaderIcon": "./build/icons/aaa.ico", // 安置时头部图标 "createDesktopShortcut": true, // 创立桌面图标 "createStartMenuShortcut": true,// 创立开端菜单图标 "shortcutName": "xxxx", // 图标名称 "include": "build/script/installer.nsh", // 包括的自定义nsis足本 }, "publish": [ { "provider": "generic", // 效劳器供给商 也可以是GitHub等等 "url": "http://xxxxx/" // 效劳器地址 } ], "files": [ "dist/electron/**/*" ], "dmg": { "contents": [ { "x": 410, "y": 150, "type": "link", "path": "/Applications" }, { "x": 130, "y": 150, "type": "file" } ] }, "mac": { "icon": "build/icons/icon.icns" }, "win": { "icon": "build/icons/aims.ico", "target": [ { "target": "nsis", "arch": [ "ia32" ] } ] }, "linux": { "icon": "build/icons" } }
命令行参数(CLI)
Commands(命令):
electron-builder build 构建命名 [default] electron-builder install-app-deps 下载app依靠 electron-builder node-gyp-rebuild 重建本人的本机代码 electron-builder create-self-signed-cert 为Windows利用程序创立自签名代码签名证书 electron-builder start 使用electronic-webpack在开发模式下运转利用程序(须臾要electron-webpack模块支撑)
Building(构建参数):
--mac, -m, -o, --macos Build for macOS, [array] --linux, -l Build for Linux [array] --win, -w, --windows Build for Windows [array] --x64 Build for x64 (64位安置包) [boolean] --ia32 Build for ia32(32位安置包) [boolean] --armv7l Build for armv7l [boolean] --arm64 Build for arm64 [boolean] --dir Build unpacked dir. Useful to test. [boolean] --prepackaged, --pd 预打包利用程序的途径(以可分发的格局打包) --projectDir, --project 项目名目的途径。 默许为当前工作名目。 --config, -c 配置文件途径。 默许为`electron-builder.yml`(或`js`,或`js5`)
Publishing(公布):
--publish, -p 公布到GitHub Releases [choices: "onTag", "onTagOrDraft", "always", "never", undefined]
<font color="red">Deprecated(废弃):</font>
--draft 请改为在GitHub公布选项中设定releaseType [boolean] --prerelease 请改为在GitHub公布选项中设定releaseType [boolean] --platform 目标平台 (请更换为选项 --mac, --win or --linux) [choices: "mac", "win", "linux", "darwin", "win32", "all", undefined] --arch 目标arch (请更换为选项 --x64 or --ia32) [choices: "ia32", "x64", "armv7l", "arm64", "all", undefined]
Other(其他):
--help Show help [boolean] --version Show version number [boolean]
Examples(例子):
electron-builder -mwl 为macOS,Windows和Linux构建(同时构建) electron-builder --linux deb tar.xz 为Linux构建deb和tar.xz electron-builder -c.extraMetadata.foo=bar 将package.js属性`foo`设定为`bar` electron-builder --config.nsis.unicode=false 为NSIS配置unicode选项
TargetConfiguration(构建目标准配置置):
target: String - 目标名称,例如snap. arch “x64” | “ia32” | “armv7l” | “arm64”> | “x64” | “ia32” | “armv7l” | “arm64” -arch支撑列表
总结
electron-builder是一个简便又强大的库。反正我是很服
以上就是electron-builder打包的具体介绍的具体内容,更多请关注百分百源码网其它相关文章!