UNPKG

eslint-doc-generator

Version:

Automatic documentation generator for ESLint plugins and rules.

github.com/eslint-community/eslint-doc-generator

eslint-community/eslint-doc-generator

15 lines (14 loc) • 985 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
export declare const BEGIN_RULE_LIST_MARKER = "begin auto-generated rules list"; export declare const END_RULE_LIST_MARKER = "end auto-generated rules list"; export declare const END_RULE_HEADER_MARKER = "end auto-generated rule header"; export declare const BEGIN_CONFIG_LIST_MARKER = "begin auto-generated configs list"; export declare const END_CONFIG_LIST_MARKER = "end auto-generated configs list"; export declare const BEGIN_RULE_OPTIONS_LIST_MARKER = "begin auto-generated rule options list"; export declare const END_RULE_OPTIONS_LIST_MARKER = "end auto-generated rule options list"; /** * Format a comment string for the appropriate comment syntax based on whether the file is MDX or not. * @param comment - the comment content, without comment syntax * @param isMdx - whether the comment is for an MDX file (true) or a plain markdown file (false) * @returns the formatted comment string */ export declare function formatComment(comment: string, isMdx: boolean): string;