Do not copy/link .DS_Store files - macOS only

[moltam89]

Hey guys,

This is a macOS only issue, which was driving me mad, because it seemed to happen randomly and I had to always clean my whole repo with git clean -fxd to bypass it.

It should be reproducible with any extensions, I used my UniswapX-extension for testing:

Open templates/base and templates/solidity-frameworks/hardhat with the Finder app.
Make sure (ls -a) that .DS_Store files were generated. (I still don't know when these files are generated exactly, sometimes I had to jump in and out of the folder a few times)

yarn build:dev && yarn cli -e UniswapX-extension --dev --skip fromUniswap

Cheers,
Tamas

[rin-st]

It happens for me very rarely, but I've seen those files in my create-eth/extensions too

Works great (to test I added files by hand)! Lgtm!

[technophile-04]

Thanks @moltam89! I think encountered similar issue here scaffold-eth#436 (comment) (checkout notion doc link in that comment)

As I understand this problem occurs when we try to symlink .DS_STORE. So I was thinking maybe instead of solving the issue here in copy-template-files.ts maybe we always ignore that file in this function link util itself:

create-eth/src/utils/link.ts

Line 20 in 8e53d38

const linkRecursive = async (source: string, destination: string, options?: Options): Promise<void> => {

So next time if anyone uses copyOrLink util it by defaults handles that case and they don't have manually skip the .DS_STORE with filter.

cc @rin-st once too for his views

[moltam89]

Thanks @technophile-04 !

As I understand this problem occurs when we try to symlink .DS_STORE. So I was thinking maybe instead of solving the issue here in copy-template-files.ts maybe we always ignore that file in this function link util itself:

Well, the process only fails during the link step, but I think we don't really want to copy .DS_Store files either. Maybe we should apply a filter for both copy and link?

[technophile-04]

Well, the process only fails during the link step, but I think we don't really want to copy .DS_Store files either. Maybe we should apply a filter for both copy and link?

Umm probably since for this PR lets don't touch copy since I think we are using direct copy function from ncp and don't have a wrapper there.

Probably in future we can tweak create-extension cli such that when u run yarn create-extension it will automatically initialize a git repo + add .gitignore at root and that .gitignore file will ignore all this misc file like .DS_Store etc.

But yeah for this PR lets not touch copy 🙌