changelog-guru/lib/core/rules/MarkRule.d.ts

Git changelog generator

import { BaseRule, IRule, IRuleConfig, IRuleLintOptions, IRuleParseOptions, IRulePrepareOptions } from './BaseRule.js';
export declare enum MarkerType {
    Breaking = "break",
    Deprecated = "deprecated",
    Grouped = "group",
    Ignore = "ignore",
    Important = "important"
}
export interface IMarkRuleConfig extends IRuleConfig {
    joins: {
        [MarkerType.Breaking]: string;
        [MarkerType.Deprecated]: string;
        [MarkerType.Important]: string;
    };
}
export default class MarkRule extends BaseRule<IMarkRuleConfig> implements IRule {
    #private;
    constructor(config: IMarkRuleConfig);
    lint({ task, body }: IRuleLintOptions): void;
    parse({ commit, context }: IRuleParseOptions): void;
    prepare({ context }: IRulePrepareOptions): void;
    private getMarkersFrom;
}