mikel-press 0.30.0 → 0.30.1

package/README.md

@@ -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:

package/index.js

@@ -1,5 +1,6 @@
 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 = "") => {
@@ -162,9 +163,17 @@ press.watchContext = (context, options = {}) => {
 
 // @description general utilities
 press.utils = {
-    // @description normalize a path
-    normalizePath: (rawPath) => {
-        return path.normalize("/" + rawPath);
+    // @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
@@ -268,7 +277,6 @@ press.SourcePlugin = (options = {}) => {
                     source: path.join(folder, file),
                     label: options.label || press.LABEL_PAGE,
                     path: path.join(options?.basePath || ".", file),
-                    url: press.utils.normalizePath(path.join(options?.basePath || ".", file)),
                 };
             });
         },
@@ -342,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 = press.utils.normalizePath(node.path);
-                }
+                node.path = node.attributes?.permalink || node.path;
             }
         },
     };
@@ -393,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") {
@@ -419,11 +433,9 @@ press.CopyAssetsPlugin = (options = {}) => ({
             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),
+                path: path.join(options?.basePath || ".", item.to || path.basename(item.from)),
                 label: options?.label || press.LABEL_ASSET,
             };
         });
@@ -437,7 +449,6 @@ press.RedirectsPlugin = (options = {}) => ({
         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),
         }));

package/package.json

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