miki-template 2.3.1 → 2.3.2

package/docs/api/cache.md

@@ -1,174 +0,0 @@
-# Cache API
-
-
-
-## clearCache
-
-
-
-Clear the compiled template cache. Templates are cached in-memory (LRU, 100 entries max). Call this when templates change on disk during development, in tests, or when dynamically registering tags/filters.
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { clearCache } = require('miki-template');
-
-
-
-    clearCache();
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { clearCache } from 'miki-template';
-
-
-
-    clearCache();
-
-    ```
-
-
-
-## How Caching Works
-
-
-
-- Templates are cached by a key combining the source string and compile options (views, custom settings).
-
-- The cache is an in-memory LRU cache limited to 100 entries.
-
-- Cached compiled templates are reused across renders, improving performance for repeated templates.
-
-- Partials defined via `{% partialdef %}` are cached along with their parent template.
-
-
-
-## When to Clear Cache
-
-
-
-- During development when templates change frequently on disk
-
-- In tests to ensure fresh compilation
-
-- When dynamically registering custom tags/filters at runtime
-
-
-
-### Development File Watcher
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const fs = require('fs');
-
-    const { clearCache } = require('miki-template');
-
-
-
-    if (process.env.NODE_ENV !== 'production') {
-
-      fs.watch('./views', () => {
-
-        clearCache();
-
-        console.log('Template cache cleared');
-
-      });
-
-    }
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import fs from 'node:fs';
-
-    import { clearCache } from 'miki-template';
-
-
-
-    if (process.env.NODE_ENV !== 'production') {
-
-      fs.watch('./views', () => {
-
-        clearCache();
-
-        console.log('Template cache cleared');
-
-      });
-
-    }
-
-    ```
-
-
-
-## cache Library
-
-
-
-The built-in `cache` library (auto-activated) provides a template tag for caching fragments:
-
-
-
-```html
-
-{% load cache %}
-
-
-
-{% cache 300 sidebar_key %}
-
-  <div class="sidebar">
-
-    {% for item in sidebar_items %}
-
-      <a href="{{ item.url }}">{{ item.title }}</a>
-
-    {% endfor %}
-
-  </div>
-
-{% endcache %}
-
-```
-
-
-
-The first argument is the TTL in seconds. The second is a cache key. Additional arguments serve as key components.
-
-
-
-## Next Steps
-
-
-
-- [Advanced Usage: Caching](../guide/advanced-usage.md#caching)
-
-- [API Reference](../index.md)
-

package/docs/api/compile.md

@@ -1,256 +0,0 @@
-# compile()
-
-
-
-Compile a template string into a reusable renderable object.
-
-
-
-## Signature
-
-
-
-```javascript
-
-compile(templateStr, options = {})
-
-```
-
-
-
-## Parameters
-
-
-
-| Parameter | Type | Description |
-
-|-----------|------|-------------|
-
-| `templateStr` | `string` | Template source string |
-
-| `options` | `object` | Options including `views` directories |
-
-
-
-## Returns
-
-
-
-An object with these render methods:
-
-
-
-| Method | Description |
-
-|--------|-------------|
-
-| `render(contextObj, callOptions)` | Synchronous render |
-
-| `renderWith(contextObj, callOptions)` | Render with options override |
-
-| `asyncRender(contextObj)` | Asynchronous render (supports async filters/tags) |
-
-| `asyncRenderWith(contextObj, callOptions)` | Async render with options override |
-
-| `renderBlock(blockName, contextObj)` | Render a single `{% block %}` |
-
-| `renderPartial(partialName, contextObj)` | Render a named `{% partialdef %}` |
-
-
-
-## Examples
-
-
-
-### Basic compile
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { compile } = require('miki-template');
-
-
-
-    const compiled = compile('<h1>{{ title }}</h1>');
-
-
-
-    const html = compiled.render({ title: 'Hello' });
-
-    // Output: <h1>Hello</h1>
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { compile } from 'miki-template';
-
-
-
-    const compiled = compile('<h1>{{ title }}</h1>');
-
-
-
-    const html = compiled.render({ title: 'Hello' });
-
-    // Output: <h1>Hello</h1>
-
-    ```
-
-
-
-### Render with options override
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { compile } = require('miki-template');
-
-
-
-    const compiled = compile(template, { views: './templates' });
-
-    const html = compiled.renderWith({ title: 'Hello' }, { views: './other-views' });
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { compile } from 'miki-template';
-
-
-
-    const compiled = compile(template, { views: './templates' });
-
-    const html = compiled.renderWith({ title: 'Hello' }, { views: './other-views' });
-
-    ```
-
-
-
-### Render a Block (template inheritance)
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { compile } = require('miki-template');
-
-
-
-    const compiled = compile(childTemplate, { views: './templates' });
-
-    const html = compiled.renderBlock('content', context);
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { compile } from 'miki-template';
-
-
-
-    const compiled = compile(childTemplate, { views: './templates' });
-
-    const html = compiled.renderBlock('content', context);
-
-    ```
-
-
-
-### Render a Partial
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { compile } = require('miki-template');
-
-
-
-    const compiled = compile(`
-
-      {% partialdef card %}
-
-        <div class="card">{{ title }}</div>
-
-      {% endpartialdef %}
-
-    `);
-
-    const html = compiled.renderPartial('card', { title: 'Hello' });
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { compile } from 'miki-template';
-
-
-
-    const compiled = compile(`
-
-      {% partialdef card %}
-
-        <div class="card">{{ title }}</div>
-
-      {% endpartialdef %}
-
-    `);
-
-    const html = compiled.renderPartial('card', { title: 'Hello' });
-
-    ```
-
-
-
-## Related
-
-
-
-- [render()](./render.md)
-
-- [asyncRender()](./async-render.md)
-

package/docs/api/context-processors.md

@@ -1,154 +0,0 @@
-# Context Processors API
-
-
-
-## registerContextProcessor
-
-
-
-Register a context processor function that runs before every render. The returned object is merged into the rendering context, with explicit context values always winning.
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { registerContextProcessor } = require('miki-template');
-
-
-
-    registerContextProcessor((context) => {
-
-      return {
-
-        siteName: 'My App',
-
-        currentYear: new Date().getFullYear()
-
-      };
-
-    });
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { registerContextProcessor } from 'miki-template';
-
-
-
-    registerContextProcessor((context) => {
-
-      return {
-
-        siteName: 'My App',
-
-        currentYear: new Date().getFullYear()
-
-      };
-
-    });
-
-    ```
-
-
-
-### Signature
-
-
-
-```typescript
-
-type ContextProcessor = (context: Context) => Record<string, any> | null
-
-```
-
-
-
-- Receives the `Context` object, allowing inspection of existing values via `context.get('key')`.
-
-- Must return a plain object. Returning `null` or `undefined` is treated as `{}`.
-
-- Must be synchronous — no async/await or Promises.
-
-
-
-## clearContextProcessors
-
-
-
-Clear all registered context processors. Useful in tests or when re-configuring.
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const { clearContextProcessors } = require('miki-template');
-
-
-
-    clearContextProcessors();
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { clearContextProcessors } from 'miki-template';
-
-
-
-    clearContextProcessors();
-
-    ```
-
-
-
-## Precedence Rules
-
-
-
-1. **Context processors run first** — their key/value pairs are added to the context.
-
-2. **Your explicit context is applied last** — explicit values always override processor values.
-
-
-
-```javascript
-
-// Processor sets: { siteName: 'My App', theme: 'dark' }
-
-// You render with: { theme: 'light' }
-
-// Result: { siteName: 'My App', theme: 'light' }
-
-```
-
-
-
-## Next Steps
-
-
-
-- [Context Processors Guide](../guide/context-processors.md)
-
-- [API Reference](../index.md)
-