miki-template 1.3.3 → 1.3.7

package/src/types.d.ts

@@ -1,107 +1,107 @@
-/**
- * TypeScript definitions for miki-template
- * Generated manually to match the actual runtime API.
- */
-
-declare namespace miki {
-  /**
-   * A compiled template instance returned by `compile()`.
-   */
-  interface CompiledTemplate {
-    /** Synchronously render the template. */
-    render(context?: TemplateContext): string;
-    /** Asynchronously render the template (awaits Promise helpers). */
-    asyncRender(context?: TemplateContext): Promise<string>;
-    /** Render a single named block. */
-    renderBlock(blockName: string, context?: TemplateContext): string;
-    /** Render a defined `{% partialdef %}` by name. */
-    renderPartial(partialName: string, context?: TemplateContext): string;
-  }
-
-  /** Context object passed to render functions. */
-  interface TemplateContext {
-    [key: string]: any;
-  }
-
-  /** Options for `compile()` and `render()`. */
-  interface CompileOptions {
-    /** Directories to search for `extends`/`include` templates. */
-    views?: string | string[];
-    /** Prefix for the `{% static %}` tag. */
-    staticUrl?: string;
-    /** Custom URL resolver for `{% url %}` tag. */
-    urlHelper?: (routeName: string, ...args: any[]) => string;
-  }
-
-  /** A custom filter function. */
-  type FilterFunction = (value: any, arg?: any) => any;
-
-  /** A custom tag parser function. */
-  type TagParserFunction = (tagContent: string, parser: any) => ASTNode;
-
-  /** A custom helper function (block tag). */
-  type HelperFunction = (content: string, context: any) => string | Promise<string>;
-
-  /** A context processor. */
-  type ContextProcessor = (context: TemplateContext) => TemplateContext | void;
-
-  /** An AST node with a `render(context)` method. */
-  interface ASTNode {
-    render(context: any): string | Promise<string>;
-  }
-
-  /**
-   * SafeString — a string marker that bypasses HTML auto-escaping.
-   */
-  class SafeString {
-    constructor(value: string);
-    toString(): string;
-  }
-}
-
-declare module "miki-template" {
-  export = miki;
-  export as namespace miki;
-
-  /** Compile a template string into a reusable renderable object. */
-  export function compile(templateStr: string, options?: miki.CompileOptions): miki.CompiledTemplate;
-
-  /** One-off template render. */
-  export function render(templateStr: string, context?: miki.TemplateContext, options?: miki.CompileOptions): string;
-
-  /** Async one-off render (supports async helpers). */
-  export function asyncRender(templateStr: string, context?: miki.TemplateContext, options?: miki.CompileOptions): Promise<string>;
-
-  /** Express view engine adapter. */
-  export function __express(filePath: string, options: miki.TemplateContext, callback: (err: Error | null, html?: string) => void): void;
-
-  /** Async Express view engine adapter (Express 5+). */
-  export function __expressAsync(filePath: string, options: miki.TemplateContext): Promise<string>;
-
-  /** Clear the in-memory compiled template cache. */
-  export function clearCache(): void;
-
-  /** Register a custom tag parser. */
-  export function registerTag(name: string, parserFn: miki.TagParserFunction): void;
-
-  /** Register a custom filter. */
-  export function registerFilter(name: string, filterFn: miki.FilterFunction): void;
-
-  /** Register a custom block helper. */
-  export function registerHelper(name: string, fn: miki.HelperFunction): void;
-
-  /** Register a context processor. */
-  export function registerContextProcessor(fn: miki.ContextProcessor): void;
-
-  /** Mark a value as HTML-safe (bypasses auto-escaping). */
-  export function markSafe(value: any): miki.SafeString;
-
-  /** Check if a value is a SafeString. */
-  export function isSafe(value: any): boolean;
-
-  /** Escape HTML special characters. */
-  export function escapeHtml(str: string): string;
-
-  /** SafeString class for marking values as safe. */
-  export const SafeString: typeof miki.SafeString;
-}
+/**
+ * TypeScript definitions for miki-template
+ * Generated manually to match the actual runtime API.
+ */
+
+declare namespace miki {
+  /**
+   * A compiled template instance returned by `compile()`.
+   */
+  interface CompiledTemplate {
+    /** Synchronously render the template. */
+    render(context?: TemplateContext): string;
+    /** Asynchronously render the template (awaits Promise helpers). */
+    asyncRender(context?: TemplateContext): Promise<string>;
+    /** Render a single named block. */
+    renderBlock(blockName: string, context?: TemplateContext): string;
+    /** Render a defined `{% partialdef %}` by name. */
+    renderPartial(partialName: string, context?: TemplateContext): string;
+  }
+
+  /** Context object passed to render functions. */
+  interface TemplateContext {
+    [key: string]: any;
+  }
+
+  /** Options for `compile()` and `render()`. */
+  interface CompileOptions {
+    /** Directories to search for `extends`/`include` templates. */
+    views?: string | string[];
+    /** Prefix for the `{% static %}` tag. */
+    staticUrl?: string;
+    /** Custom URL resolver for `{% url %}` tag. */
+    urlHelper?: (routeName: string, ...args: any[]) => string;
+  }
+
+  /** A custom filter function. */
+  type FilterFunction = (value: any, arg?: any) => any;
+
+  /** A custom tag parser function. */
+  type TagParserFunction = (tagContent: string, parser: any) => ASTNode;
+
+  /** A custom helper function (block tag). */
+  type HelperFunction = (content: string, context: any) => string | Promise<string>;
+
+  /** A context processor. */
+  type ContextProcessor = (context: TemplateContext) => TemplateContext | void;
+
+  /** An AST node with a `render(context)` method. */
+  interface ASTNode {
+    render(context: any): string | Promise<string>;
+  }
+
+  /**
+   * SafeString — a string marker that bypasses HTML auto-escaping.
+   */
+  class SafeString {
+    constructor(value: string);
+    toString(): string;
+  }
+}
+
+declare module "miki-template" {
+  export = miki;
+  export as namespace miki;
+
+  /** Compile a template string into a reusable renderable object. */
+  export function compile(templateStr: string, options?: miki.CompileOptions): miki.CompiledTemplate;
+
+  /** One-off template render. */
+  export function render(templateStr: string, context?: miki.TemplateContext, options?: miki.CompileOptions): string;
+
+  /** Async one-off render (supports async helpers). */
+  export function asyncRender(templateStr: string, context?: miki.TemplateContext, options?: miki.CompileOptions): Promise<string>;
+
+  /** Express view engine adapter. */
+  export function __express(filePath: string, options: miki.TemplateContext, callback: (err: Error | null, html?: string) => void): void;
+
+  /** Async Express view engine adapter (Express 5+). */
+  export function __expressAsync(filePath: string, options: miki.TemplateContext): Promise<string>;
+
+  /** Clear the in-memory compiled template cache. */
+  export function clearCache(): void;
+
+  /** Register a custom tag parser. */
+  export function registerTag(name: string, parserFn: miki.TagParserFunction): void;
+
+  /** Register a custom filter. */
+  export function registerFilter(name: string, filterFn: miki.FilterFunction): void;
+
+  /** Register a custom block helper. */
+  export function registerHelper(name: string, fn: miki.HelperFunction): void;
+
+  /** Register a context processor. */
+  export function registerContextProcessor(fn: miki.ContextProcessor): void;
+
+  /** Mark a value as HTML-safe (bypasses auto-escaping). */
+  export function markSafe(value: any): miki.SafeString;
+
+  /** Check if a value is a SafeString. */
+  export function isSafe(value: any): boolean;
+
+  /** Escape HTML special characters. */
+  export function escapeHtml(str: string): string;
+
+  /** SafeString class for marking values as safe. */
+  export const SafeString: typeof miki.SafeString;
+}

package/syntaxes/language-configuration.json

@@ -1,26 +1,26 @@
-{
-  "comments": {
-    "lineComment": "{#",
-    "blockComment": ["{#", "#}"]
-  },
-  "brackets": [
-    ["{", "}"],
-    ["[", "]"],
-    ["(", ")"]
-  ],
-  "autoClosingPairs": [
-    { "open": "{", "close": "}" },
-    { "open": "[", "close": "]" },
-    { "open": "(", "close": ")" },
-    { "open": "\"", "close": "\"", "notIn": ["string"] },
-    { "open": "'", "close": "'", "notIn": ["string", "comment"] }
-  ],
-  "surroundingPairs": [
-    { "open": "{", "close": "}" },
-    { "open": "[", "close": "]" },
-    { "open": "(", "close": ")" },
-    { "open": "\"", "close": "\"" },
-    { "open": "'", "close": "'" }
-  ],
-  "wordPattern": "[a-zA-Z_][a-zA-Z0-9_.]*"
-}
+{
+  "comments": {
+    "lineComment": "{#",
+    "blockComment": ["{#", "#}"]
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"", "notIn": ["string"] },
+    { "open": "'", "close": "'", "notIn": ["string", "comment"] }
+  ],
+  "surroundingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "wordPattern": "[a-zA-Z_][a-zA-Z0-9_.]*"
+}

package/syntaxes/miki-template.tmLanguage.json

@@ -1,146 +1,146 @@
-{
-  "scopeName": "text.html.miki",
-  "name": "miki-template",
-  "patterns": [
-    {
-      "include": "#comment"
-    },
-    {
-      "include": "#tag"
-    },
-    {
-      "include": "#variable"
-    },
-    {
-      "include": "#string"
-    }
-  ],
-  "repository": {
-    "comment": {
-      "name": "comment.block.miki",
-      "begin": "\\{#",
-      "end": "#\\}",
-      "beginCaptures": {
-        "0": { "name": "punctuation.definition.comment.begin.miki" }
-      },
-      "endCaptures": {
-        "0": { "name": "punctuation.definition.comment.end.miki" }
-      }
-    },
-    "tag": {
-      "name": "meta.tag.miki",
-      "begin": "\\{%",
-      "end": "%\\}",
-      "beginCaptures": {
-        "0": { "name": "punctuation.definition.tag.begin.miki" }
-      },
-      "endCaptures": {
-        "0": { "name": "punctuation.definition.tag.end.miki" }
-      },
-      "patterns": [
-        {
-          "name": "entity.name.tag.miki",
-          "match": "(?i)\\b(if|elif|else|endif|for|empty|endfor|with|endwith|cycle|comment|endcomment|verbatim|endverbatim|include|extends|block|endblock|partialdef|endpartialdef|partial|load|templatetag|trans|blocktrans|language|endlanguage|plural|widthratio|debug|endif|endfor|endwith|endblock|endcomment|endverbatim|endpartialdef|endblocktrans|endlanguage|endcache|endmarkdown)\\b"
-        },
-        {
-          "name": "string.quoted.double.miki",
-          "match": "\"[^\"]*\""
-        },
-        {
-          "name": "string.quoted.single.miki",
-          "match": "'[^']*'"
-        },
-        {
-          "name": "constant.numeric.miki",
-          "match": "\\b\\d+\\b"
-        },
-        {
-          "name": "keyword.operator.miki",
-          "match": "(?i)\\b(and|or|not|in|not in)\\b"
-        },
-        {
-          "name": "punctuation.separator.miki",
-          "match": "="
-        }
-      ]
-    },
-    "variable": {
-      "name": "variable.other.miki",
-      "begin": "\\{\\{",
-      "end": "\\}\\}",
-      "beginCaptures": {
-        "0": { "name": "punctuation.definition.variable.begin.miki" }
-      },
-      "endCaptures": {
-        "0": { "name": "punctuation.definition.variable.end.miki" }
-      },
-      "patterns": [
-        {
-          "name": "variable.other.miki",
-          "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
-        },
-        {
-          "include": "#filter"
-        },
-        {
-          "name": "string.quoted.double.miki",
-          "match": "\"[^\"]*\""
-        },
-        {
-          "name": "string.quoted.single.miki",
-          "match": "'[^']*'"
-        }
-      ]
-    },
-    "filter": {
-      "name": "meta.filter.miki",
-      "begin": "\\|",
-      "end": "(?=\\}|$)",
-      "beginCaptures": {
-        "0": { "name": "punctuation.separator.filter.miki" }
-      },
-      "patterns": [
-        {
-          "name": "support.function.miki",
-          "match": "[a-zA-Z_][a-zA-Z0-9_]*"
-        },
-        {
-          "begin": ":",
-          "beginCaptures": {
-            "0": { "name": "punctuation.separator.filter.argument.miki" }
-          },
-          "end": "(?=\\||\\}\\})",
-          "patterns": [
-            {
-              "name": "string.quoted.double.miki",
-              "match": "\"[^\"]*\""
-            },
-            {
-              "name": "string.quoted.single.miki",
-              "match": "'[^']*'"
-            },
-            {
-              "name": "constant.numeric.miki",
-              "match": "\\b\\d+\\b"
-            },
-            {
-              "name": "variable.other.miki",
-              "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
-            }
-          ]
-        }
-      ]
-    },
-    "string": {
-      "name": "string.quoted.double.miki",
-      "begin": "\"",
-      "end": "\"",
-      "beginCaptures": {
-        "0": { "name": "punctuation.definition.string.begin.miki" }
-      },
-      "endCaptures": {
-        "0": { "name": "punctuation.definition.string.end.miki" }
-      }
-    }
-  }
-}
+{
+  "scopeName": "text.html.miki",
+  "name": "miki-template",
+  "patterns": [
+    {
+      "include": "#comment"
+    },
+    {
+      "include": "#tag"
+    },
+    {
+      "include": "#variable"
+    },
+    {
+      "include": "#string"
+    }
+  ],
+  "repository": {
+    "comment": {
+      "name": "comment.block.miki",
+      "begin": "\\{#",
+      "end": "#\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.comment.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.comment.end.miki" }
+      }
+    },
+    "tag": {
+      "name": "meta.tag.miki",
+      "begin": "\\{%",
+      "end": "%\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.tag.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.tag.end.miki" }
+      },
+      "patterns": [
+        {
+          "name": "entity.name.tag.miki",
+          "match": "(?i)\\b(if|elif|else|endif|for|empty|endfor|with|endwith|cycle|comment|endcomment|verbatim|endverbatim|include|extends|block|endblock|partialdef|endpartialdef|partial|load|templatetag|trans|blocktrans|language|endlanguage|plural|widthratio|debug|endif|endfor|endwith|endblock|endcomment|endverbatim|endpartialdef|endblocktrans|endlanguage|endcache|endmarkdown)\\b"
+        },
+        {
+          "name": "string.quoted.double.miki",
+          "match": "\"[^\"]*\""
+        },
+        {
+          "name": "string.quoted.single.miki",
+          "match": "'[^']*'"
+        },
+        {
+          "name": "constant.numeric.miki",
+          "match": "\\b\\d+\\b"
+        },
+        {
+          "name": "keyword.operator.miki",
+          "match": "(?i)\\b(and|or|not|in|not in)\\b"
+        },
+        {
+          "name": "punctuation.separator.miki",
+          "match": "="
+        }
+      ]
+    },
+    "variable": {
+      "name": "variable.other.miki",
+      "begin": "\\{\\{",
+      "end": "\\}\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.variable.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.variable.end.miki" }
+      },
+      "patterns": [
+        {
+          "name": "variable.other.miki",
+          "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
+        },
+        {
+          "include": "#filter"
+        },
+        {
+          "name": "string.quoted.double.miki",
+          "match": "\"[^\"]*\""
+        },
+        {
+          "name": "string.quoted.single.miki",
+          "match": "'[^']*'"
+        }
+      ]
+    },
+    "filter": {
+      "name": "meta.filter.miki",
+      "begin": "\\|",
+      "end": "(?=\\}|$)",
+      "beginCaptures": {
+        "0": { "name": "punctuation.separator.filter.miki" }
+      },
+      "patterns": [
+        {
+          "name": "support.function.miki",
+          "match": "[a-zA-Z_][a-zA-Z0-9_]*"
+        },
+        {
+          "begin": ":",
+          "beginCaptures": {
+            "0": { "name": "punctuation.separator.filter.argument.miki" }
+          },
+          "end": "(?=\\||\\}\\})",
+          "patterns": [
+            {
+              "name": "string.quoted.double.miki",
+              "match": "\"[^\"]*\""
+            },
+            {
+              "name": "string.quoted.single.miki",
+              "match": "'[^']*'"
+            },
+            {
+              "name": "constant.numeric.miki",
+              "match": "\\b\\d+\\b"
+            },
+            {
+              "name": "variable.other.miki",
+              "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
+            }
+          ]
+        }
+      ]
+    },
+    "string": {
+      "name": "string.quoted.double.miki",
+      "begin": "\"",
+      "end": "\"",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.string.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.string.end.miki" }
+      }
+    }
+  }
+}

package/tests/asyncRender.test.js

@@ -1,17 +1,17 @@
-// tests/asyncRender.test.js
-const test = require('node:test');
-const { asyncRender, registerHelper } = require('../src');
-
-// Register a simple async helper that sleeps
-registerHelper('sleep', async (content) => {
-  const ms = parseInt(content, 10) || 0;
-  await new Promise(r => setTimeout(r, ms));
-  return `slept ${ms}ms`;
-});
-
-test('asyncRender with sleep helper', async () => {
-  const tmpl = `{% sleep %}30{% endsleep %}`;
-  const result = await asyncRender(tmpl, {});
-  const assert = require('node:assert');
-  assert.strictEqual(result, 'slept 30ms');
-});
+// tests/asyncRender.test.js
+const test = require('node:test');
+const { asyncRender, registerHelper } = require('../src');
+
+// Register a simple async helper that sleeps
+registerHelper('sleep', async (content) => {
+  const ms = parseInt(content, 10) || 0;
+  await new Promise(r => setTimeout(r, ms));
+  return `slept ${ms}ms`;
+});
+
+test('asyncRender with sleep helper', async () => {
+  const tmpl = `{% sleep %}30{% endsleep %}`;
+  const result = await asyncRender(tmpl, {});
+  const assert = require('node:assert');
+  assert.strictEqual(result, 'slept 30ms');
+});

package/tests/base.html

@@ -1,6 +1,6 @@
-<html>
-<body>
-  {% block header %}Default Header{% endblock %}
-  {% block content %}{% endblock %}
-</body>
-</html>
+<html>
+<body>
+  {% block header %}Default Header{% endblock %}
+  {% block content %}{% endblock %}
+</body>
+</html>

package/tests/child.html

@@ -1,3 +1,3 @@
-{% extends "base.html" %}
-{% block header %}Child Header ({{ block.super }}){% endblock %}
-{% block content %}Child Content{% endblock %}
+{% extends "base.html" %}
+{% block header %}Child Header ({{ block.super }}){% endblock %}
+{% block content %}Child Content{% endblock %}

package/tests/context_processors.test.js

@@ -1,13 +1,13 @@
-// Context Processors test using node:test
-const test = require('node:test');
-const assert = require('node:assert');
-const { registerContextProcessor, clearContextProcessors } = require('../src/context_processors');
-const { compile } = require('../src');
-
-test('Context processor injects variable', () => {
-  clearContextProcessors();
-  registerContextProcessor(() => ({ siteName: 'DemoSite' }));
-  const tmpl = '{{ siteName }}';
-  const rendered = compile(tmpl).render({});
-  assert.strictEqual(rendered, 'DemoSite');
-});
+// Context Processors test using node:test
+const test = require('node:test');
+const assert = require('node:assert');
+const { registerContextProcessor, clearContextProcessors } = require('../src/context_processors');
+const { compile } = require('../src');
+
+test('Context processor injects variable', () => {
+  clearContextProcessors();
+  registerContextProcessor(() => ({ siteName: 'DemoSite' }));
+  const tmpl = '{{ siteName }}';
+  const rendered = compile(tmpl).render({});
+  assert.strictEqual(rendered, 'DemoSite');
+});