What is cpy?
The cpy npm package is a simple file copying utility for Node.js. It allows you to copy files or directories from one location to another with various options such as overwriting existing files, preserving directory structure, and more.
What are cpy's main functionalities?
Copy files
This feature allows you to copy files matching a specific pattern (e.g., all PNG files in the 'source' directory) to a destination directory.
const cpy = require('cpy');
cpy(['source/*.png'], 'destination').then(() => {
console.log('Files copied!');
});
Copy files with options
This feature allows you to copy files with additional options such as not overwriting existing files (`overwrite: false`) and preserving the directory structure (`parents: true`).
const cpy = require('cpy');
cpy(['source/*.png'], 'destination', {
overwrite: false,
parents: true
}).then(() => {
console.log('Files copied with options!');
});
Copy and rename
This feature allows you to copy a file and rename it in the destination directory using a rename function.
const cpy = require('cpy');
cpy(['source/file.txt'], 'destination', {
rename: basename => `new-${basename}`
}).then(() => {
console.log('File copied and renamed!');
});
Other packages similar to cpy
ncp
The ncp (node-copy-paste) package is similar to cpy and provides asynchronous recursive file copying with Node.js. It is an older package and does not provide as modern a syntax as cpy, which uses promises.
fs-extra
fs-extra is a package that extends the built-in fs module and includes file copying functionality. It offers a broader set of file system operations compared to cpy, including copying, moving, deleting files, and more.
copyfiles
copyfiles is a package that provides a command-line utility to copy files. It can be used in npm scripts and has a flat option to copy all files to a single directory level. It is less feature-rich than cpy when it comes to API usage within Node.js code.
cpy
Copy files
Why
- Fast by using streams.
- Resilient by using graceful-fs.
- User-friendly by accepting globs and creating non-existant destination directories.
- User-friendly error messages.
Install
$ npm install --save cpy
Usage
const cpy = require('cpy');
cpy(['src/*.png', '!src/goat.png'], 'dist').then(() => {
console.log('files copied');
});
API
cpy(files, destination, [options])
files
Type: array
Files to copy.
destination
Type: string
Destination directory.
options
Type: object
Options are passed to cp-file and glob.
cwd
Type: string
Default: process.cwd()
Working directory to find source files.
parents
Type: boolean
Default: false
Preserve path structure.
rename
Type: string
Filename used to rename every file in files
.
Related
License
MIT © Sindre Sorhus