npm - mikel-press - Versions diffs - 0.29.0 → 0.30.1 - Mend

mikel-press 0.29.0 → 0.30.1

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

@@ -98,6 +98,7 @@ Each HTML file processed by **mikel-press** will be handled by the mikel templat
 | Variable | Description |
 |----------|-------------|
 | `site.pages` | A list containing all pages processed by **mikel-press**. |
+| `site.assets` | A list containing all assets files loaded by the `AssetsPlugin`. |
 | `site.data` | An object containing all data items loaded by `DataPlugin`. |
 | `site.partials` | A list containing all partials files loaded by the `PartialsPlugin`. |
 | `site.layouts` | A list containing all layout files loaded by the `LayoutsPlugin`. |
@@ -110,9 +111,22 @@ Each HTML file processed by **mikel-press** will be handled by the mikel templat
 | `page.content` | The raw content of the page before begin processed by **mikel**. |
 | `page.title` | The title of the page. |
 | `page.path` | The path to the page. Example: `about/index.html`. |
+| `page.dir` | The directory of the page. Example: `about`. |
+| `page.name` | The name of the page without extension. Example: `index`. |
+| `page.ext` | The file extension of the page. Example: `.html`. |
 | `page.url` | The path to the page including the leading `/`. Example: `/about/index.html`. |
 | `page.attributes` | An object containing all the frontmatter variables in the page processed by `FrontmatterPlugin`. |
+#### Asset variables
+| Variable | Description |
+|----------|-------------|
+| `asset.path` | The path to the asset file. Example: `images/logo.png`. |
+| `asset.dir` | The directory of the asset file. Example: `images`. |
+| `asset.name` | The name of the asset file without extension. Example: `logo`. |
+| `asset.ext` | The file extension of the asset file. Example: `.png`. |
+| `asset.url` | The path to the asset file including the leading `/`. Example: `/images/logo.png`. |
 ## Plugins
 **mikel-press** relies on plugins to handle file reading, transformation, and rendering. The following plugins are built-in:
@@ -187,6 +201,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,5 +1,11 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
+import * as crypto from "node:crypto";
+// @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) => {
@@ -11,6 +17,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
@@ -41,6 +67,26 @@ press.createContext = (config = {}) => {
         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);
     });
@@ -117,6 +163,18 @@ press.watchContext = (context, options = {}) => {
 // @description general utilities
 press.utils = {
+    // @description generate the md5 hash of the given content
+    // @param {String} content - content to hash
+    // @returns {String} md5 hash
+    md5: content => {
+        return crypto.createHash("md5").update(content).digest("hex");
+    },
+    // @description generate a random identifier
+    // @param {Number} length - length of the identifier
+    // @returns {String} random identifier
+    randomId: (length = 20) => {
+        return crypto.randomBytes(Math.ceil(length / 2)).toString("hex").slice(0, length);
+    },
     // @description read a file from disk
     // @param {String} file path to the file to read
     read: (file, encoding = "utf8") => {
@@ -149,6 +207,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
@@ -199,7 +277,6 @@ 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)),
                 };
             });
         },
@@ -273,10 +350,7 @@ press.FrontmatterPlugin = () => {
                 node.content = result.body || "";
                 node.attributes = result.attributes || {};
                 node.title = node.attributes?.title || node.path;
-                if (node.attributes.permalink) {
-                    node.path = node.attributes.permalink;
-                    node.url = path.normalize("/" + node.path);
-                }
+                node.path = node.attributes?.permalink || node.path;
             }
         },
     };
@@ -324,6 +398,15 @@ press.ContentPagePlugin = (siteData = {}) => {
                     }
                 });
             }
+            // 5. fix pages and assets variables
+            [...siteData.pages, ...siteData.assets].forEach(node => {
+                return Object.assign(node, {
+                    ext: path.extname(node.path),
+                    name: path.basename(node.path, path.extname(node.path)),
+                    dir: path.dirname(node.path),
+                    url: path.normalize(path.join("/", node.path)),
+                });
+            });
         },
         transform: (context, node) => {
             if (node.label === press.LABEL_PAGE && typeof node.content === "string") {
@@ -343,19 +426,34 @@ 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 => {
+            return {
+                source: path.resolve(item.from),
+                path: path.join(options?.basePath || ".", item.to || path.basename(item.from)),
+                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),
+            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.29.0",
+    "version": "0.30.1",
     "type": "module",
     "license": "MIT",
     "author": {