Checking the licenses of your open source dependencies is important. But the necessary collection is something, that you don't want to do again for each project. To simplify this, codecentric collects a central list of licenses that can be used for specific purposes. This list is provided as an external configuration file for the kontrolilo which can be used by pre-commit.
This repository does not contain any legal advice which licenses can be used for which purposes. Please check the list before using it. You have been warned.
To use this make sure, you have pre-commit installed.
When setting a new project, create a new file called .pre-commit-config.yaml that contains at least the following hooks:
---
repos:
- repo: https://github.com/kontrolilo/kontrolilo
rev: v2.0.0
hooks:
- id: license-check-configuration-lint
- id: license-check-gradle
- id: license-check-maven
- id: license-check-npm
- id: license-check-pipenv
Afterwards, you can setup your local git hooks using:
pre-commit install
From now on, alle your git commits will be checked locally with the configured hooks.
To use the external license list, create a file .license-check.yaml next to your package manager file:
---
include:
- url: https://raw.githubusercontent.com/codecentric/license-check-configuration/main/commercial-use/$FILE
Replace $FILE with the file for your supported package manager according to this table:
| Package Manager | Package Manager File | $FILE |
|---|---|---|
| npm | package.json |
license-check-npm.yaml |
| pipenv | Pipfile |
license-check-python.yaml |
If you want to update the list of allowed license, please edit the corresponding configuration file and submit a pull request.