mikel 0.16.0 → 0.17.1

package/README.md

@@ -311,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.d.ts

@@ -0,0 +1,48 @@
+declare type HelperFunction = (params: {
+    args: any[];
+    opt: Record<string, any>;
+    context: Record<string, any>;
+    fn: (context?: Record<string, any>, vars?: Record<string, any>, output?: string[]) => string;
+}) => string;
+
+declare interface Helpers {
+    [key: string]: HelperFunction;
+}
+
+declare interface Partials {
+    [key: string]: string;
+}
+
+declare interface Functions {
+    [key: string]: (params: {
+        args: any[];
+        opt: Record<string, any>;
+        context: Record<string, any>;
+    }) => string | void;
+}
+
+declare interface MikelOptions {
+    helpers?: Helpers;
+    partials?: Partials;
+    functions?: Functions;
+}
+
+declare interface MikelTemplate {
+    (data?: any): string;
+    addHelper(name: string, fn: HelperFunction): void;
+    removeHelper(name: string): void;
+    addFunction(name: string, fn: (params: any) => string | void): void;
+    removeFunction(name: string): void;
+    addPartial(name: string, partial: string): void;
+    removePartial(name: string): void;
+}
+
+declare const mikel: {
+    (template: string, data?: any, options?: Partial<MikelOptions>): string;
+    create(template: string, options?: Partial<MikelOptions>): MikelTemplate;
+    escape(str: string): string;
+    get(context: any, path: string): any;
+    parse(value: string, context?: any, vars?: any): any;
+};
+
+export default mikel;

package/index.js

@@ -35,18 +35,6 @@ 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 => {
@@ -61,6 +49,7 @@ 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
@@ -182,6 +171,5 @@ 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.16.0",
+    "version": "0.17.1",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",
@@ -12,12 +12,12 @@
     "bugs": "https://github.com/jmjuanes/mikel/issues",
     "main": "index.js",
     "module": "index.js",
+    "types": "index.d.ts",
     "exports": {
         ".": "./index.js",
         "./package.json": "./package.json"
     },
     "scripts": {
-        "release": "node scripts/release.js",
         "test": "node test.js"
     },
     "keywords": [
@@ -27,6 +27,7 @@
     "files": [
         "README.md",
         "LICENSE",
-        "index.js"
+        "index.js",
+        "index.d.ts"
     ]
 }