Merge pull request #327 from xhayper/patch-1

feat: improvement to template

.github/workflows/build.yml

@@ -24,12 +24,12 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
 
       - name: Install Dependencies
         run: npm install

.gitignore

@@ -10,9 +10,12 @@ lerna-debug.log*
 node_modules
 dist
 dist-ssr
+dist-electron
+release
 *.local
 
 # Editor directories and files
+.vscode/.debug.env
 .idea
 .DS_Store
 *.suo
@@ -21,9 +24,7 @@ dist-ssr
 *.sln
 *.sw?
 
-release
+# lockfile
-.vscode/.debug.env
 package-lock.json
 pnpm-lock.yaml
-yarn.lock
+yarn.lock
-dist-electron

.vscode/.debug.script.mjs

@@ -1,8 +1,8 @@
-import fs from 'fs'
+import fs from 'node:fs'
-import path from 'path'
+import path from 'node:path'
-import { fileURLToPath } from 'url'
+import { fileURLToPath } from 'node:url'
-import { createRequire } from 'module'
+import { createRequire } from 'node:module'
-import { spawn } from 'child_process'
+import { spawn } from 'node:child_process'
 
 const pkg = createRequire(import.meta.url)('../package.json')
 const __dirname = path.dirname(fileURLToPath(import.meta.url))

.vscode/launch.json

@@ -22,7 +22,7 @@
   "configurations": [
     {
       "name": "Debug Main Process",
-      "type": "pwa-node",
+      "type": "node",
       "request": "launch",
       "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
       "windows": {
@@ -39,7 +39,7 @@
       "name": "Debug Renderer Process",
       "port": 9229,
       "request": "attach",
-      "type": "pwa-chrome",
+      "type": "chrome",
       "timeout": 60000,
       "skipFiles": [
         "<node_internals>/**",

.vscode/settings.json

@@ -1,10 +1,11 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true,
+  "typescript.tsc.autoDetect": "off",
   "json.schemas": [
     {
       "fileMatch": [
-        "/*electron-builder.json5"
+        "/*electron-builder.json5",
+        "/*electron-builder.json"
       ],
       "url": "https://json.schemastore.org/electron-builder"
     }

README.md

@@ -27,7 +27,7 @@ npm create electron-vite
 
 <!-- [![quick-start](https://asciinema.org/a/483731.svg)](https://asciinema.org/a/483731) -->
 
-![electron-vite-vue.gif](https://github.com/electron-vite/electron-vite-vue/blob/main/public/electron-vite-vue.gif?raw=true)
+![electron-vite-vue.gif](/public/electron-vite-vue.gif)
 
 ## Debug
 

electron-builder.json5

@@ -4,6 +4,7 @@
 {
   "appId": "YourAppID",
   "asar": true,
+  "icon": "public/favicon.ico",
   "directories": {
     "output": "release/${version}"
   },

electron/main/index.ts

@@ -1,3 +1,7 @@
+import { app, BrowserWindow, shell, ipcMain } from 'electron'
+import { release } from 'node:os'
+import { join } from 'node:path'
+
 // The built directory structure
 //
 // ├─┬ dist-electron
@@ -14,10 +18,6 @@ process.env.PUBLIC = process.env.VITE_DEV_SERVER_URL
   ? join(process.env.DIST_ELECTRON, '../public')
   : process.env.DIST
 
-import { app, BrowserWindow, shell, ipcMain } from 'electron'
-import { release } from 'os'
-import { join } from 'path'
-
 // Disable GPU Acceleration for Windows 7
 if (release().startsWith('6.1')) app.disableHardwareAcceleration()
 
@@ -99,7 +99,7 @@ app.on('activate', () => {
 })
 
 // New window example arg: new windows url
-ipcMain.handle('open-win', (event, arg) => {
+ipcMain.handle('open-win', (_, arg) => {
   const childWindow = new BrowserWindow({
     webPreferences: {
       preload,

electron/preload/index.ts

@@ -1,5 +1,5 @@
 function domReady(condition: DocumentReadyState[] = ['complete', 'interactive']) {
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     if (condition.includes(document.readyState)) {
       resolve(true)
     } else {
@@ -85,7 +85,7 @@ function useLoading() {
 const { appendLoading, removeLoading } = useLoading()
 domReady().then(appendLoading)
 
-window.onmessage = ev => {
+window.onmessage = (ev) => {
   ev.data.payload === 'removeLoading' && removeLoading()
 }
 

index.html

@@ -2,10 +2,10 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" href="/favicon.ico" />
+    <link rel="icon" type="image/x-icon" href="/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
-    <title>Vite App</title>
+    <title>Electron + Vite + Vue</title>
   </head>
   <body>
     <div id="app"></div>

package.json

@@ -6,35 +6,32 @@
   "author": "草鞋没号 <308487730@qq.com>",
   "license": "MIT",
   "private": true,
-  "scripts": {
-    "dev": "vite",
-    "build": "vue-tsc --noEmit && vite build && electron-builder"
-  },
-  "engines": {
-    "node": "^14.18.0 || >=16.0.0"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "@vitejs/plugin-vue": "^4.0.0",
-    "electron": "^22.0.0",
-    "electron-builder": "^23.3.3",
-    "typescript": "^4.8.4",
-    "vite": "^4.0.0",
-    "vite-plugin-electron": "^0.11.1",
-    "vite-plugin-electron-renderer": "^0.11.3",
-    "vue": "^3.2.40",
-    "vue-tsc": "^1.0.9"
-  },
-  "debug": {
-    "env": {
-      "VITE_DEV_SERVER_URL": "http://127.0.0.1:3344"
-    }
-  },
   "keywords": [
     "electron",
     "rollup",
     "vite",
     "vue3",
     "vue"
-  ]
+  ],
+  "debug": {
+    "env": {
+      "VITE_DEV_SERVER_URL": "http://127.0.0.1:3344/"
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc --noEmit && vite build && electron-builder",
+    "preview": "vite preview"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^4.0.0",
+    "electron": "^22.0.0",
+    "electron-builder": "^23.6.0",
+    "typescript": "^4.9.4",
+    "vite": "^4.0.3",
+    "vite-plugin-electron": "^0.11.1",
+    "vite-plugin-electron-renderer": "^0.11.3",
+    "vue": "^3.2.45",
+    "vue-tsc": "^1.0.16"
+  }
 }

public/node.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="216" height="216" viewBox="0 0 216 216"><path fill="#80bd01" d="M104.6 180.7c-2 0-3.9-.5-5.7-1.5l-18.1-10.7c-2.7-1.5-1.4-2-.5-2.4 3.6-1.2 4.3-1.5 8.2-3.7.4-.2.9-.1 1.3.1l13.9 8.2c.5.3 1.2.3 1.7 0l54.1-31.2c.5-.3.8-.9.8-1.5V75.7c0-.6-.3-1.2-.8-1.5l-54-31.2c-.5-.3-1.2-.3-1.7 0l-54 31.2c-.5.3-.9.9-.9 1.5v62.4c0 .6.3 1.2.9 1.4l14.8 8.6c8 4 13-.7 13-5.5V81c0-.9.7-1.6 1.6-1.6h6.9c.9 0 1.6.7 1.6 1.6v61.6c0 10.7-5.8 16.9-16 16.9-3.1 0-5.6 0-12.5-3.4L44.8 148c-3.5-2-5.7-5.8-5.7-9.9V75.7c0-4.1 2.2-7.8 5.7-9.9l54.1-31.2c3.4-1.9 8-1.9 11.4 0l54.1 31.2c3.5 2 5.7 5.8 5.7 9.9v62.4c0 4.1-2.2 7.8-5.7 9.9l-54.1 31.2c-1.8 1-3.7 1.5-5.7 1.5zm43.6-61.5c0-11.7-7.9-14.8-24.5-17-16.8-2.2-18.5-3.4-18.5-7.3 0-3.2 1.4-7.6 13.9-7.6 11.1 0 15.2 2.4 16.9 9.9.1.7.8 1.2 1.5 1.2h7c.4 0 .8-.2 1.1-.5.3-.3.5-.8.4-1.2-1.1-12.9-9.7-18.9-27-18.9-15.4 0-24.6 6.5-24.6 17.4 0 11.8 9.1 15.1 23.9 16.6 17.7 1.7 19.1 4.3 19.1 7.8 0 6-4.8 8.6-16.2 8.6-14.3 0-17.5-3.6-18.5-10.7-.1-.8-.8-1.3-1.6-1.3h-7c-.9 0-1.6.7-1.6 1.6 0 9.1 5 20 28.6 20 17.3-.1 27.1-6.8 27.1-18.6zM172 55.9V57h3v8h1.2v-8h3.1v-1.1H172zm8.4 9.1h1.2v-7.6l2.6 7.6h1.2l2.6-7.6V65h1.2v-9h-1.7l-2.6 7.6-2.6-7.6h-1.8v9z"/></svg>

src/App.vue

@@ -1,67 +1,50 @@
 <script setup lang="ts">
-// This starter template is using Vue 3 <script setup> SFCs
-// Check out https://vuejs.org/api/sfc-script-setup.html#script-setup
 import HelloWorld from './components/HelloWorld.vue'
+
+console.log("[App.vue]", `Hello world from Electron ${process.versions.electron}!`)
 </script>
 
 <template>
-  <div class="logo-box">
+  <div>
-    <img class="logo vite" src="./assets/vite.svg" >
+    <a href="https://www.electronjs.org/" target="_blank">
-    <img class="logo electron" src="./assets/electron.svg" >
+      <img src="./assets/electron.svg" class="logo electron" alt="Electron logo" />
-    <img class="logo vue" src="./assets/vue.svg" >
+    </a>
+    <a href="https://vitejs.dev/" target="_blank">
+      <img src="/vite.svg" class="logo" alt="Vite logo" />
+    </a>
+    <a href="https://vuejs.org/" target="_blank">
+      <img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
+    </a>
   </div>
-  <HelloWorld msg="Hello Vue 3 + TypeScript + Vite" />
+  <HelloWorld msg="Electron + Vite + Vue" />
-  <div class="static-public">
+  <div class="flex-center">
     Place static files into the <code>/public</code> folder
-    <img style="width:77px;" :src="'./node.png'" >
+    <img style="width:5em;" src="/node.svg" alt="Node logo">
   </div>
 </template>
 
 <style>
-#app {
+.flex-center {
-  font-family: Avenir, Helvetica, Arial, sans-serif;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-  text-align: center;
-  color: #2c3e50;
-  margin-top: 60px;
-}
-
-.logo-box {
-  display: flex;
-  width: 100%;
-  justify-content: center;
-}
-
-.static-public {
   display: flex;
   align-items: center;
   justify-content: center;
 }
 
-.static-public code {
-  background-color: #eee;
-  padding: 2px 4px;
-  margin: 0 4px;
-  border-radius: 4px;
-  color: #304455;
-}
-
 .logo {
   height: 6em;
   padding: 1.5em;
   will-change: filter;
-  transition: 0.75s;
+  transition: filter 300ms;
-}
-
-.logo.vite:hover {
-  filter: drop-shadow(0 0 2em #646cffaa);
 }
 
 .logo.electron:hover {
   filter: drop-shadow(0 0 2em #9FEAF9);
 }
 
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+
 .logo.vue:hover {
   filter: drop-shadow(0 0 2em #42b883aa);
 }

src/main.ts

@@ -1,4 +1,5 @@
 import { createApp } from 'vue'
+import "./style.css"
 import App from './App.vue'
 import './samples/node-api'
 

src/samples/node-api.ts

@@ -1,5 +1,5 @@
-import { lstat } from 'fs/promises'
+import { lstat } from 'node:fs/promises'
-import { cwd } from 'process'
+import { cwd } from 'node:process'
 import { ipcRenderer } from 'electron'
 
 ipcRenderer.on('main-process-message', (_event, ...args) => {

src/style.css

@@ -0,0 +1,91 @@
+:root {
+  font-family: Inter, Avenir, Helvetica, Arial, sans-serif;
+  font-size: 16px;
+  line-height: 24px;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+code {
+  background-color: #1a1a1a;
+  padding: 2px 4px;
+  margin: 0 4px;
+  border-radius: 4px;
+}
+
+.card {
+  padding: 2em;
+}
+
+#app {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+  code {
+    background-color: #f9f9f9;
+  }
+}

src/vite-env.d.ts

@@ -2,7 +2,6 @@
 
 declare module '*.vue' {
   import type { DefineComponent } from 'vue'
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
   const component: DefineComponent<{}, {}, any>
   export default component
 }

tsconfig.json

@@ -1,18 +1,17 @@
 {
   "compilerOptions": {
     "target": "ESNext",
+    "useDefineForClassFields": true,
     "module": "ESNext",
-    "moduleResolution": "node",
+    "moduleResolution": "Node",
-    "importHelpers": true,
-    "jsx": "preserve",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "sourceMap": true,
-    "baseUrl": "./",
     "strict": true,
-    "paths": {},
+    "jsx": "preserve",
-    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
-    "skipLibCheck": true
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ESNext", "DOM"],
+    "skipLibCheck": true,
+    "noEmit": true
   },
   "include": ["src"],
   "references": [

tsconfig.node.json

@@ -1,12 +1,10 @@
 {
   "compilerOptions": {
-    "target": "ESNext",
     "composite": true,
     "module": "ESNext",
     "moduleResolution": "Node",
-    "jsx": "preserve",
     "resolveJsonModule": true,
     "allowSyntheticDefaultImports": true
   },
-  "include": ["package.json", "electron"]
+  "include": ["vite.config.ts", "package.json", "electron"]
 }

vite.config.ts

@@ -1,17 +1,14 @@
-import { rmSync } from 'fs'
+import { rmSync } from 'node:fs'
-import {
+import { defineConfig } from 'vite'
-  type Plugin,
-  defineConfig,
-  loadEnv,
-} from 'vite'
 import vue from '@vitejs/plugin-vue'
 import electron from 'vite-plugin-electron'
 import renderer from 'vite-plugin-electron-renderer'
 import pkg from './package.json'
 
 rmSync('dist-electron', { recursive: true, force: true })
-const sourcemap = !!process.env.VSCODE_DEBUG
+
-const isBuild = process.argv.slice(2).includes('build')
+const isDevelopment = process.env.NODE_ENV === "development" || !!process.env.VSCODE_DEBUG
+const isProduction = process.env.NODE_ENV === "production"
 
 // https://vitejs.dev/config/
 export default defineConfig({
@@ -30,11 +27,11 @@ export default defineConfig({
         },
         vite: {
           build: {
-            sourcemap,
+            sourcemap: isDevelopment,
-            minify: isBuild,
+            minify: isProduction,
             outDir: 'dist-electron/main',
             rollupOptions: {
-              external: Object.keys(pkg.dependencies),
+              external: Object.keys("dependencies" in pkg ? pkg.dependencies : {}),
             },
           },
         },
@@ -48,11 +45,11 @@ export default defineConfig({
         },
         vite: {
           build: {
-            sourcemap,
+            sourcemap: isDevelopment,
-            minify: isBuild,
+            minify: isProduction,
             outDir: 'dist-electron/preload',
             rollupOptions: {
-              external: Object.keys(pkg.dependencies),
+              external: Object.keys("dependencies" in pkg ? pkg.dependencies : {}),
             },
           },
         },
@@ -63,7 +60,7 @@ export default defineConfig({
       nodeIntegration: true,
     }),
   ],
-  server: process.env.VSCODE_DEBUG ? (() => {
+  server: !!process.env.VSCODE_DEBUG ? (() => {
     const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
     return {
       host: url.hostname,