Files
oh-my-pi/packages/utils/src/frontmatter.ts
T
can1357 7282d92bf4 fix: normalized line-ending handling for text and TUI output flows
- Unified line-ending normalization to `replace(/\r\n?/g, "\\n")` in editor, scraper, benchmark, and utils modules.
- Added terminal-aware line sanitization in code-cell rendering to collapse inline carriage returns and avoid overwrite corruption.
- Tightened editor and paste sanitizers to trim control characters consistently after CR normalization.
2026-05-15 23:46:23 +02:00

129 lines
4.1 KiB
TypeScript

import { YAML } from "bun";
import { truncate } from "./format";
import * as logger from "./logger";
function stripHtmlComments(content: string): string {
return content.replace(/<!--[\s\S]*?-->/g, "");
}
/** Convert kebab-case to camelCase (e.g. "thinking-level" -> "thinkingLevel") */
function kebabToCamel(key: string): string {
if (!key.includes("-")) return key;
return key.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
}
/** Recursively normalize object keys from kebab-case to camelCase */
function normalizeKeys<T>(obj: T): T {
if (obj === null || typeof obj !== "object") return obj;
if (Array.isArray(obj)) {
let changed = false;
const out: unknown[] = new Array(obj.length);
for (let i = 0; i < obj.length; i++) {
const v = obj[i];
const nv = normalizeKeys(v);
out[i] = nv;
if (nv !== v) changed = true;
}
return (changed ? (out as unknown) : obj) as T;
}
let changed = false;
const result: Record<string, unknown> = {};
for (const [key, value] of Object.entries(obj as Record<string, unknown>)) {
const nk = key.includes("-") ? kebabToCamel(key) : key;
const nv = normalizeKeys(value);
result[nk] = nv;
if (nk !== key || nv !== value) changed = true;
}
return (changed ? result : obj) as T;
}
export class FrontmatterError extends Error {
constructor(
error: Error,
readonly source?: unknown,
) {
super(`Failed to parse YAML frontmatter (${source}): ${error.message}`, { cause: error });
this.name = "FrontmatterError";
}
toString(): string {
// Format the error with stack and detail, including the error message, stack, and source if present
const details: string[] = [this.message];
if (this.source !== undefined) {
details.push(`Source: ${JSON.stringify(this.source)}`);
}
if (this.cause && typeof this.cause === "object" && "stack" in this.cause && this.cause.stack) {
details.push(`Stack:\n${this.cause.stack}`);
} else if (this.stack) {
details.push(`Stack:\n${this.stack}`);
}
return details.join("\n\n");
}
}
export interface FrontmatterOptions {
/** Source of the content (alias: source) */
location?: unknown;
/** Source of the content (alias for location) */
source?: unknown;
/** Fallback frontmatter values */
fallback?: Record<string, unknown>;
/** Normalize the content */
normalize?: boolean;
/** Level of error handling */
level?: "off" | "warn" | "fatal";
}
/**
* Parse YAML frontmatter from markdown content
* Returns { frontmatter, body } where body has frontmatter stripped
*/
export function parseFrontmatter(
content: string,
options?: FrontmatterOptions,
): { frontmatter: Record<string, unknown>; body: string } {
const { location, source, fallback, normalize = true, level = "warn" } = options ?? {};
const loc = location ?? source;
const frontmatter: Record<string, unknown> = { ...fallback };
const normalized = normalize ? stripHtmlComments(content.replace(/\r\n?/g, "\n")) : content;
if (!normalized.startsWith("---")) {
return { frontmatter, body: normalized };
}
const endIndex = normalized.indexOf("\n---", 3);
if (endIndex === -1) {
return { frontmatter, body: normalized };
}
const metadata = normalized.slice(4, endIndex);
const body = normalized.slice(endIndex + 4).trim();
try {
// Replace tabs with spaces for YAML compatibility, use failsafe mode for robustness
const loaded = YAML.parse(metadata.replaceAll("\t", " ")) as Record<string, unknown> | null;
return { frontmatter: normalizeKeys({ ...frontmatter, ...loaded }), body };
} catch (error) {
const err = new FrontmatterError(
error instanceof Error ? error : new Error(`YAML: ${error}`),
loc ?? `Inline '${truncate(content, 64)}'`,
);
if (level === "warn" || level === "fatal") {
logger.warn("Failed to parse YAML frontmatter", { err: err.toString() });
}
if (level === "fatal") {
throw err;
}
// Simple YAML parsing - just key: value pairs
for (const line of metadata.split("\n")) {
const match = line.match(/^([\w-]+):\s*(.*)$/);
if (match) {
frontmatter[match[1]] = match[2].trim();
}
}
return { frontmatter: normalizeKeys(frontmatter) as Record<string, unknown>, body };
}
}