miki-template 2.3.0 → 2.3.2

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 (160) hide show
  1. package/README.md +17 -5
  2. package/package.json +45 -1
  3. package/.eslintrc.json +0 -16
  4. package/.github/release-notes/v1.3.1.md +0 -55
  5. package/.github/release-notes/v1.3.3.md +0 -77
  6. package/.github/release-notes/v1.3.7.md +0 -20
  7. package/.github/workflows/ci.yml +0 -42
  8. package/.github/workflows/docs.yml +0 -107
  9. package/.github/workflows/release.yml +0 -107
  10. package/AGENT.md +0 -71
  11. package/API_REFERENCE.md +0 -341
  12. package/CHANGELOG.md +0 -173
  13. package/CODE_OF_CONDUCT.md +0 -14
  14. package/CONTRIBUTING.md +0 -27
  15. package/ROADMAP.md +0 -40
  16. package/assets/banner.png +0 -0
  17. package/assets/logo.png +0 -0
  18. package/benchmarks/ejs-results.json +0 -17
  19. package/benchmarks/ejs.js +0 -38
  20. package/benchmarks/handlebars-results.json +0 -17
  21. package/benchmarks/handlebars.js +0 -45
  22. package/benchmarks/miki-results.json +0 -17
  23. package/benchmarks/miki.js +0 -39
  24. package/benchmarks/pug-results.json +0 -17
  25. package/benchmarks/pug.js +0 -38
  26. package/benchmarks/report.json +0 -17
  27. package/benchmarks/run.js +0 -81
  28. package/benchmarks/stress.mjs +0 -647
  29. package/benchmarks/templates/large.dtpl +0 -7
  30. package/benchmarks/templates/medium.dtpl +0 -3
  31. package/benchmarks/templates/small.dtpl +0 -7
  32. package/context/component.md +0 -109
  33. package/context/prd.md +0 -131
  34. package/context/project-structure.md +0 -33
  35. package/dir/base.html +0 -23
  36. package/dir/cmpnt.html +0 -11
  37. package/dir/footer.html +0 -3
  38. package/dir/home.html +0 -80
  39. package/dir/index.html +0 -80
  40. package/dir/navbar.html +0 -9
  41. package/docs/api/async-render.md +0 -170
  42. package/docs/api/cache.md +0 -174
  43. package/docs/api/compile.md +0 -256
  44. package/docs/api/context-processors.md +0 -154
  45. package/docs/api/filters.md +0 -437
  46. package/docs/api/finder.md +0 -188
  47. package/docs/api/helpers.md +0 -106
  48. package/docs/api/i18n.md +0 -314
  49. package/docs/api/index.md +0 -108
  50. package/docs/api/libraries.md +0 -414
  51. package/docs/api/render-partial.md +0 -162
  52. package/docs/api/render.md +0 -184
  53. package/docs/api/security.md +0 -290
  54. package/docs/api/setup-express.md +0 -152
  55. package/docs/api/tags.md +0 -268
  56. package/docs/assets/banner.png +0 -0
  57. package/docs/assets/logo.png +0 -0
  58. package/docs/filter.md +0 -0
  59. package/docs/guide/advanced-usage.md +0 -794
  60. package/docs/guide/async-rendering.md +0 -616
  61. package/docs/guide/context-processors.md +0 -514
  62. package/docs/guide/custom-filters.md +0 -622
  63. package/docs/guide/custom-tags.md +0 -542
  64. package/docs/guide/filters.md +0 -1314
  65. package/docs/guide/getting-started.md +0 -204
  66. package/docs/guide/installation.md +0 -190
  67. package/docs/guide/partial-templates.md +0 -734
  68. package/docs/guide/quick-start.md +0 -444
  69. package/docs/guide/security.md +0 -690
  70. package/docs/guide/tags.md +0 -1566
  71. package/docs/guide/template-discovery.md +0 -340
  72. package/docs/guide/template-inheritance.md +0 -546
  73. package/docs/guide/what-is-miki-template.md +0 -28
  74. package/docs/guide/why-miki-template.md +0 -75
  75. package/docs/index.md +0 -86
  76. package/docs/integrations/elysia.md +0 -80
  77. package/docs/integrations/express.md +0 -219
  78. package/docs/integrations/fastify.md +0 -79
  79. package/docs/integrations/hono.md +0 -80
  80. package/docs/integrations/index.md +0 -68
  81. package/docs/integrations/koa.md +0 -90
  82. package/docs/integrations/nestjs.md +0 -80
  83. package/docs/integrations/tsed.md +0 -83
  84. package/docs/performance.md +0 -74
  85. package/eslint.config.mjs +0 -42
  86. package/ex.mjs +0 -36
  87. package/live-test/integrations/elysia-example.js +0 -16
  88. package/live-test/integrations/express-example.js +0 -24
  89. package/live-test/integrations/fastify-example.js +0 -20
  90. package/live-test/integrations/hono-example.js +0 -16
  91. package/live-test/integrations/koa-example.js +0 -30
  92. package/live-test/integrations/nestjs-example.js +0 -25
  93. package/live-test/integrations/smoke-test.js +0 -166
  94. package/live-test/integrations/tsed-example.js +0 -23
  95. package/live-test/package-lock.json +0 -1150
  96. package/live-test/package.json +0 -13
  97. package/live-test/packages/product/templates/product/detail.html +0 -7
  98. package/live-test/server.js +0 -38
  99. package/live-test/templates/app_templates/detail.html +0 -6
  100. package/live-test/views/base.html +0 -8
  101. package/live-test/views/child.html +0 -7
  102. package/live-test/views/home.html +0 -17
  103. package/live-test/views/index.html +0 -1
  104. package/miki-template-extension/.github/workflows/ci.yml +0 -116
  105. package/miki-template-extension/.vscodeignore +0 -7
  106. package/miki-template-extension/CHANGELOG.md +0 -99
  107. package/miki-template-extension/LICENSE +0 -21
  108. package/miki-template-extension/README.md +0 -273
  109. package/miki-template-extension/extension.js +0 -1013
  110. package/miki-template-extension/icon.png +0 -0
  111. package/miki-template-extension/icon.svg +0 -10
  112. package/miki-template-extension/miki-template-1.7.1.vsix +0 -0
  113. package/miki-template-extension/package.json +0 -280
  114. package/miki-template-extension/snippets/miki-template.json +0 -717
  115. package/miki-template-extension/syntaxes/language-configuration.json +0 -114
  116. package/miki-template-extension/syntaxes/miki-template.tmLanguage.json +0 -355
  117. package/miki-template-extension/tests/grammar-tests.json +0 -162
  118. package/miki-template-extension/tests/run-grammar-tests.js +0 -82
  119. package/mkdocs.yml +0 -195
  120. package/overrides/main.html +0 -26
  121. package/requirements-docs.txt +0 -2
  122. package/sample-app/package-lock.json +0 -901
  123. package/sample-app/package.json +0 -9
  124. package/sample-app/server.js +0 -14
  125. package/sample-app/views/index.html +0 -1
  126. package/scripts/build-vsix.js +0 -129
  127. package/scripts/build-vsix.ps1 +0 -15
  128. package/snippets/miki-template.json +0 -177
  129. package/src/asyncRender.js +0 -21
  130. package/src/types.d.ts +0 -107
  131. package/syntaxes/language-configuration.json +0 -26
  132. package/syntaxes/miki-template.tmLanguage.json +0 -146
  133. package/tests/asyncRender.test.js +0 -17
  134. package/tests/base.html +0 -6
  135. package/tests/child.html +0 -3
  136. package/tests/context_processors.test.js +0 -13
  137. package/tests/esm.test.mjs +0 -61
  138. package/tests/filters.test.js +0 -263
  139. package/tests/finder-appdirs.test.js +0 -19
  140. package/tests/finder.test.js +0 -17
  141. package/tests/fixtures/views/nested/index.html +0 -1
  142. package/tests/fixtures/views/partial.html +0 -1
  143. package/tests/fixtures/views/sub/deepfile.html +0 -1
  144. package/tests/fixtures/views-appdirs/product/site/detail.html +0 -1
  145. package/tests/include_security.test.js +0 -9
  146. package/tests/integration/README.md +0 -32
  147. package/tests/integration/features.test.cjs +0 -1681
  148. package/tests/integration/features.test.mjs +0 -1697
  149. package/tests/integration/finder.esm.test.mjs +0 -13
  150. package/tests/integration/partial-render.test.cjs +0 -13
  151. package/tests/integration/templates/base.miki +0 -6
  152. package/tests/integration/templates/child.miki +0 -6
  153. package/tests/integration/templates/index.html +0 -17
  154. package/tests/lexer.test.js +0 -45
  155. package/tests/parser.test.js +0 -57
  156. package/tests/partial.html +0 -1
  157. package/tests/partialdef.test.js +0 -79
  158. package/tests/production_checks.js +0 -57
  159. package/tests/security.test.js +0 -28
  160. package/tests/tags.test.js +0 -233
@@ -1,45 +0,0 @@
1
- const Handlebars = require('handlebars');
2
- const { performance } = require('perf_hooks');
3
-
4
- const SMALL = `{{#each items}}{{this}}:{{this.length}}\n{{/each}}`;
5
- const MEDIUM = `{{#each big_items}}{{#if (isEven this)}}Even: {{this}}\n{{else}}Odd: {{this}}\n{{/if}}{{/each}}`;
6
- const LARGE = `{{#each big_items}}{{#each ../small_items}}{{this}}:{{../this}} {{repeat "x" 10}}\n{{/each}}{{/each}}`;
7
-
8
- Handlebars.registerHelper('isEven', function(n) {
9
- return n % 2 === 0;
10
- });
11
- Handlebars.registerHelper('repeat', function(str, n) {
12
- return str.repeat(n);
13
- });
14
-
15
- const data = {
16
- items: ['alpha', 'beta', 'gamma', 'delta', 'epsilon'],
17
- big_items: Array.from({ length: 500 }, (_, i) => i),
18
- small_items: Array.from({ length: 5 }, (_, j) => j)
19
- };
20
-
21
- function bench(name, tpl, data, iterations = 5000) {
22
- const compiled = Handlebars.compile(tpl);
23
- for (let i = 0; i < 20; i++) compiled(data);
24
-
25
- const times = [];
26
- for (let i = 0; i < iterations; i++) {
27
- const t0 = performance.now();
28
- compiled(data);
29
- times.push(performance.now() - t0);
30
- }
31
- times.sort((a, b) => a - b);
32
- const median = times[Math.floor(times.length / 2)];
33
- const rps = Math.round(1000 / median);
34
- console.log(`${name}: ${median.toFixed(3)} ms/op (~${rps.toLocaleString()} rps)`);
35
- return { name, medianMs: median, rps };
36
- }
37
-
38
- const results = [];
39
- results.push(bench('handlebars:small', SMALL, data, 10000));
40
- results.push(bench('handlebars:medium', MEDIUM, data, 5000));
41
- results.push(bench('handlebars:large', LARGE, data, 1000));
42
-
43
- const outPath = require('path').join(__dirname, 'handlebars-results.json');
44
- require('fs').writeFileSync(outPath, JSON.stringify(results, null, 2));
45
- console.log(`\nResults saved to ${outPath}`);
@@ -1,17 +0,0 @@
1
- [
2
- {
3
- "name": "miki:small",
4
- "medianMs": 0.0009000000000014552,
5
- "rps": 1111111
6
- },
7
- {
8
- "name": "miki:medium",
9
- "medianMs": 0.009999999999990905,
10
- "rps": 100000
11
- },
12
- {
13
- "name": "miki:large",
14
- "medianMs": 0.30579999999997654,
15
- "rps": 3270
16
- }
17
- ]
@@ -1,39 +0,0 @@
1
- const miki = require('../src');
2
- const { performance } = require('perf_hooks');
3
-
4
- const SMALL = `{% for item in items %}{{ item|upper }}:{{ item|length }}\n{% endfor %}`;
5
- const MEDIUM = `{% for i in big_items %}{% if i % 2 == 0 %}Even: {{ i }}\n{% else %}Odd: {{ i }}\n{% endif %}{% endfor %}`;
6
- const LARGE = `{% for i in big_items %}{% for j in small_items %}{{ i }}:{{ j }} {{ x10|repeat:5 }}\n{% endfor %}{% endfor %}`;
7
-
8
- const data = {
9
- items: ['alpha', 'beta', 'gamma', 'delta', 'epsilon'],
10
- big_items: Array.from({ length: 500 }, (_, i) => i),
11
- small_items: Array.from({ length: 5 }, (_, j) => j),
12
- x10: 'x'
13
- };
14
-
15
- function bench(name, tpl, data, iterations = 5000) {
16
- const compiled = miki.compile(tpl);
17
- for (let i = 0; i < 20; i++) compiled.render(data);
18
-
19
- const times = [];
20
- for (let i = 0; i < iterations; i++) {
21
- const t0 = performance.now();
22
- compiled.render(data);
23
- times.push(performance.now() - t0);
24
- }
25
- times.sort((a, b) => a - b);
26
- const median = times[Math.floor(times.length / 2)];
27
- const rps = Math.round(1000 / median);
28
- console.log(`${name}: ${median.toFixed(3)} ms/op (~${rps.toLocaleString()} rps)`);
29
- return { name, medianMs: median, rps };
30
- }
31
-
32
- const results = [];
33
- results.push(bench('miki:small', SMALL, data, 10000));
34
- results.push(bench('miki:medium', MEDIUM, data, 5000));
35
- results.push(bench('miki:large', LARGE, data, 1000));
36
-
37
- const outPath = require('path').join(__dirname, 'miki-results.json');
38
- require('fs').writeFileSync(outPath, JSON.stringify(results, null, 2));
39
- console.log(`\nResults saved to ${outPath}`);
@@ -1,17 +0,0 @@
1
- [
2
- {
3
- "name": "pug:small",
4
- "medianMs": 0.0006000000000199179,
5
- "rps": 1666667
6
- },
7
- {
8
- "name": "pug:medium",
9
- "medianMs": 0.019200000000012096,
10
- "rps": 52083
11
- },
12
- {
13
- "name": "pug:large",
14
- "medianMs": 0.3955999999999449,
15
- "rps": 2528
16
- }
17
- ]
package/benchmarks/pug.js DELETED
@@ -1,38 +0,0 @@
1
- const pug = require('pug');
2
- const { performance } = require('perf_hooks');
3
-
4
- const SMALL = `each item in items\n = item.toUpperCase() + ':' + item.length\n`;
5
- const MEDIUM = `each i in big_items\n if i % 2 === 0\n | Even: #{i}\n else\n | Odd: #{i}\n`;
6
- const LARGE = `each i in big_items\n each j in small_items\n | #{i}:#{j} #{'x'.repeat(10)}\n`;
7
-
8
- const data = {
9
- items: ['alpha', 'beta', 'gamma', 'delta', 'epsilon'],
10
- big_items: Array.from({ length: 500 }, (_, i) => i),
11
- small_items: Array.from({ length: 5 }, (_, j) => j)
12
- };
13
-
14
- function bench(name, tpl, data, iterations = 5000) {
15
- const compiled = pug.compile(tpl);
16
- for (let i = 0; i < 20; i++) compiled(data);
17
-
18
- const times = [];
19
- for (let i = 0; i < iterations; i++) {
20
- const t0 = performance.now();
21
- compiled(data);
22
- times.push(performance.now() - t0);
23
- }
24
- times.sort((a, b) => a - b);
25
- const median = times[Math.floor(times.length / 2)];
26
- const rps = Math.round(1000 / median);
27
- console.log(`${name}: ${median.toFixed(3)} ms/op (~${rps.toLocaleString()} rps)`);
28
- return { name, medianMs: median, rps };
29
- }
30
-
31
- const results = [];
32
- results.push(bench('pug:small', SMALL, data, 10000));
33
- results.push(bench('pug:medium', MEDIUM, data, 5000));
34
- results.push(bench('pug:large', LARGE, data, 1000));
35
-
36
- const outPath = require('path').join(__dirname, 'pug-results.json');
37
- require('fs').writeFileSync(outPath, JSON.stringify(results, null, 2));
38
- console.log(`\nResults saved to ${outPath}`);
@@ -1,17 +0,0 @@
1
- [
2
- {
3
- "name": "small",
4
- "syncAvgMs": "0.01",
5
- "asyncAvgMs": "0.03"
6
- },
7
- {
8
- "name": "medium",
9
- "syncAvgMs": "0.01",
10
- "asyncAvgMs": "0.01"
11
- },
12
- {
13
- "name": "large",
14
- "syncAvgMs": "0.01",
15
- "asyncAvgMs": "0.01"
16
- }
17
- ]
package/benchmarks/run.js DELETED
@@ -1,81 +0,0 @@
1
- const { execSync } = require('child_process');
2
- const fs = require('fs');
3
- const path = require('path');
4
-
5
- const ENGINES = ['miki', 'pug', 'ejs', 'handlebars'];
6
- const RESULTS_DIR = __dirname;
7
-
8
- function runBench(name) {
9
- const file = path.join(RESULTS_DIR, `${name}.js`);
10
- if (!fs.existsSync(file)) {
11
- console.log(`Skipping ${name} (file not found)`);
12
- return null;
13
- }
14
- console.log(`\n--- Running ${name} benchmark ---`);
15
- const out = execSync(`node "${file}"`, { encoding: 'utf8', stdio: 'pipe' });
16
- console.log(out);
17
- const resultFile = path.join(RESULTS_DIR, `${name}-results.json`);
18
- if (fs.existsSync(resultFile)) {
19
- return JSON.parse(fs.readFileSync(resultFile, 'utf8'));
20
- }
21
- return null;
22
- }
23
-
24
- function printComparison(allResults) {
25
- console.log('\n========================================');
26
- console.log(' BENCHMARK COMPARISON (lower is better)');
27
- console.log('========================================\n');
28
-
29
- const categories = ['small', 'medium', 'large'];
30
- for (const cat of categories) {
31
- console.log(`-- ${cat.toUpperCase()} --`);
32
- const rows = [];
33
- for (const [engine, results] of Object.entries(allResults)) {
34
- const r = results.find(x => x.name === `${engine}:${cat}`);
35
- if (r) rows.push({ engine, rps: r.rps, ms: r.medianMs });
36
- }
37
- rows.sort((a, b) => b.rps - a.rps);
38
- const bestRps = rows[0]?.rps || 1;
39
- for (const row of rows) {
40
- const pct = ((bestRps / row.rps) * 100).toFixed(0);
41
- const marker = row.engine === 'miki' ? '★' : ' ';
42
- console.log(` ${marker}${row.engine.padEnd(12)} ${row.ms.toFixed(3).padStart(8)} ms ${row.rps.toString().padStart(8)} rps (${pct}%)`);
43
- }
44
- console.log('');
45
- }
46
- }
47
-
48
- function main() {
49
- const allResults = {};
50
- for (const engine of ENGINES) {
51
- const results = runBench(engine);
52
- if (results) allResults[engine] = results;
53
- }
54
-
55
- if (Object.keys(allResults).length === 0) {
56
- console.log('No benchmark results collected.');
57
- process.exit(1);
58
- }
59
-
60
- printComparison(allResults);
61
-
62
- const mikiResults = allResults['miki'] || [];
63
- const mikiAvgRps = mikiResults.reduce((a, r) => a + r.rps, 0) / mikiResults.length;
64
- const mikiLarge = mikiResults.find(r => r.name === 'miki:large');
65
- const othersSlowOnLarge = Object.entries(allResults)
66
- .filter(([engine]) => engine !== 'miki')
67
- .every(([, results]) => {
68
- const large = results.find(r => r.name === `${Object.keys(allResults).find(k => allResults[k] === results)}:large`);
69
- return !large || (mikiLarge && mikiLarge.rps >= large.rps);
70
- });
71
-
72
- if (othersSlowOnLarge) {
73
- console.log('★ miki-template dominates on large/real-world workloads.\n');
74
- } else if (mikiAvgRps >= 100000) {
75
- console.log('★ miki-template delivers strong performance across workloads.\n');
76
- } else {
77
- console.log('Note: miki-template performance may vary by workload.\n');
78
- }
79
- }
80
-
81
- main();