Add informations about whitelisting modules into the README.md

README.md

@@ -45,10 +45,12 @@ or Yarn:
 yarn add @brainhubeu/license-auditor
 ```
 
-In the next step, copy `license-template` directory with `licenses.js`, `blacklist.js`, and `whitelist.js` files, naming it `license` in your project. The first one contains a full list of all currently acknowledged, depreciated, and exceptional software licenses. To whitelist or blacklist the license, you must copy selected licenses from the main file into them.
+In the next step, copy `license-template` directory with `licenses.js`, `blacklist.js`, `whitelist.js` and (optionally) `modules.js` files, naming it `license` in your project. The first one contains a full list of all currently acknowledged, depreciated, and exceptional software licenses. To whitelist or blacklist the license, you must copy selected licenses from the main file into them.
 
 Whitelisting stops **License Auditor** from analyzing and displaying any notifications for a given package with whitelisted license type. Blacklisting a license leads to the generation of fail notification log or causes CI job to fail if the blacklisted license is found, which prevents the developer from merging unwanted dependencies into the destination branch. Any license that is included in neither `blacklist.js` nor `whitelist.js`, but is found during packages analyze or merge request, becomes a warning, which developer should address during merge process or further development.
 
+Modules whitelisting, with the usage of the `modules.js` file, allows specifying which licenses should be ignored for which module. If `any` is assigned, all provided licenses are accepted. Please review the [template](./license-template/modules.js) file for examples.
+
 If a given dependency has no license specified, it's marked with `UNKNOWN` and thus the default blacklist contains `UNKNOWN` license to notify about a potentially unwanted license.
 
 For **License Auditor** to work, all project dependencies have to be installed before an audit. **License Auditor** iterates through the `node_modules` and retrieves the license information from them. List of licenses is also available at [spdx site](https://spdx.org/licenses/).

examples/ci_example.js

@@ -3,10 +3,12 @@ const licenseAuditor = require('@brainhubeu/license-auditor');
 
 const whitelist = require('./license/whitelist');
 const blacklist = require('./license/blacklist');
+const modules = require('./license/modules');
 
 licenseAuditor({
   whitelistedLicenses: whitelist,
   blacklistedLicenses: blacklist,
+  whitelistedModules: modules,
   projectPath: process.env.PROJECT_PATH,
   ciManager: {
     warn,

examples/logging_example.js

@@ -3,6 +3,7 @@ const licenseAuditor = require('@brainhubeu/license-auditor');
 
 const whitelist = require('./license/whitelist');
 const blacklist = require('./license/blacklist');
+const modules = require('./license/modules');
 
 const warn = msg => {
   // eslint-disable-next-line no-console
@@ -17,6 +18,7 @@ const fail = msg => {
 licenseAuditor({
   whitelistedLicenses: whitelist,
   blacklistedLicenses: blacklist,
+  whitelistedModules: modules,
   projectPath: process.env.PROJECT_PATH,
   ciManager: {
     warn,