14 Commits

Author SHA1 Message Date
dependabot[bot]
18c28994f9 chore(deps-dev): bump electron from 29.3.1 to 30.0.1
Bumps [electron](https://github.com/electron/electron) from 29.3.1 to 30.0.1.
- [Release notes](https://github.com/electron/electron/releases)
- [Changelog](https://github.com/electron/electron/blob/main/docs/breaking-changes.md)
- [Commits](https://github.com/electron/electron/compare/v29.3.1...v30.0.1)

---
updated-dependencies:
- dependency-name: electron
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-05-01 02:17:38 +00:00
Leo Wang(草鞋没号)
f06b279554 chore: remove globalThis.__dirname 2024-04-21 09:40:01 +08:00
Leo Wang(草鞋没号)
7d5708d600 Merge branch 'main' of github.com:electron-vite/electron-vite-vue into main 2024-04-18 17:36:57 +08:00
Leo Wang(草鞋没号)
f876aa8d3b v28.1.0 2024-04-18 17:36:21 +08:00
Leo Wang(草鞋没号)
22136b7410 chore: update electron-builder.json5 2024-04-18 17:36:13 +08:00
Leo Wang(草鞋没号)
107ffe8d40 refactor: better export process.env.XXX 2024-04-18 17:35:48 +08:00
Haojie Ning
a085952032 fix: resolve ipcRenderer no returns (#478) 2024-03-28 22:08:07 +08:00
Leo Wang(草鞋没号)
c7e5fd70cd chore: bump vite-plugin-electron to 0.28.4 2024-03-17 11:03:37 +08:00
Leo Wang(草鞋没号)
11e9c4bffa feat: better ipcRenderer api expose 2024-03-11 16:19:01 +08:00
Leo Wang(草鞋没号)
a9952f16c8 feat: upgrade to electron@29 #467 2024-03-11 11:10:58 +08:00
Leo Wang(草鞋没号)
8a73559962 chore: bump deps 2024-03-11 11:03:06 +08:00
Leo Wang(草鞋没号)
af8aa6cf7c feat: define globalThis.__dirname 2024-02-11 10:53:28 +08:00
Leo Wang(草鞋没号)
85ed267c48 chore: bump vite-plugin-electron to 0.28.0 2024-01-09 22:25:53 +08:00
草鞋没号
e0a6f8c355 chore: bump vite-plugin-electron to 0.28.0-beta.3 2024-01-06 12:21:25 +08:00
5 changed files with 67 additions and 59 deletions

View File

@@ -1,6 +1,4 @@
/**
* @see https://www.electron.build/configuration/configuration
*/
// @see https://www.electron.build/configuration/configuration
{
"$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/master/packages/app-builder-lib/scheme.json",
"appId": "YourAppID",

View File

@@ -3,8 +3,20 @@
declare namespace NodeJS {
interface ProcessEnv {
VSCODE_DEBUG?: 'true'
DIST_ELECTRON: string
DIST: string
/**
* The built directory structure
*
* ```tree
* ├─┬ dist-electron
* │ ├─┬ main
* │ │ └── index.js > Electron-Main
* │ └─┬ preload
* │ └── index.mjs > Preload-Scripts
* ├─┬ dist
* │ └── index.html > Electron-Renderer
* ```
*/
APP_ROOT: string
/** /dist/ or /public/ */
VITE_PUBLIC: string
}

View File

@@ -1,10 +1,11 @@
import { app, BrowserWindow, shell, ipcMain } from 'electron'
import { release } from 'node:os'
import { join, dirname } from 'node:path'
import { createRequire } from 'node:module'
import { fileURLToPath } from 'node:url'
import path from 'node:path'
import os from 'node:os'
const __filename = fileURLToPath(import.meta.url)
const __dirname = dirname(__filename)
const require = createRequire(import.meta.url)
const __dirname = path.dirname(fileURLToPath(import.meta.url))
// The built directory structure
//
@@ -12,18 +13,22 @@ const __dirname = dirname(__filename)
// │ ├─┬ main
// │ │ └── index.js > Electron-Main
// │ └─┬ preload
// │ └── index.mjs > Preload-Scripts
// │ └── index.mjs > Preload-Scripts
// ├─┬ dist
// │ └── index.html > Electron-Renderer
//
process.env.DIST_ELECTRON = join(__dirname, '..')
process.env.DIST = join(process.env.DIST_ELECTRON, '../dist')
process.env.VITE_PUBLIC = process.env.VITE_DEV_SERVER_URL
? join(process.env.DIST_ELECTRON, '../public')
: process.env.DIST
process.env.APP_ROOT = path.join(__dirname, '../..')
export const MAIN_DIST = path.join(process.env.APP_ROOT, 'dist-electron')
export const RENDERER_DIST = path.join(process.env.APP_ROOT, 'dist')
export const VITE_DEV_SERVER_URL = process.env.VITE_DEV_SERVER_URL
process.env.VITE_PUBLIC = VITE_DEV_SERVER_URL
? path.join(process.env.APP_ROOT, 'public')
: RENDERER_DIST
// Disable GPU Acceleration for Windows 7
if (release().startsWith('6.1')) app.disableHardwareAcceleration()
if (os.release().startsWith('6.1')) app.disableHardwareAcceleration()
// Set application name for Windows 10+ notifications
if (process.platform === 'win32') app.setAppUserModelId(app.getName())
@@ -33,21 +38,14 @@ if (!app.requestSingleInstanceLock()) {
process.exit(0)
}
// Remove electron security warnings
// This warning only shows in development mode
// Read more on https://www.electronjs.org/docs/latest/tutorial/security
// process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = 'true'
let win: BrowserWindow | null = null
// Here, you can also use other preload
const preload = join(__dirname, '../preload/index.mjs')
const url = process.env.VITE_DEV_SERVER_URL
const indexHtml = join(process.env.DIST, 'index.html')
const preload = path.join(__dirname, '../preload/index.mjs')
const indexHtml = path.join(RENDERER_DIST, 'index.html')
async function createWindow() {
win = new BrowserWindow({
title: 'Main window',
icon: join(process.env.VITE_PUBLIC, 'favicon.ico'),
icon: path.join(process.env.VITE_PUBLIC, 'favicon.ico'),
webPreferences: {
preload,
// Warning: Enable nodeIntegration and disable contextIsolation is not secure in production
@@ -59,8 +57,8 @@ async function createWindow() {
},
})
if (process.env.VITE_DEV_SERVER_URL) { // electron-vite-vue#298
win.loadURL(url)
if (VITE_DEV_SERVER_URL) { // #298
win.loadURL(VITE_DEV_SERVER_URL)
// Open devTool if the app is not packaged
win.webContents.openDevTools()
} else {
@@ -114,8 +112,8 @@ ipcMain.handle('open-win', (_, arg) => {
},
})
if (process.env.VITE_DEV_SERVER_URL) {
childWindow.loadURL(`${url}#${arg}`)
if (VITE_DEV_SERVER_URL) {
childWindow.loadURL(`${VITE_DEV_SERVER_URL}#${arg}`)
} else {
childWindow.loadFile(indexHtml, { hash: arg })
}

View File

@@ -1,26 +1,27 @@
import { ipcRenderer, contextBridge } from 'electron'
// --------- Expose some API to the Renderer process ---------
contextBridge.exposeInMainWorld('ipcRenderer', withPrototype(ipcRenderer))
contextBridge.exposeInMainWorld('ipcRenderer', {
on(...args: Parameters<typeof ipcRenderer.on>) {
const [channel, listener] = args
return ipcRenderer.on(channel, (event, ...args) => listener(event, ...args))
},
off(...args: Parameters<typeof ipcRenderer.off>) {
const [channel, ...omit] = args
return ipcRenderer.off(channel, ...omit)
},
send(...args: Parameters<typeof ipcRenderer.send>) {
const [channel, ...omit] = args
return ipcRenderer.send(channel, ...omit)
},
invoke(...args: Parameters<typeof ipcRenderer.invoke>) {
const [channel, ...omit] = args
return ipcRenderer.invoke(channel, ...omit)
},
// `exposeInMainWorld` can't detect attributes and methods of `prototype`, manually patching it.
function withPrototype(obj: Record<string, any>) {
const protos = Object.getPrototypeOf(obj)
for (const [key, value] of Object.entries(protos)) {
if (Object.prototype.hasOwnProperty.call(obj, key)) continue
if (typeof value === 'function') {
// Some native APIs, like `NodeJS.EventEmitter['on']`, don't work in the Renderer process. Wrapping them into a function.
obj[key] = function (...args: any) {
return value.call(obj, ...args)
}
} else {
obj[key] = value
}
}
return obj
}
// You can expose other APTs you need here.
// ...
})
// --------- Preload scripts loading ---------
function domReady(condition: DocumentReadyState[] = ['complete', 'interactive']) {

View File

@@ -1,6 +1,6 @@
{
"name": "electron-vue-vite",
"version": "28.0.0",
"version": "28.1.0",
"main": "dist-electron/main/index.js",
"description": "Really simple Electron + Vue + Vite boilerplate.",
"author": "草鞋没号 <308487730@qq.com>",
@@ -25,15 +25,14 @@
"preview": "vite preview"
},
"devDependencies": {
"@vitejs/plugin-vue": "^5.0.1",
"electron": "^28.1.0",
"electron-builder": "^24.9.1",
"tree-kill": "^1.2.2",
"typescript": "^5.3.3",
"vite": "^5.0.10",
"vite-plugin-electron": "^0.28.0-beta.2",
"@vitejs/plugin-vue": "^5.0.4",
"electron": "^30.0.1",
"electron-builder": "^24.13.3",
"typescript": "^5.4.2",
"vite": "^5.1.5",
"vite-plugin-electron": "^0.28.4",
"vite-plugin-electron-renderer": "^0.14.5",
"vue": "^3.4.1",
"vue-tsc": "^1.8.27"
"vue": "^3.4.21",
"vue-tsc": "^2.0.6"
}
}