mothwing 0.0.0-stage → 0.0.2

package/types/seo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @param {string} description HTML, as the <x-seo> attribute has it
+ * @param {number} max
+ * @returns {string} At most `max` characters of text, cut at a word so it ends on "...", still HTML
+ */
+export function fitDescription(description: string, max: number): string;
+/**
+ * The <title>, description, canonical URL, link preview tags and breadcrumbs for <x-seo title="..." description="..."/>.
+ * Optional: image="..." image-alt="..." image-size="WxH" for its own preview image, and section="..." name="..." for its
+ * breadcrumb in search results.
+ * @param {import("./config.js").Site} site
+ * @param {import("./routes.js").Route} route
+ * @param {Record<string, string | true>} attrs
+ * @returns {string[]} The tags, one per line
+ */
+export function seoTags(site: import("./config.js").Site, route: import("./routes.js").Route, attrs: Record<string, string | true>): string[];

package/types/site.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Writes the CNAME, sitemaps and robots.txt, those the config turned on.
+ * @param {import("./config.js").Site} site
+ * @param {import("./routes.js").Route[]} routes
+ * @param {boolean} [dated] Add each page's lastmod, from git, which takes a moment
+ */
+export function writeSiteFiles(site: import("./config.js").Site, routes: import("./routes.js").Route[], dated?: boolean): Promise<void>;

package/types/template.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Pastes in the <x-html src="..."/> partials. One on a line of its own is indented like its tag, so partials are
+ * written unindented.
+ * @param {string} src The source folder, partials are relative to it
+ * @param {string} html
+ * @param {string} from For errors, the file `html` came from
+ * @param {Set<string>} [used] Gets every partial pasted in, relative to src
+ * @param {number} [depth]
+ * @returns {string}
+ */
+export function includeHtml(src: string, html: string, from: string, used?: Set<string>, depth?: number): string;
+/**
+ * {{ name }} is filled with the value as text, {{{ name }}} as HTML, on a line of its own each line indented like it.
+ * Names can go into objects: {{ project.name }}.
+ * @param {string} html
+ * @param {Record<string, any>} values
+ * @param {string} from For errors, the page's file
+ * @param {Set<string>} [used] Gets the first part of every name filled in
+ * @returns {string}
+ */
+export function fillPlaceholders(html: string, values: Record<string, any>, from: string, used?: Set<string>): string;
+/**
+ * @param {string} html
+ * @param {string} from For errors, the page's file
+ * @returns {Node[]}
+ */
+export function parseTemplate(html: string, from: string): Node[];
+/**
+ * Fills in the placeholders and runs the blocks:
+ * - <x-each items="projects" as="project">...</x-each> once per item, `index="i"` names its position
+ * - <x-if value="project.url">...</x-if> only when it's there, `not="..."` only when it isn't
+ * @param {Node[]} nodes
+ * @param {Record<string, any>} values
+ * @param {Context} context
+ * @returns {string}
+ */
+export function renderNodes(nodes: Node[], values: Record<string, any>, context: Context): string;
+export function parseAttrs(attrs: string): Record<string, string | true>;
+export function lookup(values: Record<string, any>, name: string): any;
+/**
+ * What a page is filled from, and what it used of it.
+ */
+export type Context = {
+    /**
+     * The page, for errors
+     */
+    from: string;
+    /**
+     * The first part of every name looked up, "projects" for {{ projects.0.name }}
+     */
+    used: Set<string>;
+};
+/**
+ * A page's HTML split at its <x-each> and <x-if> blocks.
+ */
+export type Node = {
+    type: "text";
+    text: string;
+} | {
+    type: "x-each" | "x-if";
+    attrs: Record<string, string | true>;
+    dedent: number;
+    children: Node[];
+};