Documentation for copy() options.filter function

I’m not sure how to use the options.filter function with copy().

The docs say:

Function to filter copied files. Return true to include, false to exclude.

I need to copy a folder and sub files/folders, however I need to exclude some from the copy (I’m copying a node project folder and need to exclude the node_modules folder within). The above makes it sound like this function can used but I’m not sure how.

Can this function be used for what I need…?

[pwang2]

@stephen-last You may have the same puzzle as I had. When copying directory and use the filter to include/exclude files in subdirectory, it actually filters from the root first. If the root folder does not match the filter function, it did not go to the subdirectory at all. To make it work as expected, I use this workaround. here if (fs.lstatSync(n).isDirectory()) {return true} is needed to bypass the root folder to have chance to match sub directories and files.

src
├── bar
│   └── baz
│       └── file1.txt
└── foo
    ├── baz
    │   └── file1.txt
    └── mie.js

var fs = require('fs-extra');
fs.copy('./src', './dist', {
        clobber: true,
        filter: n => {
             if (fs.lstatSync(n).isDirectory()) {
                return true;
            }
            var result = /\/baz\//.test(n);
            console.log(result ? 'copied' : 'skipped', n);
            return result;
        }
    },
    () => console.log('done')
);

This gives output like this.

➜ test node index.js skipped /private/tmp/test/src/foo/mie.js copied /private/tmp/test/src/foo/baz/file1.txt copied /private/tmp/test/src/bar/baz/file1.txt done

[RyanZim]

Quick example:

fs.copy(src, dest, {
  filter: function (path) {
    return path.indexOf('node_modules') > -1
  }
}, callback)

We should add an example to the docs.