mikel 0.17.1 → 0.18.0

package/README.md

@@ -161,6 +161,35 @@ const result = m("{{>>foo}}Bob{{/foo}}", {}, options);
 // Output: 'Hello Bob!'
 ```
 
+#### Partials data
+
+> This feature was added in `v0.18.0`.
+
+Partials allows you to define custom data. Instead of providing a string with the partial content, you can provide an object with the following keys:
+
+- `body`: a string with the partial content.
+- `data`: an object with your custom data for the partial. You can also use `attributes` as an alias.
+
+Custom data will be available in the partial content as a variable `@partial`.
+
+Example:
+
+```javascript
+const options = {
+    partials: {
+        foo: {
+            body: "Hello {{@partial.name}}!",
+            data: {
+                name: "Bob",
+            },
+        },
+    },
+};
+
+const result = m("{{> foo}}", {}, options);
+// Output: 'Hello Bob!'
+```
+
 ### Inline partials
 
 > This feature was added in `v0.16.0`.

package/index.js

@@ -35,6 +35,18 @@ const parse = (v, context = {}, vars = {}) => {
     return (v || "").startsWith("@") ? get(vars, v.slice(1)) : get(context, v || ".");
 };
 
+// @description tiny front-matter parser
+const frontmatter = (str = "", parser = null) => {
+    let body = (str || "").trim(), data = {};
+    const matches = Array.from(body.matchAll(/^(--- *)/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();
+        data = typeof parser === "function" ? parser(front) : front;
+    }
+    return {body, data};
+};
+
 // @description default helpers
 const defaultHelpers = {
     "each": p => {
@@ -112,10 +124,14 @@ const create = (template = "", options = {}) => {
                 if (tokens[i].startsWith(">>")) {
                     i = compile(tokens, blockContent, context, vars, i + 1, t);
                 }
-                if (typeof partials[t] === "string") {
+                if (typeof partials[t] === "string" || typeof partials[t]?.body === "string") {
                     const newCtx = args.length > 0 ? args[0] : (Object.keys(opt).length > 0 ? opt : context);
-                    const newVars = {...vars, content: blockContent.join("")};
-                    compile(tokenize(partials[t]), output, newCtx, newVars, 0, "");
+                    const newVars = {
+                        ...vars,
+                        content: blockContent.join(""),
+                        partial: partials[t]?.attributes || partials[t]?.data || {},
+                    };
+                    compile(tokenize(partials[t]?.body || partials[t]), output, newCtx, newVars, 0, "");
                 }
             }
             else if (tokens[i].startsWith("=")) {
@@ -171,5 +187,6 @@ mikel.create = create;
 mikel.escape = escape;
 mikel.get = get;
 mikel.parse = parse;
+mikel.frontmatter = frontmatter;
 
 export default mikel;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel",
     "description": "Micro templating library with zero dependencies",
-    "version": "0.17.1",
+    "version": "0.18.0",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",