License Report

This module enables the user to execute a container to generate project license usage report as well as authorise or disqualify specified license and packaged.

Installation

Global to run local

npm install -g lic_report@latest

In project to run local or upon github commit

npm install --save lic_report

Configuration

Sample Config file

{
  "type": "html2",
  "name": "[Project Name to Display]",
  "path": "./LicenseReports",
  "github": {
    "enabled": false,
    "user": {
      "name": "test",
      "email": "[email protected]"
    },
    "repo": "[email protected]:test/test.git",
    "ssh_key": {
      "pub": "id_rsa.pub",
      "pvt": "id_rsa"
    },
    "branch": "lic_report"
  },
  "githubPages": {
    "enabled": false
  },
  "styling": {
    "enabled": false,
    "files": [
      "custom.css"
    ]
  },
  "ssh": {
    "enabled": false,
    "auth": {
      "host": "localhost",
      "username": "steel",
      "password": ""
    },
    "path":"/path/to/folder"
  },
  "licenses": {
    "whiteList": [
      "MIT"
    ],
    "blackList": [
      "Apache 2.0"
    ]
  },
  "dependencies": [
    "express",
    "mongo"
  ],
  "notifications": {
    "email": {
      "enabled": false,
      "from": "LicenseReport <[email protected]>",
      "subject": "License Report",
      "recipients": ["[email protected]"],
      "server": {
        "smtp": {
          "host": "smtp.test.net",
          "port": "587",
          "secure": false
        },
        "auth": {
          "user": "username",
          "pass": "password"
        }
      }
    }
  }
}

Run Locally

To get the help menu simply run lic_report.

To run in the current project root folder, run lic_report run or to run for a differant root folder run lic_report run /my/project/path/root.