This repository contains the Griffin+ LicenseCollector, a tool which helps to collect licenses of used 3rd party libraries in a Visual Studio solution.
The tool is designed to accept a solution file with given build configuration. It collects all projects that are build under this configuration. It examines all referenced NuGet packages for C# and C++ projects and extract their license information. In addition the tool supports static licenses which are found in the project folders via a given pattern. At last all collected license information are copied together and can be shipped with your software.
An optional parameter can be given to load a razor template file. The template defines how the output is formatted to ensure optimal flexibility when generating a Third Party Notices. An example for a template can be found in this repository (THIRD_PARTY_NOTICES.template). It is important to define the following header for the template.
@using RazorLight
@using GriffinPlus.LicenseCollector
@using System.Collections.Generic
@inherits RazorLight.TemplatePage<List<PackageLicenseInfo>>
After that you can write a razor template with Model containing a List<PackageLicenseInfo> object.
The template does not support HTML encoding because the extracted licenses contain plain text and escape sequences.
The PackageLicenseInfo class consists of following properties:
public string PackageIdentifier { get; }
public string PackageVersion { get; }
public string Author { get; }
public string Copyright { get; }
public string LicenseUrl { get; }
public string ProjectUrl { get; }
public string License { get; }
It also has an override for the ToString() method which generates a readable format of its information.
- Only supports C# and C++ projects within a given solution
- Only downloads licenses with a Github URL, when a URL is defined for the NuGet package
- Only prints the SPDX expression when given instead of a template license