@wenbo/copy

copy

Copy files or directories using globs.

TOC

• Install
• Usage
• Examples
• API
• CLI
• History
• Related projects
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save copy

Usage

var copy = require('copy');

See the API documentation for usage details and available methods.

Examples

The main export is a function that takes:

• src - glob pattern or file path(s)
• dest - the destination directory
• cb - callback function

copy('*.js', 'foo', function(err, files) {
  if (err) throw err;
  // `files` is an array of the files that were copied
});

Usage with gulp

In your project's gulpfile.js:

var gulp = require('gulp');
var copy = require('copy');

gulp.task('default', function (cb) {
  copy('fixtures/*.txt', 'actual', cb);
});

API

copy

Copy a filepath, vinyl file, array of files, or glob of files to the given destination directory, with options and callback function that exposes err and the array of vinyl files that are created by the copy operation.

Params

• patterns {String|Object|Array}: Filepath(s), vinyl file(s) or glob of files.
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy('*.js', 'dist', function(err, file) {
  // exposes the vinyl `file` created when the file is copied
});

.copy.each

Copy an array of files to the given destination directory, with options and callback function that exposes err and the array of vinyl files that are created by the copy operation.

Params

• files {Array}: Filepaths or vinyl files.
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy.each(['foo.txt', 'bar.txt', 'baz.txt'], 'dist', function(err, files) {
  // exposes the vinyl `files` created when the files are copied
});

.copy.one

Copy a single file to the given dest directory, using the specified options and callback function.

Params

• file {String|Object}: Filepath or vinyl file
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy.one('foo.txt', 'dist', function(err, file) {
  if (err) throw err;
  // exposes the vinyl `file` that is created when the file is copied
});

CLI

To use the CLI, install copy globally with the following command:

$ npm install --global copy

This adds copy to your system path, allowing the copy command to be executed anywhere.

CLI usage

$ copy <patterns> <dir>

• patterns: glob pattern or array of file paths
• dir: destination directory

Example

Copy* all files with the .js extension to the foo directory

$ copy *.js foo

*Note that glob patterns may need to be wrapped in quotes depending on the shell you're using.

History

v0.2.0 - breaking changes

• The API was changed in 0.2.0. please review the API documentation

Related projects

You might also be interested in these projects:

• expand-config: Expand tasks, targets and files in a declarative configuration. | homepage
• expand-files: Expand glob patterns in a declarative configuration into src-dest mappings. | homepage
• expand-target: Expand target definitions in a declarative configuration. | homepage
• expand-task: Expand and normalize task definitions in a declarative configuration. | homepage
• export-files: node.js utility for exporting a directory of files as modules. | homepage
• write: Write files to disk, creating intermediate directories if they don't exist. | homepage

Contributing

This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.

Building docs

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on June 19, 2016.