mikel 0.27.0 → 0.28.0

package/README.md

@@ -205,7 +205,7 @@ Partials allows you to define custom data. Instead of providing a string with th
 - `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`.
+Custom data will be available in the partial content in the `@partial.attributes` variable.
 
 Example:
 
@@ -213,7 +213,7 @@ Example:
 const options = {
     partials: {
         foo: {
-            body: "Hello {{@partial.name}}!",
+            body: "Hello {{@partial.attributes.name}}!",
             data: {
                 name: "Bob",
             },
@@ -225,6 +225,31 @@ const result = m("{{>foo}}", {}, options);
 // Output: 'Hello Bob!'
 ```
 
+#### Accessing to partial metadata using the `@partial` variable
+
+> Added in `v0.28.0`.
+
+Partial metadata can be accessed using the `@partial` variable inside the partial. It contains the following fields:
+
+- `@partial.name`: the name of the partial being rendered.
+- `@partial.args`: an array containing the positional arguments provided to the partial (if any).
+- `@partial.options`: an object containing the keyword arguments provided to the partial (if any).
+- `@partial.attributes`: the custom data provided to the partial (if any).
+- `@partial.context`: the current rendering context.
+
+### Inline partials
+
+> Added in `v0.28.0`.
+
+Inline partials allows you to define partials directly in your template. Use `>*` followed by the partial name to start the partial definition, and end the partial definition with a slash `/` followed by the partial name. For example, `{{>*foo}}` begins a partial definition called `foo`, and `{{/foo}}` ends it.
+
+Example:
+
+```javascript
+const result = m(`{{>*foo}}Hello {{name}}!{{/foo}}{{>foo name="Bob"}}`, {});
+// Output: 'Hello Bob!'
+```
+
 ### Helpers
 
 > Added in `v0.4.0`.
@@ -440,7 +465,7 @@ console.log(result); // --> "0: John, 1: Alice, 2: Bob,"
 
 #### Expand helper arguments using the spread operator
 
-> This feature was addedin `v0.20.0`.
+> This feature was added in `v0.20.0`.
 
 You can use the spread operator `...` to expand the arguments of a helper. This allows you to pass an array of values as individual arguments to the helper, or to pass an object as keyword arguments.
 
@@ -465,6 +490,17 @@ const result = m("{{#join ...items ...options}}{{/join}}", data, options);
 console.log(result); // --> "John, Alice, Bob"
 ```
 
+#### Accessing to helper metadata using the `@helper` variable
+
+> Introduced in `v0.28.0`.
+
+Inside any helper block, you can access metadata about the current invocation through the `@helper` variable. It exposes the following fields:
+
+- `@helper.name`: the name of the helper being invoked.
+- `@helper.args`: an array of positional arguments passed to the helper.
+- `@helper.options`: an object containing named (key-value) arguments.
+- `@helper.context`: the current rendering context.
+
 ### Runtime Variables
 
 > Added in `v0.4.0`.

package/index.js

@@ -110,12 +110,25 @@ const create = (options = {}) => {
                 i = findClosingToken(tokens, j, t);
                 output.push(ctx.helpers[t]({
                     args: args,
-                    opt: opt,
+                    opt: opt, // deprecated
+                    options: opt,
                     tokens: tokens.slice(j, i),
                     data: data,
                     variables: vars,
                     fn: (blockData = {}, blockVars = {}, blockOutput = []) => {
-                        compile(tokens, blockOutput, blockData, {...vars, ...blockVars, parent: data, root: vars.root}, j, t);
+                        const helperVars = {
+                            ...vars,
+                            ...blockVars,
+                            helper: {
+                                name: t,
+                                options: opt || {},
+                                args: args || [],
+                                context: blockData,
+                            },
+                            parent: data,
+                            root: vars.root,
+                        };
+                        compile(tokens, blockOutput, blockData, helperVars, j, t);
                         return blockOutput.join("");
                     },
                 }));
@@ -135,6 +148,16 @@ const create = (options = {}) => {
                     i = compile(tokens, includeOutput ? output : [], data, vars, i + 1, t);
                 }
             }
+            else if (tokens[i].startsWith(">*")) {
+                const t = tokens[i].slice(2).trim(), partialTokens = tokens.slice(i + 1);
+                const lastIndex = partialTokens.findIndex((token, j) => {
+                    return j % 2 !== 0 && token.trim().startsWith("/") && token.trim().endsWith(t);
+                });
+                if (typeof ctx.partials[t] === "undefined") {
+                    ctx.partials[t] = untokenize(partialTokens.slice(0, lastIndex));
+                }
+                i = i + lastIndex + 1;
+            }
             else if (tokens[i].startsWith(">")) {
                 const [t, args, opt] = parseArgs(tokens[i].replace(/^>{1,2}/, ""), data, vars);
                 const blockContent = []; // to store partial block content
@@ -146,7 +169,13 @@ const create = (options = {}) => {
                     const newVars = {
                         ...vars,
                         content: blockContent.join(""),
-                        partial: ctx.partials[t]?.attributes || ctx.partials[t]?.data || {},
+                        partial: {
+                            name: t,
+                            attributes: ctx.partials[t]?.attributes || ctx.partials[t]?.data || {},
+                            args: args || [],
+                            options: opt || {},
+                            context: newData,
+                        },
                     };
                     compile(tokenize(ctx.partials[t]?.body || ctx.partials[t]), output, newData, newVars, 0, "");
                 }

package/package.json

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