bun-html-lite

A lightweight, Bun-native HTML templating engine and caching system designed for the BETHA stack (Bun, Elysia, Turso, HTMX, Alpine).

Features

• 🚀 Bun Native: Uses Bun.file() for blazing fast I/O.
• 🔒 Secure: Automatic HTML escaping by default.
• ⚡ HTMX Friendly: renderMany method optimized for generating lists.
• 🦊 Elysia Plugin: Includes a ready-to-use caching plugin.

Installation

bun add bun-html-lite

Usage

1. Templating (HtmlEngine)

Create your HTML views (e.g., src/views/hello.html):

<h1>Hello, {{ name }}!</h1>
<div>Raw HTML: {{ @content }}</div>

Use it in your code:

import { HtmlEngine } from "bun-html-lite";

const engine = new HtmlEngine("./src/views");

const html = await engine.render("hello", {
  name: "Lukáš",
  content: "<b>Bold Text</b>"
});

console.log(html);

2. Caching with Elysia (HtmlCache)

import { Elysia } from "elysia";
import { HtmlCache, htmlCachePlugin } from "bun-html-lite";

const cache = new HtmlCache();

// Optional: Preload templates or fragments
cache.upload("sidebar", "<nav>...</nav>");

new Elysia()
  .use(htmlCachePlugin(cache))
  .get("/", ({ htmlCache }) => {
    if (htmlCache.has("sidebar")) {
      return htmlCache.get("sidebar");
    }
    return "Cache miss";
  })
  .listen(3000);

##API {{ variable }} vs {{ @variable }} {{ variable }}: Escapes HTML entities (prevents XSS).

{{ @variable }}: Renders raw HTML (use carefully).

License

Copyright (c) 2025 Lukáš Němeček

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.

Jak publikovat

1. Ujisti se, že jsi přihlášený k npm:

   npm login

2. Z kořenového adresáře spusť:

   npm publish

   (Můžeš použít i bun publish, pokud máš nastavený bunfig.toml, ale npm publish je zatím spolehlivější standard).