feat(plugin-vite): add derefSymlinks option to config (#3632)

electron · Jun 19, 2024 · 131b414 · 131b414
1 parent 620a6ae
commit 131b414
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/packages/plugin/vite/src/Config.ts b/packages/plugin/vite/src/Config.ts
@@ -36,4 +36,8 @@ export interface VitePluginConfig {
    * Renderer process Vite configs.
    */
   renderer: VitePluginRendererConfig[];
+  /**
+   * Whether symlinked dependencies should be dereferenced during the copying of node_modules. Defaults to false.
+   */
+  derefSymlinks?: boolean;
 }
diff --git a/packages/plugin/vite/src/ViteConfig.ts b/packages/plugin/vite/src/ViteConfig.ts
@@ -37,6 +37,10 @@ export default class ViteConfigGenerator {
     return this.isProd ? 'production' : 'development';
   }
 
+  get derefSymlinks(): boolean {
+    return this.pluginConfig.derefSymlinks ?? false;
+  }
+
   async getBuildConfig(): Promise<UserConfig[]> {
     if (!Array.isArray(this.pluginConfig.build)) {
       throw new Error('"config.build" must be an Array');

diff --git a/packages/plugin/vite/src/VitePlugin.ts b/packages/plugin/vite/src/VitePlugin.ts
@@ -120,9 +120,11 @@ the generated files). Instead, it is ${JSON.stringify(pj.main)}`);
       spaces: 2,
     });
 
+    const dereference = this.configGenerator.derefSymlinks;
+
     // Copy the dependencies in package.json
     for (const dep of flatDependencies) {
-      await fs.copy(dep.src, path.resolve(buildPath, dep.dest));
+      await fs.copy(dep.src, path.resolve(buildPath, dep.dest), { dereference });
     }
   };
 

diff --git a/packages/plugin/vite/test/ViteConfig_spec.ts b/packages/plugin/vite/test/ViteConfig_spec.ts
@@ -61,4 +61,23 @@ describe('ViteConfigGenerator', () => {
 
     expect(buildConfig1).deep.equal(buildConfig2);
   });
+
+  it('derefSymlinks', () => {
+    const createGeneratorWithConfig = (config: Partial<VitePluginConfig>) => {
+      const _config: VitePluginConfig = { build: [], renderer: [], ...config };
+      return new ViteConfigGenerator(_config, configRoot, true);
+    };
+
+    const testCases = new Map<boolean, Partial<VitePluginConfig>>([
+      [false, {}],
+      [false, { derefSymlinks: false }],
+      [true, { derefSymlinks: true }],
+    ]);
+
+    for (const [expectedResult, config] of testCases) {
+      const generator = createGeneratorWithConfig(config);
+
+      expect(generator.derefSymlinks).to.eq(expectedResult);
+    }
+  });
 });