npm - mikel-press - Versions diffs - 0.28.0 → 0.30.0 - Mend

mikel-press 0.28.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -162,6 +162,20 @@ This plugin loads additional files (aka assets) and includes them in the build f
 This plugin processes and parses the frontmatter in each file. The parsed frontmatter content will be available in `page.attributes` field.
+### `press.TransformPlugin(options)`
+A generic transform plugin that will execute the provided `options.transform` function with the `context` and the current `node` object. Example:
+```javascript
+press.TransformPlugin({
+    transform: node => {
+        if (node.label === press.LABEL_PAGE && node.content && path.extname(node.source) === ".md") {
+            node.content = `{{#markdown}}\n\n${node.content}\n\n{{/markdown}}\n`;
+        }
+    },
+});
+```
 ### `press.ContentPagePlugin()`
 This plugin processes each page using the mikel templating.
@@ -173,6 +187,21 @@ This plugin copies static files from the source to the destination.
 Options:
 - `options.patterns` (array): List of file patterns to copy. Each pattern should have `from` and `to`.
+### `press.RedirectsPlugin(options)`
+The RedirectsPlugin lets you define URL redirects. For each redirect rule, the plugin generates a small HTML file that forwards visitors to the target URL using both HTML and JavaScript fallbacks.
+Options:
+- `options.redirects` (array): list of redirections. Each redirection should have `from` and `to`.
+```javascript
+press.RedirectsPlugin({
+    redirects: [
+        { from: "/socials/github.html", to: "https://github.com/jmjuanes" },
+    ],
+});
+```
 ## API
 **mikel-press** exposes a single function that triggers the build with the given configuration object provided as an argument.

package/index.js CHANGED Viewed

@@ -1,6 +1,11 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
+// @description internal method to get the first node that ends with the provided string
+const getNodeFromSource = (nodes = [], endingStr = "") => {
+    return (nodes || []).find(node => (node.source || "").endsWith(endingStr || ""));
+};
 // @description get all plugins of the given type
 const getPlugins = (context, name) => {
     return context.plugins.filter(plugin => typeof plugin[name] === "function");
@@ -11,6 +16,26 @@ const applyLayout = page => {
     return `{{>>layout:${page.attributes.layout}}}\n\n${page.content}\n\n{{/layout:${page.attributes.layout}}}\n`;
 };
+// @description generate the content for the redirection page
+const generateRedirectHTML = (to, status) => {
+    const content = [
+        `<!DOCTYPE html>`,
+        `<html lang="en">`,
+        `<head>`,
+        `    <meta charset="utf-8" />`,
+        `    <title>Redirecting...</title>`,
+        `    <meta http-equiv="refresh" content="0; url=${to}" />`,
+        `    <link rel="canonical" href="${to}" />`,
+        `    <script>window.location.replace("${to}");</script>`,
+        `</head>`,
+        `<body>`,
+        `    <p>Redirectig to <a href="${to}">${to}</a>...</p>`,
+        `</body>`,
+        `</html>`,
+    ];
+    return content.join("\n");
+};
 // @description press main function
 // @param {Object} config - configuration object
 // @param {String} config.source - source folder
@@ -39,7 +64,28 @@ press.createContext = (config = {}) => {
             ...plugins,
         ],
         nodes: [],
+        actions: {},
+    });
+    // register helpers and funcions
+    context.template.addFunction("getPageUrl", params => {
+        return getNodeFromSource(params?.variables?.root?.site?.pages || [], params.args[0])?.url || "";
+    });
+    context.template.addFunction("getAssetUrl", params => {
+        return getNodeFromSource(params?.variables?.root?.site?.assets || [], params.args[0])?.url || "";
+    });
+    context.template.addHelper("pages", params => {
+        const draft = params?.options?.draft ?? params?.opt?.draft;
+        const collection = params?.opt?.collection || params?.options?.collection || null;
+        const items = (params.data?.site?.pages || []).filter(page => {
+            if (typeof draft === "boolean" && draft !== !!page?.attributes?.draft) {
+                return false;
+            }
+            return !collection || page.attributes?.collection === collection;
+        });
+        const limit = Math.min(items.length, params.options?.limit || params.opt?.limit || items.length);
+        return items.slice(0, limit).reverse().map((c, i) => params.fn(c, {index: i})).join("");
     });
+    // initialize plugins
     getPlugins(context, "init").forEach(plugin => {
         return plugin.init(context);
     });
@@ -59,7 +105,15 @@ press.createContext = (config = {}) => {
 // @description build the provided context
 press.buildContext = (context, nodesToBuild = null) => {
-    const nodes = Array.isArray(nodesToBuild) ? nodesToBuild : context.nodes;
+    const nodes = (Array.isArray(nodesToBuild) ? nodesToBuild : context.nodes).slice();
+    const createNode = (nodeLabel, nodeObject = {}) => {
+        nodes.push({ label: nodeLabel, content: "", ...nodeObject });
+    };
+    // 0. assign actions to context
+    Object.assign(context.actions, {
+        createPage: pageObject => createNode(press.LABEL_PAGE, pageObject),
+        createAsset: assetObject => createNode(press.LABEL_ASSET, assetObject),
+    });
     // 1. transform nodes
     getPlugins(context, "transform").forEach(plugin => {
         // special hook to initialize the transform plugin
@@ -108,6 +162,10 @@ press.watchContext = (context, options = {}) => {
 // @description general utilities
 press.utils = {
+    // @description normalize a path
+    normalizePath: (rawPath) => {
+        return path.normalize("/" + rawPath);
+    },
     // @description read a file from disk
     // @param {String} file path to the file to read
     read: (file, encoding = "utf8") => {
@@ -140,6 +198,26 @@ press.utils = {
             .filter(file => (extensions === "*" || extensions.includes(path.extname(file))) && !exclude.includes(file))
             .filter(file => fs.statSync(path.join(folder, file)).isFile());
     },
+    // @description walk through the given folder and get all files
+    // @params {String} folder folder to walk through
+    // @params {Array|String} extensions extensions to include. Default: "*"
+    walkdir: (folder, extensions = "*", exclude = []) => {
+        const walkSync = (currentFolder, files = []) => {
+            const fullFolderPath = path.join(folder, currentFolder);
+            fs.readdirSync(fullFolderPath).forEach(file => {
+                const filePath = path.join(currentFolder, file);
+                const fullFilePath = path.join(fullFolderPath, file);
+                if (fs.statSync(fullFilePath).isDirectory()) {
+                    return walkSync(filePath, files);
+                }
+                if (extensions === "*" || extensions.includes(path.extname(file))) {
+                    files.push(filePath);
+                }
+            });
+            return files;
+        };
+        return walkSync("./", []);
+    },
     // @description watch for file changes
     // @param {String} filePath path to the file to watch
     // @param {Function} listener method to listen for file changes
@@ -190,7 +268,7 @@ press.SourcePlugin = (options = {}) => {
                     source: path.join(folder, file),
                     label: options.label || press.LABEL_PAGE,
                     path: path.join(options?.basePath || ".", file),
-                    url: path.normalize("/" + path.join(options?.basePath || ".", file)),
+                    url: press.utils.normalizePath(path.join(options?.basePath || ".", file)),
                 };
             });
         },
@@ -247,6 +325,14 @@ press.LayoutsPlugin = (options = {}) => {
     });
 };
+// @description generic transform plugin
+press.TransformPlugin = (options = {}) => {
+    const transformFn = typeof options?.transform === "function" ? options.transform : options;
+    return {
+        transform: (context, node) => transformFn(node, context),
+    };
+};
 // @description frontmatter plugin
 press.FrontmatterPlugin = () => {
     return {
@@ -258,7 +344,7 @@ press.FrontmatterPlugin = () => {
                 node.title = node.attributes?.title || node.path;
                 if (node.attributes.permalink) {
                     node.path = node.attributes.permalink;
-                    node.url = path.normalize("/" + node.path);
+                    node.url = press.utils.normalizePath(node.path);
                 }
             }
         },
@@ -326,19 +412,37 @@ press.UsePlugin = mikelPlugin => {
 };
 // @description copy plugin
-press.CopyAssetsPlugin = (options = {}) => {
-    return {
-        load: () => {
-            return (options?.patterns || [])
-                .filter(item => item.from && fs.existsSync(path.resolve(item.from)))
-                .map(item => ({
-                    source: path.resolve(item.from),
-                    path: path.join(options?.basePath || ".", item.to || path.basename(item.from)),
-                    label: options?.label || press.LABEL_ASSET,
-                }));
-        },
-    };
-};
+press.CopyAssetsPlugin = (options = {}) => ({
+    name: "CopyAssetsPlugin",
+    load: () => {
+        const filesToCopy = (options?.patterns || []).filter(item => {
+            return item.from && fs.existsSync(path.resolve(item.from));
+        });
+        return filesToCopy.map(item => {
+            const filePath = path.join(options?.basePath || ".", item.to || path.basename(item.from));
+            return {
+                source: path.resolve(item.from),
+                path: filePath,
+                url: press.utils.normalizePath(filePath),
+                label: options?.label || press.LABEL_ASSET,
+            };
+        });
+    },
+});
+// @description redirections plugin
+press.RedirectsPlugin = (options = {}) => ({
+    name: "RedirectsPlugin",
+    load: () => {
+        return (options.redirects || []).map(redirection => ({
+            source: redirection.from,
+            path: path.join(options?.basePath || ".", redirection.from),
+            url: press.utils.normalizePath(path.join(options?.basePath || ".", redirection.from)),
+            label: press.LABEL_ASSET,
+            content: generateRedirectHTML(redirection.to),
+        }));
+    },
+});
 // export press generator
 export default press;

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
     "name": "mikel-press",
     "description": "A tiny and fast static site generator based on mikel templating",
-    "version": "0.28.0",
+    "version": "0.30.0",
     "type": "module",
     "license": "MIT",
     "author": {