Grunt-legal-eagle NPM

grunt-legal-eagle

Generate a LICENSE file with all the licenses for your dependencies, extracted using legal-eagle.

Getting Started

This plugin requires Grunt ~0.4.0

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-legal-eagle --save-dev

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

grunt.loadNpmTasks('grunt-legal-eagle');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Legal Eagle task

Run this task with the grunt legal-eagle command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Usage

To generate a LICENSE file starting from a particular directory:

'legal-eagle': {
  app: {
    src: 'path/to/app/'
    dest: 'path/to/dist/LICENSE'
  }
}

You can also provide overrides for certain dependencies:

'legal-eagle': {
  options: {
    overrides: {
      'aws-sign@0.3.0': {
        repository: 'https://github.com/mikeal/aws-sign',
        license: 'MIT',
        source: 'index.js'
      }
    }
  },
  baz: {
    src: 'path/to/baz/'
    dest: 'path/to/dist/LICENSE-BAZ'
  },
  qux: {
    src: 'path/to/qux/'
    dest: 'path/to/dist/LICENSE-QUX'
  }
}

Options

src

Type: String

Path to the folder that needs to be scanned.

dest

Type: String

Path to the file that will be written with the summary.

options.safeLicenses

Type: Array[String] Default: ['Apache', 'BSD', 'CC-BY', 'ISC', 'MIT', 'Unlicense', 'WTF']

List of licenses that are considered safe for your project.

options.failOnUnknown

Type: Boolean Default: true

Fail the build if there are dependencies with an unknown license.

options.failOnUnsafe

Type: Boolean Default: true

Fail the build if there are dependencies with an unsafe license (not listed in safeLicenses).

options.omitSafe

Type: Boolean Default: false

Omit safe licenses in the summary, showing only unknown and unsafe ones.

options.omitSourceText

Type: Boolean Default: false

Omit license source text in the summary.

options.overrides

Type: Object Default: {}

If you know the license of a given dependency but legal-eagle can't automatically determine it, pass an overrides hash with its name@version as the key, and the license, source and sourceText you want to use in the summary.