eslint-doc-generator/dist/lib/rule-doc-notices.d.ts

Automatic documentation generator for ESLint plugins and rules.

import { Plugin, ConfigsToRules, ConfigEmojis, NOTICE_TYPE, UrlRuleDocFunction, PathRuleDocFunction } from './types.js';
import { RuleDocTitleFormat } from './rule-doc-title-format.js';
import { ConfigFormat } from './config-format.js';
/**
 * Generate a rule doc header for a particular rule.
 * @returns {string} - new header including marker
 */
export declare function generateRuleHeaderLines(description: string | undefined, name: string, plugin: Plugin, configsToRules: ConfigsToRules, pluginPrefix: string, pathPlugin: string, pathRuleDoc: string | PathRuleDocFunction, configEmojis: ConfigEmojis, configFormat: ConfigFormat, ignoreConfig: readonly string[], ruleDocNotices: readonly NOTICE_TYPE[], ruleDocTitleFormat: RuleDocTitleFormat, urlConfigs?: string, urlRuleDoc?: string | UrlRuleDocFunction): string;