fs: add recursive cp method by bcoe · Pull Request #39372 · nodejs/node · GitHub

Introduces recursive cp method, based on fs-extra implementation

Refs: nodejs/tooling#98
Fixes: #35880

Opening to start conversation.

TODO:

still have many tests to write, to increase coverage. (coverage is at 92%).
need to document sync and promise API.

CC: @nodejs/tooling, @jprichardson, @manidlou, @RyanZim

lgtm

Just making sure this doesn't land without documentation for the Promises and sync APIs

Looks good overall! 🙌

@mcollina @targos small, but significant update, I thought force would be a better option than overwrite for when clobbering the destination folder, and have renamed it to this. Also, force now defaults to false.

CI: https://ci.nodejs.org/job/node-test-pull-request/39071/

I thought force would be a better option than overwrite for when clobbering the destination folder, and have renamed it to this. Also, force now defaults to false.

While we're rethinking options, should errorOnExist default to false or true? This is another one of those options that has its value for compat reasons.

Also, for reference; discussion thread on how fs-extra should handle the forthcoming naming conflict: jprichardson/node-fs-extra#912

Further simplifications on the subject of replacing open + futimes + close with utimes.

@RyanZim @iansu

While we're rethinking options, should errorOnExist default to false or true? This is another one of those options that has its value for compat reasons.

I was tempted to go with false, which I believe would make copying to the same folder twice relatively safe, i.e., you don't clobber files, but it's less of a pain in the neck to recover from a partial copy (you don't have to lookup an option).

Thoughts?

FYI, waiting on a windows machine at work (there are some hiccups with provisioning). Would happily pair with someone on fixing up the failing windows test, if anyone has a system up and running.

Introduces recursive cp method, based on fs-extra implementation. PR-URL: #39372 Fixes: #35880 Refs: nodejs/tooling#98 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca>

Landed in 87d6fd7

Introduces recursive cp method, based on fs-extra implementation. PR-URL: #39372 Fixes: #35880 Refs: nodejs/tooling#98 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca>

Notable changes: * fs: * add recursive cp method (Benjamin Coe) #39372 PR-URL: #39782

Notable changes: * fs: * experimental: add recursive cp method (Benjamin Coe) #39372 PR-URL: #39782

Is there any place to give feedback on this function?

Just looking through the docs, I think the option force: <boolean> is a bit ambiguous and would have been better suited to be named overwrite- as that's literally what it achieves, according to the docs.

[EDIT]
Sorry, after reading further comments, I see it was actually changed from overwrite to force - which I'm a little confused about now...

@lostpebble please feel free to open an issue. As much as possible I'd like to model after cp's flags, but perhaps clobber is the better name in this case?

One good thing about force is it's consistent with rm.

As per nodejs/node#39372 (comment) Resolves #918

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jul 13, 2021

bcoe commented Jul 13, 2021

View reviewed changes

Comment thread test/parallel/test-copy.js Outdated

bcoe commented Jul 13, 2021

View reviewed changes

Comment thread lib/internal/fs/copy/copy.js Outdated

bcoe commented Jul 13, 2021

View reviewed changes

Comment thread lib/internal/fs/copy/copy.js Outdated

bcoe force-pushed the copy branch from bb5fe4a to 4107b45 Compare July 13, 2021 01:02

This comment has been minimized.

Sign in to view

aduh95 reviewed Jul 13, 2021

View reviewed changes

Comment thread lib/internal/fs/promises.js Outdated

Comment thread lib/internal/fs/promises.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

Comment thread lib/internal/fs/copy/copy-sync.js Outdated

mcollina approved these changes Jul 13, 2021

View reviewed changes

targos suggested changes Jul 13, 2021

View reviewed changes

merceyz reviewed Jul 13, 2021

View reviewed changes

Comment thread lib/internal/fs/copy/copy-sync.js

This comment has been minimized.

Sign in to view

iansu reviewed Jul 14, 2021

View reviewed changes

Comment thread lib/internal/fs/promises.js Outdated

Comment thread lib/internal/fs/utils.js Outdated

bcoe added notable-change PRs with changes that should be highlighted in changelogs. semver-minor PRs that contain new features and should be released in the next minor version. labels Jul 15, 2021

aduh95 reviewed Jul 15, 2021

View reviewed changes

Comment thread lib/internal/fs/copy/copy-sync.js Outdated

RyanZim mentioned this pull request Jul 15, 2021

fs.cp coming to Node.js core jprichardson/node-fs-extra#912

Open

aduh95 reviewed Jul 15, 2021

View reviewed changes

Comment thread lib/internal/fs/copy/copy-sync.js Outdated

Comment thread lib/internal/fs/copy/copy-sync.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

targos reviewed Jul 16, 2021

View reviewed changes

Comment thread lib/internal/fs/utils.js Outdated

This comment has been minimized.

Sign in to view

manidlou reviewed Jul 18, 2021

View reviewed changes

Comment thread doc/api/errors.md Outdated

Comment thread doc/api/errors.md Outdated

Comment thread doc/api/fs.md Outdated

Comment thread lib/internal/fs/copy/copy-sync.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

Comment thread lib/internal/fs/copy/copy.js Outdated

bcoe force-pushed the copy branch from f94a533 to 83a403c Compare July 19, 2021 02:34

bcoe force-pushed the copy branch from 5988d2c to 86d3eeb Compare July 25, 2021 20:25

bcoe closed this Aug 12, 2021

danielleadams mentioned this pull request Aug 16, 2021

v16.7.0 release proposal #39782

Merged

danielleadams added a commit that referenced this pull request Aug 16, 2021

2021-08-17, Version 16.7.0 (Current)

bb06ce8

Notable changes: * fs: * add recursive cp method (Benjamin Coe) #39372 PR-URL: #39782

aduh95 added the experimental Issues and PRs related to experimental features. label Aug 16, 2021

danielleadams added a commit that referenced this pull request Aug 17, 2021

2021-08-17, Version 16.7.0 (Current)

d5987f8

Notable changes: * fs: * experimental: add recursive cp method (Benjamin Coe) #39372 PR-URL: #39782

danielleadams added a commit that referenced this pull request Aug 18, 2021

2021-08-17, Version 16.7.0 (Current)

7ca38f0

Notable changes: * fs: * experimental: add recursive cp method (Benjamin Coe) #39372 PR-URL: #39782

targos added the dont-land-on-v14.x label Sep 4, 2021

theoludwig mentioned this pull request Sep 11, 2022

Stabilize fs.cp(), fs.cpSync(), fsPromises.cp() methods #44598

Closed

RyanZim added a commit to jprichardson/node-fs-extra that referenced this pull request Oct 25, 2022

Remove unneeded and buggy stats check

fe73a03

As per nodejs/node#39372 (comment) Resolves #918

RyanZim mentioned this pull request Oct 25, 2022

Remove unneeded and buggy stats check jprichardson/node-fs-extra#976

Merged

RyanZim added a commit to jprichardson/node-fs-extra that referenced this pull request Nov 19, 2022

Remove unneeded and buggy stats check (#976 )

1a3205d

As per nodejs/node#39372 (comment) Resolves #918

targos mentioned this pull request Apr 24, 2024

fs: ensure return value type of options.filter in cpSync consistent with doc #52461

Closed

neysidevhcr1j added a commit to neysidevhcr1j/neysidevhcr1j that referenced this pull request May 20, 2025

Remove unneeded and buggy stats check (#976)

2b9a8be

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

9liaswilde added a commit to 9liaswilde/robotboy6558 that referenced this pull request May 30, 2025

Remove unneeded and buggy stats check (#976)

508644a

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

AnthoneTurner added a commit to AnthoneTurner/stone that referenced this pull request Jun 10, 2025

Remove unneeded and buggy stats check (#976)

dbaf0aa

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

Ronaldnoore added a commit to Ronaldnoore/gcs that referenced this pull request Jun 10, 2025

Remove unneeded and buggy stats check (#976)

9323885

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

SaurabViena pushed a commit to SaurabViena/NoneCharacter that referenced this pull request Jun 13, 2025

Remove unneeded and buggy stats check (#976)

f85159a

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

bugcloudLeah pushed a commit to bugcloudLeah/vert-x3 that referenced this pull request Jun 15, 2025

Remove unneeded and buggy stats check (#976)

a39daeb

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

FabianSili pushed a commit to FabianSili/CazaresLuisc that referenced this pull request Jun 15, 2025

Remove unneeded and buggy stats check (#976)

ca1b9ce

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

JosepehWilson added a commit to JosepehWilson/Xilinxa that referenced this pull request Jul 6, 2025

Remove unneeded and buggy stats check (#976)

fed0f2b

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

StevensBrownu added a commit to StevensBrownu/funicular that referenced this pull request Jul 8, 2025

Remove unneeded and buggy stats check (#976)

1d36e7c

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

ID279184665 added a commit to ID279184665/phytochemical that referenced this pull request Jul 22, 2025

Remove unneeded and buggy stats check (#976)

e3f3f96

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

criticalPathway added a commit to criticalPathway/node-fs-extra that referenced this pull request Nov 17, 2025

Remove unneeded and buggy stats check (#976)

b95c1f1

As per nodejs/node#39372 (comment) Resolves jprichardson/node-fs-extra#918

coderabbitai Bot mentioned this pull request Aug 2, 2026

[Feat] KRIC standard snapshot transaction registration AquilaXk/easysubway-data#40

Merged

19 tasks

fs: add recursive cp method by bcoe · Pull Request #39372 · nodejs/node · GitHub

Uh oh!

Uh oh!

fs: add recursive cp method - #39372

fs: add recursive cp method#39372bcoe wants to merge 1 commit intonodejs:masternodejs/node:masterfrom bcoe:copybcoe/node-1:copyCopy head branch name to clipboard

Conversation

bcoe commented Jul 13, 2021 • edited by aduh95 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

targos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

iansu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bcoe commented Jul 15, 2021

Uh oh!

nodejs-github-bot commented Jul 15, 2021

Uh oh!

Uh oh!

RyanZim commented Jul 15, 2021

Uh oh!

RyanZim commented Jul 15, 2021

Uh oh!

aduh95 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bcoe commented Jul 15, 2021

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bcoe commented Jul 22, 2021

Uh oh!

bcoe commented Aug 12, 2021

Uh oh!

lostpebble commented Aug 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bcoe commented Aug 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

fs: add recursive cp method#39372
bcoe wants to merge 1 commit into
nodejs:masterfrom
bcoe:copy

bcoe commented Jul 13, 2021 •
edited by aduh95
Loading

lostpebble commented Aug 19, 2021 •
edited
Loading