grunt-attribution
Give credit to the 3rd party projects you use
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-attribution --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-attribution');
The "attribution" task
Overview
In your project's Gruntfile, add a section named attribution
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
attribution: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Options
options.include
Type: Array
Default value: ['dependencies']
An array of places in your package.json you want us to check for attribution
options.start
Type: String
Default value: '/*'
A string that is used at the beginning of the output file
options.end
Type: String
Default value: '*/'
A string that is used at the end of the output file
Usage Examples
Default Options
grunt.initConfig({
attribution: {
options: {},
files: {
'dest/attribution.js': 'package.json',
},
},
});
Custom Options
grunt.initConfig({
attribution: {
options: {
include: ['dependencies', 'devDependencies'],
start: '/**********',
end: '**********/'
},
files: {
'dest/attribution.js': 'package.json',
},
},
});
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
(Nothing yet)