generate_disclaimer library

Classes

Config: Represents the config parsed from a config file for the license checker.
DisclaimerDisplay<C, F>: Encapsulates a generic cli and file display.
PackageChecker: Represents the config of the package we are checking dependencies for.

generateDisclaimers<C, F>({required Config config, required PackageChecker packageConfig, required bool showDirectDepsOnly, required bool noDevDependencies, required DisclaimerCLIDisplayFunction<C> disclaimerCLIDisplay, required DisclaimerFileDisplayFunction<F> disclaimerFileDisplay}) → Future<DisclaimerDisplay<List<C>, List<F>>>: Generate disclaimers for all packages
generatePackageDisclaimer<C, F>({required Config config, required DependencyChecker package, required DisclaimerCLIDisplayFunction<C> disclaimerCLIDisplay, required DisclaimerFileDisplayFunction<F> disclaimerFileDisplay}) → Future<DisclaimerDisplay<C, F>>: Generate the disclaimer for a single package/

DisclaimerCLIDisplayFunction<D> = D Function({required String copyright, required String licenseName, required String packageName, required String sourceLocation}): Type defintion for the function that formats the display of the disclaimer based on the license for the CLI.
DisclaimerFileDisplayFunction<D> = D Function({required String copyright, required File? licenseFile, required String licenseName, required String packageName, required String sourceLocation}): Type defintion for the function that formats the display of the disclaimer based on the license for a file.