https://github.com/senssei/grunt-license-bower

Generate a list of licenses used within a project based on bower.json.
https://github.com/senssei/grunt-license-bower

Last synced: 23 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/senssei/grunt-license-bower
• Owner: senssei
• License: mit
• Created: 2014-07-28T11:50:05.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-03-02T17:46:30.000Z (over 6 years ago)
• Last Synced: 2024-10-09T21:53:52.168Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://github.com/senssei/grunt-license-bower
• Size: 15.6 KB
• Stars: 2
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-license-bower [![Build Status](https://secure.travis-ci.org/senssei/grunt-license-bower.png?branch=master)](http://travis-ci.org/senssei/grunt-license-bower)

[![NPM version](https://badge.fury.io/js/grunt-license-bower.svg)](http://badge.fury.io/js/grunt-license-bower)

[![Dependency Status](https://gemnasium.com/senssei/grunt-license-bower.svg)](https://gemnasium.com/senssei/grunt-license-bower) 

[![Code Climate](https://codeclimate.com/github/senssei/grunt-license-bower.png)](https://codeclimate.com/github/senssei/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](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

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:

```js

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

```

or load grunt tasks automatically

  

```js

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()`.

```js

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](http://gruntjs.com/).

## License

Copyright (c) 2014 Rafał Warzycha  

Licensed under the MIT license.