grunt-mcopy

0.4.3 • Public • Published

grunt-mcopy v0.4.3 Build Status

Copy files and folders. Fork of grunt-contrib-copy.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-mcopy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-mcopy');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Copy task

Run this task with the grunt copy command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

process

Type: Function(content, srcpath)

This option is passed to grunt.file.copy as an advanced way to control the file contents that are copied.

processContent has been renamed to process and the option name will be removed in the future.

noProcess

Type: String

This option is passed to grunt.file.copy as an advanced way to control which file contents are processed.

processContentExclude has been renamed to noProcess and the option name will be removed in the future.

encoding

Type: String Default: grunt.file.defaultEncoding

The file encoding to copy files with.

checkMtime

Type: Boolean

If true check for last modification time of destination files, and if no changes (modification time are equal) don't do copy.

Usage Examples

copy: {
  main: {
    files: [
      // includes files within path
      {expand: true, src: ['path/*'], dest: 'dest/', filter: 'isFile'},
 
      // includes files within path and its sub-directories
      {expand: true, src: ['path/**'], dest: 'dest/'},
 
      // makes all src relative to cwd
      {expand: true, cwd: 'path/', src: ['**'], dest: 'dest/'},
 
      // flattens results to a single level
      {expand: true, flatten: true, src: ['path/**'], dest: 'dest/', filter: 'isFile'}
    ]
  }
}

This task supports all the file mapping format Grunt supports. Please read Globbing patterns and Building the files object dynamically for additional details.

Here are some additional examples, given the following file tree:

$ tree -I node_modules
.
├── Gruntfile.js
└── src
    ├── a
    └── subdir
        └── b
 
2 directories, 3 files

Copy a single file tree:

copy: {
  main: {
    src: 'src/*',
    dest: 'dest/',
  },
},
$ grunt copy
Running "copy:main" (copy) task
Created 1 directories, copied 1 files
 
Done, without errors.
$ tree -I node_modules
.
├── Gruntfile.js
├── dest
│   └── src
│       ├── a
│       └── subdir
└── src
    ├── a
    └── subdir
        └── b
 
5 directories, 4 files

Flattening the filepath output:

copy: {
  main: {
    expand: true,
    cwd: 'src/',
    src: '**',
    dest: 'dest/',
    flatten: true,
    filter: 'isFile',
  },
},
$ grunt copy
Running "copy:main" (copy) task
Copied 2 files
 
Done, without errors.
$ tree -I node_modules
.
├── Gruntfile.js
├── dest
│   ├── a
│   └── b
└── src
    ├── a
    └── subdir
        └── b
 
3 directories, 5 files

Release History

  • 2013-10-29   v0.4.2   Added checkMtime option for skip coping already fresh files.
  • 2013-03-26   v0.4.1   Output summary by default ("Copied N files, created M folders"). Individual transaction output available via --verbose.
  • 2013-02-15   v0.4.0   First official release for Grunt 0.4.0.
  • 2013-01-23   v0.4.0rc7   Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
  • 2013-01-14   v0.4.0rc5   Updating to work with grunt v0.4.0rc5. Conversion to grunt v0.4 conventions. Replace basePath with cwd. Empty directory support.
  • 2012-10-18   v0.3.2   Pass copyOptions on single file copy.
  • 2012-10-12   v0.3.1   Rename grunt-contrib-lib dep to grunt-lib-contrib.
  • 2012-09-24   v0.3.0   General cleanup and consolidation. Global options depreciated.
  • 2012-09-18   v0.2.4   No valid source check.
  • 2012-09-17   v0.2.3   Path.sep fallback for node <= 0.7.9.
  • 2012-09-17   v0.2.2   Single file copy support. Test refactoring.
  • 2012-09-07   v0.2.0   Refactored from grunt-contrib into individual repo.

Task submitted by Chris Talkington

This file was generated on Tue Oct 29 2013 17:50:12.

Readme

Keywords

none

Package Sidebar

Install

npm i grunt-mcopy

Weekly Downloads

0

Version

0.4.3

License

none

Last publish

Collaborators

  • anru