grunt-copy-bower

A grunt plugin that copies bower component files to wherever you want.

I found neither grunt-bowercopy nor grunt-bower-copy does the intuitive things they should do.Bower is manager tool for front-end compoents.Every component has its own bower.json which indicates the main file,so copying operation requires no source file but the destination.So obvious!

Getting Started

This plugin requires Grunt ~0.4.5

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-copy-bower --save-dev

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

grunt.loadNpmTasks('grunt-copy-bower');

The "copy_bower" task

Overview

In your project's Gruntfile, add a section named copy_bower to the data object passed into grunt.initConfig().

grunt.initConfig({
  copy_bower: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  }
});

Options

options.shim

Type: Object Default value: {}

Override default copying behavier of a component

options.ignore

Type: Function|Array|String|RegExp Default value: []

A series of pattern to match the files you want to ignore.

options.install

Type: Boolean Default value: false

If try to install bower components before copying.

Usage Examples

In general,you should always define only one task,because all the src defined in bower will be copied if not in ignore pattern.

In shim,you could override the default copying behavier,e.g,

grunt.initConfig({
  copy_bower: {
    options: {
      shim: {
        'requirejs-text': {
          main: 'text.js',
          dest: 'test/dest/plugin/'
        },
        'underscore': {
           dest: 'test/dest/us.js'
        }
      }
    },
    dest: 'test/dest/'
  }
});

All the files defined in bower will be copied into test/dest keeping the origin file name except underscore.js to us.js,text.js to plugin/text.js.Note that no main file defined will lead to a warning,so the main defined for requirejs-text is highly required.

You can also define dest as a function:

grunt.initConfig({
  copy_bower: {
    options: {
      shim: {
        'requirejs-text': {
          main: 'text.js',
          dest: 'test/dest/plugin/'
        },
        'underscore': {
           dest: 'test/dest/_.js'
        }
      }
    },
    dest: function(path) {
          if (/\.(c|le)ss$/i.test(path)) {
            return 'test/dest/css/';
          } else if (/\.js$/i.test(path)) {
            return 'test/dest/js/';
          } else {
            return 'test/dest/bin';
          }
    }
  }
});

But it's restricted that dest in tasks does this,not the ones in options.shim.

There are some shortcuts for dest,e.g,

grunt.initConfig({
  copy_bower: {
    dest: 'test/dest',
    cssDest: 'test/dest/css',
    jsDest: 'test/dest/js'
  }
});

ignore could be patterns in Array/Function/RegExp/String,and nest of arrays is allowed,e.g,

grunt.initConfig({
  copy_bower: {
    options: {
      shim: {
        bootstrap: {
              ignore: ['less/*.less', /\.(eot|svg|ttf|woff)$/i, functfilename) {
            if ('dist/js/bootstrap.js' === filename) {
              return true;
            }
          }]
        }
      },
      ignore: 'dist/js/bootstrap.css'
    },
    dest: 'test/dest/'
  }
});

ignore in options could work too.Note that the patterns only match the main file in bower,not the real file name or path.

Setting options.install to true will enable installing bower components before any copying.

grunt.initConfig({
  copy_bower: {
    options: {
      shim: {
        install: true
      }
    },
    dest: 'test/dest/'
  }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• 2014-11-27: Support basic copying operation