Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/copy
Copy files using glob patterns. Sync, async, promise or streams. (node.js utility)
https://github.com/jonschlinkert/copy
copy files fs javascript node nodejs write writefile
Last synced: about 1 hour ago
JSON representation
Copy files using glob patterns. Sync, async, promise or streams. (node.js utility)
- Host: GitHub
- URL: https://github.com/jonschlinkert/copy
- Owner: jonschlinkert
- License: mit
- Created: 2015-07-03T03:54:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T20:02:12.000Z (over 2 years ago)
- Last Synced: 2024-05-01T22:11:34.628Z (5 months ago)
- Topics: copy, files, fs, javascript, node, nodejs, write, writefile
- Language: JavaScript
- Size: 70.3 KB
- Stars: 94
- Watchers: 5
- Forks: 126
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# copy [](https://www.npmjs.com/package/copy) [](https://npmjs.org/package/copy) [](https://npmjs.org/package/copy) [](https://travis-ci.org/jonschlinkert/copy) [](https://ci.appveyor.com/project/jonschlinkert/copy)
> Copy files or directories using globs.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Examples](#examples)
- [API](#api)
- [CLI](#cli)
- [History](#history)
- [About](#about)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save copy
```
## Usage
```js
var copy = require('copy');
```
See the [API documentation](#api) 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
```js
copy('*.js', 'foo', function(err, files) {
if (err) throw err;
// `files` is an array of the files that were copied
});
```
**Usage with [gulp](http://gulpjs.com)**
In your project's gulpfile.js:
```js
var gulp = require('gulp');
var copy = require('copy');
gulp.task('default', function (cb) {
copy('fixtures/*.txt', 'actual', cb);
});
```
## API
### [copy](index.js#L27)
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**
```js
copy('*.js', 'dist', function(err, file) {
// exposes the vinyl `file` created when the file is copied
});
```
### [.copy.each](index.js#L79)
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**
```js
copy.each(['foo.txt', 'bar.txt', 'baz.txt'], 'dist', function(err, files) {
// exposes the vinyl `files` created when the files are copied
});
```
### [.copy.one](index.js#L132)
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**
```js
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:
```js
$ npm install --global copy
```
This adds `copy` to your system path, allowing the `copy` command to be executed anywhere.
**CLI usage**
```sh
$ copy
```
* `patterns`: glob pattern or array of file paths
* `dir`: destination directory
**Example**
Copy* all files with the `.js` extension to the `foo` directory
```sh
$ 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](#api)
## About
### Related projects
* [expand-config](https://www.npmjs.com/package/expand-config): Expand tasks, targets and files in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-config "Expand tasks, targets and files in a declarative configuration.")
* [expand-files](https://www.npmjs.com/package/expand-files): Expand glob patterns in a declarative configuration into src-dest mappings. | [homepage](https://github.com/jonschlinkert/expand-files "Expand glob patterns in a declarative configuration into src-dest mappings.")
* [expand-target](https://www.npmjs.com/package/expand-target): Expand target definitions in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-target "Expand target definitions in a declarative configuration.")
* [expand-task](https://www.npmjs.com/package/expand-task): Expand and normalize task definitions in a declarative configuration. | [homepage](https://github.com/jonschlinkert/expand-task "Expand and normalize task definitions in a declarative configuration.")
* [export-files](https://www.npmjs.com/package/export-files): node.js utility for exporting a directory of files as modules. | [homepage](https://github.com/jonschlinkert/export-files "node.js utility for exporting a directory of files as modules.")
* [write](https://www.npmjs.com/package/write): Write data to a file, replacing the file if it already exists and creating any… [more](https://github.com/jonschlinkert/write) | [homepage](https://github.com/jonschlinkert/write "Write data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Thin wrapper around node's native fs methods.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 61 | [jonschlinkert](https://github.com/jonschlinkert) |
| 2 | [joakimbeng](https://github.com/joakimbeng) |
| 1 | [bleathem](https://github.com/bleathem) |
| 1 | [doowb](https://github.com/doowb) |
| 1 | [gsantiago](https://github.com/gsantiago) |
| 1 | [SoulRIver2015](https://github.com/SoulRIver2015) |
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 01, 2017._