open-license-check

open-license-check is an open source module for license checking.

Getting start

Install

npm i -g open-license-check

Run

# open-license-check

Docs

The definition of Config

Please refer to deglob

interface Config {
  patterns: string[];
  options: {
    useGitIgnore?: boolean;
    usePackageJson?: boolean;
    configKey?: string;
    gitIgnoreFile?: string;
    ignore?: string[];
    cwd?: string;
  };
}

Default config

{
  patterns: [ '**/*' ],
  options: {
    useGitIgnore: true,
    ignore: [ 'node_modules/**/*' ],
  },
}

Customer configuration

Note: In order to facilitate the user to integrate the configuration into the package.json file, after loading the configuration file, the configuration will be read from the open-license-check field, so the specific configuration should be included in the open-license-check field, for example:

{
  "open-license-check": {
    "patterns": [ "**/*" ],
    "options": {
      "useGitIgnore": true,
      "ignore": [ "node_modules/**/*" ]
    }
  }
}

The configuration file can be placed in any path of the project and specified by LICENSE_CHECK_CONFIG_PATH environment variable, for example:

# export LICENSE_CHECK_CONFIG_PATH=./open-license-check.json
# open-license-check

docker

build

# docker build -t open-license-check .

run

# docker run -it -v src/path:/github/workspace open-license-check