kibana/tasks/licenses.js
Tyler Smalley ad97552c03 Upgrade to Node 6.4.0
* Updated dependencies to include graceful-fs ~4.0
* Replaced deprecated grunt-s3 package with suggested grunt-aws-s3
* Update licenses task to better support npm 3

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2016-08-25 08:40:14 -07:00

78 lines
2 KiB
JavaScript

import _ from 'lodash';
import { fromNode } from 'bluebird';
import npm from 'npm';
import npmLicense from 'license-checker';
export default function licenses(grunt) {
grunt.registerTask('licenses', 'Checks dependency licenses', async function () {
const config = this.options();
const done = this.async();
const result = [];
const options = {
start: process.cwd(),
production: true,
json: true
};
const packages = await fromNode(cb => {
npmLicense.init(options, (result, error) => {
cb(undefined, result);
});
});
/**
* Licenses for a package by name with overrides
*
* @param {String} name
* @return {Array}
*/
function licensesForPackage(name) {
let licenses = packages[name].licenses;
if (config.overrides.hasOwnProperty(name)) {
licenses = config.overrides[name];
}
return typeof licenses === 'string' ? [licenses] : licenses;
}
/**
* Determine if a package has a valid license
*
* @param {String} name
* @return {Boolean}
*/
function isInvalidLicense(name) {
let licenses = licensesForPackage(name);
// verify all licenses for the package are in the config
return _.intersection(licenses, config.licenses).length < licenses.length;
}
// Build object containing only invalid packages
const invalidPackages = _.pick(packages, (pkg, name) => {
return isInvalidLicense(name);
});
if (Object.keys(invalidPackages).length) {
const util = require('util');
const execSync = require('child_process').execSync;
const names = Object.keys(invalidPackages);
// Uses npm ls to create tree for package locations
const tree = execSync(`npm ls ${names.join(' ')}`);
grunt.log.debug(JSON.stringify(invalidPackages, null, 2));
grunt.fail.warn(
`Non-confirming licenses:\n ${names.join('\n ')}\n\n${tree}`,
invalidPackages.length
);
}
done();
});
};