Vue Cli Plugin Electron Builder Versions Save

With this release, only the modern build is run when building for production (requires @vue/cli-service v3.4.1). Previously, both the legacy and the modern build had to be run, even though the legacy build is never used. It also includes a few bug fixes (check the commit log for more details).

After closing 163 issues, writing thousands of lines of code across 251 commits, and spending countless hours in front of a computer, 1.0.0 is finally here! We now have 0 open issues (not sure how long that will last :thinking:), a pretty good sign of stability :+1:. This release includes a few features as well:

Features:

• Mocha tests will be added when plugin is installed (#128, e99bba0f056b2b970b9508c3474163d24f79b778)
• You can now use a custom file protocol with the customFileProtocol configuration option (#183, 3bf42d47c8ca4e195dbd216f4a062d1fc1715934)

Thanks to everyone who clicked that :star: (we're almost at 500!!!), reported an issue, requested a feature, or made a PR (extra thanks)!

This release include a fix with the latest version of vue-cli (publicPath and baseUrl), as well as some other fixes and features.

Features:

• Command line args are now passed to electron in electron:serve (#185, 0e2b395cc261237135099e77110e501519f609c0)
• process.env.IS_ELECTRON is now set accordingly (#181, 346701f3252b04a765d52523eee902469f07839d)

Bug Fixes:

• Broken vue cli ui pages are now removed (#48, 793805e5c5eb11c46ddcfddf995a60a0d37bd616)
• electron:build now works properly with vue-cli 3.3.0 (#177, 28b5be002b1f719f02a4c5f9b4e0cc99c44acd78)
• electron-builder install-app-deps is now run on postuninstall as well as postinstall (#168, f9f8b470479dc2671ad149a809abce7322d308e2)

With 1.0.0-rc.10, electron ^4.0.0 will be available for use when invoking the generator, and ^3.0.0 will be the default. Internally (for testing), electron v4 is used, along with spectron v5. The background.js no longer relies on process.env.NODE_ENV to determine whether to load from the dev server or from the packaged app (#164).

This release removes use of flatmap-stream, which contains a major security vulnerability, used in event-stream. Also, make sure you read this message and follow the instructions there!

Features:

• If your project uses Jest, you will be prompted to set up a Spectron test when adding this plugin (#128, 57895c78a2f5da39a26f0ab0ad6dbaad6e950e24)

Bug fixes:

• The app protocol is used to load index.html, fixes some CORS issues (#129, 8dc5bbabeca7185abd0ee93864e814ee313804fa)
• --dashboard is now removed from electron-builder args, so builds started with the CLI UI will work (https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/48#issuecomment-434621628, d122fe60330832f7c8368fb36d5e34edd1d65df0)

These releases fix #117, where installVueDevtools() would not return a promise. If you are using electron@^3.0.0, it is recommended that you upgrade. You do not need to re-invoke the generator.

This release includes a hotfix for #117, where Electron v3 would only display a blank screen. It also removes the need of the <base> tag in the index.html. After updating, remove that line, and your app will continue to work as normal.

Breaking Changes

Yes, I know it is in RC phase, but these needed to happen before the final release.

This release changes the command names! Before: yarn (serve|build):electron After: yarn electron:(serve|build) This was changed to make it match other Vue CLI Plugins, see #94 for more info.

You MUST re-invoke the generator if you upgrade to this version. To do so, run vue invoke electron-builder. This is caused because: Previously, your app would be packaged relative to the project's root. Since your built code is placed in dist_electron/bundled, __dirname in a built app would be [path-to-install]/resources/app.asar/dist_electron/bundled/. Now, it is packaged relative to dist_electron/bundled. In a built app, __dirname would be [path-to-install]/resources/app.asar/. __static and process.env.BASE_URL will still function the same.

Features

• You can now choose your desired Electron version when adding this plugin (ec4836908078cdbe03980058335e0c8cea14562e)
• CLI output is prettier, and errors when bundling the main process are friendlier (#105, 61510e717860a9cbe58842e157f8d42efb472dc4)
• Custom electron args are now supported (#93, b45b2ef24151a56d20dd4aa6c9074be825d04575) thanks @zdevwu
• The output dir can be set with --dest, and changing it no longer requires you to set the main property of your package.json (7e4afa689effb6a4fac999a656f54a52ae44beba)
• Environment variables prefixed with VUE_APP_ can now be accessed in the main process (#83, 23ff11be10a725af00e77f474494e397f3f2de4d)

Bug Fixes

• Electron is killed gracefully during development (#110, ed0bcb8e517500fd31bd6a23f9ae38b27da9f474) Huge thanks to @Desuuuu
• Entry name is now used as output file. This makes it easier to add files to the main process bundling (#106, dc9940b5a13de955f46d1a380e739bb576c0c202)
• The installation process of VueJS devtools now supports a dynamically set userData path (83229ec573a8a8c8eb4589db51384e9406bcf1f0)

12 issues have been closed since the last release :tada:! This means a lot of small features/fixes.

A few new features

• Electron's junk output is now stripped from the terminal (#60, da4033e85f64df135bedc320c2812325d0eb046c)
• --skipBundle only runs electron-builder, skipping all bundling (#70, 368a9e4ab66ad20770611aa724ea42d0d1a261a0)
• --legacy disables modern mode while bundling the renderer process (#71, 368a9e4ab66ad20770611aa724ea42d0d1a261a0)
• Add support for custom node_modules folder path when detecting externals (#75, 4cb68866da88778edf1ab77e86bc1e44dd7e8554)

And, the bug fixes

• Support not having a css folder inside dist_electron/bundled (#64, e3cb7cb2e757e0fdaff8f64f596c8a883245be20)
• Fixes electron not detecting app's product name (#74, 6c76898874035f98d9160d1f01a8eb2f8fc18244)