@shivaedev/work-board 0.2.0 → 0.2.1

package/src/page/nav.ts

@@ -1,7 +1,7 @@
-import type { MarkdownFile } from "../files/list.ts";
+import type { MarkdownFile } from "#files/list.ts";
 import { escapeHtml } from "./escape.ts";
 
-const nameOf = (path: string): string => path.slice(path.lastIndexOf("/") + 1).replace(/\.md$/, "");
+const nameOf = (path: string): string => path.slice(path.lastIndexOf("/") + 1).replace(/\.md$/u, "");
 
 const folderOf = (path: string): string => path.slice(0, Math.max(0, path.lastIndexOf("/")));
 
@@ -13,13 +13,13 @@ const link = (file: MarkdownFile, current: string): string => {
 	return `<a href="${hrefOf(file.path)}"${here}>${escapeHtml(nameOf(file.path))}</a>${age}`;
 };
 
-const folder = (name: string, files: ReadonlyArray<MarkdownFile>, current: string): string => {
+const folder = (name: string, files: readonly MarkdownFile[], current: string): string => {
 	const links = files.map((file) => `<li>${link(file, current)}</li>`).join("");
 	const open = files.some((file) => file.path === current) ? " open" : "";
 	return `<details data-key="folder:${escapeHtml(name)}"${open}><summary>${escapeHtml(name)}/ (${files.length})</summary><ul>${links}</ul></details>`;
 };
 
-export const navHtml = (files: ReadonlyArray<MarkdownFile>, current: string, home: string | undefined): string => {
+export const navHtml = (files: readonly MarkdownFile[], current: string, home: string | undefined): string => {
 	const ordered = [...files.filter((file) => file.path === home), ...files.filter((file) => file.path !== home)];
 	const folders = Map.groupBy(ordered, (file) => (file.path === home ? "" : folderOf(file.path)));
 	return [...folders]

package/src/render/board.ts

@@ -2,26 +2,26 @@ import type { RootContent } from "mdast";
 import { markdownToMdast } from "satteri";
 
 export interface Section {
-	readonly title: string;
 	readonly heading: string;
+	readonly items: readonly string[];
 	readonly notes: string;
-	readonly items: ReadonlyArray<string>;
+	readonly title: string;
 }
 
 export interface Board {
-	readonly title: string;
-	readonly intro: string;
-	readonly sections: ReadonlyArray<Section>;
-	readonly footer: string;
 	readonly definitions: string;
+	readonly footer: string;
+	readonly intro: string;
+	readonly sections: readonly Section[];
+	readonly title: string;
 }
 
 interface Draft {
-	title: string;
+	definitions: string[];
+	footer: string[] | undefined;
 	intro: string[];
 	sections: Array<{ title: string; heading: string; notes: string[]; items: string[][] }>;
-	footer: string[] | undefined;
-	definitions: string[];
+	title: string;
 }
 
 const textOf = (node: RootContent): string => {
@@ -42,7 +42,7 @@ const place = (draft: Draft, node: RootContent, source: string, closing: boolean
 	} else if (node.type === "heading" && node.depth === 1 && draft.title === "") {
 		draft.title = source;
 	} else if (isSection(node)) {
-		draft.sections.push({ title: textOf(node), heading: source, notes: [], items: [] });
+		draft.sections.push({ heading: source, items: [], notes: [], title: textOf(node) });
 	} else if (section === undefined) {
 		draft.intro.push(source);
 	} else if (node.type === "heading" && node.depth === 3) {
@@ -54,10 +54,10 @@ const place = (draft: Draft, node: RootContent, source: string, closing: boolean
 	}
 };
 
-const joined = (blocks: ReadonlyArray<string>): string => blocks.join("\n\n");
+const joined = (blocks: readonly string[]): string => blocks.join("\n\n");
 
 export const boardOf = (source: string): Board => {
-	const draft: Draft = { title: "", intro: [], sections: [], footer: undefined, definitions: [] };
+	const draft: Draft = { definitions: [], footer: undefined, intro: [], sections: [], title: "" };
 	const root = markdownToMdast(source);
 	const nodes = root.type === "root" ? root.children : [];
 	const lastHeading = nodes.findLastIndex((node) => node.type === "heading");
@@ -65,18 +65,18 @@ export const boardOf = (source: string): Board => {
 		place(draft, node, source.slice(node.position?.start.offset, node.position?.end.offset), index > lastHeading);
 	});
 	return {
-		title: draft.title,
-		intro: joined(draft.intro),
-		sections: draft.sections.map((section) => ({ ...section, notes: joined(section.notes), items: section.items.map(joined) })),
-		footer: joined(draft.footer ?? []),
 		definitions: joined(draft.definitions),
+		footer: joined(draft.footer ?? []),
+		intro: joined(draft.intro),
+		sections: draft.sections.map((section) => ({ ...section, items: section.items.map(joined), notes: joined(section.notes) })),
+		title: draft.title,
 	};
 };
 
 export interface Count {
-	readonly title: string;
 	readonly count: number;
+	readonly title: string;
 }
 
-export const countsOf = (board: Board): ReadonlyArray<Count> =>
-	board.sections.flatMap((section) => (section.items.length === 0 ? [] : [{ title: section.title, count: section.items.length }]));
+export const countsOf = (board: Board): readonly Count[] =>
+	board.sections.flatMap((section) => (section.items.length === 0 ? [] : [{ count: section.items.length, title: section.title }]));

package/src/render/code.ts

@@ -17,10 +17,10 @@ const textOf = (node: ElementContent): string => {
 };
 
 const diagram = (source: string): Element => ({
-	type: "element",
-	tagName: "figure",
+	children: [{ children: [{ type: "text", value: source }], properties: { className: ["diagram-source"] }, tagName: "pre", type: "element" }],
 	properties: { className: ["diagram"], dataState: "pending" },
-	children: [{ type: "element", tagName: "pre", properties: { className: ["diagram-source"] }, children: [{ type: "text", value: source }] }],
+	tagName: "figure",
+	type: "element",
 });
 
 const isBundled = (language: string): language is BundledLanguage => Object.hasOwn(bundledLanguages, language);
@@ -30,12 +30,11 @@ const highlighted = async (highlighter: Shiki, source: string, language: string)
 		return undefined;
 	}
 	await highlighter.loadLanguage(language);
-	return highlighter.codeToHast(source, { lang: language, themes: THEMES, defaultColor: false }).children[0];
+	return highlighter.codeToHast(source, { defaultColor: false, lang: language, themes: THEMES }).children.at(0);
 };
 
 export const codeBlocks = (highlighter: Shiki) =>
 	defineHastPlugin({
-		name: "work-board-code",
 		element: {
 			filter: ["pre"],
 			visit: async (pre) => {
@@ -51,4 +50,5 @@ export const codeBlocks = (highlighter: Shiki) =>
 				return language === undefined ? undefined : await highlighted(highlighter, source, language);
 			},
 		},
+		name: "work-board-code",
 	});

package/src/render/footnotes.ts

@@ -1,7 +1,7 @@
 import type { Element } from "hast";
 import { defineHastPlugin } from "satteri";
 
-const FOOTNOTE_IDS = /^(?:user-content-fn|footnote-label)/;
+const FOOTNOTE_IDS = /^(?:user-content-fn|footnote-label)/u;
 
 type Value = Element["properties"][string];
 
@@ -19,7 +19,6 @@ const scoped = (prefix: string, value: Value): Value => {
 
 export const footnoteIds = (prefix: string) =>
 	defineHastPlugin({
-		name: "work-board-footnote-ids",
 		element: {
 			filter: ["a", "h2", "li"],
 			visit: (element) => ({
@@ -29,4 +28,5 @@ export const footnoteIds = (prefix: string) =>
 				),
 			}),
 		},
+		name: "work-board-footnote-ids",
 	});

package/src/render/highlighter.ts

@@ -2,14 +2,14 @@ import { Context, Effect, Layer } from "effect";
 import { createHighlighter, type Highlighter as Shiki } from "shiki";
 import { RenderFailed } from "./failed.ts";
 
-export const THEMES = { light: "github-light", dark: "github-dark" } as const;
+export const THEMES = { dark: "github-dark", light: "github-light" } as const;
 
 export class Highlighter extends Context.Service<Highlighter, Shiki>()("WorkBoard/Highlighter") {
 	static readonly layer = Layer.effect(Highlighter)(
 		Effect.acquireRelease(
 			Effect.tryPromise({
-				try: () => createHighlighter({ themes: Object.values(THEMES), langs: [] }),
 				catch: (cause) => new RenderFailed({ cause }),
+				try: () => createHighlighter({ langs: [], themes: Object.values(THEMES) }),
 			}),
 			(highlighter) => Effect.sync(() => highlighter.dispose()),
 		),

package/src/render/markdown.ts

@@ -8,9 +8,9 @@ import { Highlighter } from "./highlighter.ts";
 export const renderMarkdown = Effect.fn("WorkBoard.renderMarkdown")(function* (source: string, idPrefix = "") {
 	const highlighter = yield* Highlighter;
 	const { html } = yield* Effect.tryPromise({
+		catch: (cause) => new RenderFailed({ cause }),
 		try: async () =>
 			markdownToHtml(source, { hastPlugins: idPrefix === "" ? [codeBlocks(highlighter)] : [codeBlocks(highlighter), footnoteIds(idPrefix)] }),
-		catch: (cause) => new RenderFailed({ cause }),
 	});
 	return html;
 });

package/src/serve.ts

@@ -10,7 +10,7 @@ export interface ServeOptions extends BoardOptions {
 	readonly port: number;
 }
 
-export const listenOn = (port: number) => NodeHttpServer.layer(createServer, { host: HOST, port, disablePreemptiveShutdown: true });
+export const listenOn = (port: number) => NodeHttpServer.layer(createServer, { disablePreemptiveShutdown: true, host: HOST, port });
 
 export const serveBoard = (options: ServeOptions) =>
 	HttpRouter.serve(boardLayer(options), { disableLogger: true }).pipe(Layer.provideMerge(listenOn(options.port)));