danger-plugin-pr-hygiene/lib/index.d.ts

A Danger plugin for enforcing good PR hygiene.

export type EmitLevel = "message" | "warn" | "fail";
export interface RequirePrefixConfig {
    level: EmitLevel;
    message: string;
}
export interface UseImperativeMoodConfig {
    level: EmitLevel;
    message: string;
}
export interface UseSentenceCaseConfig {
    level: EmitLevel;
    message: string;
}
export interface NoTrailingPunctuationConfig {
    level: EmitLevel;
    message: string;
}
export type ConfigurationOrOff<T> = T | "off";
export type PartialConfigurationOrOff<T> = ConfigurationOrOff<Partial<T>>;
export interface PrHygieneOptions {
    prefixPattern?: RegExp;
    rules?: {
        requirePrefix?: PartialConfigurationOrOff<RequirePrefixConfig>;
        useImperativeMood?: PartialConfigurationOrOff<UseImperativeMoodConfig>;
        useSentenceCase?: PartialConfigurationOrOff<UseSentenceCaseConfig>;
        noTrailingPunctuation?: PartialConfigurationOrOff<NoTrailingPunctuationConfig>;
    };
}
export declare function prHygiene(options?: PrHygieneOptions): void;