check_license library

Classes

Config: Represents the config parsed from a config file for the license checker.
DependencyChecker: Represents a single package that is a dependency of the package we are checking.
LicenseDisplayWithPriority<D>: Encapsulates a generic license display along with a priority that can be used for sorting.
PackageChecker: Represents the config of the package we are checking dependencies for.

checkAllPackageLicenses<D>({required bool showDirectDepsOnly, required bool filterApproved, required LicenseDisplayFunction<D> licenseDisplay, required PackageChecker packageConfig, bool sort = false}) → Future<List<LicenseDisplayWithPriority<D>>>: Checks all licenses in a the package.
checkPackageLicense<D>({required DependencyChecker package, required LicenseDisplayFunction<D> licenseDisplay}) → Future<D>: Check the license of a single package.

LicenseDisplayFunction<D> = D Function({required String licenseName, required LicenseStatus licenseStatus, required String packageName}): Type defintion for the function that formats the display of the parsed license result.