mikel 0.15.0 → 0.17.0

package/README.md

@@ -142,6 +142,38 @@ const result = m("User: {{>user userName=name userEmail=email }}", data, {partia
 
 Please note that providing keyword arguments and a custom context to a partial is not supported. On this situation, the partial will be evaluated only with the custom context.
 
+#### Partial blocks
+
+> This feature was added in `v0.16.0`.
+
+You can pass a block to a partial using a greather than symbol `>>` followed by the partial name to start the partial block, and a slash followed by the partial name to end the partial block. The provided block content will be available in the `@content` variable.
+
+Example:
+
+```javascript
+const options = {
+    partials: {
+        foo: "Hello {{@content}}!",
+    },
+};
+
+const result = m("{{>>foo}}Bob{{/foo}}", {}, options);
+// Output: 'Hello Bob!'
+```
+
+### Inline partials
+
+> This feature was added in `v0.16.0`.
+
+Inline partials allows you to define partials directly in your template. Use the plus symbol `+` 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!'
+```
+
 ### Built-in helpers
 
 > Added in `v0.4.0`.
@@ -279,6 +311,16 @@ const data = {
 console.log(m("{{#with autor}}{{name}} <{{email}}>{{/with}}", data)); // --> 'Bob <bob@email.com>'
 ```
 
+#### escape
+
+> Added in `v0.17.0`.
+
+The `escape` helper allows to escape the provided block content.
+
+```javascript
+console.log(m("{{#escape}}<b>Hello World!</b>{{/escape}}")); // --> '&lt;b&gt;Hello World!&lt;/b&gt;
+```
+
 ### Custom Helpers
 
 > Added in `v0.5.0`.

package/index.js

@@ -1,4 +1,3 @@
-const tags = /\{\{|\}\}/;
 const escapedChars = {
     "&": "&",
     "<": "&lt;",
@@ -11,6 +10,12 @@ const escape = s => s.toString().replace(/[&<>\"']/g, m => escapedChars[m]);
 
 const get = (c, p) => (p === "." ? c : p.split(".").reduce((x, k) => x?.[k], c)) ?? "";
 
+// @description tokenize and untokenize methods
+const tokenize = (str = "") => str.split(/\{\{|\}\}/);
+const untokenize = (ts = [], s = "{{", e = "}}") => {
+    return ts.reduce((p, t, i) => p + (i % 2 === 0 ? e : s) + t);
+};
+
 // @description parse string arguments
 const parseArgs = (argString = "", context = {}, vars = {}) => {
     const [t, ...args] = argString.trim().match(/(?:[^\s"]+|"[^"]*")+/g);
@@ -56,13 +61,13 @@ const defaultHelpers = {
     "eq": p => p.args[0] === p.args[1] ? p.fn(p.context) : "",
     "ne": p => p.args[0] !== p.args[1] ? p.fn(p.context) : "",
     "with": p => p.fn(p.args[0]),
+    "escape": p => escape(p.fn(p.context)),
 };
 
 // @description create a new instance of mikel
 const create = (template = "", options = {}) => {
-    // initialize internal context
     const helpers = Object.assign({}, defaultHelpers, options?.helpers || {});
-    const partials = options?.partials || {};
+    const partials = Object.assign({}, options?.partials || {});
     const functions = options?.functions || {};
     // internal method to compile the template
     const compile = (tokens, output, context, vars, index = 0, section = "") => {
@@ -103,11 +108,26 @@ const create = (template = "", options = {}) => {
                     i = compile(tokens, includeOutput ? output : [], context, vars, i + 1, t);
                 }
             }
+            else if (tokens[i].startsWith("<")) {
+                const t = tokens[i].slice(1).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 partials[t] === "undefined") {
+                    partials[t] = untokenize(partialTokens.slice(0, lastIndex));
+                }
+                i = i + lastIndex + 1;
+            }
             else if (tokens[i].startsWith(">")) {
-                const [t, args, opt] = parseArgs(tokens[i].slice(1), context, vars);
+                const [t, args, opt] = parseArgs(tokens[i].replace(/^>{1,2}/, ""), context, vars);
+                const blockContent = []; // to store partial block content
+                if (tokens[i].startsWith(">>")) {
+                    i = compile(tokens, blockContent, context, vars, i + 1, t);
+                }
                 if (typeof partials[t] === "string") {
                     const newCtx = args.length > 0 ? args[0] : (Object.keys(opt).length > 0 ? opt : context);
-                    compile(partials[t].split(tags), output, newCtx, vars, 0, "");
+                    const newVars = {...vars, content: blockContent.join("")};
+                    compile(tokenize(partials[t]), output, newCtx, newVars, 0, "");
                 }
             }
             else if (tokens[i].startsWith("=")) {
@@ -139,7 +159,7 @@ const create = (template = "", options = {}) => {
     };
     // entry method to compile the template with the provided data object
     const compileTemplate = (data = {}, output = []) => {
-        compile(template.split(tags), output, data, {root: data}, 0, "");
+        compile(tokenize(template), output, data, {root: data}, 0, "");
         return output.join("");
     };
     // assign api methods and return method to compile the template

package/package.json

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