Electron-Vue 打包配置

Electron-Vue 发布App应用的默认打包的安装包,名称不能设置中文,logo是默认,不能自定义安装等等问题,就我自己的情况,就以下三个内容进行说明

  • 如何更换应用名称
  • 如何更换应用Logo
  • 如何自定义安装

环境

  • vue3
  • electron13
  • electron-builder
  • ...

其它不多说先看配置vue.config.js文件的部分内容

const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
  transpileDependencies: true,
  pluginOptions: {
      electronBuilder: {
          nodeIntegration: true,
          externals: ['serialport'],
          builderOptions: {
              "productName": "Build串口调试Api工具",
              "appId": "com.apitool",
              "win": {
              },
              //window自动义安装
              "nsis": {
                  "oneClick": false,            //是否静默安装(一键式安装)
                  "perMachine": true,           //安装模式 true=所有用户 false=自己
                  "allowElevation": true,       //允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序
                  "allowToChangeInstallationDirectory": true,   //是否安装时是否能更换安装目录
                  "createDesktopShortcut": true,    //是否创建桌面快捷建
                  "menuCategory": true,             //是否在开始菜单里创建子菜单
                  "installerIcon":  "build/icons/icon.ico",     //安装应用的图片,一定要 ico格式的图片
                  "installerSidebar": "public/logo.bmp",   //安装程序左边的图片,一定是要位图 bmp 格式 一定要 164*314
                  "uninstallerSidebar": "build/icons/uninstall.bmp",   //安装程序左边的图片,一定是要位图 bmp 格式 一定要 164*314
                  "include": "scripts/installer.nsi"
              }
          }
      }
  }
})

上页的配置,以我实际的需求进行的简单,至于更多的配置内容详情可以查看官方文档 nsis配置文件 ,在这里也可以查看其它平台安装的。

如何更换应用名称

更换应用名称的方法两个,一是在package.json中增加一个producteName属性,这个属性是可以设置为中文的(name属性只能用英文),二是在vue.confog.js中配置,如上面的文件所示那样。vue.config.js 中的配置是最高级

如何更换应用Logo

因为Logo所要的尺寸有点多,这里要安装一个依赖工具electron-icon-builder,这个工具可以自动生成多个不一样的尺寸,是一个很方便工具。同时重点说明一下electron-builder默认使用的图片路径是buildpackage.json同级,这应该算是隐性规则,要注意

npm i electron-icon-builder --D

通过安装上面的工具后,在package.json配置命令,增加electron:icon-builder命令,如下所示

  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint",
    "electron:build": "vue-cli-service electron:build",

    "electron:icon-builder": "electron-icon-builder --input=./public/logo.png --output=build --flatten",

    "electron:serve": "vue-cli-service electron:serve",
    "postinstall": "electron-builder install-app-deps",
    "postuninstall": "electron-builder install-app-deps"
  },

关于electron:icon-builder,它有三个参数

  • --input 输入的文件路径,相对于当前文件而言
  • --output 输出的文件夹,这个最好固定的build,原因上面有说明
  • --flatten 是否压塑,没有值

配置完成后执行下面命令,就会生成 build目录,这个时候再打包生成的应用及安装包的图标就是 logo.pnglogo.png不能太大,最好不要起过1M。小,清楚就可以

yarn electron:icon-builder

如何自定义安装

electron-builder打包后默认的安装方便是便捷式的,没有欢迎界面,也不能自己选择安装目录等问题,上页的主体配置文件与给说明,现在看一下关键位置的配置信息

  "nsis": {
                  "oneClick": false,          //是否静默安装(一键式安装)
                  "perMachine": true,             //安装模式 true=所有用户 false=自己
                  "allowElevation": true,         //允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序
                  "allowToChangeInstallationDirectory": true,   //是否安装时是否能更换安装目录
                  "createDesktopShortcut": true,    //是否创建桌面快捷建
                  "menuCategory": true,             //是否在开始菜单里创建子菜单
                  "installerIcon":  "build/icons/icon.ico",     //安装应用的图片,一定要 ico格式的图片
                  "installerSidebar": "public/logo.bmp",   //安装程序左边的图片,一定是要位图 bmp 格式 一定要 164*314
                  "uninstallerSidebar": "build/icons/uninstall.bmp",   //卸载程序左边的图片,一定是要位图 bmp 格式 一定要 164*314
                  "include": "scripts/installer.nsi"
  }

都有文字说明,应该都挺好理解,这里重点说一下installerIcon,installerSidebar,installerSidebar,这个图片路径设置,这个路径是相对于vue.config.js或是相对于build同级目录都可以,目前配置都是基于build的同级路径

关于include的配置的文件 scripts/installer.nsi 这个是window的安装配置,目前对于这一块不很懂,详情可以nsis的教程,但给个最基本的内容,供参考(也是网上找的,但测试过能用)

; HM NIS Edit Wizard helper defines
!include "MUI2.nsh"

;  MUI Settings
!define MUI_ABORTWARNING

; 欢迎页面
!insertmacro MUI_PAGE_WELCOME

ShowInstDetails show
ShowUnInstDetails show
SpaceTexts show

; 安装脚本
!macro customInstall

!macroend

大概意思是
引入现代用户界面,相关于类库
预定义常量
定义宏
设置属性
执行自动安装

关于这一块更多还是要看nsis文档,不对之处,欢迎留言指正。

The End

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容