<commit_before># 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/)

[![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)

[![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)

## 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/MergeGithubFork.git --save-dev
```

# Usage

## CLI

In your project folder run

	license-compatibility-checker
	
or<commit_msg>corrected readme<commit_after># 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/)

[![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)

[![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)

## 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

	license-compatibility-checker
	
or
{'fraction_non_alphanumeric': 0.1557478368355995, 'fraction_numerical': 0.0007063393960798164, 'mean_word_length': 6.133501259445844, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 11, 'https://': 42, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '158755', 'n_tokens_mistral': 1957, 'n_tokens_neox': 1812, 'n_words': 244}