reportAtDocumentStart

eslint-plugin-copilot Documentation v1.1.4

---

eslint-plugin-copilot Documentation / _internal/markdown-rule / reportAtDocumentStart

Function: reportAtDocumentStart()

function reportAtDocumentStart<MessageIds>(
    context: Readonly<TSESLint.RuleContext<MessageIds, Readonly<UnknownArray>>>,
    options: Readonly<{
        data?: Readonly<Record<string, string>>;
        messageId: MessageIds;
    }>
): void;

Defined in: _internal/markdown-rule.ts:19

Report a markdown document-level problem at the start of the file.

Type Parameters

Type Parameter
MessageIds extends string

Parameters

Parameter	Type
context	Readonly<TSESLint.RuleContext<MessageIds, Readonly<UnknownArray>>>
options	Readonly<{ data?: Readonly<Record<string, string>>; messageId: MessageIds; }>

Returns

void