miki-template 1.3.3 → 1.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/.eslintrc.json +16 -0
  2. package/.github/release-notes/v1.3.1.md +55 -55
  3. package/.github/release-notes/v1.3.3.md +77 -0
  4. package/.github/workflows/ci.yml +38 -54
  5. package/.github/workflows/release.yml +106 -0
  6. package/AGENT.md +71 -71
  7. package/API_REFERENCE.md +314 -314
  8. package/CHANGELOG.md +173 -169
  9. package/CODE_OF_CONDUCT.md +14 -14
  10. package/CONTRIBUTING.md +27 -27
  11. package/README.md +342 -321
  12. package/ROADMAP.md +40 -40
  13. package/benchmarks/report.json +16 -16
  14. package/benchmarks/run.js +49 -49
  15. package/benchmarks/stress.mjs +647 -647
  16. package/benchmarks/templates/large.dtpl +7 -7
  17. package/benchmarks/templates/medium.dtpl +3 -3
  18. package/benchmarks/templates/small.dtpl +7 -7
  19. package/context/component.md +109 -109
  20. package/context/prd.md +131 -131
  21. package/context/project-structure.md +33 -33
  22. package/dir/base.html +22 -22
  23. package/dir/cmpnt.html +10 -10
  24. package/dir/footer.html +2 -2
  25. package/dir/home.html +80 -80
  26. package/dir/index.html +80 -0
  27. package/dir/navbar.html +8 -8
  28. package/docs/README.md +18 -18
  29. package/docs/advanced_usage.md +71 -71
  30. package/docs/api.md +119 -119
  31. package/docs/filters.md +708 -708
  32. package/docs/installation.md +106 -106
  33. package/docs/overview.md +79 -57
  34. package/docs/partialdef.md +70 -70
  35. package/docs/security.md +27 -27
  36. package/docs/tags.md +673 -673
  37. package/docs/usage.md +646 -646
  38. package/eslint.config.mjs +42 -42
  39. package/ex.mjs +34 -32
  40. package/live-test/package-lock.json +915 -0
  41. package/live-test/package.json +9 -0
  42. package/live-test/server.js +14 -0
  43. package/live-test/views/base.html +8 -0
  44. package/live-test/views/child.html +7 -0
  45. package/live-test/views/index.html +1 -0
  46. package/miki-template-extension/.github/workflows/ci.yml +116 -116
  47. package/miki-template-extension/.vscodeignore +7 -7
  48. package/miki-template-extension/CHANGELOG.md +99 -99
  49. package/miki-template-extension/LICENSE +21 -21
  50. package/miki-template-extension/README.md +273 -273
  51. package/miki-template-extension/extension.js +1013 -1013
  52. package/miki-template-extension/icon.svg +10 -10
  53. package/miki-template-extension/package.json +280 -280
  54. package/miki-template-extension/snippets/miki-template.json +717 -717
  55. package/miki-template-extension/syntaxes/language-configuration.json +114 -114
  56. package/miki-template-extension/syntaxes/miki-template.tmLanguage.json +355 -355
  57. package/miki-template-extension/tests/grammar-tests.json +162 -162
  58. package/miki-template-extension/tests/run-grammar-tests.js +82 -82
  59. package/package.json +40 -34
  60. package/sample-app/package-lock.json +901 -0
  61. package/sample-app/package.json +9 -0
  62. package/sample-app/server.js +14 -0
  63. package/sample-app/views/index.html +1 -0
  64. package/scripts/build-vsix.js +129 -129
  65. package/scripts/build-vsix.ps1 +15 -15
  66. package/snippets/miki-template.json +177 -177
  67. package/src/asyncRender.js +20 -20
  68. package/src/cache.js +80 -80
  69. package/src/context.js +126 -126
  70. package/src/context_processors.js +48 -48
  71. package/src/esm.mjs +89 -84
  72. package/src/filters.js +975 -975
  73. package/src/i18n.js +171 -171
  74. package/src/index.js +1112 -940
  75. package/src/lexer.js +114 -114
  76. package/src/libraries.js +371 -371
  77. package/src/parser.js +270 -270
  78. package/src/security.js +53 -53
  79. package/src/tags/control.js +719 -719
  80. package/src/tags/extra.js +154 -154
  81. package/src/tags/helpers.js +26 -26
  82. package/src/tags/i18n.js +256 -256
  83. package/src/tags/inheritance.js +335 -335
  84. package/src/tags/registry.js +18 -18
  85. package/src/tags/util.js +400 -400
  86. package/src/types.d.ts +107 -107
  87. package/syntaxes/language-configuration.json +26 -26
  88. package/syntaxes/miki-template.tmLanguage.json +146 -146
  89. package/tests/asyncRender.test.js +17 -17
  90. package/tests/base.html +6 -6
  91. package/tests/child.html +3 -3
  92. package/tests/context_processors.test.js +13 -13
  93. package/tests/esm.test.mjs +61 -61
  94. package/tests/filters.test.js +254 -254
  95. package/tests/finder-appdirs.test.js +19 -0
  96. package/tests/finder.test.js +17 -0
  97. package/tests/fixtures/views/nested/index.html +1 -0
  98. package/tests/fixtures/views/partial.html +1 -0
  99. package/tests/fixtures/views/sub/deepfile.html +1 -0
  100. package/tests/fixtures/views-appdirs/product/site/detail.html +1 -0
  101. package/tests/include_security.test.js +9 -9
  102. package/tests/integration/README.md +32 -32
  103. package/tests/integration/features.test.cjs +1681 -1681
  104. package/tests/integration/features.test.mjs +1697 -1697
  105. package/tests/integration/finder.esm.test.mjs +13 -0
  106. package/tests/integration/templates/base.miki +6 -6
  107. package/tests/integration/templates/child.miki +6 -6
  108. package/tests/integration/templates/index.html +17 -17
  109. package/tests/lexer.test.js +45 -45
  110. package/tests/parser.test.js +57 -57
  111. package/tests/partial.html +1 -1
  112. package/tests/partialdef.test.js +79 -79
  113. package/tests/production_checks.js +57 -57
  114. package/tests/security.test.js +28 -28
  115. package/tests/tags.test.js +233 -233
package/dir/home.html CHANGED
@@ -1,80 +1,80 @@
1
- {% extends 'base.html' %}
2
-
3
- {% block title %}
4
- {{ siteName|default:'Home page Here'|title }} | {{ block.super }}
5
- {% endblock %}
6
-
7
- {% block content %}
8
- {% partialdef card inline %}
9
- <div class="card">
10
- <h3>{{ title|default:'No title' }}</h3>
11
- <p>{{ description|default:'{% lorem 20 %}'|upper }}</p>
12
- </div>
13
- {% endpartialdef %}
14
-
15
- {% partial card with title='Hello' description='World' %}
16
-
17
- {% with a=5 %}
18
- <marquee behavior="" direction="">
19
- <span>some new stuff with with tag : {{ a|add:5 }}</span>
20
- </marquee>
21
- {% endwith %}
22
-
23
- {{ name }}
24
- {{ login.name }}
25
- {{ login.email }}
26
- <h1>Users table goes below</h1>
27
- <table border="3">
28
- <th>name</th>
29
- <th>email</th>
30
- <th>action</th>
31
-
32
- {% for user in users %}
33
- <tr>
34
- <td>{{ user.name|title }}</td>
35
- <td>{{ user.email }}</td>
36
- <td>
37
- <a href="">Delete user</a>
38
- </td>
39
- </tr>
40
- {% endfor %}
41
-
42
- </table>
43
- <h1>Data list</h1>
44
- <h2>data list of data</h2>
45
- {% for obj in data %}
46
- {% partialdef mike inline %}
47
-
48
- <li>{{ obj.name }}</li>
49
- <li>{{ forloop.counter }}</li>
50
- <li> {{ obj.email }}</li>
51
- {% endpartialdef %}
52
- {% endfor %}
53
-
54
- <h2>users list of data</h2>
55
- <ul style="background-color: aqua;color: blueviolet; list-style-type:upper-roman;">
56
-
57
- {% for obj in users %}
58
- {% partial mike %}
59
- {% endfor %}
60
- </ul>
61
-
62
- <h3>form with crsf</h3>
63
-
64
- <form action="">
65
- {% csrf_token %}
66
- <input type="text" name="" id="" title="some text"/>
67
- </form>
68
- <h3>included content here</h3>
69
- {% include 'cmpnt.html#me' %}
70
-
71
- {{"2324"|filesizeformat}}
72
- {{"224"|filesizeformat}}
73
- {{ "123456789"|filesizeformat }}
74
- {{ "1234567890"|filesizeformat }}
75
- {{ "1234567890123"|filesizeformat }}
76
- {{ "1234567890123456"|filesizeformat }}
77
- {{ "1234567890123456789"|filesizeformat }}
78
-
79
-
80
- {% endblock %}
1
+ {% extends 'base.html' %}
2
+
3
+ {% block title %}
4
+ {{ siteName|default:'Home page Here'|title }} | {{ block.super }}
5
+ {% endblock %}
6
+
7
+ {% block content %}
8
+ {% partialdef card inline %}
9
+ <div class="card">
10
+ <h3>{{ title|default:'No title' }}</h3>
11
+ <p>{{ description|default:'{% lorem 20 %}'|upper }}</p>
12
+ </div>
13
+ {% endpartialdef %}
14
+
15
+ {% partial card with title='Hello' description='World' %}
16
+
17
+ {% with a=5 %}
18
+ <marquee behavior="" direction="">
19
+ <span>some new stuff with with tag : {{ a|add:5 }}</span>
20
+ </marquee>
21
+ {% endwith %}
22
+
23
+ {{ name }}
24
+ {{ login.name }}
25
+ {{ login.email }}
26
+ <h1>Users table goes below</h1>
27
+ <table border="3">
28
+ <th>name</th>
29
+ <th>email</th>
30
+ <th>action</th>
31
+
32
+ {% for user in users %}
33
+ <tr>
34
+ <td>{{ user.name|title }}</td>
35
+ <td>{{ user.email }}</td>
36
+ <td>
37
+ <a href="">Delete user</a>
38
+ </td>
39
+ </tr>
40
+ {% endfor %}
41
+
42
+ </table>
43
+ <h1>Data list</h1>
44
+ <h2>data list of data</h2>
45
+ {% for obj in data %}
46
+ {% partialdef mike inline %}
47
+
48
+ <li>{{ obj.name }}</li>
49
+ <li>{{ forloop.counter }}</li>
50
+ <li> {{ obj.email }}</li>
51
+ {% endpartialdef %}
52
+ {% endfor %}
53
+
54
+ <h2>users list of data</h2>
55
+ <ul style="background-color: aqua;color: blueviolet; list-style-type:upper-roman;">
56
+
57
+ {% for obj in users %}
58
+ {% partial mike %}
59
+ {% endfor %}
60
+ </ul>
61
+
62
+ <h3>form with crsf</h3>
63
+
64
+ <form action="">
65
+ {% csrf_token %}
66
+ <input type="text" name="" id="" title="some text"/>
67
+ </form>
68
+ <h3>included content here</h3>
69
+ {% include 'cmpnt.html#me' %}
70
+
71
+ {{"2324"|filesizeformat}}
72
+ {{"224"|filesizeformat}}
73
+ {{ "123456789"|filesizeformat }}
74
+ {{ "1234567890"|filesizeformat }}
75
+ {{ "1234567890123"|filesizeformat }}
76
+ {{ "1234567890123456"|filesizeformat }}
77
+ {{ "1234567890123456789"|filesizeformat }}
78
+
79
+
80
+ {% endblock %}
package/dir/index.html ADDED
@@ -0,0 +1,80 @@
1
+ {% extends 'base.html' %}
2
+
3
+ {% block title %}
4
+ {{ siteName|default:'Home page Here'|title }} | {{ block.super }}
5
+ {% endblock %}
6
+
7
+ {% block content %}
8
+ {% partialdef card inline %}
9
+ <div class="card">
10
+ <h3>{{ title|default:'No title' }}</h3>
11
+ <p>{{ description|default:'{% lorem 20 %}'|upper }}</p>
12
+ </div>
13
+ {% endpartialdef %}
14
+
15
+ {% partial card with title='Hello' description='World' %}
16
+
17
+ {% with a=5 %}
18
+ <marquee behavior="" direction="">
19
+ <span>some new stuff with with tag : {{ a|add:5 }}</span>
20
+ </marquee>
21
+ {% endwith %}
22
+
23
+ {{ name }}
24
+ {{ login.name }}
25
+ {{ login.email }}
26
+ <h1>Users table goes below</h1>
27
+ <table border="3">
28
+ <th>name</th>
29
+ <th>email</th>
30
+ <th>action</th>
31
+
32
+ {% for user in users %}
33
+ <tr>
34
+ <td>{{ user.name|title }}</td>
35
+ <td>{{ user.email }}</td>
36
+ <td>
37
+ <a href="">Delete user</a>
38
+ </td>
39
+ </tr>
40
+ {% endfor %}
41
+
42
+ </table>
43
+ <h1>Data list</h1>
44
+ <h2>data list of data</h2>
45
+ {% for obj in data %}
46
+ {% partialdef mike inline %}
47
+
48
+ <li>{{ obj.name }}</li>
49
+ <li>{{ forloop.counter }}</li>
50
+ <li> {{ obj.email }}</li>
51
+ {% endpartialdef %}
52
+ {% endfor %}
53
+
54
+ <h2>users list of data</h2>
55
+ <ul style="background-color: aqua;color: blueviolet; list-style-type:upper-roman;">
56
+
57
+ {% for obj in users %}
58
+ {% partial mike %}
59
+ {% endfor %}
60
+ </ul>
61
+
62
+ <h3>form with crsf</h3>
63
+
64
+ <form action="">
65
+ {% csrf_token %}
66
+ <input type="text" name="" id="" title="some text"/>
67
+ </form>
68
+ <h3>included content here</h3>
69
+ {% include 'cmpnt.html#me' %}
70
+
71
+ {{"2324"|filesizeformat}}
72
+ {{"224"|filesizeformat}}
73
+ {{ "123456789"|filesizeformat }}
74
+ {{ "1234567890"|filesizeformat }}
75
+ {{ "1234567890123"|filesizeformat }}
76
+ {{ "1234567890123456"|filesizeformat }}
77
+ {{ "1234567890123456789"|filesizeformat }}
78
+
79
+
80
+ {% endblock %}
package/dir/navbar.html CHANGED
@@ -1,9 +1,9 @@
1
- <header>
2
- <div class="brand">
3
- <img src="/path/to/logo.png" alt="Logo" width="40px">
4
- </div>
5
- <nav>
6
- <a href="/">Home</a>
7
-
8
- </nav>
1
+ <header>
2
+ <div class="brand">
3
+ <img src="/path/to/logo.png" alt="Logo" width="40px">
4
+ </div>
5
+ <nav>
6
+ <a href="/">Home</a>
7
+
8
+ </nav>
9
9
  </header>
package/docs/README.md CHANGED
@@ -1,18 +1,18 @@
1
- # Documentation Index
2
-
3
- Welcome to the **miki-template** documentation hub. Below is a quick navigation guide to all docs.
4
-
5
- | Document | Description |
6
- |---|---|
7
- | [overview.md](overview.md) | High‑level project overview and repository layout |
8
- | [installation.md](installation.md) | How to install the package and prerequisites |
9
- | [usage.md](usage.md) | Basic API usage, rendering, compilation, and block rendering |
10
- | [tags.md](tags.md) | Reference for every built‑in tag (`if`, `for`, `partialdef`, etc.) |
11
- | [filters.md](filters.md) | Comprehensive list of built‑in filters with examples |
12
- | [partialdef.md](partialdef.md) | Detailed guide for the `partialdef` feature (including inline, nesting, API) |
13
- | [security.md](security.md) | Security considerations (auto‑escaping, CSP, CSRF) |
14
- | [api.md](api.md) | Low‑level API surface – `compile`, `renderPartial`, `registerTag`, etc. |
15
- | [contributing.md](contributing.md) | Guidelines for contributing, pull‑request flow, and code style |
16
- | [roadmap.md](roadmap.md) | Future milestones and release schedule |
17
-
18
- All files are located under `c:/Users/Coder Miki/Desktop/miki-template/docs/`.
1
+ # Documentation Index
2
+
3
+ Welcome to the **miki-template** documentation hub. Below is a quick navigation guide to all docs.
4
+
5
+ | Document | Description |
6
+ |---|---|
7
+ | [overview.md](overview.md) | High‑level project overview and repository layout |
8
+ | [installation.md](installation.md) | How to install the package and prerequisites |
9
+ | [usage.md](usage.md) | Basic API usage, rendering, compilation, and block rendering |
10
+ | [tags.md](tags.md) | Reference for every built‑in tag (`if`, `for`, `partialdef`, etc.) |
11
+ | [filters.md](filters.md) | Comprehensive list of built‑in filters with examples |
12
+ | [partialdef.md](partialdef.md) | Detailed guide for the `partialdef` feature (including inline, nesting, API) |
13
+ | [security.md](security.md) | Security considerations (auto‑escaping, CSP, CSRF) |
14
+ | [api.md](api.md) | Low‑level API surface – `compile`, `renderPartial`, `registerTag`, etc. |
15
+ | [contributing.md](contributing.md) | Guidelines for contributing, pull‑request flow, and code style |
16
+ | [roadmap.md](roadmap.md) | Future milestones and release schedule |
17
+
18
+ All files are located under `c:/Users/Coder Miki/Desktop/miki-template/docs/`.
@@ -1,71 +1,71 @@
1
- # Advanced Usage
2
-
3
- This document showcases real‑world examples of the **miki‑template** engine.
4
-
5
- ## 1. Partial Definition & Inclusion
6
- ```django
7
- {% partialdef "header" %}
8
- <header>
9
- <h1>{{ site.title }}</h1>
10
- </header>
11
- {% endpartialdef %}
12
-
13
- {% include "header" %}
14
- ```
15
- *Result:* Renders a reusable header component.
16
-
17
- ---
18
- ## 2. Custom Tag Helper – Markdown
19
- ```js
20
- const { registerHelper } = require('./src/tags/helpers');
21
- const markdownIt = require('markdown-it')();
22
- registerHelper('markdown', (content) => markdownIt.render(content));
23
- ```
24
- ```django
25
- {% markdown %}
26
- # Hello World
27
- * Item 1
28
- * Item 2
29
- {% endmarkdown %}
30
- ```
31
- *Result:* Converts markdown to HTML on‑the‑fly.
32
-
33
- ---
34
- ## 3. Async Rendering with a Sleep Helper
35
- ```js
36
- registerHelper('sleep', async (content) => {
37
- await new Promise(r => setTimeout(r, 50));
38
- return `Awake after ${content}`;
39
- });
40
- ```
41
- ```django
42
- {% sleep %}50ms{% endsleep %}
43
- ```
44
- ```js
45
- const { asyncRender } = require('./src');
46
- asyncRender(template, {} ).then(console.log);
47
- ```
48
- *Result:* `Awake after 50ms`
49
-
50
- ---
51
- ## 4. Extended Date Formatting
52
- ```django
53
- {{ now|date_format:"yyyy-MM-dd HH:mm:ss" }}
54
- ```
55
- *Result:* `2026-08-29 13:48:07`
56
- ### Additional Date Filter Examples
57
-
58
- ```django
59
- {{ now|strftime:"PPpp" }} {# Full date-fns pattern #}
60
- {{ now|date:"Y-m-d H:i:s" }} {# Django style with seconds #}
61
- {{ now|time:"H:i:s" }} {# Time only #}
62
- ```
63
-
64
- *Result:* Example outputs will appear when rendered.
65
-
66
- ---
67
- ## 5. Performance Benchmark (see `benchmarks/run.js`)
68
- The benchmark renders three template sizes (small, medium, large) synchronously and asynchronously, reporting average render time and cache hit ratio.
69
-
70
- ---
71
- > **Tip:** All examples work with the default Express integration via `app.engine('dtpl', require('miki-template').__express);`
1
+ # Advanced Usage
2
+
3
+ This document showcases real‑world examples of the **miki‑template** engine.
4
+
5
+ ## 1. Partial Definition & Inclusion
6
+ ```django
7
+ {% partialdef "header" %}
8
+ <header>
9
+ <h1>{{ site.title }}</h1>
10
+ </header>
11
+ {% endpartialdef %}
12
+
13
+ {% include "header" %}
14
+ ```
15
+ *Result:* Renders a reusable header component.
16
+
17
+ ---
18
+ ## 2. Custom Tag Helper – Markdown
19
+ ```js
20
+ const { registerHelper } = require('./src/tags/helpers');
21
+ const markdownIt = require('markdown-it')();
22
+ registerHelper('markdown', (content) => markdownIt.render(content));
23
+ ```
24
+ ```django
25
+ {% markdown %}
26
+ # Hello World
27
+ * Item 1
28
+ * Item 2
29
+ {% endmarkdown %}
30
+ ```
31
+ *Result:* Converts markdown to HTML on‑the‑fly.
32
+
33
+ ---
34
+ ## 3. Async Rendering with a Sleep Helper
35
+ ```js
36
+ registerHelper('sleep', async (content) => {
37
+ await new Promise(r => setTimeout(r, 50));
38
+ return `Awake after ${content}`;
39
+ });
40
+ ```
41
+ ```django
42
+ {% sleep %}50ms{% endsleep %}
43
+ ```
44
+ ```js
45
+ const { asyncRender } = require('./src');
46
+ asyncRender(template, {} ).then(console.log);
47
+ ```
48
+ *Result:* `Awake after 50ms`
49
+
50
+ ---
51
+ ## 4. Extended Date Formatting
52
+ ```django
53
+ {{ now|date_format:"yyyy-MM-dd HH:mm:ss" }}
54
+ ```
55
+ *Result:* `2026-08-29 13:48:07`
56
+ ### Additional Date Filter Examples
57
+
58
+ ```django
59
+ {{ now|strftime:"PPpp" }} {# Full date-fns pattern #}
60
+ {{ now|date:"Y-m-d H:i:s" }} {# Django style with seconds #}
61
+ {{ now|time:"H:i:s" }} {# Time only #}
62
+ ```
63
+
64
+ *Result:* Example outputs will appear when rendered.
65
+
66
+ ---
67
+ ## 5. Performance Benchmark (see `benchmarks/run.js`)
68
+ The benchmark renders three template sizes (small, medium, large) synchronously and asynchronously, reporting average render time and cache hit ratio.
69
+
70
+ ---
71
+ > **Tip:** All examples work with the default Express integration via `app.engine('dtpl', require('miki-template').__express);`