mikel 0.26.2 → 0.27.1

package/README.md

@@ -36,6 +36,18 @@ const result = m(`Hello {{name || "World"}}!`, {});
 // Output: 'Hello World!'
 ```
 
+### Comments
+
+> This feature was added in `v0.27.0`.
+
+Any content between `{{!--` and `--}}` will be completely ignored during template rendering. Comments can span multiple lines and are not included in the output or parsed AST.
+
+```
+{{!-- This is a comment --}}
+```
+
+> **Note**: Nested comments are not supported. The first closing `--}}` encountered will terminate the comment block.
+
 ### Sections
 
 Sections allow for conditional rendering of blocks of content based on the presence or absence of a value in the data object. Use the pound symbol `#` to start a section and the caret `^` to denote an inverted section. End the section with a forward slash `/`.
@@ -100,6 +112,13 @@ const result = m("{{> hello}}", data, {partials});
 // Output: 'Hello Bob!'
 ```
 
+Partial metadata can be accessed using the `@partial` variable inside the partial. It contains the following fields:
+
+- `name`: the name of the partial being rendered.
+- `args`: an array containing the positional arguments provided to the partial (if any). See the **Custom context in partials** section for more details.
+- `opt`: an object containing the keyword arguments provided to the partial (if any). See the **Keyword arguments in partials** section for more details.
+- `attributes`: the custom data provided to the partial (if any). See the **Partials data** section for more details.
+
 #### Custom context in partials
 
 > This feature was added in `v0.3.1`.
@@ -193,7 +212,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:
 
@@ -201,7 +220,7 @@ Example:
 const options = {
     partials: {
         foo: {
-            body: "Hello {{@partial.name}}!",
+            body: "Hello {{@partial.attributes.name}}!",
             data: {
                 name: "Bob",
             },

package/index.js

@@ -16,8 +16,12 @@ const get = (data, path = ".") => {
     return path.replace(/^this\./, "").split(".").reduce((x, k) => x?.[k], data) ?? "";
 };
 
-// @description tokenize and untokenize methods
-const tokenize = (str = "") => str.split(/\{\{|\}\}/);
+// @description tokenize the provided string
+const tokenize = (str = "") => {
+    return str.replace(/\{\{!--[\s\S]*?--}}/g, "").split(/\{\{|\}\}/);
+}
+
+// @description untokenize the provided tokens array and get a string
 const untokenize = (ts = [], s = "{{", e = "}}") => {
     return ts.length > 0 ? ts.reduce((p, t, i) => p + (i % 2 === 0 ? e : s) + t) : "";
 };
@@ -142,7 +146,12 @@ 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 || [],
+                            opt: opt || {},
+                        },
                     };
                     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.26.2",
+    "version": "0.27.1",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",