[Bug?]: yarn patch may generate a patch with extraneous files

[jakub-g]

Self-service

• I'd be willing to implement a fix

Describe the bug

When doing yarn patch, it does a diff on disk between two folders, and everything found on disk will be included in the patch. The package.json#files field is not checked.

This may result in the patch containing more than the author patch had in mind. For example, certain auto-generated hidden files by the operating system may be included in the patch (notably .DS_store on MacOS).

This is problematic because then when reviewing a pull request with such patch, if it includes large binary data, such patch might be unreadable e.g. in GH UI, and may require fetching the branch locally and using a special tool for understanding contents of the patch

To reproduce

# start patching, this writes on disk to <path>
yarn patch <package>

# open <path> in MacOS Finder

# finalize the patch
yarn patch-commit -s <path>

Environment

MacOS

Additional context

• Relevant code
• After briefly discussing with @arcanis, the recommended approach would be to just exclude .DS_store files from the diff, and perhaps some other files like ~ files created by some text editors.