grunt-license-bower

Generate a list of licenses used within a project based on bower.json.

Getting Started

This plugin requires Grunt ~0.4.1

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

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

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

or load grunt tasks automatically

require('load-grunt-tasks')(grunt);

The "license" task

Overview

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

grunt.initConfig({
	license: {
      your_target: {
      // Target-specific file lists and/or options go here.
        options: {
        // Target-specific options go here.
           directory: 'bower_components',
           output: 'LICENSES'
        },
      },
    },
})

Options

options.directory

Type: String Default Value: bower_components

The path in which installed components should be saved. If not specified this defaults to bower_components.

options.output

Type: String Default Value: LICENSES

The path/filename to write the metadata to.

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.

senssei/grunt-license-bower