@atomist/sdm-pack-aspect
Version:
an Atomist SDM Extension Pack for visualizing drift across an organization
34 lines • 1.13 kB
TypeScript
import { Aspect, FP } from "@atomist/sdm-pack-fingerprint";
import { ContentClassifier } from "./ContentClassifier";
export declare const NoLicense = "None";
export declare const LicenseType = "license";
export declare function hasNoLicense(ld: LicenseData): boolean;
export declare function isLicenseFingerprint(fp: FP): fp is FP<LicenseData>;
export interface LicenseData {
/**
* Path to the license file
*/
path: string;
/**
* What we've classified the license as by parsing the license file.
*/
classification: string;
}
/**
* License aspect. Every repository gets a license fingerprint, which may have unknown
* as a license.
* @param opts provides classifier function, taking the license content and returning
* a classificiation
*/
export declare function license(opts?: {
classifier: ContentClassifier;
}): Aspect<LicenseData>;
export declare const LicensePresenceType: string;
/**
* Does this repository have a license?
* Works with data from the license aspect.
*/
export declare const LicensePresence: Aspect<{
present: boolean;
}>;
//# sourceMappingURL=license.d.ts.map