mikel 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Josemi Juanes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# Mikel
+
+![npm version](https://badgen.net/npm/v/mikel?labelColor=1d2734&color=21bf81)
+![license](https://badgen.net/github/license/jmjuanes/mikel?labelColor=1d2734&color=21bf81)
+
+Mikel is a lightweight implementation of the Mustache templating system in JavaScript, designed to be concise and simple. With less than 60 lines of code, it offers a convenient way to render templates using data.
+
+## Installation
+
+You can install Mikel via npm or yarn:
+
+```bash
+## Install using npm
+$ npm install mikel
+
+## Install using yarn
+$ yarn add mikel
+```
+
+## Usage
+
+### `m(template, data)`
+
+Render the given template string with the provided data object.
+
+- `template` (string): The Mustache template string.
+- `data` (object): The data object containing the values to render.
+
+Returns: A string with the rendered output.
+
+```javascript
+import m from "mikel";
+
+const template = "Hello, {{ name }}!";
+const data = {
+    name: "World",
+};
+
+const result = m(template, data);
+console.log(result); // Output: "Hello, World!"
+```
+
+## Limitations
+
+Mikel aims to provide a minimalistic implementation of Mustache templating and currently has the following limitations:
+
+- **No support for partials:** Mikel does not support partials, meaning you cannot include separate templates within your main template file.
+- **Basic functionality:** While Mikel supports the core features of Mustache templating, it may lack some advanced features found in other implementations.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

package/index.js

@@ -0,0 +1,58 @@
+const escapedChars = {
+    "&": "&",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&#039;",
+};
+
+const escape = str => {
+    return str.toString().replace(/[&<>\"']/g, m => escapedChars[m]);
+};
+
+const get = (ctx, path) => {
+    return path === "." ? ctx : (path.split(".").reduce((p, k) => p?.[k], ctx) || "");
+};
+
+const compile = (tokens, output, ctx, index, section) => {
+    let i = index;
+    while (i < tokens.length) {
+        if (i % 2 === 0) {
+            output.push(tokens[i]);
+        }
+        else if (tokens[i].startsWith("!")) {
+            output.push(get(ctx, tokens[i].slice(1).trim()));
+        }
+        else if (tokens[i].startsWith("#") || tokens[i].startsWith("^")) {
+            const t = tokens[i].slice(1).trim();
+            const value = get(ctx, t);
+            const negate = tokens[i].startsWith("^");
+            if (!negate && value && Array.isArray(value)) {
+                const j = i + 1;
+                value.forEach(item => {
+                    i = compile(tokens, output, item, j, t);
+                });
+            }
+            else {
+                const includeOutput = (!negate && !!value) || (negate && !!!value);
+                i = compile(tokens, includeOutput ? output : [], ctx, i + 1, t);
+            }
+        }
+        else if (tokens[i].startsWith("/")) {
+            if (tokens[i].slice(1).trim() !== section) {
+                throw new Error(`Unmatched section end: {{${tokens[i]}}}`);
+            }
+            break;
+        }
+        else {
+            output.push(escape(get(ctx, tokens[i].trim())));
+        }
+        i = i + 1;
+    }
+    return i;
+};
+
+export default (str, ctx = {}, output = []) => {
+    compile(str.split(/\{\{|\}\}/), output, ctx, 0, "");
+    return output.join("").replace(/\n/g, "\\n");
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "mikel",
+    "description": "Micro mustache implementation with zero dependencies",
+    "version": "0.2.0",
+    "type": "module",
+    "author": {
+        "name": "Josemi Juanes",
+        "email": "hello@josemi.xyz"
+    },
+    "license": "MIT",
+    "repository": "https://github.com/jmjuanes/mikel",
+    "bugs": "https://github.com/jmjuanes/mikel/issues",
+    "main": "index.js",
+    "module": "index.js",
+    "exports": {
+        ".": "./index.js",
+        "./package.json": "./package.json"
+    },
+    "scripts": {
+        "test": "jest test.js"
+    },
+    "keywords": [
+        "mustache",
+        "templating"
+    ],
+    "files": [
+        "README.md",
+        "LICENSE",
+        "index.js"
+    ],
+    "babel": {
+        "presets": [
+            "@babel/preset-env"
+        ]
+    },
+    "devDependencies": {
+        "@babel/preset-env": "^7.24.3",
+        "jest": "^29.7.0"
+    }
+}