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

Git changelog generator

import { Dependencies, IChange, Restriction } from 'package-json-helper/types/package';
import { Task } from 'tasktree-cli/lib/Task';
import { ICommit } from '../entities/Commit.js';
import { ISection, ISectionOptions } from '../entities/Section.js';
export declare enum Rule {
    Highlight = "highlight",
    Mark = "mark",
    PackageStatisticRender = "package",
    ScopeRename = "scope",
    SectionGroup = "section"
}
export interface IRuleContext {
    readonly currentLicense: string;
    readonly hasChangedLicense: boolean;
    readonly previousLicense?: string;
    addSection(options: ISectionOptions): ISection | undefined;
    findSection(name: string): ISection | undefined;
    getChanges(type: Dependencies | Restriction): IChange[] | undefined;
}
export type IRuleActionOptions = {
    context: IRuleContext;
};
export type IRulePrepareOptions = IRuleActionOptions;
export type IRuleModifyOptions = {
    task: Task;
} & IRuleActionOptions;
export type IRuleParseOptions = {
    commit: ICommit;
} & IRuleActionOptions;
export type IRuleLintOptions = {
    body: string[];
    headline: string;
    scope: string;
    subject: string;
    task: Task;
    type: string;
};
export type IRule = {
    lint?: (options: IRuleLintOptions) => void;
    modify?: (options: IRuleModifyOptions) => void;
    parse?: (options: IRuleParseOptions) => void;
    prepare?: (options: IRulePrepareOptions) => void;
};
export interface IRuleConfig {
    [key: string]: string | boolean | number | string[] | undefined | IRuleConfig | IRuleConfig[];
}
export declare class BaseRule<T> {
    protected config: T;
    constructor(config: T);
}