Merge pull request #62 from electron-vite/v0.14.2

V0.14.2

Author: caoxiemeihao

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.14.2 (2023-05-05)
+
+- 6930c08 v0.14.2
+- d99bec7 feat(build): target `node14`
+- af15ae0 fix: correct lookup path for `require()` #63 | closes [#63]https://github.com/electron-vite/vite-plugin-electron-renderer/issues/63
+- 69a6a0b chore: cleanup
+- ef1f57e docs: update
+- dd3e052 chore: cleanup
+
 ## 0.14.1 (2023-04-15)
 
 - ffef5f2 chore: bump vite-plugin-utils to 0.4.1

README.md

@@ -140,26 +140,27 @@ const { ipcRenderer } = require('electron')
 ```
 -->
 
-<!--
 ## Dependency Pre-Bundling
 
-**In general**. Vite will pre-bundle all third-party modules in a Web-based usage format, but it can not adapt to Electron Renderer process especially C/C++ modules. So we must be make a little changes for this.  
-When a module detected as a `cjs` module. it will be pre-bundle like the following.
+**In general**. Vite will pre-bundle all third-party modules in a Web-based usage format, but it can not adapt to Electron Renderer process especially C/C++ modules. So we must be make a little changes for this.
+
+<!-- When a module detected as a `cjs` module. it will be pre-bundle like the following. -->
 
 ```js
-const lib = require("cjs-module");
+// 👉 https://github.com/electron-vite/vite-plugin-electron-renderer/blob/v0.13.0/src/optimizer.ts#L139-L142
+const _M_ = require("serialport");
 
-export const member = lib.member;
-export default (lib.default || lib);
+export default (_M_.default || _M_);
+export const SerialPort = _M_.SerialPort;
+// export other members ...
 ```
 
-[See source code](https://github.com/electron-vite/vite-plugin-electron-renderer/blob/v0.13.0/src/optimizer.ts#L139-L142)
-
+<!--
 **By the way**. If an npm package is a pure ESM format package, and the packages it depends on are also in ESM format, then put it in `optimizeDeps.exclude` and it will work normally.  
 [See the explanation](https://github.com/electron-vite/vite-plugin-electron-renderer/blob/v0.10.3/examples/quick-start/vite.config.ts#L33-L36)
 -->
 
-## `dependencies` vs `devDependencies`
+## dependencies vs devDependencies
 
 <table>
   <thead>

README.zh-CN.md

@@ -64,7 +64,7 @@ export default (lib.default || lib);
 [这里解释了它](https://github.com/electron-vite/vite-plugin-electron/blob/14684ba108beec305edf4c9d8865527f6508f987/examples/nodeIntegration/vite.config.ts#L36-L39)
 -->
 
-## `dependencies` 与 `devDependencies`
+## dependencies 与 devDependencies
 
 <table>
   <thead>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-electron-renderer",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "Support use Node.js API in Electron-Renderer",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -37,8 +37,7 @@
     "vitest": "^0.29.3"
   },
   "files": [
-    "dist",
-    "install.js"
+    "dist"
   ],
   "keywords": [
     "vite",

src/index.ts

@@ -115,22 +115,22 @@ export interface RendererOptions {
 export default function renderer(options: RendererOptions = {}): VitePlugin {
   let root: string
   let cacheDir: string
-  const cwd = process.cwd()
   const resolveKeys: string[] = []
   const moduleCache = new Map<string, string>()
 
   return {
     name: 'vite-plugin-electron-renderer',
     async config(config, { command }) {
       // https://github.com/vitejs/vite/blob/v4.2.1/packages/vite/src/node/config.ts#L469-L472
-      root = normalizePath(config.root ? path.resolve(config.root) : cwd)
+      root = normalizePath(config.root ? path.resolve(config.root) : process.cwd())
 
-      cacheDir = path.join(find_node_modules(root)[0] ?? cwd, CACHE_DIR)
+      cacheDir = path.join(find_node_modules(root)[0] ?? process.cwd(), CACHE_DIR)
 
       for (const [key, option] of Object.entries(options.resolve ?? {})) {
         if (command === 'build' && option.type === 'esm') {
           // A `esm` module can be build correctly during the `vite build`
-          continue
+          // Because the current C/C++ modules are imported through `cjs` format, so exclude `esm`
+          continue // (🚧-① only `type:cjs`)
         }
         resolveKeys.push(key)
       }
@@ -159,7 +159,7 @@ export default function renderer(options: RendererOptions = {}): VitePlugin {
         },
       }]
 
-      // options.resolve (only `cjs`)
+      // options.resolve (🚧-① only `type:cjs`)
       aliases.push({
         find: new RegExp(`^(${resolveKeys.join('|')})$`),
         replacement: '$1',
@@ -178,7 +178,6 @@ export default function renderer(options: RendererOptions = {}): VitePlugin {
                   snippets = await resolved.build({
                     cjs: module => Promise.resolve(getSnippets({ import: module, export: module })),
                     esm: (module, buildOptions) => getPreBundleSnippets({
-                      root,
                       module,
                       outdir: cacheDir,
                       buildOptions,
@@ -188,7 +187,6 @@ export default function renderer(options: RendererOptions = {}): VitePlugin {
                   snippets = getSnippets({ import: source, export: source })
                 } else if (resolved.type === 'esm') {
                   snippets = await getPreBundleSnippets({
-                    root,
                     module: source,
                     outdir: cacheDir,
                   })
@@ -318,13 +316,11 @@ function getSnippets(module: {
 }
 
 async function getPreBundleSnippets(options: {
-  root: string
   module: string
   outdir: string
   buildOptions?: esbuild.BuildOptions
 }) {
   const {
-    root,
     module,
     outdir,
     buildOptions = {},
@@ -345,9 +341,8 @@ async function getPreBundleSnippets(options: {
 
   return getSnippets({
     import: outfile,
-    // Since any module will be imported as an `import` in the Renderer process,
-    // the __dirname(import.meta.url) of the module should be http://localhost:5173/ which is the `root` directory
-    export: relativeify(path.posix.relative(root, outfile)),
+    // `require()` in script-module lookup path based on `process.cwd()` 🤔
+    export: relativeify(path.posix.relative(process.cwd(), outfile)),
   })
 }
 

tsconfig.json

@@ -13,5 +13,5 @@
     "baseUrl": ".",
     "outDir": "types"
   },
-  "include": ["src/**/*.ts"]
+  "include": ["src"]
 }

vite.config.ts

@@ -11,6 +11,7 @@ export default defineConfig({
   build: {
     minify: false,
     emptyOutDir: !isdev,
+    target: 'node14',
     lib: {
       entry: {
         index: 'src/index.ts',