miki-template 1.3.3 → 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 (101) hide show
  1. package/.github/release-notes/v1.3.1.md +55 -55
  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 -169
  8. package/CODE_OF_CONDUCT.md +14 -14
  9. package/CONTRIBUTING.md +27 -27
  10. package/README.md +342 -321
  11. package/ROADMAP.md +40 -40
  12. package/benchmarks/report.json +16 -16
  13. package/benchmarks/run.js +49 -49
  14. package/benchmarks/stress.mjs +647 -647
  15. package/benchmarks/templates/large.dtpl +7 -7
  16. package/benchmarks/templates/medium.dtpl +3 -3
  17. package/benchmarks/templates/small.dtpl +7 -7
  18. package/context/component.md +109 -109
  19. package/context/prd.md +131 -131
  20. package/context/project-structure.md +33 -33
  21. package/dir/base.html +22 -22
  22. package/dir/cmpnt.html +10 -10
  23. package/dir/footer.html +2 -2
  24. package/dir/home.html +80 -80
  25. package/dir/index.html +80 -0
  26. package/dir/navbar.html +8 -8
  27. package/docs/README.md +18 -18
  28. package/docs/advanced_usage.md +71 -71
  29. package/docs/api.md +119 -119
  30. package/docs/filters.md +708 -708
  31. package/docs/installation.md +106 -106
  32. package/docs/overview.md +57 -57
  33. package/docs/partialdef.md +70 -70
  34. package/docs/security.md +27 -27
  35. package/docs/tags.md +673 -673
  36. package/docs/usage.md +646 -646
  37. package/eslint.config.mjs +42 -42
  38. package/ex.mjs +32 -32
  39. package/miki-template-extension/.github/workflows/ci.yml +116 -116
  40. package/miki-template-extension/.vscodeignore +7 -7
  41. package/miki-template-extension/CHANGELOG.md +99 -99
  42. package/miki-template-extension/LICENSE +21 -21
  43. package/miki-template-extension/README.md +273 -273
  44. package/miki-template-extension/extension.js +1013 -1013
  45. package/miki-template-extension/icon.svg +10 -10
  46. package/miki-template-extension/package.json +280 -280
  47. package/miki-template-extension/snippets/miki-template.json +717 -717
  48. package/miki-template-extension/syntaxes/language-configuration.json +114 -114
  49. package/miki-template-extension/syntaxes/miki-template.tmLanguage.json +355 -355
  50. package/miki-template-extension/tests/grammar-tests.json +162 -162
  51. package/miki-template-extension/tests/run-grammar-tests.js +82 -82
  52. package/package.json +37 -34
  53. package/sample-app/package-lock.json +901 -0
  54. package/sample-app/package.json +9 -0
  55. package/sample-app/server.js +14 -0
  56. package/sample-app/views/index.html +1 -0
  57. package/scripts/build-vsix.js +129 -129
  58. package/scripts/build-vsix.ps1 +15 -15
  59. package/snippets/miki-template.json +177 -177
  60. package/src/asyncRender.js +20 -20
  61. package/src/cache.js +80 -80
  62. package/src/context.js +126 -126
  63. package/src/context_processors.js +48 -48
  64. package/src/esm.mjs +84 -84
  65. package/src/filters.js +975 -975
  66. package/src/i18n.js +171 -171
  67. package/src/index.js +974 -940
  68. package/src/lexer.js +114 -114
  69. package/src/libraries.js +371 -371
  70. package/src/parser.js +270 -270
  71. package/src/security.js +53 -53
  72. package/src/tags/control.js +719 -719
  73. package/src/tags/extra.js +154 -154
  74. package/src/tags/helpers.js +26 -26
  75. package/src/tags/i18n.js +256 -256
  76. package/src/tags/inheritance.js +335 -335
  77. package/src/tags/registry.js +18 -18
  78. package/src/tags/util.js +400 -400
  79. package/src/types.d.ts +107 -107
  80. package/syntaxes/language-configuration.json +26 -26
  81. package/syntaxes/miki-template.tmLanguage.json +146 -146
  82. package/tests/asyncRender.test.js +17 -17
  83. package/tests/base.html +6 -6
  84. package/tests/child.html +3 -3
  85. package/tests/context_processors.test.js +13 -13
  86. package/tests/esm.test.mjs +61 -61
  87. package/tests/filters.test.js +254 -254
  88. package/tests/include_security.test.js +9 -9
  89. package/tests/integration/README.md +32 -32
  90. package/tests/integration/features.test.cjs +1681 -1681
  91. package/tests/integration/features.test.mjs +1697 -1697
  92. package/tests/integration/templates/base.miki +6 -6
  93. package/tests/integration/templates/child.miki +6 -6
  94. package/tests/integration/templates/index.html +17 -17
  95. package/tests/lexer.test.js +45 -45
  96. package/tests/parser.test.js +57 -57
  97. package/tests/partial.html +1 -1
  98. package/tests/partialdef.test.js +79 -79
  99. package/tests/production_checks.js +57 -57
  100. package/tests/security.test.js +28 -28
  101. package/tests/tags.test.js +233 -233
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).
@@ -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();