miki-template 1.2.0 → 1.3.6

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 (105) hide show
  1. package/.github/release-notes/v1.3.1.md +55 -0
  2. package/.github/release-notes/v1.3.3.md +77 -0
  3. package/.github/workflows/ci.yml +38 -54
  4. package/.github/workflows/release.yml +106 -0
  5. package/AGENT.md +71 -71
  6. package/API_REFERENCE.md +314 -314
  7. package/CHANGELOG.md +173 -97
  8. package/CODE_OF_CONDUCT.md +14 -14
  9. package/CONTRIBUTING.md +27 -27
  10. package/README.md +342 -304
  11. package/ROADMAP.md +40 -40
  12. package/assets/banner.png +0 -0
  13. package/benchmarks/report.json +16 -16
  14. package/benchmarks/run.js +49 -49
  15. package/benchmarks/stress.mjs +647 -0
  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 +23 -0
  23. package/dir/cmpnt.html +11 -0
  24. package/dir/footer.html +3 -0
  25. package/dir/home.html +80 -0
  26. package/dir/index.html +80 -0
  27. package/dir/navbar.html +9 -0
  28. package/docs/README.md +18 -18
  29. package/docs/advanced_usage.md +71 -71
  30. package/docs/api.md +119 -102
  31. package/docs/filters.md +708 -540
  32. package/docs/installation.md +106 -106
  33. package/docs/overview.md +57 -57
  34. package/docs/partialdef.md +70 -41
  35. package/docs/security.md +27 -27
  36. package/docs/tags.md +673 -610
  37. package/docs/usage.md +646 -599
  38. package/eslint.config.mjs +42 -34
  39. package/ex.mjs +33 -0
  40. package/miki-template-extension/.github/workflows/ci.yml +116 -0
  41. package/miki-template-extension/.vscodeignore +7 -0
  42. package/miki-template-extension/CHANGELOG.md +99 -0
  43. package/miki-template-extension/LICENSE +21 -21
  44. package/miki-template-extension/README.md +273 -82
  45. package/miki-template-extension/extension.js +1013 -0
  46. package/miki-template-extension/icon.png +0 -0
  47. package/miki-template-extension/icon.svg +10 -10
  48. package/miki-template-extension/miki-template-1.7.1.vsix +0 -0
  49. package/miki-template-extension/package.json +280 -46
  50. package/miki-template-extension/snippets/miki-template.json +717 -177
  51. package/miki-template-extension/syntaxes/language-configuration.json +114 -26
  52. package/miki-template-extension/syntaxes/miki-template.tmLanguage.json +355 -146
  53. package/miki-template-extension/tests/grammar-tests.json +162 -0
  54. package/miki-template-extension/tests/run-grammar-tests.js +82 -0
  55. package/package.json +37 -31
  56. package/sample-app/package-lock.json +901 -0
  57. package/sample-app/package.json +9 -0
  58. package/sample-app/server.js +14 -0
  59. package/sample-app/views/index.html +1 -0
  60. package/scripts/build-vsix.js +129 -0
  61. package/scripts/build-vsix.ps1 +15 -0
  62. package/snippets/miki-template.json +177 -177
  63. package/src/asyncRender.js +20 -20
  64. package/src/cache.js +80 -41
  65. package/src/context.js +126 -122
  66. package/src/context_processors.js +48 -41
  67. package/src/esm.mjs +84 -72
  68. package/src/filters.js +975 -527
  69. package/src/i18n.js +171 -171
  70. package/src/index.js +974 -454
  71. package/src/lexer.js +114 -92
  72. package/src/libraries.js +371 -240
  73. package/src/parser.js +270 -250
  74. package/src/security.js +53 -51
  75. package/src/tags/control.js +719 -590
  76. package/src/tags/extra.js +154 -0
  77. package/src/tags/helpers.js +26 -26
  78. package/src/tags/i18n.js +256 -230
  79. package/src/tags/inheritance.js +335 -216
  80. package/src/tags/registry.js +18 -18
  81. package/src/tags/util.js +400 -322
  82. package/src/types.d.ts +107 -107
  83. package/syntaxes/language-configuration.json +26 -26
  84. package/syntaxes/miki-template.tmLanguage.json +146 -146
  85. package/tests/asyncRender.test.js +17 -17
  86. package/tests/base.html +6 -6
  87. package/tests/child.html +3 -3
  88. package/tests/context_processors.test.js +13 -13
  89. package/tests/esm.test.mjs +61 -26
  90. package/tests/filters.test.js +254 -99
  91. package/tests/include_security.test.js +9 -9
  92. package/tests/integration/README.md +32 -0
  93. package/tests/integration/features.test.cjs +1681 -0
  94. package/tests/integration/features.test.mjs +1697 -0
  95. package/tests/integration/templates/base.miki +6 -0
  96. package/tests/integration/templates/child.miki +6 -0
  97. package/tests/integration/templates/index.html +17 -0
  98. package/tests/lexer.test.js +45 -45
  99. package/tests/parser.test.js +57 -55
  100. package/tests/partial.html +1 -1
  101. package/tests/partialdef.test.js +79 -40
  102. package/tests/production_checks.js +57 -57
  103. package/tests/security.test.js +28 -28
  104. package/tests/tags.test.js +233 -203
  105. package/miki-template-1.2.0.vsix +0 -0
package/ROADMAP.md CHANGED
@@ -1,40 +1,40 @@
1
- # Project Roadmap - Django-Style Template Engine
2
-
3
- Our release and packaging timeline.
4
-
5
- ---
6
-
7
- ## 🏁 Phase 1 - Core Delivery (Day 1-2)
8
- - [x] High-performance tokenizing Lexer.
9
- - [x] AST parser mapping nested blocks.
10
- - [x] Context Stack Manager supporting dotted lookup and function calls.
11
- - [x] HTML Auto-escaping using `he` library and `SafeString` wrappers.
12
- - [x] Complete suite of built-in filters (25+ filters).
13
- - [x] Core control flow tags (`if`, `for`, `with`, `cycle`, `autoescape`, `comment`, `verbatim`).
14
- - [x] Dynamic inheritance (`extends`, `block`, `include` with parameter scope).
15
- - [x] Express layout adapter (`__express`).
16
- - [x] Complete test suite verification.
17
-
18
- ---
19
-
20
- ## 🚀 Phase 2 - Advanced Performance & Ecosystem (Next Month)
21
- - [x] **CI/CD Pipeline** – linting, testing, and automated npm publishing via GitHub Actions.
22
- - [x] **AST Caching** – cache compiled ASTs for static templates (implemented).
23
- - [x] **Custom Tag Helpers** – simplify registration of custom block tags (implemented via helpers).
24
- - [x] **Async Render Options** – support async filters/tags for DB lookups (implemented).
25
- - [x] **Extended Date Syntax** – integrate `date-fns` for full date formatting parity (implemented).
26
- - [x] **Advanced Usage Docs** – examples covering partialdef, block rendering, and API (added).
27
- - [x] **Performance Benchmarks** – baseline measurements and optimization guide (added).
28
-
29
- ---
30
-
31
- ## 📦 Phase 3 - Ecosystem & Tooling (Q4)
32
- - [ ] VS Code Extension: Syntax highlighting for `.dtpl` or `.html` Django templates.
33
- - [ ] Web Playground: An interactive sandbox to experiment with the engine.
34
- - [ ] CLI Compiler: Render templates from the command line.
35
-
36
- ---
37
-
38
- ## 📚 Documentation
39
- - [x] Comprehensive docs in `docs/` covering installation, usage, tags, filters, partialdef, security, and API.
40
- - [x] Advanced examples and performance guide (added).
1
+ # Project Roadmap - Django-Style Template Engine
2
+
3
+ Our release and packaging timeline.
4
+
5
+ ---
6
+
7
+ ## 🏁 Phase 1 - Core Delivery (Day 1-2)
8
+ - [x] High-performance tokenizing Lexer.
9
+ - [x] AST parser mapping nested blocks.
10
+ - [x] Context Stack Manager supporting dotted lookup and function calls.
11
+ - [x] HTML Auto-escaping using `he` library and `SafeString` wrappers.
12
+ - [x] Complete suite of built-in filters (25+ filters).
13
+ - [x] Core control flow tags (`if`, `for`, `with`, `cycle`, `autoescape`, `comment`, `verbatim`).
14
+ - [x] Dynamic inheritance (`extends`, `block`, `include` with parameter scope).
15
+ - [x] Express layout adapter (`__express`).
16
+ - [x] Complete test suite verification.
17
+
18
+ ---
19
+
20
+ ## 🚀 Phase 2 - Advanced Performance & Ecosystem (Next Month)
21
+ - [x] **CI/CD Pipeline** – linting, testing, and automated npm publishing via GitHub Actions.
22
+ - [x] **AST Caching** – cache compiled ASTs for static templates (implemented).
23
+ - [x] **Custom Tag Helpers** – simplify registration of custom block tags (implemented via helpers).
24
+ - [x] **Async Render Options** – support async filters/tags for DB lookups (implemented).
25
+ - [x] **Extended Date Syntax** – integrate `date-fns` for full date formatting parity (implemented).
26
+ - [x] **Advanced Usage Docs** – examples covering partialdef, block rendering, and API (added).
27
+ - [x] **Performance Benchmarks** – baseline measurements and optimization guide (added).
28
+
29
+ ---
30
+
31
+ ## 📦 Phase 3 - Ecosystem & Tooling (Q4)
32
+ - [ ] VS Code Extension: Syntax highlighting for `.dtpl` or `.html` Django templates.
33
+ - [ ] Web Playground: An interactive sandbox to experiment with the engine.
34
+ - [ ] CLI Compiler: Render templates from the command line.
35
+
36
+ ---
37
+
38
+ ## 📚 Documentation
39
+ - [x] Comprehensive docs in `docs/` covering installation, usage, tags, filters, partialdef, security, and API.
40
+ - [x] Advanced examples and performance guide (added).
Binary file
@@ -1,17 +1,17 @@
1
- [
2
- {
3
- "name": "small",
4
- "syncAvgMs": "0.04",
5
- "asyncAvgMs": "0.03"
6
- },
7
- {
8
- "name": "medium",
9
- "syncAvgMs": "0.00",
10
- "asyncAvgMs": "0.01"
11
- },
12
- {
13
- "name": "large",
14
- "syncAvgMs": "0.00",
15
- "asyncAvgMs": "0.01"
16
- }
1
+ [
2
+ {
3
+ "name": "small",
4
+ "syncAvgMs": "0.04",
5
+ "asyncAvgMs": "0.03"
6
+ },
7
+ {
8
+ "name": "medium",
9
+ "syncAvgMs": "0.00",
10
+ "asyncAvgMs": "0.01"
11
+ },
12
+ {
13
+ "name": "large",
14
+ "syncAvgMs": "0.00",
15
+ "asyncAvgMs": "0.01"
16
+ }
17
17
  ]
package/benchmarks/run.js CHANGED
@@ -1,49 +1,49 @@
1
- // benchmarks/run.js
2
- // Simple benchmark for sync vs async rendering
3
- const { compile, asyncRender } = require('../src');
4
- const fs = require('fs');
5
- const path = require('path');
6
- const { performance } = require('perf_hooks');
7
-
8
- function loadTemplate(name) {
9
- const filePath = path.join(__dirname, 'templates', `${name}.dtpl`);
10
- return fs.readFileSync(filePath, 'utf8');
11
- }
12
-
13
- function benchRender(name, iterations = 20) {
14
- const tmplStr = loadTemplate(name);
15
- const compiled = compile(tmplStr);
16
- // warm up cache
17
- compiled.render({});
18
- compiled.asyncRender({});
19
-
20
- const syncTimes = [];
21
- const asyncTimes = [];
22
- for (let i = 0; i < iterations; i++) {
23
- const t0 = performance.now();
24
- compiled.render({});
25
- syncTimes.push(performance.now() - t0);
26
-
27
- const t1 = performance.now();
28
- asyncRender(tmplStr, {});
29
- asyncTimes.push(performance.now() - t1);
30
- }
31
- const avg = arr => arr.reduce((a,b)=>a+b,0)/arr.length;
32
- return {
33
- name,
34
- syncAvgMs: avg(syncTimes).toFixed(2),
35
- asyncAvgMs: avg(asyncTimes).toFixed(2)
36
- };
37
- }
38
-
39
- function main() {
40
- const results = [];
41
- ['small','medium','large'].forEach(name => {
42
- results.push(benchRender(name));
43
- });
44
- console.log('Benchmark results:', results);
45
- const outPath = path.join(__dirname, 'report.json');
46
- fs.writeFileSync(outPath, JSON.stringify(results, null, 2));
47
- }
48
-
49
- main();
1
+ // benchmarks/run.js
2
+ // Simple benchmark for sync vs async rendering
3
+ const { compile, asyncRender } = require('../src');
4
+ const fs = require('fs');
5
+ const path = require('path');
6
+ const { performance } = require('perf_hooks');
7
+
8
+ function loadTemplate(name) {
9
+ const filePath = path.join(__dirname, 'templates', `${name}.dtpl`);
10
+ return fs.readFileSync(filePath, 'utf8');
11
+ }
12
+
13
+ function benchRender(name, iterations = 20) {
14
+ const tmplStr = loadTemplate(name);
15
+ const compiled = compile(tmplStr);
16
+ // warm up cache
17
+ compiled.render({});
18
+ compiled.asyncRender({});
19
+
20
+ const syncTimes = [];
21
+ const asyncTimes = [];
22
+ for (let i = 0; i < iterations; i++) {
23
+ const t0 = performance.now();
24
+ compiled.render({});
25
+ syncTimes.push(performance.now() - t0);
26
+
27
+ const t1 = performance.now();
28
+ asyncRender(tmplStr, {});
29
+ asyncTimes.push(performance.now() - t1);
30
+ }
31
+ const avg = arr => arr.reduce((a,b)=>a+b,0)/arr.length;
32
+ return {
33
+ name,
34
+ syncAvgMs: avg(syncTimes).toFixed(2),
35
+ asyncAvgMs: avg(asyncTimes).toFixed(2)
36
+ };
37
+ }
38
+
39
+ function main() {
40
+ const results = [];
41
+ ['small','medium','large'].forEach(name => {
42
+ results.push(benchRender(name));
43
+ });
44
+ console.log('Benchmark results:', results);
45
+ const outPath = path.join(__dirname, 'report.json');
46
+ fs.writeFileSync(outPath, JSON.stringify(results, null, 2));
47
+ }
48
+
49
+ main();