src -> packages

README.md

@@ -38,11 +38,11 @@ You can learn more details by looking at the source code. Trust me, this templat
 
 ## Directory
 
-Once `dev` or `build` npm-script executed will be generate named `dist` folder. It has children dir of same as `src` folder, the purpose of this design can ensure the correct path calculation.
+Once `dev` or `build` npm-script executed will be generate named `dist` folder. It has children dir of same as `packages` folder, the purpose of this design can ensure the correct path calculation.
 
 ```tree
 ├
-├── dist                      After build, it's generated according to the "src" directory
+├── dist                      After build, it's generated according to the "packages" directory
 ├   ├── main
 ├   ├── preload
 ├   ├── renderer
@@ -52,7 +52,7 @@ Once `dev` or `build` npm-script executed will be generate named `dist` folder.
 ├   ├── vite.config.mjs       Marin-process, Preload-script vite-config
 ├   ├── watch.mjs             Develop script, for -> npm run dev
 ├
-├── src
+├── packages
 ├   ├── main                  Main-process source code
 ├   ├── preload               Preload-script source code
 ├   ├── renderer              Renderer-process source code
@@ -66,7 +66,7 @@ Once `dev` or `build` npm-script executed will be generate named `dist` folder.
 
 #### All Electron, NodeJs API invoke passed `Preload-script`
 
-* **src/preload/index.ts**
+* **packages/preload/index.ts**
 
   ```typescript
   import fs from 'fs'
@@ -77,7 +77,7 @@ Once `dev` or `build` npm-script executed will be generate named `dist` folder.
   contextBridge.exposeInMainWorld('ipcRenderer', ipcRenderer)
   ```
 
-* **src/renderer/src/global.d.ts**
+* **packages/renderer/src/global.d.ts**
 
   ```typescript
   // Defined on the window
@@ -87,7 +87,7 @@ Once `dev` or `build` npm-script executed will be generate named `dist` folder.
   }
   ```
 
-* **src/renderer/src/main.ts**
+* **packages/renderer/src/main.ts**
 
   ```typescript
   // Use Electron, NodeJs API in Renderer-process

README.zh-CN.md

@@ -38,11 +38,11 @@
 
 ## 目录结构
 
-  一旦启动或打包脚本执行过，会在根目录产生 **`dist` 文件夹，里面的文件夹同 `src` 一模一样**；在使用一些路径计算时，尤其是相对路径计算；`dist` 与 `src` 里面保持相同的目录结构能避开好多问题
+  一旦启动或打包脚本执行过，会在根目录产生 **`dist` 文件夹，里面的文件夹同 `packages` 一模一样**；在使用一些路径计算时，尤其是相对路径计算；`dist` 与 `packages` 里面保持相同的目录结构能避开好多问题
 
 ```tree
 ├
-├── dist                      构建后，根据 src 目录生成
+├── dist                      构建后，根据 packages 目录生成
 ├   ├── main
 ├   ├── preload
 ├   ├── renderer
@@ -52,7 +52,7 @@
 ├   ├── vite.config.mjs       主进程, 预加载脚本源码 vite 配置
 ├   ├── watch.mjs             项目开发脚本，对应 npm run dev
 ├
-├── src
+├── packages
 ├   ├── main                  主进程源码
 ├   ├── preload               预加载脚本源码
 ├   ├── renderer              渲染进程源码
@@ -78,7 +78,7 @@ electron-builder 打包时候会将 dependencies 中的包打包到 app.asar 里
 
 **推荐所有的 NodeJs、Electron API 通过 `Preload-script` 注入到 渲染进程中，例如：**
 
-* **src/preload/index.ts**
+* **packages/preload/index.ts**
 
   ```typescript
   import fs from 'fs'
@@ -89,7 +89,7 @@ electron-builder 打包时候会将 dependencies 中的包打包到 app.asar 里
   contextBridge.exposeInMainWorld('ipcRenderer', ipcRenderer)
   ```
 
-* **src/renderer/src/global.d.ts**
+* **packages/renderer/src/global.d.ts**
 
   ```typescript
   // Defined on the window
@@ -99,7 +99,13 @@ electron-builder 打包时候会将 dependencies 中的包打包到 app.asar 里
   }
   ```
 
-* **src/renderer/main.ts**
+* **packages/renderer/src/main.ts**
+
+  ```typescript
+  // Use Electron, NodeJs API in Renderer-process
+  console.log('fs', window.fs)
+  console.log('ipcRenderer', window.ipcRenderer)
+  ```
 
   ```typescript
   // Use Electron, NodeJs API in Renderer-process

package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "scripts": {
     "dev": "node scripts/watch.mjs",
-    "build": "vue-tsc --project src/renderer/tsconfig.json --noEmit && node scripts/build.mjs && electron-builder"
+    "build": "vue-tsc --project packages/renderer/tsconfig.json --noEmit && node scripts/build.mjs && electron-builder"
   },
   "engines": {
     "node": ">=14.17.0"

scripts/build.mjs

@@ -8,7 +8,7 @@ const __dirname = dirname(fileURLToPath(import.meta.url))
 
 await build({
   configFile: 'scripts/vite.config.mjs',
-  root: join(__dirname, '../src/main'),
+  root: join(__dirname, '../packages/main'),
   build: {
     outDir: '../../dist/main',
   },
@@ -16,10 +16,10 @@ await build({
 
 await build({
   configFile: 'scripts/vite.config.mjs',
-  root: join(__dirname, '../src/preload'),
+  root: join(__dirname, '../packages/preload'),
   build: {
     outDir: '../../dist/preload',
   },
 })
 
-await build({ configFile: 'src/renderer/vite.config.ts' })
+await build({ configFile: 'packages/renderer/vite.config.ts' })

scripts/watch.mjs

@@ -22,7 +22,7 @@ function watchMain() {
 
   return build({
     configFile: 'scripts/vite.config.mjs',
-    root: join(__dirname, '../src/main'),
+    root: join(__dirname, '../packages/main'),
     build: {
       outDir: '../../dist/main',
       watch: true,
@@ -46,7 +46,7 @@ function watchMain() {
 function watchPreload(server) {
   return build({
     configFile: 'scripts/vite.config.mjs',
-    root: join(__dirname, '../src/preload'),
+    root: join(__dirname, '../packages/preload'),
     build: {
       outDir: '../../dist/preload',
       watch: true,
@@ -61,7 +61,7 @@ function watchPreload(server) {
 }
 
 // bootstrap
-const server = await createServer({ configFile: 'src/renderer/vite.config.ts' })
+const server = await createServer({ configFile: 'packages/renderer/vite.config.ts' })
 
 await server.listen()
 await watchPreload(server)