Merge pull request #25 from caoxiemeihao/v0.4.4

V0.4.4
caoxiemeihao · Mar 29, 2023 · 49efcd6 · 49efcd6
2 parents 99e3a8d + 1b41694
commit 49efcd6
Show file tree

Hide file tree

Showing 9 changed files with 964 additions and 2,781 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.4.4 (2023-03-29)
+
+- 57f06ec docs: v0.4.4 (#21, #24)
+- 00dbfd7 feat: support customize default behavior
+
 ## 0.4.3 (2023-03-29)
 
 - 12d8c58 refactor: cleanup

diff --git a/README.md b/README.md
@@ -63,8 +63,6 @@ That's it! You can now use Electron in your Nuxt app ✨
 
 ## Electron Options
 
-> This is based on the `vite-electron-plugin`, see the **[Documents](https://github.com/electron-vite/vite-electron-plugin#configuration)** for more detailed options
-
 Here is the default `electron` options
 
 ```ts
@@ -79,20 +77,38 @@ export default defineNuxtConfig({
 })
 ```
 
-Use Node.js in Renderer process
+Full types definition
+
+> This is based on the `vite-electron-plugin`, see the **[Documents](https://github.com/electron-vite/vite-electron-plugin#configuration)** for more detailed options
 
 ```ts
-export default defineNuxtConfig({
-  modules: [
-    'nuxt-electron',
-  ],
-  electron: {
-    /**
-     * @see https://github.com/electron-vite/vite-plugin-electron-renderer
-     */
-    renderer: {},
-  },
-})
+import type { Configuration } from 'vite-electron-plugin'
+
+export interface ElectronOptions extends Partial<Configuration> {
+  /**
+   * @see https://github.com/electron-vite/vite-plugin-electron-renderer
+   */
+  renderer?: Parameters<typeof import('vite-plugin-electron-renderer').default>[0]
+  /**
+   * nuxt-electron will modify some options by default
+   * 
+   * ```js
+   * export default defineNuxtConfig({
+   *   ssr: false,
+   *   app: {
+   *     buildAssetsDir: '/',
+   *     baseURL: './',
+   *   },
+   *   runtimeConfig: {
+   *     app: {
+   *       baseURL: './',
+   *     },
+   *   },
+   * })
+   * ```
+   */
+  disableDefaultOptions?: boolean
+}
 ```
 
 ## Recommend Structure
@@ -122,6 +138,8 @@ Let's use the official [nuxt-starter-v3](https://codeload.github.com/nuxt/starte
 ## Notes
 By default, we force the App to run in SPA mode since we don't need SSR for desktop apps
 
+If you want to fully customize the default behavior, you can disable it by `disableDefaultOptions`
+
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/nuxt-electron/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
 [npm-version-href]: https://npmjs.com/package/nuxt-electron

diff --git a/examples/quick-start/app.vue b/examples/quick-start/app.vue
@@ -3,3 +3,14 @@
     <NuxtWelcome />
   </div>
 </template>
+
+<script setup>
+import { onMounted } from 'vue'
+import { ipcRenderer } from 'electron'
+import fs from 'node:fs'
+
+onMounted(() => {
+  console.log('ipcRenderer:',ipcRenderer)
+  console.log('fs:', fs)
+})
+</script>
diff --git a/examples/quick-start/electron/main.ts b/examples/quick-start/electron/main.ts
@@ -25,6 +25,10 @@ function bootstrap() {
   win = new BrowserWindow({
     webPreferences: {
       preload,
+      nodeIntegrationInWorker: true,
+      contextIsolation: false,
+      nodeIntegration: true,
+      webSecurity: false,
     },
   })
 

diff --git a/examples/quick-start/nuxt.config.ts b/examples/quick-start/nuxt.config.ts
@@ -2,4 +2,13 @@ export default defineNuxtConfig({
   modules: [
     'nuxt-electron',
   ],
+  electron: {
+    renderer: {},
+  },
+  vite: {
+    build: {
+      // https://github.com/electron-vite/vite-plugin-electron-renderer/blob/v0.13.13/src/index.ts#L57
+      cssCodeSplit: true,
+    },
+  },
 })
diff --git a/examples/quick-start/package.json b/examples/quick-start/package.json
@@ -11,9 +11,9 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "electron": "^21.3.0",
+    "electron": "^23.1.1",
     "electron-builder": "^23.6.0",
-    "nuxt": "^3.0.0",
+    "nuxt": "^3.2.2",
     "nuxt-electron": "workspace:*"
   }
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nuxt-electron",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Nuxt Integration with Electron",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -38,13 +38,13 @@
     }
   },
   "devDependencies": {
-    "@types/node": "^18.13.0",
-    "esbuild": "^0.17.8",
-    "nuxt": "^3.2.0",
+    "@types/node": "^18.15.11",
+    "esbuild": "^0.17.14",
+    "nuxt": "^3.2.2",
     "typescript": "^4.9.5",
-    "vite": "^4.1.1",
-    "vite-electron-plugin": "^0.7.4",
-    "vite-plugin-electron-renderer": "^0.12.1"
+    "vite": "^4.1.4",
+    "vite-electron-plugin": "latest",
+    "vite-plugin-electron-renderer": "latest"
   },
   "files": [
     "electron-env.d.ts",