Copy files
npm install @brickdoc/cpyForked from sindresorhus/cpy and add security patch for CVE-2020-28469.
> Copy files
- Fast by using streams.
- Resilient by using graceful-fs.
- User-friendly by accepting globs and creating non-existent destination directories.
- User-friendly error messages.
- Progress reporting.
``
$ npm install @brickdoc/cpy
`js
const cpy = require("cpy");
(async () => {
await cpy(["source/*.png", "!source/goat.png"], "destination");
console.log("Files copied!");
})();
`
Returns a Promise with the destination file paths.
#### source
Type: string | string[]
Files to copy.
If any of the files do not exist, an error will be thrown (does not apply to globs).
#### destination
Type: string
Destination directory.
#### options
Type: object
Options are passed to globby.
In addition, you can specify the below options.
##### cwd
Type: string\process.cwd()
Default:
Working directory to find source files.
##### overwrite
Type: boolean\true
Default:
Overwrite existing files.
##### parents
Type: boolean\false
Default:
Preserve path structure.
##### rename
Type: string | Function
Filename or function returning a filename used to rename every file in source.
`js
const cpy = require("cpy");
(async () => {
await cpy("foo.js", "destination", {
rename: (basename) => prefix-${basename},`
});
})();
##### concurrency
Type: number\(os.cpus().length || 1) * 2
Default:
Number of files being copied concurrently.
##### ignoreJunk
Type: boolean\true
Default:
Ignores junk files.
##### filter
Type: Function
Function to filter files to copy.
Receives a source file object as the first argument.
Return true to include, false to exclude. You can also return a Promise that resolves to true or false.
`js
const cpy = require("cpy");
(async () => {
await cpy("foo", "destination", {
filter: (file) => file.extension !== "nocopy",
});
})();
`
##### Source file object
###### path
Type: string\'/tmp/dir/foo.js'
Example:
Resolved path to the file.
###### relativePath
Type: string\'dir/foo.js'
Example: if cwd was '/tmp'
Relative path to the file from cwd.
###### name
Type: string\'foo.js'
Example:
Filename with extension.
###### nameWithoutExtension
Type: string\'foo'
Example:
Filename without extension.
###### extension
Type: string\'js'
Example:
File extension.
#### handler(progress)
Type: Function
##### progress
`js`
{
completedFiles: number,
totalFiles: number,
completedSize: number,
percent: number
}
- completedSize is in bytespercent
- is a value between 0 and 1
Note that the .on() method is available only right after the initial cpy call, so make sure you add a handler before awaiting the promise:
`js``
(async () => {
await cpy(source, destination).on("progress", (progress) => {
// …
});
})();
- cpy-cli - CLI for this module
- cp-file - Copy a single file
- move-file - Move a file
- make-dir - Make a directory and its parents if needed