hypexr / grunt-version-copy-bower-components Goto Github PK

A Grunt plugin to version and stage Bower components for release

License: MIT License

JavaScript 91.36% CSS 1.26% HTML 7.38%

grunt-version-copy-bower-components's Introduction

grunt-version-copy-bower-components

This plugin copies Bower components into a staging directory with the component's versions appended to the directory name. It will also fix references to the components in HTML or other specified files. This aids in creating releases so caching layers will not serve stale libraries when there are updates and so that caches don't need to be updated with every deploy when the library version hasn't changed.

Getting Started

This plugin requires Grunt ~0.4.4

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

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

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

This plugin may not work with every bower component. Many of the popular ones have been tested, but if the components packaging is not standard there could be problems.

The "versionCopyBowerComponents" task

Overview

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

grunt.initConfig({
  versionCopyBowerComponents: {
    options: {
      // Task-specific options go here.
    }
  }
});

Options

options.dest

Type: String Default value: dist/libs

The location to place the versioned bower components.

options.exclude

Type: Array Default value: []

Bower libraries that you don't want versioned and copied to the destination.

options.filesReferencingComponents.files

Type: Array Default value: []

An array of files that have references to bower components. For example if you have installed bootstrap with bower and your html file is like:

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>Test Page</title>
  <link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap.css">
  <script src="bower_components/bootstrap/dist/js/bootstrap.js">
</head>
<body>
</body>
</html>

you would list this file in the files array so that it is updated with the new bootstrap locations post versioning. All files that reference bower components should be listed here.

options.filesReferencingComponents.useComponentMin

Type: Boolean Default value: false

Change references to bower component in files to use the .min in the filename if it exists.

Example Options

grunt.initConfig({
  versionCopyBowerComponents: {
    options: {
      exclude: ['underscore'],
      dest: 'dist/libs',
      filesReferencingComponents: {
        files: ['dist/test.html', 'dist/test.css'],
        useComponentMin: true
      }
    }
  }
});

With these options all of the bower components except for underscore will be versioned and copied to 'dist/libs'.

The files 'dist/test.html' and 'dist/test.css' will be modified with the correct paths to the bower components ('lib/component-version') and will use min in the file name if a minified resource exists.

grunt-version-copy-bower-components's People

Contributors

Stargazers

Watchers

Forkers

alexbartsch gitter-badger gruntjs-updater gfmclean emmanuelconrardy

grunt-version-copy-bower-components's Issues

How can I remove version numbers?

I have the following configuration

module.exports = {
  options: {
    exclude: [
     //excludes here
     ],
    dest: path.join(ROOT_LOCATION, 'vendor'),
    filesReferencingComponents: {
      files: [
        path.join(ROOT_LOCATION, 'testapp', 'index.html'),
      ],
      useComponentMin: true
    }
  }
};

So now all bower components go to vendors library with version numbers.

However, I would like to override the behaviour for say one file and for that I do not want the version number attached to the component folder.

So for example if this copies jquery-1.10.0 into vendor folder, I would like it to be just jquery. Reason being the JS code is referencing the jquery folder and I would not like to hardcoded version # in it.

Is that possible without me having to create a separate grunt task for it.

It emits a fatal error after added bootstrap by `bower install bootstrap --save`

It works well from I first use it. But It emits a fatal error as following.
Running "versionCopyBowerComponents" task Fatal error: Cannot read property 'name' of undefined

How can I fix it?

VersionCopy task adds extra c: to the end of directory it tries to create

The issue of contrib-copy seems to be realized also under the hood on the codes of this component.
gruntjs/grunt-contrib-copy#134

This all means, copy of js-deps is not possible.

I used modified code like this:

versionCopyBowerComponents: {
options: {
exclude: ['underscore'],
dest: 'cordova/www/js',
filesReferencingComponents: {
files: ['cordova/www/index.html'],
useComponentMin: true
}
}
}

So taken from https://www.npmjs.com/package/grunt-version-copy-bower-components and changed the dist folder to another, copy is not working as it tries to copy the deps to a folder having c: at the end.

My operation system is Windows 8.1 and I run it from Visual Studio plugin and also from cmd with newest grunt.

A C: added to creating a directory.

I am working under Windows. Visual Studio and utilizing Node.js command prompt.

Following is my grunt section:

versionCopyBowerComponents: {
options: {
exclude: ['underscore'],
//cwd: 'js', // source
dest: 'build/js/vendor/bower',
filesReferencingComponents: {
files: ['examples/ModalTest.html', 'Utilities/jQuery.modalDialog.min.js'],
useComponentMin: true
}
}
}

Following is the result:

C:\Users\GMac\Source\Repos\MyProject\MyProject>grunt versionCopyBowerComponents
Running "versionCopyBowerComponents" task

Successfully obtained grunt packages and versions
bootstrap: 3.3.6
jquery: 2.2.3
datatables: 1.10.11
datatables.net: 1.10.12
datatables.net-bs: 1.10.12
datatables.net-responsive: 2.1.0
datatables.net-responsive-dt: 2.1.0
printThis: 0.1.2
Fatal error: Unable to create directory "C:\Users\GMac\Source\Repos\MyProject\MyProject\build\js\vendor\bower\bootstrap-3.3.6C:" (Error code: ENOENT).

Any ideas of how to overcome this? I would appreciate any help I can get.

Thanks