Files
openclaw/packages/markdown-core/src/fences.ts
Peter Steinberger 1e7510ae10 docs: continue inline comment pass (#88849)
Adds broad inline comments and JSDoc for CLI, cron, outbound/channel, plugin SDK, ACP, shared helpers, net policy, and related utility contracts. Proof: git diff --check on latest exact head plus focused cron tests passed; CI had no failing checks observed before merge attempt.
2026-05-31 22:32:28 -04:00

144 lines
3.7 KiB
TypeScript

/** Markdown fenced-code block span with the opener data needed to reopen it. */
export type FenceSpan = {
start: number;
end: number;
openLine: string;
marker: string;
indent: string;
};
/** Streaming fence scanner state carried across partial markdown chunks. */
export type FenceScanState = {
atLineStart?: boolean;
open?: {
markerChar: string;
markerLen: number;
openLine: string;
marker: string;
indent: string;
};
};
/** Scans fenced-code spans incrementally so chunking can carry an open fence forward. */
export function scanFenceSpans(
buffer: string,
state?: FenceScanState,
): { spans: FenceSpan[]; state: FenceScanState } {
const spans: FenceSpan[] = [];
const startsAtLineStart = state?.atLineStart ?? true;
let open:
| {
start: number;
markerChar: string;
markerLen: number;
openLine: string;
marker: string;
indent: string;
}
| undefined = state?.open ? { ...state.open, start: 0 } : undefined;
let offset = 0;
while (offset <= buffer.length) {
const nextNewline = buffer.indexOf("\n", offset);
const lineEnd = nextNewline === -1 ? buffer.length : nextNewline;
const line = buffer.slice(offset, lineEnd);
const match = line.match(/^( {0,3})(`{3,}|~{3,})(.*)$/);
if (match && (offset > 0 || startsAtLineStart)) {
const indent = match[1];
const marker = match[2];
const markerChar = marker[0];
const markerLen = marker.length;
if (!open) {
open = {
start: offset,
markerChar,
markerLen,
openLine: line,
marker,
indent,
};
} else if (open.markerChar === markerChar && markerLen >= open.markerLen) {
// CommonMark allows a closing fence to be longer than the opener, but
// it must use the same marker character to avoid crossing fence kinds.
const end = lineEnd;
spans.push({
start: open.start,
end,
openLine: open.openLine,
marker: open.marker,
indent: open.indent,
});
open = undefined;
}
}
if (nextNewline === -1) {
break;
}
offset = nextNewline + 1;
}
if (open) {
spans.push({
start: open.start,
end: buffer.length,
openLine: open.openLine,
marker: open.marker,
indent: open.indent,
});
}
const atLineStart = buffer.length === 0 ? startsAtLineStart : buffer.endsWith("\n");
const nextState: FenceScanState = {
atLineStart,
...(open
? {
open: {
markerChar: open.markerChar,
markerLen: open.markerLen,
openLine: open.openLine,
marker: open.marker,
indent: open.indent,
},
}
: {}),
};
return { spans, state: nextState };
}
/** Parses all fenced-code spans in a complete markdown buffer. */
export function parseFenceSpans(buffer: string): FenceSpan[] {
return scanFenceSpans(buffer).spans;
}
/** Looks up the fence containing an offset; spans must be sorted by start offset. */
export function findFenceSpanAt(spans: FenceSpan[], index: number): FenceSpan | undefined {
let low = 0;
let high = spans.length - 1;
while (low <= high) {
const mid = Math.floor((low + high) / 2);
const span = spans[mid];
if (!span) {
break;
}
if (index <= span.start) {
high = mid - 1;
continue;
}
if (index >= span.end) {
low = mid + 1;
continue;
}
return span;
}
return undefined;
}
/** True when a chunk boundary would not split a fenced-code block. */
export function isSafeFenceBreak(spans: FenceSpan[], index: number): boolean {
return !findFenceSpanAt(spans, index);
}