Add followSymlinks option

[sindresorhus]

Should be off by default.

This task also involves adding it to https://github.com/sindresorhus/cpy-cli

Inspiration:

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

---

IssueHunt Summary

Sponsors (Total: $40.00)

• issuehunt ($40.00)

Become a sponsor now!

Or submit a pull request to get the deposits!

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

[IssueHuntBot]

@issuehunt has funded $40.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[itaisteinherz]

I'd like to work on this.

[Idered]

I just tested this:

1. Created test-symlink and ran yarn init
2. Used yarn link in that directory
3. Used yarn link "test-symlink" in cpy project
4. Copied all package.json files except test-symlink/package.json using

await cpy(['node_modules/**/package.json'], 'dest');

5. Copied all package.json files, including test-symlink/package.json using

await cpy(['node_modules/**/package.json'], 'dest', {
    followSymbolicLinks: true,
});

It works

[sindresorhus]

@Idered I'm confused, cpy doesn't have a followSymbolicLinks option.

[Idered]

@sindresorhus Since cpy accepts fast-glob options, it's supported out of the box https://github.com/mrmlnc/fast-glob#followsymboliclinks

[sindresorhus]

Ah right. It's such a common need, so I think we should directly document it in the readme here.

[Idered]

Do you want to create PR or should I take care of it?

You can take off bounty, docs update PR is not worth it.

[sindresorhus]

I don't plan to work on this, so PR welcome if you want to :)