mikel-press 0.1.0 → 0.2.0

package/index.d.ts

@@ -4,11 +4,6 @@ interface MikelTemplateOptions {
     partials: {[key: string]: string};
 }
 
-interface FrontmatterOptions {
-    separator?: string;
-    parse?: (front: string) => any;
-}
-
 interface FrontmatterResult {
     body: string;
     attributes: any;
@@ -19,15 +14,22 @@ interface VirtualPageOptions {
     file?: string;
     extname?: string;
     basename?: string;
+    frontmatter?: (str: string) => FrontmatterResult;
+    transform?: (str: string) => string;
 }
 
 interface VirtualPage {
-    content: string,
-    attributes: any,
-    name: string,
-    extname: string,
-    basename: string,
-    url: string,
+    content: string;
+    attributes: any;
+    name: string;
+    extname: string;
+    basename: string;
+    url: string;
+}
+
+interface PostsPluginOptions {
+    dir: string;
+    parser: (str: string) => string;
 }
 
 interface SiteConfig {
@@ -38,13 +40,16 @@ interface SiteConfig {
     dataDir: string;
     pagesDir: string;
     assetsDir: string;
-    frontmatter: Partial<FrontmatterOptions>;
+    frontmatter: (str: string) => FrontmatterResult;
     mikel: Partial<MikelTemplateOptions>;
     plugins: any[];
 }
 
 declare module "mikel-press" {
-    export function frontmatter(str: string, options?: FrontmatterOptions): FrontmatterResult;
+    export function frontmatter(str: string): FrontmatterResult;
     export function createVirtualPage(options: VirtualPageOptions): VirtualPage;
     export function run(config: Partial<SiteConfig>): void;
+
+    export function postsPlugin(options: PostsPluginOptions): any;
+    export function progressPlugin(): any;
 }

package/index.js

@@ -2,16 +2,28 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 import mikel from "mikel";
 
+// @description tiny yaml parser
+const parseYaml = (str = "") => {
+    const lines = str.split("\n").filter(line => line.trim() !== "" && !line.trim().startsWith("#"));
+    return Object.fromEntries(lines.map(line => {
+        const [key, value] = line.split(":").map(part => part.trim());
+        if (!isNaN(value)) {
+            return [key, Number(value)];
+        }
+        if (value === "true" || value === "false" || value === "null") {
+            return [key, JSON.parse(value)];
+        }
+        return [key, value.replaceAll(/^["']|["']$/g, "")];
+    }));
+};
+
 // @description tiny front-matter parser
-const frontmatter = (str = "", options = {}) => {
+const frontmatter = (str = "") => {
     let body = (str || "").trim(), attributes = {};
-    if (!!options && typeof options === "object") {
-        const matches = Array.from(body.matchAll(new RegExp("^(" + (options.separator || "---") + " *)", "gm")));
-        if (matches?.length === 2 && matches[0].index === 0) {
-            const front = body.substring(0 + matches[0][1].length, matches[1].index).trim();
-            body = body.substring(matches[1].index + matches[1][1].length).trim();
-            attributes = typeof options.parse === "function" ? options.parse(front) : front;
-        }
+    const matches = Array.from(body.matchAll(/^(--- *)/gm));
+    if (matches?.length === 2 && matches[0].index === 0) {
+        attributes = parseYaml(body.substring(0 + matches[0][1].length, matches[1].index).trim());
+        body = body.substring(matches[1].index + matches[1][1].length).trim();
     }
     return {body, attributes};
 };
@@ -37,10 +49,11 @@ const getLayoutContent = config => {
         content = config.layoutContent || config.templateContent;
     }
     // parse with frontmatter
-    const {body, attributes} = frontmatter(content, config.frontmatter);
+    const {body, attributes} = typeof config.frontmatter == "function" ? config.frontmatter(content) : {body: content, attributes: {}};
     return {
         content: body,
         data: attributes || {},
+        attributes: attributes || {},
     };
 };
 
@@ -49,7 +62,7 @@ const createVirtualPage = (options = {}) => {
     const content = options.content || fs.readFileSync(options.file, "utf8");
     const extname = options.extname || path.extname(options.file || "") || ".html";
     const basename = options.basename || path.basename(options.file || "", extname) || "virtual";
-    const {body, attributes} = frontmatter(content, options.frontmatter);
+    const {body, attributes} = typeof options?.frontmatter == "function" ? options.frontmatter(content) : {body: content, attributes: {}};
     return {
         name: basename + extname,
         basename: basename,
@@ -57,61 +70,56 @@ const createVirtualPage = (options = {}) => {
         url: options.url || attributes?.permalink || path.join("/", basename + extname),
         data: attributes || {}, // DEPRECATED
         attributes: attributes || {},
-        content: typeof options.parse === "function" ? options.parse(body) : body,
+        content: typeof options.transform === "function" ? options.transform(body) : body,
     };
 };
 
 // @description get pages from input folder
-const readPages = (folder, extensions = ".html", fm = null, parse = null) => {
+const readPages = (folder, extensions = ".html", fm = null, transform = null) => {
     const extensionsList = new Set([extensions].flat());
-    return fs.readdirSync(folder, "utf8")
-        .filter(file => extensionsList.has(path.extname(file)))
-        .map(file => {
-            return createVirtualPage({
-                file: path.join(folder, file),
-                frontmatter: fm,
-                parse: parse,
-                extname: ".html",
+    if (fs.existsSync(folder) && fs.lstatSync(folder).isDirectory()) {
+        return fs.readdirSync(folder, "utf8")
+            .filter(file => extensionsList.has(path.extname(file)))
+            .map(file => {
+                return createVirtualPage({
+                    file: path.join(folder, file),
+                    frontmatter: fm,
+                    transform: transform,
+                    extname: ".html",
+                });
             });
-        });
+    }
+    return [];
 };
 
 // @description get assets
 const readAssets = (folder, fm = null) => {
-    const assetPaths = fs.readdirSync(folder, "utf8");
-    return Object.fromEntries(assetPaths.map(file => {
-        const asset = createVirtualPage({
-            file: path.join(folder, file),
-            frontmatter: fm,
-        });
-        const assetName = asset.basename.replaceAll(".", "_").replaceAll("-", "_");
-        return [assetName, asset];
-    }));
+    if (fs.existsSync(folder) && fs.lstatSync(folder).isDirectory()) {
+        const assetPaths = fs.readdirSync(folder, "utf8");
+        return Object.fromEntries(assetPaths.map(file => {
+            const asset = createVirtualPage({
+                file: path.join(folder, file),
+                frontmatter: fm,
+            });
+            const assetName = asset.basename.replaceAll(".", "_").replaceAll("-", "_");
+            return [assetName, asset];
+        }));
+    }
+    return {};
 };
 
 // @description read a data folder
 const readData = folder => {
-    const files = fs.readdirSync(folder, "utf8")
-        .filter(file => path.extname(file) === ".json")
-        .map(file => path.join(folder, file))
-        .map(file => {
-            return [path.basename(file, ".json"), JSON.parse(fs.readFileSync(file, "utf8"))];
-        });
-    return Object.fromEntries(files);
-};
-
-// @description plugins
-const plugins = {
-    // plugin to read and include posts in markdown
-    posts: (options = {}) => {
-        return context => {
-            context.hooks.beforeEmit.add(() => {
-                const posts = readPages(path.join(context.source, options?.dir || "posts"), [".md"], context.site.frontmatter, options?.parser);
-                context.site.posts = posts; // posts will be accesible in site.posts
-                context.site.pages = [...context.site.pages, ...posts]; // posts will be included as pages also
+    if (fs.existsSync(folder) && fs.lstatSync(folder).isDirectory()) {
+        const files = fs.readdirSync(folder, "utf8")
+            .filter(file => path.extname(file) === ".json")
+            .map(file => path.join(folder, file))
+            .map(file => {
+                return [path.basename(file, ".json"), JSON.parse(fs.readFileSync(file, "utf8"))];
             });
-        };
-    },
+        return Object.fromEntries(files);
+    }
+    return {};
 };
 
 // @description run mikel press with the provided configuration
@@ -160,5 +168,37 @@ const run = (config = {}) => {
     dispatch("done", []);
 };
 
+// plugin to read and include posts in markdown
+const postsPlugin = (options = {}) => {
+    return context => {
+        context.hooks.beforeEmit.add(() => {
+            const posts = readPages(path.join(context.source, options?.dir || "posts"), [".md"], context.site.frontmatter, options?.parser);
+            context.site.posts = posts; // posts will be accesible in site.posts
+            context.site.pages = [...context.site.pages, ...posts]; // posts will be included as pages also
+        });
+    };
+};
+
+// progress plugin
+const progressPlugin = () => {
+    return context => {
+        const timeStart = Date.now();
+        const log = (status, msg) => console.log(`[${new Date().toISOString()}] (${status}) ${msg}`);
+        context.hooks.initialize.add(() => {
+            log("info", `source directory:       ${context.source}`);
+            log("info", `destination directory:  ${context.destination}`);
+        });
+        context.hooks.emitPage.add(page => {
+            log("info", `saving page:  ${page.url} --> ${path.join(context.destination, page.url)}`);
+        });
+        context.hooks.emitAsset.add(asset => {
+            log("info", `saving asset: ${asset.url} --> ${path.join(context.destination, asset.url)}`);
+        });
+        context.hooks.done.add(() => {
+            log("done", `build completed in ${Date.now() - timeStart}ms`);
+        });
+    };
+};
+
 // export
-export default {run, createVirtualPage, frontmatter, plugins};
+export default {run, createVirtualPage, frontmatter, postsPlugin, progressPlugin};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel-press",
     "description": "A minimal static site generator based on mikel templating",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",