packager icon indicating copy to clipboard operation
packager copied to clipboard

Incorrectly documented default for derefSymlinks

Open Bluenix2 opened this issue 6 months ago • 1 comments

Expected Behavior

According to the documentation for derefSymlinks, the default value is true:

https://github.com/electron/packager/blob/34f88573ed8cc2a1a2f23598906669059babf174/src/types.ts#L356-L362

Actual Behavior

However, as we can see by the call to fs-extra, there is no default value used which means that we rely on their default value:

https://github.com/electron/packager/blob/34f88573ed8cc2a1a2f23598906669059babf174/src/platform.ts#L168-L171

As a result, the actual default value becomes false:

dereference <boolean>: dereference symlinks, default is false.

https://github.com/jprichardson/node-fs-extra/blob/master/docs/copy.md

To Reproduce

Package a repository with symlinks, for example due to usage of workspaces. The final build will also contain symlinks inside of its node_modules/.

Bluenix2 avatar May 15 '25 19:05 Bluenix2

👋 Thanks for opening your first issue here! If you have a question about using Electron Packager, read the support docs. If you're reporting a 🐞 bug, please make sure you include steps to reproduce it. Development and issue triage is community-driven, so please be patient and we will get back to you as soon as we can.

To help make it easier for us to investigate your issue, please follow the contributing guidelines.

welcome[bot] avatar May 15 '25 19:05 welcome[bot]