@primate/markdown 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+# Markdown
+
+This handler serves Markdown components with the `md` file extension.
+
+## [Documentation](https://primatejs.com/modules/markdown)

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@primate/markdown",
+  "version": "0.1.0",
+  "description": "Primate Markdown module",
+  "homepage": "https://primatejs.com/modules/markdown",
+  "bugs": "https://github.com/primatejs/primate/issues",
+  "license": "MIT",
+  "files": [
+    "src/**/*.js",
+    "src/errors.json",
+    "!src/**/*.spec.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/primatejs/primate",
+    "directory": "packages/markdown"
+  },
+  "dependencies": {
+    "marked": "^7.0.4",
+    "runtime-compat": "^0.25.7"
+  },
+  "peerDependencies": {
+    "primate": "0.22"
+  },
+  "type": "module",
+  "exports": "./src/exports.js"
+}

package/src/compile.js

@@ -0,0 +1,39 @@
+import {marked} from "marked";
+
+const identity_heading = (text, level) => `<h${level}>${text}</h${level}>`;
+
+export default async ({
+  app,
+  directory,
+  options,
+}) => {
+  const {location} = app.config;
+  const monkeyed_heading = options?.renderer?.heading ?? identity_heading;
+  const source = app.runpath(directory);
+  const target = app.runpath(location.server, directory);
+  await target.file.create();
+
+  return async (filename, input) => {
+    const toc = [];
+    const renderer = {
+      ...options?.renderer ?? {},
+      heading(text, level) {
+        const name = text.toLowerCase().replaceAll(/[?{}%]/gu, "");
+        toc.push({level, text, name});
+        return monkeyed_heading(text, level);
+      },
+    };
+    marked.use({
+      ...options,
+      renderer,
+    });
+
+    const content = marked.parse(input);
+    const html = target.join(`${filename}.html`.replace(source, ""));
+    await html.directory.file.create();
+    await html.file.write(content);
+
+    const json = target.join(`${filename}.json`.replace(source, ""));
+    await json.file.write(JSON.stringify(toc));
+  };
+};

package/src/errors.js

@@ -0,0 +1,6 @@
+import {Path} from "runtime-compat/fs";
+import {Logger} from "primate";
+
+const json = await new Path(import.meta.url).up(1).join("errors.json").json();
+
+export default Logger.err(json.errors, json.module);

package/src/errors.json

@@ -0,0 +1,10 @@
+{
+  "module": "primate/solid",
+  "errors": {
+    "MissingComponent": {
+      "message": "missing component {0}",
+      "fix": "create {1} or remove route function",
+      "level": "Error"
+    }
+  }
+}

package/src/exports.js

@@ -0,0 +1,3 @@
+export {default} from "./module.js";
+
+export {default as compile} from "./compile.js";

package/src/module.js

@@ -0,0 +1,67 @@
+import {Response, Status, MediaType} from "runtime-compat/http";
+import precompile from "./compile.js";
+
+const respond = (handler, directory) => (...[name, ...rest]) => async app => {
+  const base = app.runpath(app.config.location.server, directory);
+  const content = await base.join(`${name}.html`).text();
+  const toc = await base.join(`${name}.json`).json();
+
+  return handler({
+    content,
+    toc,
+  }, ...rest);
+};
+
+const as_html = app => async ({content}, _, {status = Status.OK} = {}) =>
+  new Response(await app.render({body: content}), {
+    status,
+    headers: {...await app.headers(), "Content-Type": MediaType.TEXT_HTML},
+});
+
+export default ({
+  directory,
+  extension = "md",
+  options,
+  handler,
+} = {}) => {
+  const env = {};
+  const re = new RegExp(`^.*.(?:${extension})$`, "u");
+  let compile;
+
+  return {
+    name: "primate:markdown",
+    async init(app, next) {
+      env.directory = directory ?? app.config.location.components;
+
+      return next(app);
+    },
+    register(app, next) {
+      app.register(extension, respond(handler ?? as_html(app), env.directory));
+      return next(app);
+    },
+    async compile(app, next) {
+      const {location} = app.config;
+      const source = app.runpath(directory);
+      // copy ${env.directory} to build/${env.directory}
+      await app.stage(app.root.join(env.directory), env.directory, re);
+
+      const components = await source.collect(re);
+      const target = app.runpath(location.server, env.directory);
+      await target.file.create();
+
+      compile = await precompile({
+        app,
+        directory: env.directory,
+        options,
+      });
+
+      await Promise.all(components.map(async component =>
+        compile(component.path, await component.file.read())));
+
+      return next(app);
+    },
+    async handle(request, next) {
+      return next({...request, markdown: {compile}});
+    },
+  };
+};