highlight.js

const hljs: HLJSApi;

type BeforeHighlightContext = {
    code: string;
    language: string;
    result?: HighlightResult;
};

type CompiledMode = Omit<Mode, 'contains'> & {
    begin?: RegExp | string;
    end?: RegExp | string;
    scope?: string;
    contains: CompiledMode[];
    keywords: KeywordDict;
    data: Record<string, any>;
    terminatorEnd: string;
    keywordPatternRe: RegExp;
    beginRe: RegExp;
    endRe: RegExp;
    illegalRe: RegExp;
    matcher: any;
    isCompiled: true;
    starts?: CompiledMode;
    parent?: CompiledMode;
    beginScope?: CompiledScope;
    endScope?: CompiledScope;
};

type CompiledScope = Record<number, string> & {
    _emit?: Record<number, boolean>;
    _multi?: boolean;
    _wrap?: string;
};

type CompilerExt = (mode: Mode, parent: Mode | Language | null) => void;

type HighlightedHTMLElement = HTMLElement & {
    result?: object;
    secondBest?: object;
    parentNode: HTMLElement;
};

type HLJSApi = PublicApi & ModesAPI;

type HLJSPlugin = {
    'after:highlight'?: (result: HighlightResult) => void;
    'before:highlight'?: (context: BeforeHighlightContext) => void;
    'after:highlightElement'?: (data: {
        el: Element;
        result: HighlightResult;
        text: string;
    }) => void;
    'before:highlightElement'?: (data: { el: Element; language: string }) => void;
    // TODO: Old API, remove with v12
    'after:highlightBlock'?: (data: {
        block: Element;
        result: HighlightResult;
        text: string;
    }) => void;
    'before:highlightBlock'?: (data: { block: Element; language: string }) => void;
};

type Language = LanguageDetail & Partial<Mode>;

type LanguageFn = (hljs: HLJSApi) => Language;

type ModeCallback = (match: RegExpMatchArray, response: CallbackResponse) => void;

type PluginEvent = keyof HLJSPlugin;

const defineLanguage: LanguageFn;

type AnnotatedError = Error & {
    mode?: Mode | Language;
    languageName?: string;
    badRule?: Mode;
};

type EnhancedMatch = RegExpMatchArray & { rule: CompiledMode; type: MatchType };

type KeywordData = [string, number];

type KeywordDict = Record<string, KeywordData>;

type MatchType = 'begin' | 'end' | 'illegal';