Interface BlockRule

Block rule interface.

interface BlockRule {
    name: string;
    preservesPrecedingLineBreak?: boolean;
    requiresLineStart: boolean;
    startTokens: TokenType[];
    isStartPattern?(ctx: ParseContext, pos: number): boolean;
    parse(ctx: ParseContext): RuleResult<Element>;
}

Index

Properties

name preservesPrecedingLineBreak? requiresLineStart startTokens

Methods

isStartPattern? parse

Properties

name

name: string

Rule name for debugging.

`Optional`preservesPrecedingLineBreak

preservesPrecedingLineBreak?: boolean

When true, a single newline before this block becomes a line-break.

requiresLineStart

requiresLineStart: boolean

Whether this rule requires line start.

startTokens

startTokens: TokenType[]

Token types that can start this rule.

Methods

`Optional`isStartPattern

isStartPattern?(ctx: ParseContext, pos: number): boolean
Check if tokens at the given position match this rule's start pattern. Used by inline parser to determine behavior before a block boundary.
Parameters
- ctx: ParseContext
- pos: number
Returns boolean
- Defined in parser/src/parser/rules/contracts/rule.ts:26

parse

parse(ctx: ParseContext): RuleResult<Element>
Try to parse this block.
Parameters
- ctx: ParseContext
Returns RuleResult<Element>
- Defined in parser/src/parser/rules/contracts/rule.ts:21