---
# System prepended metadata

title: license-reporter-plugin

---

# license-reporter-plugin

## Opis tasków

**generateLicenseCreditsReport** - task generuje docelowy raport 

**validateLicense** - sprawdza czy wszystkie zależności możemy używać i czy wszystkie informacje o licencjach są poprawnie uzupełnione

**licenseReport** - generuje raport licencji z uwzględnieniem analizy prawnej


## Słownik pojęć
- **License_normalizer_bundle.json** - słownik do normalizowania nazw licencji
```
{
  "bundles" : [
    { "bundleName" : "apache1", "licenseName" : "Apache Software License, Version 1.1", "licenseUrl" : "http://www.apache.org/licenses/LICENSE-1.1" },
    { "bundleName" : "apache2", "licenseName" : "Apache License, Version 2.0", "licenseUrl" : "http://www.apache.org/licenses/LICENSE-2.0" },
    { "bundleName" : "cddl1", "licenseName" : "COMMON DEVELOPMENT AND DISTRIBUTION LICENSE Version 1.0 (CDDL-1.0)", "licenseUrl" : "http://opensource.org/licenses/CDDL-1.0" }
  ]
}
```

- **Dependency_licenses** - wynik używanego zewnętrznego pluginu (https://github.com/jk1/Gradle-License-Report)
- **Dependency_missing_license.csv** - plik jest uzupełnieniem brakujących licencji dla zależności
![](https://i.imgur.com/ESP2gpI.png)

- **License_legality_advice.csv** - analiza prawna licencji
![](https://i.imgur.com/d24bDRP.png)



## Normalizowanie nazw
https://spdx.org/licenses/
==todo==

## Konfiguracja pluginu licenseReporter:

### Ustawienia katalogu plików wejściowych   

Konfiguracja katalogu jest niezbędna. W katalogu musi znajdować się plik "license_legality_advice.csv". Dodanie pliku "dependency_missing_license.csv" jest opcjonalne.

```
licenseReporter {
                 externalFileDir.set(file("$externalNameDirectory"))
    }
```

Przykłowe pliki:
==todo==

### Katalog wyjściowy:
Domyślny katalog wyjściowy to "licensesInfo".

```
 licenseReporter {
           outputDir.set file("${project.buildDir}/custom/path")
     }
     
```

### Konfiguracja dystrybucji projektu
Domyślnie ustawiona jest tylko usageInCommercialSaaS

distributionWithCommercialOnPrem - ==todo==
usageInCommercialSaaS - ==todo==
buildCommercialOnPerem - ==todo==
buildCommercialSaaS - ==todo==

```
licenseReporter {
                distributionWithCommercialOnPrem.set(false)
                usageInCommercialSaaS.set(true)
                buildCommercialOnPerem.set(false)
                buildCommercialSaaS.set(false)
    }
```
    
### Ustawienia dla raportu licencji frontendu
==todo==


## Schemat działania
![](https://i.imgur.com/ge5Bf3H.png)
