@digitalroute/license-checker-config

Licence checker configuration for Digitalroute projects.

Usage

Install this config and license-checker-rseidelsohn as a devDependency:

1npm install @digitalroute/license-checker-config --save-dev

You can then run the script as this in your Git Actions or Jenkinsfile

1npx digitalroute-license-checker

Like this for Git Actions example:

1      - name: License Checker
2        run: |
3          npx digitalroute-license-checker

Like this for Jenkins example:

1    stage("License Checker") {
2      steps {
3        nvm('version': 'v10.10.0') {
4          script {
5            sh "npx digitalroute-license-checker"
6          }
7        }
8      }
9    }

Change of Library since v2.0.0 of Digitalroute-License-Checker

The repository license-checker has been abandoned since 2019 and a fork of the repo is being maintained by RSeidelsohn and can be checked here: https://github.com/RSeidelsohn/license-checker-rseidelsohn

Parameters being used

We are currently using the following parameters:

--production - Ensure we only check licenses for production packages only since this is what goes to production for commercial purposes.

--failOn[list] - This will make the script fail (exit with code 1) on the first occurrence of the licenses of the semicolon-separated list.

--excludePrivatePackages - Restrict output to not include any package marked as private (our own internal DR packages)

--excludePackagesStartingWith - We might have exceptions being added due to special licenses (@sap for instance)