@infctr/eslint-docs/dist/actions/read-rule.d.ts

Keep your rule names and descriptions up-to-date across your repo

interface Options {
    rule: import('eslint').Rule.RuleModule & {
        meta: {
            docs: {
                extraDescription?: string | string[];
            };
        };
    };
    docs: string;
    friendlyDocPath: string;
}
export interface RuleMeta {
    name: string;
    description: string;
    extraDescription?: string | string[];
    recommended?: boolean;
    fixable?: 'whitespace' | 'code';
}
declare const _default: ({ rule, docs, friendlyDocPath }: Options, name: string) => {
    newDocs: string;
    meta: RuleMeta;
};
export default _default;