Skip to content

Colorfully and informatively copy files without overwriting

License

Notifications You must be signed in to change notification settings

dmitriz/gently-copy

Repository files navigation

gently-copy

Safely, colorfully and informatively copy files without overwriting

npm version Build Status Dependency Status

PRs Welcome MIT License npm downloads

js-standard-style

Why?

  • Copying files is sensitive operation with possible side-effects.
  • Standard utilities do not sufficiently inform the user about what is going on.

Features

  • Safely copy files and directories without overwriting.
  • Skip overwriting existing files, inform instead (or configure to overwrite instead with option = {overwrite: true}.
  • Create new directories if needed.
  • Clearly and colorfully inform about all actions peformed.

Install

$ npm install --save gently-copy

Usage

var gentlyCopy = require('gently-copy')

var fileList = ['some-file', 'some-dir']
var dest = 'some-dest'

gentlyCopy(fileList, dest) // no overwriting (default)
gentlyCopy(fileList, dest, {overwrite: true}) // force overwriting

Console output with colors, thanks to the wonderful chalk:

= Begin copying files
 - Copying file or directory: some-file
 - Copying file or directory: some-dir
= End copying files

API

gentlyCopy (source, destination, options)

source

Type: string or (array of strings)

Single or list of file and directory name(s).

destination

Type: string

Destination directory name.

options (optional)

Type: object

To overwrite existing files, pass option = {overwrite: true}

License

MIT © Dmitri Zaitsev

About

Colorfully and informatively copy files without overwriting

Resources

License

Stars

Watchers

Forks

Packages

No packages published