license-compatibility-checker/README.md

Check npm dependencies' package.json for license compatibility (aka compliance check) with the current project based on spdx notation and naming conventions.

# license-compatibility-checker
Check npm dependencies' package.json for license compatibility (aka compliance check) with the current project based on spdx notation and naming conventions.

[![NPM](https://nodei.co/npm/license-compatibility-checker.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/license-compatibility-checker/) 
[![NPM](https://nodei.co/npm-dl/license-compatibility-checker.png?months=9&height=3)](https://nodei.co/npm/license-compatibility-checker/)

[![Build Status](https://travis-ci.org/HansHammel/license-compatibility-checker.svg?branch=master)](https://travis-ci.org/HansHammel/license-compatibility-checker)
[![npm version](https://img.shields.io/npm/v/license-compatibility-checker.svg)](https://www.npmjs.com/package/license-compatibility-checker)
[![npm license](https://img.shields.io/npm/l/license-compatibility-checker.svg)](https://www.npmjs.com/package/license-compatibility-checker)
[![npm download](https://img.shields.io/npm/dm/license-compatibility-checker.svg)](https://www.npmjs.com/package/license-compatibility-checker)
[![npm download](https://img.shields.io/npm/dt/license-compatibility-checker.svg)](https://www.npmjs.com/package/license-compatibility-checker)
[![Package Quality](http://npm.packagequality.com/shield/license-compatibility-checker.svg)](http://packagequality.com/#?package=license-compatibility-checker)
[![Inline docs](http://inch-ci.org/github/HansHammel/license-compatibility-checker.svg?branch=master)](http://inch-ci.org/github/HansHammel/license-compatibility-checker)
[![star this repo](http://githubbadges.com/star.svg?user=HansHammel&repo=license-compatibility-checker&style=flat&color=fff&background=007ec6)](https://github.com/HansHammel/license-compatibility-checker)
[![fork this repo](http://githubbadges.com/fork.svg?user=HansHammel&repo=license-compatibility-checker&style=flat&color=fff&background=007ec6)](https://github.com/HansHammel/license-compatibility-checker/fork)
[![david dependency](https://img.shields.io/david/HansHammel/license-compatibility-checker.svg)](https://david-dm.org/HansHammel/license-compatibility-checker)
[![david devDependency](https://img.shields.io/david/dev/HansHammel/license-compatibility-checker.svg)](https://david-dm.org/HansHammel/license-compatibility-checker)
[![david optionalDependency](https://img.shields.io/david/optional/HansHammel/license-compatibility-checker.svg)](https://david-dm.org/HansHammel/license-compatibility-checker)
[![david peerDependency](https://img.shields.io/david/peer/HansHammel/license-compatibility-checker.svg)](https://david-dm.org/HansHammel/license-compatibility-checker)
[![npms score](https://badges.npms.io/license-compatibility-checker.svg)](https://www.npmjs.com/package/license-compatibility-checker)
[![Known Vulnerabilities](https://snyk.io/test/github/HansHammel/license-compatibility-checker/badge.svg)](https://snyk.io/test/github/HansHammel/license-compatibility-checker)

## This is WIP and likely to change but already useable.
Does a simple comparison like Public Domain > Permissive > Weakly Protective > Strongly Protective > Network Protective of the primary dependencies in node_modules (no recursive search).
Checks for unlicensed or unknown licenses.

Screenshot with sample data (some licenses changed for demo)
[![Screenshot](screenshots/screen.png)](screenshots/screen.png)

# Install

```sh
npm install license-compatibility-checker -g
```

or better

```sh
npm install license-compatibility-checker --save-dev
```

or

```sh
npm install https://github.com/HansHammel/license-compatibility-checker.git --save-dev
```

# Usage

## CLI

In your project folder run

```bash
license-compatibility-checker
```
	
or

```bash
lcc PATH_TO_PACKAGE_JSON
```
	
or (win)

```bash
.\node_modules\.bin\lcc ..\droppy\package.json c:/l/droppy/node_modules
```

or (*nix)

```bash
./node_modules/.bin/lcc PATH_TO_PACKAGE_JSON PATH_TO_MODULES
```

etc.

Supports to optional parameters: 
1. path to package json (defaults to ./package.json)
2. path to node_modules (defaults to ./node_modules)

Paths can be relative to the CWD and/or mixed Win/nix-style 

## As Module

### v0.2.x

```node
var lcc = require('license-compatibility-checker');
var path = require('path');
lcc.check(path.join(process.cwd(),'package.json'), path.join(process.cwd(),"node_modules"),function(/*error*/ err,/*boolean*/ passed,/*string*/ output){
  if (err) console.log(err);
  else if (passed)
  {
	//No license issues found
	console.log(output);
  } else
  { 
	//License issues found 
	console.log(output);
	//process.exit(1);
	//or
	//throw new Error('License issues found');
  }  
});
```

### v0.1.1

```node
var lcc = require('license-compatibility-checker');
var path=require('path');
lcc.check(path.join(process.cwd(),'package.json'), path.join(process.cwd(),"node_modules"));
```

## Legal notice
 
 use without warranty
 
### Honorable Mention
Based on license-compatibility ruby gem by Libraries.io


## A License Overview

[![Licences](licenses.png)](licenses.svg)