Scripts: Add support for license ignore

Author: aduth

packages/scripts/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.3.0 (Unreleased)
+
+### Improvements
+
+- New flag `--ignore` for `check-licenses` script
+
 ## 2.2.1 (2018-09-05)
 
 ### Bug Fix
@@ -8,7 +14,6 @@
 
 - Updated dependencies: `jest`, `npm-package-json-lint` and `read-pkg-up`
 
-
 ## 2.0.0 (2018-07-12)
 
 ### Breaking Change

packages/scripts/README.md

@@ -67,6 +67,27 @@ This is how you execute those scripts using the presented setup:
 * `npm run test:help` - prints all available options to configure unit tests runner.
 * `npm run test:watch` - runs all unit tests in the watch mode.
 
+### `wp-scripts check-licenses`
+
+Validates that all dependencies of a project are compatible with the project's own license.
+
+_Example:_
+
+```json
+{
+	"scripts": {
+		"check-licenses": "wp-scripts check-licenses --prod --gpl2 --ignore=abab",
+	}
+}
+```
+
+_Flags_:
+
+- `--prod` (or `--production`): When present, validates only `dependencies` and not `devDependencies`
+- `--dev` (or `--development`): When present, validates both `dependencies` and `devDependencies`
+- `--gpl2`: Validates against [GPLv2 license compatibility](https://www.gnu.org/licenses/license-list.en.html)
+- `--ignore=a,b,c`: A comma-separated set of package names to ignore for validation. This is intended to be used primarily in cases where a dependency's `license` field is malformed. It's assumed that any `ignored` package argument would be manually vetted for compatibility by the project owner.
+
 ## Inspiration
 
 This is inspired by [react-scripts](https://www.npmjs.com/package/react-scripts) and [kcd-scripts](https://www.npmjs.com/package/kcd-scripts).

packages/scripts/scripts/check-licenses.js

@@ -3,12 +3,13 @@
  */
 const spawn = require( 'cross-spawn' );
 const { existsSync, readFileSync } = require( 'fs' );
+const { sep } = require( 'path' );
 const chalk = require( 'chalk' );
 
 /**
  * Internal dependencies
  */
-const { hasCliArg } = require( '../utils' );
+const { getCliArg, hasCliArg } = require( '../utils' );
 
 /*
  * WARNING: Changes to this file may inadvertently cause us to distribute code that
@@ -24,6 +25,13 @@ const ERROR = chalk.reset.inverse.bold.red( ' ERROR ' );
 const prod = hasCliArg( '--prod' ) || hasCliArg( '--production' );
 const dev = hasCliArg( '--dev' ) || hasCliArg( '--development' );
 const gpl2 = hasCliArg( '--gpl2' );
+const ignored = hasCliArg( '--ignore' ) ?
+	getCliArg( '--ignore' )
+		// "--ignore=a, b" -> "[ 'a', ' b' ]"
+		.split( ',' )
+		// "[ 'a', ' b' ]" -> "[ 'a', 'b' ]"
+		.map( ( moduleName ) => moduleName.trim() ) :
+	[];
 
 /*
  * A list of license strings that we've found to be GPL2 compatible.
@@ -155,6 +163,23 @@ const checkLicense = ( allowedLicense, licenseType ) => {
 	return undefined !== subLicenseTypes.find( ( subLicenseType ) => checkLicense( allowedLicense, subLicenseType ) );
 };
 
+/**
+ * Returns true if the given module path is not to be ignored for consideration
+ * in license validation, or false otherwise.
+ *
+ * @param {string} moduleName Module path.
+ *
+ * @return {boolean} Whether module path is not to be ignored.
+ */
+const isNotIgnoredModule = ( moduleName ) => (
+	! ignored.some( ( ignoredItem ) => (
+		// `moduleName` is a file path to the module directory. Assume CLI arg
+		// is passed as basename of package (directory(s) after node_modules).
+		// Prefix with sep to avoid false-positives on prefixing variations.
+		moduleName.endsWith( sep + ignoredItem )
+	) )
+);
+
 // Use `npm ls` to grab a list of all the packages.
 const child = spawn.sync( 'npm', [
 	'ls',
@@ -163,7 +188,10 @@ const child = spawn.sync( 'npm', [
 	...( dev ? [ '--dev' ] : [] ),
 ] );
 
-const modules = child.stdout.toString().split( '\n' );
+const modules = child.stdout
+	.toString()
+	.split( '\n' )
+	.filter( isNotIgnoredModule );
 
 modules.forEach( ( path ) => {
 	if ( ! path ) {

packages/scripts/utils/index.js

@@ -11,10 +11,16 @@ const path = require( 'path' );
 const { getPackagePath, hasPackageProp } = require( './package' );
 const { exit, getCliArgs } = require( './process' );
 
-const first = ( list ) => list[ 0 ];
+const getCliArg = ( arg ) => {
+	for ( const cliArg of getCliArgs() ) {
+		const [ name, value ] = cliArg.split( '=' );
+		if ( name === arg ) {
+			return value || null;
+		}
+	}
+};
 
-const hasCliArg = ( arg ) => getCliArgs()
-	.some( ( value ) => first( value.split( '=' ) ) === arg );
+const hasCliArg = ( arg ) => getCliArg( arg ) !== undefined;
 
 const fromProjectRoot = ( fileName ) =>
 	path.join( path.dirname( getPackagePath() ), fileName );
@@ -86,6 +92,7 @@ module.exports = {
 	fromConfigRoot,
 	getCliArgs,
 	hasCliArg,
+	getCliArg,
 	hasProjectFile,
 	hasPackageProp,
 	spawnScript,