@kensio/colophon 2.2.0 → 2.4.0

package/dist/validate/values.js

@@ -0,0 +1,71 @@
+import { checkEach, checkKeys, isRecord } from "./check.js";
+import { backgroundTypes, gradientBackgroundKeys, gradientPointKeys, backgroundFits, gradientStopKeys, imageBackgroundKeys, imageSourceKeys, scrimKeys, slugStrategies, solidBackgroundKeys, } from "./keys.js";
+import { nearestName } from "./suggest.js";
+/**
+ * Report a value that is not one of the names a field accepts. `noun` names
+ * the field, `plural` heads the list of what it does accept.
+ */
+export function describeUnknownValue(noun, plural, value, known) {
+    const suggestion = nearestName(value, known);
+    return suggestion === undefined
+        ? `Unknown ${noun} "${value}". Valid ${plural}: ${known.join(", ")}.`
+        : `Unknown ${noun} "${value}". Did you mean "${suggestion}"?`;
+}
+/**
+ * Check a background against the keys of whichever variant it declares.
+ *
+ * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
+ * anything that is not `solid` as a gradient, so `gradiant` silently becomes
+ * one and then falls over on the stops it does not have. A background with no
+ * `type` at all is left alone, since the type is what says which keys apply,
+ * and guessing would report the keys rather than the omission.
+ */
+export function checkBackground(background, path, problems) {
+    if (!isRecord(background)) {
+        return;
+    }
+    const { type, stops, from, to } = background;
+    if (type === "solid") {
+        checkKeys(background, path, solidBackgroundKeys, problems);
+        return;
+    }
+    if (type === "image") {
+        checkKeys(background, path, imageBackgroundKeys, problems);
+        checkKeys(background["source"], `${path}.source`, imageSourceKeys, problems);
+        checkKeys(background["scrim"], `${path}.scrim`, scrimKeys, problems);
+        checkFit(background["fit"], problems);
+        return;
+    }
+    if (type === "gradient") {
+        checkKeys(background, path, gradientBackgroundKeys, problems);
+        checkEach(stops, `${path}.stops`, gradientStopKeys, problems);
+        checkKeys(from, `${path}.from`, gradientPointKeys, problems);
+        checkKeys(to, `${path}.to`, gradientPointKeys, problems);
+        return;
+    }
+    if (typeof type === "string") {
+        problems.push(describeUnknownValue("background type", "types", type, backgroundTypes));
+    }
+}
+/** Check a background image's fit names one of the two there are. */
+function checkFit(fit, problems) {
+    if (typeof fit !== "string" || backgroundFits.includes(fit)) {
+        return;
+    }
+    problems.push(describeUnknownValue("background fit", "fits", fit, backgroundFits));
+}
+/**
+ * Check the slug strategy names a real one. Only a string can be a strategy;
+ * anything else is a shape the type checker already covers, as elsewhere here.
+ */
+export function checkSlugStrategy(content, problems) {
+    if (!isRecord(content)) {
+        return;
+    }
+    const strategy = content["slugStrategy"];
+    if (typeof strategy !== "string" || slugStrategies.includes(strategy)) {
+        return;
+    }
+    problems.push(describeUnknownValue("slug strategy", "strategies", strategy, slugStrategies));
+}
+//# sourceMappingURL=values.js.map

package/dist/validate/values.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.js","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,SAAS,EACT,cAAc,EACd,mBAAmB,GACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,MAAc,EACd,KAAa,EACb,KAAwB;IAExB,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE7C,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,YAAY,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACrE,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,oBAAoB,UAAU,IAAI,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,UAAmB,EACnB,IAAY,EACZ,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,UAAU,CAAC;IAE7C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,SAAS,CACP,UAAU,CAAC,QAAQ,CAAC,EACpB,GAAG,IAAI,SAAS,EAChB,eAAe,EACf,QAAQ,CACT,CAAC;QACF,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrE,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QACtC,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7D,SAAS,CAAC,EAAE,EAAE,GAAG,IAAI,KAAK,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,CACxE,CAAC;IACJ,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,SAAS,QAAQ,CAAC,GAAY,EAAE,QAAkB;IAChD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,CACpE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,QAAkB;IACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,cAAc,CACf,CACF,CAAC;AACJ,CAAC"}

package/dist/validate.d.ts

@@ -0,0 +1,15 @@
+import type { ColophonConfig } from "./types.js";
+/**
+ * Reject a config carrying options Colophon does not know.
+ *
+ * An unrecognised key is otherwise ignored in silence: the build succeeds, the
+ * option does nothing, and the images come out with the defaults in its place.
+ * That is at its worst across an upgrade, where a config that still reads
+ * correctly is describing images nobody is rendering.
+ *
+ * Only the closed parts of the config are checked. The names in `templates`
+ * are the project's own, and a post's props are open by design — a template
+ * reads whatever fields it understands.
+ */
+export declare function validateConfig(config: ColophonConfig): void;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,cAAc,EAMf,MAAM,YAAY,CAAC;AAsWpB;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAkC3D"}

package/dist/validate.js

@@ -0,0 +1,300 @@
+/**
+ * The keys of one config object, as a list to check incoming keys against.
+ *
+ * Taking a `Record<keyof T, true>` rather than a plain array of strings is
+ * what keeps the list honest: adding an option to `types.ts` without listing
+ * it here fails the build, which is much better than the new option quietly
+ * becoming an unknown one.
+ */
+function knownKeys(shape) {
+    return Object.keys(shape);
+}
+const configKeys = knownKeys({
+    colors: true,
+    background: true,
+    fonts: true,
+    systemFonts: true,
+    fontFamily: true,
+    footer: true,
+    badge: true,
+    code: true,
+    onWarning: true,
+    sizes: true,
+    templates: true,
+    content: true,
+});
+const contentKeys = knownKeys({
+    propsKey: true,
+    templateField: true,
+    defaultTemplate: true,
+    props: true,
+    slugField: true,
+    slugStrategy: true,
+    extensions: true,
+});
+const colorKeys = knownKeys({
+    brand: true,
+    brandDark: true,
+    brandWarm: true,
+    foreground: true,
+});
+const badgeKeys = knownKeys({
+    text: true,
+    color: true,
+    background: true,
+});
+const codeKeys = knownKeys({
+    theme: true,
+    fontFamily: true,
+    charWidthRatio: true,
+    lineHeight: true,
+    tabSize: true,
+    cornerScale: true,
+    maxFontScale: true,
+    minFontScale: true,
+});
+const sizeKeys = knownKeys({
+    name: true,
+    width: true,
+    height: true,
+    colors: true,
+    background: true,
+    fontFamily: true,
+    footer: true,
+    badge: true,
+    code: true,
+});
+/**
+ * Both font variants at once. Which of `path` and `data` a font may carry is
+ * `fonts.ts`'s ruling to make, and it has a better message for it than a list
+ * of keys could.
+ */
+const fontKeys = [
+    ...new Set([
+        ...knownKeys({ family: true, path: true }),
+        ...knownKeys({ family: true, data: true }),
+    ]),
+];
+const solidBackgroundKeys = knownKeys({
+    type: true,
+    color: true,
+});
+const gradientBackgroundKeys = knownKeys({
+    type: true,
+    stops: true,
+    from: true,
+    to: true,
+});
+const gradientStopKeys = knownKeys({
+    offset: true,
+    color: true,
+});
+const gradientPointKeys = knownKeys({ x: true, y: true });
+/**
+ * The background variants, as values to check a declared `type` against. Typed
+ * against the union for the same reason the key lists are: a variant added to
+ * `Background` and not listed here would otherwise be reported as an unknown
+ * type, rejecting a config that is perfectly valid.
+ */
+const backgroundTypes = knownKeys({
+    solid: true,
+    gradient: true,
+});
+/**
+ * The slug strategies, for the same reason as {@link backgroundTypes}:
+ * `slugFromPath` treats anything that is not `basename` as a route, so a
+ * mistyped `rout` would quietly re-slug a whole site rather than complain.
+ */
+const slugStrategies = knownKeys({
+    basename: true,
+    route: true,
+});
+/**
+ * Options that have been renamed, keyed by where the old name turns up.
+ * Edit distance cannot connect a rename that changed the word — `dimensions`
+ * became `sizes` — and a config carried over from an older version is exactly
+ * where a bare "unknown option" helps least.
+ */
+const renamedOptions = new Map([["dimensions", "sizes"]]);
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isList(value) {
+    return Array.isArray(value);
+}
+/**
+ * Levenshtein distance between two strings, used to work out which option a
+ * typo was aiming at. Both strings are option names and the lists are a
+ * handful of entries long, so the plain two-row dynamic program is ample.
+ */
+function editDistance(a, b) {
+    let previous = Array.from({ length: b.length + 1 }, (_, index) => index);
+    for (let row = 1; row <= a.length; row += 1) {
+        const current = [row];
+        for (let column = 1; column <= b.length; column += 1) {
+            const cost = a[row - 1] === b[column - 1] ? 0 : 1;
+            // Every index here is within the row by construction; the fallbacks are
+            // there for `noUncheckedIndexedAccess` rather than for any real case.
+            current.push(Math.min((previous[column - 1] ?? 0) + cost, (previous[column] ?? 0) + 1, (current[column - 1] ?? 0) + 1));
+        }
+        previous = current;
+    }
+    return previous[b.length] ?? 0;
+}
+/**
+ * The known name a mistyped one was most likely meant to be, or `undefined`
+ * when nothing is close enough. A confident suggestion of something unrelated
+ * is worse than none, so the tolerance stays under the length of the name:
+ * a slip of a key or two earns a suggestion, a different word does not.
+ */
+function nearestName(name, known) {
+    const tolerance = Math.min(name.length - 1, Math.max(2, Math.ceil(name.length / 4)));
+    let nearest;
+    let shortest = Infinity;
+    for (const candidate of known) {
+        // Case-insensitive: `tabsize` for `tabSize` is the same slip as a typo.
+        const distance = editDistance(name.toLowerCase(), candidate.toLowerCase());
+        if (distance < shortest) {
+            nearest = candidate;
+            shortest = distance;
+        }
+    }
+    return shortest <= tolerance ? nearest : undefined;
+}
+function describeUnknownOption(path, key, known) {
+    const suggestion = renamedOptions.get(path) ?? nearestName(key, known);
+    if (suggestion !== undefined) {
+        return `Unknown option "${path}". Did you mean "${suggestion}"?`;
+    }
+    return `Unknown option "${path}". Valid options here: ${known.join(", ")}.`;
+}
+/**
+ * Report every key of one config object that is not a known option. Anything
+ * that is not an object is left alone: the shape of a value is the type
+ * checker's business, and there are no keys to judge either way.
+ */
+function checkKeys(value, path, known, problems) {
+    if (!isRecord(value)) {
+        return;
+    }
+    for (const key of Object.keys(value)) {
+        if (!known.includes(key)) {
+            problems.push(describeUnknownOption(path === "" ? key : `${path}.${key}`, key, known));
+        }
+    }
+}
+/** Check every entry of a list, naming each by its index. */
+function checkEach(values, path, known, problems) {
+    if (!isList(values)) {
+        return;
+    }
+    for (const [index, value] of values.entries()) {
+        checkKeys(value, `${path}[${String(index)}]`, known, problems);
+    }
+}
+/**
+ * Check a background against the keys of whichever variant it declares.
+ *
+ * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
+ * anything that is not `solid` as a gradient, so `gradiant` silently becomes
+ * one and then falls over on the stops it does not have. A background with no
+ * `type` at all is left alone — the type is what says which keys apply, and
+ * guessing would report the keys rather than the omission.
+ */
+function checkBackground(background, path, problems) {
+    if (!isRecord(background)) {
+        return;
+    }
+    const { type, stops, from, to } = background;
+    if (type === "solid") {
+        checkKeys(background, path, solidBackgroundKeys, problems);
+        return;
+    }
+    if (type === "gradient") {
+        checkKeys(background, path, gradientBackgroundKeys, problems);
+        checkEach(stops, `${path}.stops`, gradientStopKeys, problems);
+        checkKeys(from, `${path}.from`, gradientPointKeys, problems);
+        checkKeys(to, `${path}.to`, gradientPointKeys, problems);
+        return;
+    }
+    if (typeof type === "string") {
+        const suggestion = nearestName(type, backgroundTypes);
+        problems.push(suggestion === undefined
+            ? `Unknown background type "${type}". Valid types: ${backgroundTypes.join(", ")}.`
+            : `Unknown background type "${type}". Did you mean "${suggestion}"?`);
+    }
+}
+/**
+ * Check the slug strategy names a real one. Only a string can be a strategy;
+ * anything else is a shape the type checker already covers, as elsewhere here.
+ */
+function checkSlugStrategy(content, problems) {
+    if (!isRecord(content)) {
+        return;
+    }
+    const strategy = content["slugStrategy"];
+    if (typeof strategy !== "string" || slugStrategies.includes(strategy)) {
+        return;
+    }
+    const suggestion = nearestName(strategy, slugStrategies);
+    problems.push(suggestion === undefined
+        ? `Unknown slug strategy "${strategy}". Valid strategies: ${slugStrategies.join(", ")}.`
+        : `Unknown slug strategy "${strategy}". Did you mean "${suggestion}"?`);
+}
+/**
+ * Check each output size, and the overrides it carries.
+ *
+ * A size is the one place the same option names appear twice over, so the paths
+ * matter more here than anywhere else: `sizes[1].code.minFontScal` has to say
+ * which size it is talking about to be worth reading at all.
+ */
+function checkSizes(sizes, problems) {
+    if (!isList(sizes)) {
+        return;
+    }
+    for (const [index, size] of sizes.entries()) {
+        const path = `sizes[${String(index)}]`;
+        checkKeys(size, path, sizeKeys, problems);
+        if (!isRecord(size)) {
+            continue;
+        }
+        checkKeys(size["colors"], `${path}.colors`, colorKeys, problems);
+        checkKeys(size["badge"], `${path}.badge`, badgeKeys, problems);
+        checkKeys(size["code"], `${path}.code`, codeKeys, problems);
+        checkBackground(size["background"], `${path}.background`, problems);
+    }
+}
+/**
+ * Reject a config carrying options Colophon does not know.
+ *
+ * An unrecognised key is otherwise ignored in silence: the build succeeds, the
+ * option does nothing, and the images come out with the defaults in its place.
+ * That is at its worst across an upgrade, where a config that still reads
+ * correctly is describing images nobody is rendering.
+ *
+ * Only the closed parts of the config are checked. The names in `templates`
+ * are the project's own, and a post's props are open by design — a template
+ * reads whatever fields it understands.
+ */
+export function validateConfig(config) {
+    // The types say what should be here; validation exists for when it is not.
+    const raw = config;
+    const problems = [];
+    checkKeys(config, "", configKeys, problems);
+    checkKeys(raw.colors, "colors", colorKeys, problems);
+    checkKeys(raw.badge, "badge", badgeKeys, problems);
+    checkKeys(raw.code, "code", codeKeys, problems);
+    checkKeys(raw.content, "content", contentKeys, problems);
+    checkSlugStrategy(raw.content, problems);
+    checkSizes(raw.sizes, problems);
+    checkEach(raw.fonts, "fonts", fontKeys, problems);
+    checkBackground(raw.background, "background", problems);
+    const [first, ...rest] = problems;
+    if (first === undefined) {
+        return;
+    }
+    throw new Error(rest.length === 0
+        ? first
+        : `Invalid config:\n${problems.map((problem) => `  - ${problem}`).join("\n")}`);
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAaA;;;;;;;GAOG;AACH,SAAS,SAAS,CAAI,KAA4B;IAChD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAQD,MAAM,UAAU,GAAG,SAAS,CAAiB;IAC3C,MAAM,EAAE,IAAI;IACZ,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,IAAI;IACX,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,SAAS,EAAE,IAAI;IACf,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,SAAS,CAAiB;IAC5C,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,SAAS,CAAc;IACvC,KAAK,EAAE,IAAI;IACX,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,SAAS,CAAQ;IACjC,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;CACjB,CAAC,CAAC;AAEH,MAAM,QAAQ,GAAG,SAAS,CAAY;IACpC,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI;CACnB,CAAC,CAAC;AAEH,MAAM,QAAQ,GAAG,SAAS,CAAa;IACrC,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;CACX,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,QAAQ,GAAG;IACf,GAAG,IAAI,GAAG,CAAC;QACT,GAAG,SAAS,CAAa,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACtD,GAAG,SAAS,CAAa,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;KACvD,CAAC;CACH,CAAC;AAEF,MAAM,mBAAmB,GAAG,SAAS,CAAkB;IACrD,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,SAAS,CAAqB;IAC3D,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,EAAE,EAAE,IAAI;CACT,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,SAAS,CAAe;IAC/C,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,SAAS,CAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,eAAe,GAAG,SAAS,CAAsC;IACrE,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,cAAc,GAAG,SAAS,CAAgC;IAC9D,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAiB,CAAC,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAE1E,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS;IACxC,IAAI,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAEzE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAEtB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,wEAAwE;YACxE,sEAAsE;YACtE,OAAO,CAAC,IAAI,CACV,IAAI,CAAC,GAAG,CACN,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,EAClC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAC3B,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAC/B,CACF,CAAC;QACJ,CAAC;QAED,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAClB,IAAY,EACZ,KAAwB;IAExB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CACxB,IAAI,CAAC,MAAM,GAAG,CAAC,EACf,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACxC,CAAC;IACF,IAAI,OAA2B,CAAC;IAChC,IAAI,QAAQ,GAAG,QAAQ,CAAC;IAExB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,wEAAwE;QACxE,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;QAE3E,IAAI,QAAQ,GAAG,QAAQ,EAAE,CAAC;YACxB,OAAO,GAAG,SAAS,CAAC;YACpB,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,IAAI,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAY,EACZ,GAAW,EACX,KAAwB;IAExB,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEvE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,mBAAmB,IAAI,oBAAoB,UAAU,IAAI,CAAC;IACnE,CAAC;IAED,OAAO,mBAAmB,IAAI,0BAA0B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAChB,KAAc,EACd,IAAY,EACZ,KAAwB,EACxB,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CACX,qBAAqB,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,CACxE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,SAAS,SAAS,CAChB,MAAe,EACf,IAAY,EACZ,KAAwB,EACxB,QAAkB;IAElB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACpB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CACtB,UAAmB,EACnB,IAAY,EACZ,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,UAAU,CAAC;IAE7C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7D,SAAS,CAAC,EAAE,EAAE,GAAG,IAAI,KAAK,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAEtD,QAAQ,CAAC,IAAI,CACX,UAAU,KAAK,SAAS;YACtB,CAAC,CAAC,4BAA4B,IAAI,mBAAmB,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YAClF,CAAC,CAAC,4BAA4B,IAAI,oBAAoB,UAAU,IAAI,CACvE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,OAAgB,EAAE,QAAkB;IAC7D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAEzD,QAAQ,CAAC,IAAI,CACX,UAAU,KAAK,SAAS;QACtB,CAAC,CAAC,0BAA0B,QAAQ,wBAAwB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACxF,CAAC,CAAC,0BAA0B,QAAQ,oBAAoB,UAAU,IAAI,CACzE,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,KAAc,EAAE,QAAkB;IACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QACvC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,SAAS;QACX,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACjE,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/D,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC5D,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,cAAc,CAAC,MAAsB;IACnD,2EAA2E;IAC3E,MAAM,GAAG,GAAG,MAQX,CAAC;IACF,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5C,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACrD,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnD,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzD,iBAAiB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAChC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;IAExD,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,QAAQ,CAAC;IAElC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IAED,MAAM,IAAI,KAAK,CACb,IAAI,CAAC,MAAM,KAAK,CAAC;QACf,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,oBAAoB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjF,CAAC;AACJ,CAAC"}

package/package.json

@@ -8,12 +8,12 @@
   },
   "homepage": "https://github.com/KensioSoftware/colophon#readme",
   "license": "Apache-2.0",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
-    "colophon": "./dist/cli.js"
+    "colophon": "./dist/cli/index.js"
   },
   "exports": {
     ".": {
@@ -24,6 +24,14 @@
       "types": "./dist/content/index.d.ts",
       "import": "./dist/content/index.js"
     },
+    "./layout": {
+      "types": "./dist/layout/index.d.ts",
+      "import": "./dist/layout/index.js"
+    },
+    "./meta": {
+      "types": "./dist/meta/index.d.ts",
+      "import": "./dist/meta/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -36,7 +44,7 @@
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=22.2.0"
   },
   "keywords": [
     "open-graph",
@@ -47,7 +55,7 @@
     "frontmatter",
     "static-site",
     "svg",
-    "sharp",
+    "resvg",
     "syntax-highlighting",
     "code-image",
     "shiki"
@@ -56,16 +64,19 @@
     "@eslint/js": "^10.0.1",
     "@kensio/smartass": "^1.33.0",
     "@types/eslint-plugin-security": "^3.0.1",
+    "@types/fontkit": "^2.0.9",
     "@types/node": "^26.0.0",
     "@typescript/native": "npm:typescript@^7.0.2",
     "@vitest/coverage-v8": "^4.1.10",
     "@vitest/eslint-plugin": "^1.6.22",
+    "dejavu-fonts-ttf": "^2.37.3",
     "eslint": "^10.6.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-jsdoc": "^63.0.13",
     "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-security": "^4.0.1",
     "eslint-plugin-unicorn": "^69.0.0",
+    "fta-cli": "^3.0.0",
     "globals": "^17.7.0",
     "jiti": "^2.7.0",
     "prettier": "^3.9.5",
@@ -74,8 +85,9 @@
     "vitest": "^4.1.10"
   },
   "dependencies": {
+    "@resvg/resvg-js": "^2.6.2",
+    "fontkit": "^2.0.4",
     "gray-matter": "^4.0.3",
-    "sharp": "^0.35.3",
     "shiki": "^4.3.1"
   },
   "scripts": {
@@ -86,6 +98,7 @@
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "samples": "pnpm build && node scripts/gen-samples.ts",
-    "check": "pnpm fmt && pnpm build:check && pnpm test:coverage"
+    "fta": "./scripts/sh/fta.sh",
+    "check": "pnpm fmt && pnpm fta && pnpm build:check && pnpm test:coverage"
   }
 }