miki-template 2.3.0 → 2.3.2

package/docs/integrations/tsed.md

@@ -1,83 +0,0 @@
-# TSDX / TSed (Ts.ED)
-
-Use miki-template with Ts.ED (TSed) by wiring it into the underlying Express or Koa adapter.
-
-## Setup
-
-Ts.ED can run on Express or Koa. When using the Express adapter, obtain the raw Express app and call `setupExpress()`.
-
-=== "TypeScript"
-
-    ```typescript
-    // server.ts
-    import { ServerLoader } from '@tsed/di';
-    import * as miki from 'miki-template';
-
-    async function bootstrap() {
-      const server = await ServerLoader.bootstrap();
-      // server.rawApp is the underlying Express/Koa instance depending on adapter
-      miki.setupExpress(server.rawApp, {
-        extension: 'html',
-        views: './views'
-      });
-      await server.listen();
-    }
-
-    bootstrap();
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    const { ServerLoader } = require('@tsed/di');
-    const miki = require('miki-template');
-
-    async function bootstrap() {
-      const server = await ServerLoader.bootstrap();
-      miki.setupExpress(server.rawApp, {
-        extension: 'html',
-        views: './views'
-      });
-      await server.listen();
-    }
-
-    bootstrap();
-    ```
-
-## Using in Controllers
-
-Once wired, use `res.render()` in your Ts.ED controllers:
-
-```typescript
-import { Controller, Get, Req, Res } from '@tsed/common';
-import { Request, Response } from 'express';
-
-@Controller('/')
-export class AppController {
-  @Get('/')
-  renderHome(@Req() req: Request, @Res() res: Response) {
-    res.render('home', { user: req.user });
-  }
-
-  @Get('/partials/:name')
-  renderPartial(@Req() req: Request, @Res() res: Response) {
-    res.render(`home#${req.params.name}`, { user: req.user });
-  }
-}
-```
-
-## Partial Rendering
-
-```typescript
-@Get('/cards/:id')
-renderCard(@Req() req: Request, @Res() res: Response) {
-  res.render(`home#card`, { user: req.user });
-}
-```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: setupExpress param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md' 

package/docs/performance.md

@@ -1,74 +0,0 @@
-# Performance
-
-
-
-miki-template is built for real-world apps. Its compiled-AST engine is especially fast on templates with loops, conditionals, and filters — where other engines struggle.
-
-
-
-## Benchmark Results
-
-
-
-Renders per second (higher is better):
-
-
-
-| Template | miki-template | pug | handlebars | ejs |
-
-|----------|--------------|-----|------------|-----|
-
-| Small | ~770k rps | 1.1M rps | 300k rps | 113k rps |
-
-| Medium | ~40k rps | 27k rps | 4k rps | 2k rps |
-
-| Large | **~2530 rps** | 1886 rps | 493 rps | 1881 rps |
-
-
-
-## Key Takeaways
-
-
-
-- On **small** templates, miki-template is competitive with pug.
-
-- On **medium** templates, miki-template beats pug.
-
-- On **large/realistic** templates (the ones that matter in production), miki-template **dominates by ~150×**.
-
-
-
-## Why miki-template Wins on Real Templates
-
-
-
-- **Compiled AST**: Templates are compiled once and reused, avoiding repeated parsing.
-
-- **No runtime interpretation**: No string concatenation or function reconstruction per render.
-
-- **Optimized loops and filters**: for-loops and filters are implemented as efficient node traversals.
-
-- **Cache-friendly**: Compiled templates are cached by default.
-
-
-
-## Running Benchmarks
-
-
-
-```bash
-
-npm run bench
-
-```
-
-
-
-## Next Steps
-
-
-
-- [Getting Started](guide/getting-started.md)
-
-- [API Reference](api/index.md)
-

package/eslint.config.mjs

@@ -1,42 +0,0 @@
-export default [
-  {
-    files: ['src/**/*.js'],
-    languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'commonjs',
-      globals: {
-        Buffer: 'readonly',
-        console: 'readonly',
-        exports: 'readonly',
-        module: 'readonly',
-        process: 'readonly',
-        __dirname: 'readonly',
-        __filename: 'readonly',
-        require: 'readonly',
-        setTimeout: 'readonly',
-        setInterval: 'readonly',
-        clearTimeout: 'readonly',
-        clearInterval: 'readonly',
-        setImmediate: 'readonly',
-        clearImmediate: 'readonly',
-        global: 'readonly',
-        // Node 18+ standard globals
-        URL: 'readonly',
-        URLSearchParams: 'readonly',
-        TextEncoder: 'readonly',
-        TextDecoder: 'readonly',
-        fetch: 'readonly',
-        crypto: 'readonly',
-        performance: 'readonly'
-      }
-    },
-    rules: {
-      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-      'no-console': 'off',
-      'no-undef': 'error',
-      'semi': ['error', 'always'],
-      'quotes': ['error', 'single'],
-      'indent': ['error', 2]
-    }
-  }
-];

package/ex.mjs

@@ -1,36 +0,0 @@
-import express from 'express'
-import miki, {__express,registerContextProcessor} from "miki-template"
-import path from 'node:path';
-
-const app =express()
-const dir=path.join(process.cwd(),"dir")
-
-  // app.engine('html', __express);
-  // app.set('view engine', 'html');
-  // app.set('views', dir);
-  miki.setupExpress(app, { extension: 'html', views: dir });
-
-
-  
-  // registerContextProcessor((cx)=>({
-  //   siteName:"code with miki",
-  //   login:{'name':"miki", 'email':"miki@example.com"}
-  // }))
-  app.get("/",(req,res)=>{
-    const users=[
-      {'name':"miki", 'email':"miki@example.com"},
-      {'name':"miki2", 'email':"miki2@example.com"},
-      {'name':"miki3", 'email':"miki3@example.com"}
-    ]
-    let data=[
-      {name:"miki", email:"jack@miki.com",address:"kumba"},
-      {name:"luis",email:"luis@miki.com",address:"kumba"}
-    ]
-    res.render("index",{name:"miki-template context", users:users, data:data})
-    // res.send(content)
-  })
-
-
-app.listen(3000, () => {
-    console.log('Server is running on port 3000 click: http://localhost:3000')
-}  )

package/live-test/integrations/elysia-example.js

@@ -1,16 +0,0 @@
-import { Elysia } from 'elysia';
-import path from 'path';
-import miki from '../../src/esm.mjs';
-
-const app = new Elysia();
-
-app.get('/', async () => {
-  const html = await miki.asyncRender('home', {}, { views: path.resolve('./live-test/views') });
-  return new Response(html, { headers: { 'Content-Type': 'text/html' } });
-});
-
-export async function start(port = 3004) {
-  return app.listen({ port });
-}
-
-if (import.meta.url === `file://${process.argv[1]}`) start().then(() => console.log('Elysia example listening on 3004'));

package/live-test/integrations/express-example.js

@@ -1,24 +0,0 @@
-const express = require('express');
-const path = require('path');
-const miki = require('../../');
-
-const app = express();
-miki.setupExpress(app, { extension: 'html', views: path.resolve(__dirname, '..', 'views') });
-
-app.get('/', (req, res) => res.render('home', { user: 'ExpressUser', title: 'ExpressCard' }));
-app.get('/partial', (req, res) => res.render('home#card', { user: 'ExpressUser', title: 'ExpressCard' }));
-
-function start(port = 3000, host = '127.0.0.1') {
-	return new Promise((resolve, reject) => {
-		try {
-			const srv = app.listen(port, host, () => {
-				console.log('Express example listening on', port);
-				resolve(srv);
-			});
-		} catch (err) { reject(err); }
-	});
-}
-
-if (require.main === module) start().catch(err => { console.error(err); process.exit(1); });
-
-module.exports = { app, start };

package/live-test/integrations/fastify-example.js

@@ -1,20 +0,0 @@
-const Fastify = require('fastify');
-const path = require('path');
-const miki = require('../../');
-
-const app = Fastify();
-
-app.get('/', async (request, reply) => {
-  const html = await miki.asyncRender('home', { user: 'FastifyUser', title: 'FastifyCard' }, { views: path.resolve(__dirname, '..', 'views') });
-  reply.type('text/html').send(html);
-});
-
-function start(port = 3002, host = '127.0.0.1') {
-  return app.listen({ port, host });
-}
-
-if (require.main === module) {
-  start().then(() => console.log('Fastify example listening on 3002')).catch(err => { console.error('Fastify failed to start', err); process.exit(1); });
-}
-
-module.exports = { app, start };

package/live-test/integrations/hono-example.js

@@ -1,16 +0,0 @@
-import { Hono } from 'hono';
-import miki from '../../src/esm.mjs';
-import path from 'path';
-
-const app = new Hono();
-
-app.get('/', async (c) => {
-  const html = await miki.asyncRender('home', {}, { views: path.resolve('./live-test/views') });
-  return c.html(html);
-});
-
-export async function start(port = 3005) {
-  return app.listen({ port });
-}
-
-if (import.meta.url === `file://${process.argv[1]}`) start().then(() => console.log('Hono example listening on 3005'));

package/live-test/integrations/koa-example.js

@@ -1,30 +0,0 @@
-const Koa = require('koa');
-const path = require('path');
-const miki = require('../../');
-
-const app = new Koa();
-
-app.context.render = async function (view, locals = {}) {
-  const html = await miki.asyncRender(view, locals, { views: path.resolve(__dirname, '..', 'views') });
-  this.type = 'text/html';
-  this.body = html;
-};
-
-app.use(async (ctx) => {
-  await ctx.render('home', { user: 'KoaUser', title: 'KoaCard' });
-});
-
-function start(port = 3001, host = '127.0.0.1') {
-  return new Promise((resolve, reject) => {
-    try {
-      const srv = app.listen(port, host, () => {
-        console.log('Koa example listening on', port);
-        resolve(srv);
-      });
-    } catch (err) { reject(err); }
-  });
-}
-
-if (require.main === module) start().catch(err => { console.error(err); process.exit(1); });
-
-module.exports = { app, start };

package/live-test/integrations/nestjs-example.js

@@ -1,25 +0,0 @@
-/*
-Minimal NestJS integration example (TypeScript flavor shown).
-
-This file is an illustrative snippet and is NOT executed by the
-smoke-test (NestJS requires heavier deps). Use it as a guide.
-
-// main.ts
-import { NestFactory } from '@nestjs/core';
-import { AppModule } from './app.module';
-import * as miki from 'miki-template';
-
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-  const expressApp = app.getHttpAdapter().getInstance();
-  // Wire miki into underlying Express instance
-  miki.setupExpress(expressApp, { extension: 'html', views: './views' });
-  await app.listen(3006);
-}
-
-bootstrap();
-
-*/
-
-// Plain JS note: If you use Nest with JS, the same pattern applies:
-// obtain the underlying Express instance and call miki.setupExpress(...)

package/live-test/integrations/smoke-test.js

@@ -1,166 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const http = require('http');
-
-async function start(scriptPath) {
-  // Skip optional ESM integrations when their deps are missing
-  const missing = {
-    'elysia-example.js': 'elysia',
-    'hono-example.js': 'hono'
-  };
-  const basename = path.basename(scriptPath);
-  if (missing[basename]) {
-    try { require.resolve(missing[basename]); }
-    catch {
-      console.warn(`Skipping ${basename}: ${missing[basename]} is not installed`);
-      return null;
-    }
-  }
-
-  // Require the example module and call its exported start() which
-  // returns a Promise or a server instance.
-  const mod = require(scriptPath);
-  if (mod && typeof mod.start === 'function') {
-    let res;
-    try {
-      res = mod.start();
-    } catch (err) {
-      console.warn(`Skipping ${basename}: start() failed: ${err.message}`);
-      return null;
-    }
-    // Fastify returns a Promise resolving to server address; Koa/Express
-    // return a server instance synchronously — normalize both.
-    if (res && typeof res.then === 'function') {
-      try {
-        await res;
-        return res;
-      } catch (err) {
-        console.warn(`Skipping ${basename}: start() promise rejected: ${err.message}`);
-        return null;
-      }
-    }
-    return res;
-  }
-  // Fallback: spawn as a child process
-  return new Promise((resolve, reject) => {
-    const child = spawn(process.execPath, [scriptPath], { stdio: 'inherit' });
-    child.on('error', reject);
-    setTimeout(() => resolve(child), 800);
-  });
-}
-
-async function fetch(url) {
-  return new Promise((resolve, reject) => {
-    http.get(url, res => {
-      let data = '';
-      res.on('data', c => data += c.toString());
-      res.on('end', () => resolve({ status: res.statusCode, body: data }));
-    }).on('error', reject);
-  });
-}
-
-async function main() {
-  const root = path.resolve(__dirname);
-  const servers = [
-    { file: path.join(root, 'express-example.js'), url: 'http://localhost:3000/' },
-    { file: path.join(root, 'koa-example.js'), url: 'http://localhost:3001/' },
-    { file: path.join(root, 'fastify-example.js'), url: 'http://localhost:3002/' }
-  ];
-  // Add ESM-based examples (elysia, hono). These will be spawned as
-  // child processes if they cannot be required as modules.
-  servers.push({ file: path.join(root, 'elysia-example.js'), url: 'http://localhost:3004/' });
-  servers.push({ file: path.join(root, 'hono-example.js'), url: 'http://localhost:3005/' });
-
-  const procs = [];
-  for (const s of servers) {
-    procs.push(await start(s.file));
-  }
-
-  // Test each server
-  for (let i = 0; i < servers.length; i++) {
-    const s = servers[i];
-    const p = procs[i];
-    if (!p) {
-      console.warn(`Skipping smoke-test for ${path.basename(s.file)} (not running)`);
-      continue;
-    }
-    try {
-      const res = await fetch(s.url);
-      console.log(`${s.url} -> ${res.status} length=${res.body.length}`);
-    } catch (e) {
-      console.error(`Failed to fetch ${s.url}:`, e.message || e);
-    }
-  }
-
-  // Test partial route on express
-  try {
-    const res = await fetch('http://localhost:3000/partial');
-    console.log(`/partial -> ${res.status} length=${res.body.length}`);
-  } catch (e) { console.error('Partial fetch failed', e.message || e); }
-
-  // Programmatic engine tests: render('home#card') via the engine APIs
-  try {
-    // Try requiring as if the package were installed; fallback to local
-    let miki;
-    try { miki = require('miki-template'); } catch (e) { miki = require('../..'); }
-
-    // For each framework, test programmatic partial rendering and finder behavior
-    const frameworks = ['express', 'koa', 'fastify', 'elysia', 'hono'];
-    for (const name of frameworks) {
-      const viewsDir = path.resolve(__dirname, '..', 'views');
-      try {
-        const asyncHtml = await miki.asyncRender('home#card', { user: name + 'Async', title: name + 'Card' }, { views: viewsDir });
-        console.log(`${name}: asyncRender(home#card) length=${asyncHtml.length}`);
-      } catch (e) { console.error(`${name}: asyncRender failed`, e && e.message ? e.message : e); }
-
-      try {
-        const syncHtml = miki.render('home#card', { user: name + 'Sync', title: name + 'Card' }, { views: viewsDir });
-        console.log(`${name}: render(home#card) length=${syncHtml.length}`);
-      } catch (e) { console.error(`${name}: render failed`, e && e.message ? e.message : e); }
-
-      // Finder tests: simulate multiple view roots including nested app-template dirs
-      try {
-        const found = miki.findTemplateInViews('home', [viewsDir, path.resolve(__dirname, '..')]);
-        console.log(`${name}: finder resolved -> ${found ? found : 'not found'}`);
-      } catch (e) { console.error(`${name}: finder error`, e && e.message ? e.message : e); }
-    }
-  } catch (e) {
-    console.error('Engine partial render failed:', e && e.stack ? e.stack : e);
-  }
-
-  // Cleanup: attempt graceful shutdown for each started server
-  for (let i = 0; i < procs.length; i++) {
-    const p = procs[i];
-    if (!p) continue;
-    try {
-      if (typeof p.kill === 'function') {
-        p.kill();
-        continue;
-      }
-      if (typeof p.close === 'function') {
-        p.close();
-        continue;
-      }
-      // Fastify may return an address string; try to require module and call exported stop/close
-      try {
-        const mod = require(servers[i].file);
-        if (mod) {
-          if (typeof mod.stop === 'function') await mod.stop();
-          else if (typeof mod.close === 'function') await mod.close();
-          else if (mod.app && typeof mod.app.close === 'function') mod.app.close();
-        }
-      } catch (e) {
-        // ignore
-      }
-    } catch (e) {
-      // ignore errors during cleanup
-    }
-  }
-}
-
-if (require.main === module) {
-  main().catch(err => {
-    console.error('smoke-test failed', err && err.stack ? err.stack : err);
-    process.exit(1);
-  });
-}

package/live-test/integrations/tsed-example.js

@@ -1,23 +0,0 @@
-/*
-Ts.ED integration (Express adapter)
-
-This is an example snippet for Ts.ED users. Ts.ED can run on Express
-or Koa — when using the Express adapter, obtain the raw Express app
-and call `miki.setupExpress()` as shown.
-
-// server.ts (snippet)
-import { ServerLoader } from '@tsed/di';
-import * as miki from 'miki-template';
-
-async function bootstrap() {
-  const server = await ServerLoader.bootstrap();
-  // server.rawApp is the underlying Express/Koa instance depending on adapter
-  miki.setupExpress(server.rawApp, { extension: 'html', views: './views' });
-  await server.listen();
-}
-
-bootstrap();
-
-*/
-
-// Plain JS: same approach — call setupExpress on the underlying app.