github/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-13 00:02:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(shared): dedupe frontmatter parsing

Browse Source
This commit is contained in:
Peter Steinberger
2026-02-14 13:55:30 +00:00
parent 1b03eb71aa
commit ece55b4682
4 changed files with 176 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
src/hooks/frontmatter.ts
View File

@@ -1,4 +1,3 @@
import JSON5 from "json5";
import type {
OpenClawHookMetadata,
HookEntry,
@@ -6,30 +5,18 @@ import type {
HookInvocationPolicy,
ParsedHookFrontmatter,
} from "./types.js";
import { LEGACY_MANIFEST_KEYS, MANIFEST_KEY } from "../compat/legacy-names.js";
import { parseFrontmatterBlock } from "../markdown/frontmatter.js";
import { parseBooleanValue } from "../utils/boolean.js";
import {
getFrontmatterString,
normalizeStringList,
parseFrontmatterBool,
resolveOpenClawManifestBlock,
} from "../shared/frontmatter.js";
export function parseFrontmatter(content: string): ParsedHookFrontmatter {
return parseFrontmatterBlock(content);
}
function normalizeStringList(input: unknown): string[] {
if (!input) {
return [];
}
if (Array.isArray(input)) {
return input.map((value) => String(value).trim()).filter(Boolean);
}
if (typeof input === "string") {
return input
.split(",")
.map((value) => value.trim())
.filter(Boolean);
}
return [];
}
function parseInstallSpec(input: unknown): HookInstallSpec | undefined {
if (!input || typeof input !== "object") {
return undefined;
@@ -66,79 +53,48 @@ function parseInstallSpec(input: unknown): HookInstallSpec | undefined {
return spec;
}
function getFrontmatterValue(frontmatter: ParsedHookFrontmatter, key: string): string | undefined {
const raw = frontmatter[key];
return typeof raw === "string" ? raw : undefined;
}
function parseFrontmatterBool(value: string | undefined, fallback: boolean): boolean {
const parsed = parseBooleanValue(value);
return parsed === undefined ? fallback : parsed;
}
export function resolveOpenClawMetadata(
frontmatter: ParsedHookFrontmatter,
): OpenClawHookMetadata | undefined {
const raw = getFrontmatterValue(frontmatter, "metadata");
if (!raw) {
return undefined;
}
try {
const parsed = JSON5.parse(raw);
if (!parsed || typeof parsed !== "object") {
return undefined;
}
const metadataRawCandidates = [MANIFEST_KEY, ...LEGACY_MANIFEST_KEYS];
let metadataRaw: unknown;
for (const key of metadataRawCandidates) {
const candidate = parsed[key];
if (candidate && typeof candidate === "object") {
metadataRaw = candidate;
break;
}
}
if (!metadataRaw || typeof metadataRaw !== "object") {
return undefined;
}
const metadataObj = metadataRaw as Record<string, unknown>;
const requiresRaw =
typeof metadataObj.requires === "object" && metadataObj.requires !== null
? (metadataObj.requires as Record<string, unknown>)
: undefined;
const installRaw = Array.isArray(metadataObj.install) ? (metadataObj.install as unknown[]) : [];
const install = installRaw
.map((entry) => parseInstallSpec(entry))
.filter((entry): entry is HookInstallSpec => Boolean(entry));
const osRaw = normalizeStringList(metadataObj.os);
const eventsRaw = normalizeStringList(metadataObj.events);
return {
always: typeof metadataObj.always === "boolean" ? metadataObj.always : undefined,
emoji: typeof metadataObj.emoji === "string" ? metadataObj.emoji : undefined,
homepage: typeof metadataObj.homepage === "string" ? metadataObj.homepage : undefined,
hookKey: typeof metadataObj.hookKey === "string" ? metadataObj.hookKey : undefined,
export: typeof metadataObj.export === "string" ? metadataObj.export : undefined,
os: osRaw.length > 0 ? osRaw : undefined,
events: eventsRaw.length > 0 ? eventsRaw : [],
requires: requiresRaw
? {
bins: normalizeStringList(requiresRaw.bins),
anyBins: normalizeStringList(requiresRaw.anyBins),
env: normalizeStringList(requiresRaw.env),
config: normalizeStringList(requiresRaw.config),
}
: undefined,
install: install.length > 0 ? install : undefined,
};
} catch {
const metadataObj = resolveOpenClawManifestBlock({ frontmatter });
if (!metadataObj) {
return undefined;
}
const requiresRaw =
typeof metadataObj.requires === "object" && metadataObj.requires !== null
? (metadataObj.requires as Record<string, unknown>)
: undefined;
const installRaw = Array.isArray(metadataObj.install) ? (metadataObj.install as unknown[]) : [];
const install = installRaw
.map((entry) => parseInstallSpec(entry))
.filter((entry): entry is HookInstallSpec => Boolean(entry));
const osRaw = normalizeStringList(metadataObj.os);
const eventsRaw = normalizeStringList(metadataObj.events);
return {
always: typeof metadataObj.always === "boolean" ? metadataObj.always : undefined,
emoji: typeof metadataObj.emoji === "string" ? metadataObj.emoji : undefined,
homepage: typeof metadataObj.homepage === "string" ? metadataObj.homepage : undefined,
hookKey: typeof metadataObj.hookKey === "string" ? metadataObj.hookKey : undefined,
export: typeof metadataObj.export === "string" ? metadataObj.export : undefined,
os: osRaw.length > 0 ? osRaw : undefined,
events: eventsRaw.length > 0 ? eventsRaw : [],
requires: requiresRaw
? {
bins: normalizeStringList(requiresRaw.bins),
anyBins: normalizeStringList(requiresRaw.anyBins),
env: normalizeStringList(requiresRaw.env),
config: normalizeStringList(requiresRaw.config),
}
: undefined,
install: install.length > 0 ? install : undefined,
};
}
export function resolveHookInvocationPolicy(
frontmatter: ParsedHookFrontmatter,
): HookInvocationPolicy {
return {
enabled: parseFrontmatterBool(getFrontmatterValue(frontmatter, "enabled"), true),
enabled: parseFrontmatterBool(getFrontmatterString(frontmatter, "enabled"), true),
};
}