eslint-doc-generator/dist/lib/context.d.ts

Automatic documentation generator for ESLint plugins and rules.

import type { ResolvedGenerateOptions } from './options.js';
import type { ConfigsToRules, GenerateOptions, Plugin } from './types.js';
/**
 * Context about the current invocation of the program.
 *
 * Note: all markdown content is processed using LF (`\n`) line endings
 * internally. The desired end of line for each file is only applied when
 * writing the file in the generator.
 */
export interface Context {
    configsToRules: ConfigsToRules;
    options: ResolvedGenerateOptions;
    path: string;
    plugin: Plugin;
    pluginPrefix: string;
}
export declare function getContext(path: string, userOptions?: GenerateOptions, useMockPlugin?: boolean): Promise<Context>;