Generates a list of licenses used in a project
Generates a list of recursively dependent licenses used within a project
This plugin requires Grunt
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 --save-dev
In your project's Gruntfile, add a section named
license to the data object passed into
gruntinitConfiglicense:options:// Task-specific options go here.your_target:// Target-specific file lists and/or options go here.
Only generate a list of unknown licenses (as opposed to all)
Project directory from which to start the search
How deep to search for dependencies. Setting value to
null will recurse through all.
The types of dependencies to include, such as:
["dependencies", "devDependencies", "peerDependencies"].
The path/filename to write the metadata to (WIP: should eventually output the actual licenses)
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.