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
@@ -1,177 +1,177 @@
1
- {
2
- "miki-template": {
3
- "if": {
4
- "prefix": "if",
5
- "body": [
6
- "{% if ${1:condition} %}",
7
- " ${2:content}",
8
- "{% endif %}"
9
- ],
10
- "description": "If block"
11
- },
12
- "ifelse": {
13
- "prefix": "ifelse",
14
- "body": [
15
- "{% if ${1:condition} %}",
16
- " ${2:content}",
17
- "{% else %}",
18
- " ${3:fallback}",
19
- "{% endif %}"
20
- ],
21
- "description": "If/else block"
22
- },
23
- "for": {
24
- "prefix": "for",
25
- "body": [
26
- "{% for ${1:item} in ${2:items} %}",
27
- " ${3:{{ ${1} }}}",
28
- "{% empty %}",
29
- " ${4:No items}",
30
- "{% endfor %}"
31
- ],
32
- "description": "For loop"
33
- },
34
- "block": {
35
- "prefix": "block",
36
- "body": [
37
- "{% block ${1:name} %}",
38
- " ${2:content}",
39
- "{% endblock %}"
40
- ],
41
- "description": "Block definition"
42
- },
43
- "extends": {
44
- "prefix": "extends",
45
- "body": "{% extends \"${1:base.html}\" %}",
46
- "description": "Extends parent template"
47
- },
48
- "include": {
49
- "prefix": "include",
50
- "body": "{% include \"${1:header.html}\" %}",
51
- "description": "Include template"
52
- },
53
- "with": {
54
- "prefix": "with",
55
- "body": [
56
- "{% with ${1:var} as ${2:alias} %}",
57
- " ${3:{{ ${2} }}}",
58
- "{% endwith %}"
59
- ],
60
- "description": "With block"
61
- },
62
- "cycle": {
63
- "prefix": "cycle",
64
- "body": "{% cycle '${1:odd}' '${2:even}' %}",
65
- "description": "Cycle tag"
66
- },
67
- "trans": {
68
- "prefix": "trans",
69
- "body": "{% trans \"${1:Hello, World!}\" %}",
70
- "description": "Translate string"
71
- },
72
- "blocktrans": {
73
- "prefix": "blocktrans",
74
- "body": [
75
- "{% blocktrans with ${1:name}=${2:user.name} %}",
76
- " ${3:Hello {{ ${1} }}}",
77
- "{% endblocktrans %}"
78
- ],
79
- "description": "Translate block"
80
- },
81
- "language": {
82
- "prefix": "language",
83
- "body": [
84
- "{% language \"${1:fr}\" %}",
85
- " ${2}",
86
- "{% endlanguage %}"
87
- ],
88
- "description": "Switch language"
89
- },
90
- "partialdef": {
91
- "prefix": "partialdef",
92
- "body": [
93
- "{% partialdef ${1:name} %}",
94
- " ${2}",
95
- "{% endpartialdef %}"
96
- ],
97
- "description": "Define partial"
98
- },
99
- "partial": {
100
- "prefix": "partial",
101
- "body": "{% partial ${1:name} %}",
102
- "description": "Render partial"
103
- },
104
- "csrf": {
105
- "prefix": "csrf",
106
- "body": "{% csrf_token %}",
107
- "description": "CSRF token input"
108
- },
109
- "csp": {
110
- "prefix": "csp",
111
- "body": "<script {% csp_nonce_attr %}></script>",
112
- "description": "CSP nonce attribute"
113
- },
114
- "static": {
115
- "prefix": "static",
116
- "body": "{% static \"${1:css/app.css}\" %}",
117
- "description": "Static file URL"
118
- },
119
- "url": {
120
- "prefix": "url",
121
- "body": "{% url \"${1:route_name}\" ${2:args} %}",
122
- "description": "URL for named route"
123
- },
124
- "widthratio": {
125
- "prefix": "widthratio",
126
- "body": "{% widthratio ${1:value} ${2:max} ${3:max_width} %}",
127
- "description": "Proportional width"
128
- },
129
- "debug": {
130
- "prefix": "debug",
131
- "body": "{% debug %}",
132
- "description": "Dump template context"
133
- },
134
- "load": {
135
- "prefix": "load",
136
- "body": "{% load ${1:i18n} %}",
137
- "description": "Load tag library"
138
- },
139
- "comment": {
140
- "prefix": "comment",
141
- "body": [
142
- "{#",
143
- " ${1:comment}",
144
- "#}"
145
- ],
146
- "description": "Comment block"
147
- },
148
- "verbatim": {
149
- "prefix": "verbatim",
150
- "body": [
151
- "{% verbatim %}",
152
- " ${1}",
153
- "{% endverbatim %}"
154
- ],
155
- "description": "Verbatim block"
156
- },
157
- "regroup": {
158
- "prefix": "regroup",
159
- "body": "{% for ${1:group} in ${2:items}|regroup:\"${3:category}\" %}{{ ${1}.grouper }}{% endfor %}",
160
- "description": "Regroup by attribute"
161
- },
162
- "firstof": {
163
- "prefix": "firstof",
164
- "body": "{% firstof ${1:var1} ${2:var2} \"${3:fallback}\" %}",
165
- "description": "First truthy value"
166
- },
167
- "filter_block": {
168
- "prefix": "filter",
169
- "body": [
170
- "{% filter ${1:lower} %}",
171
- " ${2}",
172
- "{% endfilter %}"
173
- ],
174
- "description": "Filter block"
175
- }
176
- }
177
- }
1
+ {
2
+ "miki-template": {
3
+ "if": {
4
+ "prefix": "if",
5
+ "body": [
6
+ "{% if ${1:condition} %}",
7
+ " ${2:content}",
8
+ "{% endif %}"
9
+ ],
10
+ "description": "If block"
11
+ },
12
+ "ifelse": {
13
+ "prefix": "ifelse",
14
+ "body": [
15
+ "{% if ${1:condition} %}",
16
+ " ${2:content}",
17
+ "{% else %}",
18
+ " ${3:fallback}",
19
+ "{% endif %}"
20
+ ],
21
+ "description": "If/else block"
22
+ },
23
+ "for": {
24
+ "prefix": "for",
25
+ "body": [
26
+ "{% for ${1:item} in ${2:items} %}",
27
+ " ${3:{{ ${1} }}}",
28
+ "{% empty %}",
29
+ " ${4:No items}",
30
+ "{% endfor %}"
31
+ ],
32
+ "description": "For loop"
33
+ },
34
+ "block": {
35
+ "prefix": "block",
36
+ "body": [
37
+ "{% block ${1:name} %}",
38
+ " ${2:content}",
39
+ "{% endblock %}"
40
+ ],
41
+ "description": "Block definition"
42
+ },
43
+ "extends": {
44
+ "prefix": "extends",
45
+ "body": "{% extends \"${1:base.html}\" %}",
46
+ "description": "Extends parent template"
47
+ },
48
+ "include": {
49
+ "prefix": "include",
50
+ "body": "{% include \"${1:header.html}\" %}",
51
+ "description": "Include template"
52
+ },
53
+ "with": {
54
+ "prefix": "with",
55
+ "body": [
56
+ "{% with ${1:var} as ${2:alias} %}",
57
+ " ${3:{{ ${2} }}}",
58
+ "{% endwith %}"
59
+ ],
60
+ "description": "With block"
61
+ },
62
+ "cycle": {
63
+ "prefix": "cycle",
64
+ "body": "{% cycle '${1:odd}' '${2:even}' %}",
65
+ "description": "Cycle tag"
66
+ },
67
+ "trans": {
68
+ "prefix": "trans",
69
+ "body": "{% trans \"${1:Hello, World!}\" %}",
70
+ "description": "Translate string"
71
+ },
72
+ "blocktrans": {
73
+ "prefix": "blocktrans",
74
+ "body": [
75
+ "{% blocktrans with ${1:name}=${2:user.name} %}",
76
+ " ${3:Hello {{ ${1} }}}",
77
+ "{% endblocktrans %}"
78
+ ],
79
+ "description": "Translate block"
80
+ },
81
+ "language": {
82
+ "prefix": "language",
83
+ "body": [
84
+ "{% language \"${1:fr}\" %}",
85
+ " ${2}",
86
+ "{% endlanguage %}"
87
+ ],
88
+ "description": "Switch language"
89
+ },
90
+ "partialdef": {
91
+ "prefix": "partialdef",
92
+ "body": [
93
+ "{% partialdef ${1:name} %}",
94
+ " ${2}",
95
+ "{% endpartialdef %}"
96
+ ],
97
+ "description": "Define partial"
98
+ },
99
+ "partial": {
100
+ "prefix": "partial",
101
+ "body": "{% partial ${1:name} %}",
102
+ "description": "Render partial"
103
+ },
104
+ "csrf": {
105
+ "prefix": "csrf",
106
+ "body": "{% csrf_token %}",
107
+ "description": "CSRF token input"
108
+ },
109
+ "csp": {
110
+ "prefix": "csp",
111
+ "body": "<script {% csp_nonce_attr %}></script>",
112
+ "description": "CSP nonce attribute"
113
+ },
114
+ "static": {
115
+ "prefix": "static",
116
+ "body": "{% static \"${1:css/app.css}\" %}",
117
+ "description": "Static file URL"
118
+ },
119
+ "url": {
120
+ "prefix": "url",
121
+ "body": "{% url \"${1:route_name}\" ${2:args} %}",
122
+ "description": "URL for named route"
123
+ },
124
+ "widthratio": {
125
+ "prefix": "widthratio",
126
+ "body": "{% widthratio ${1:value} ${2:max} ${3:max_width} %}",
127
+ "description": "Proportional width"
128
+ },
129
+ "debug": {
130
+ "prefix": "debug",
131
+ "body": "{% debug %}",
132
+ "description": "Dump template context"
133
+ },
134
+ "load": {
135
+ "prefix": "load",
136
+ "body": "{% load ${1:i18n} %}",
137
+ "description": "Load tag library"
138
+ },
139
+ "comment": {
140
+ "prefix": "comment",
141
+ "body": [
142
+ "{#",
143
+ " ${1:comment}",
144
+ "#}"
145
+ ],
146
+ "description": "Comment block"
147
+ },
148
+ "verbatim": {
149
+ "prefix": "verbatim",
150
+ "body": [
151
+ "{% verbatim %}",
152
+ " ${1}",
153
+ "{% endverbatim %}"
154
+ ],
155
+ "description": "Verbatim block"
156
+ },
157
+ "regroup": {
158
+ "prefix": "regroup",
159
+ "body": "{% for ${1:group} in ${2:items}|regroup:\"${3:category}\" %}{{ ${1}.grouper }}{% endfor %}",
160
+ "description": "Regroup by attribute"
161
+ },
162
+ "firstof": {
163
+ "prefix": "firstof",
164
+ "body": "{% firstof ${1:var1} ${2:var2} \"${3:fallback}\" %}",
165
+ "description": "First truthy value"
166
+ },
167
+ "filter_block": {
168
+ "prefix": "filter",
169
+ "body": [
170
+ "{% filter ${1:lower} %}",
171
+ " ${2}",
172
+ "{% endfilter %}"
173
+ ],
174
+ "description": "Filter block"
175
+ }
176
+ }
177
+ }
@@ -1,21 +1,21 @@
1
- // Async rendering utilities
2
-
3
- /**
4
- * Async version of renderAST that awaits any Promise returned by node.render.
5
- * Handles async nodes anywhere in the AST (inside conditionals, loops, etc.)
6
- */
7
- async function asyncRenderAST(nodes, context) {
8
- // Helper to render a single node, awaiting if needed, and recursively handling children
9
- const renderNode = async (node) => {
10
- const result = node.render(context);
11
- return result instanceof Promise ? await result : result;
12
- };
13
-
14
- const parts = [];
15
- for (const node of nodes) {
16
- parts.push(await renderNode(node));
17
- }
18
- return parts.join('');
19
- }
20
-
1
+ // Async rendering utilities
2
+
3
+ /**
4
+ * Async version of renderAST that awaits any Promise returned by node.render.
5
+ * Handles async nodes anywhere in the AST (inside conditionals, loops, etc.)
6
+ */
7
+ async function asyncRenderAST(nodes, context) {
8
+ // Helper to render a single node, awaiting if needed, and recursively handling children
9
+ const renderNode = async (node) => {
10
+ const result = node.render(context);
11
+ return result instanceof Promise ? await result : result;
12
+ };
13
+
14
+ const parts = [];
15
+ for (const node of nodes) {
16
+ parts.push(await renderNode(node));
17
+ }
18
+ return parts.join('');
19
+ }
20
+
21
21
  module.exports = { asyncRenderAST };
package/src/cache.js CHANGED
@@ -1,80 +1,80 @@
1
- // Simple AST cache module
2
-
3
- /**
4
- * In‑memory LRU cache for compiled templates.
5
- * For demo purposes we use a plain Map limited to 100 entries.
6
- */
7
- const CACHE_LIMIT = 100;
8
- const cache = new Map();
9
-
10
- /**
11
- * Parent-source cache shared across renders. Populated by
12
- * renderAST/renderASTAsync in src/index.js so that `{% extends %}`
13
- * doesn't re-read the parent file from disk on every render.
14
- */
15
- const parentSourceCache = new Map();
16
- const PARENT_SOURCE_LIMIT = 64;
17
-
18
- function getParentSource(key, loader) {
19
- if (parentSourceCache.has(key)) {
20
- const v = parentSourceCache.get(key);
21
- parentSourceCache.delete(key);
22
- parentSourceCache.set(key, v);
23
- return v;
24
- }
25
- const v = loader();
26
- if (v != null) {
27
- parentSourceCache.set(key, v);
28
- if (parentSourceCache.size > PARENT_SOURCE_LIMIT) {
29
- const firstKey = parentSourceCache.keys().next().value;
30
- parentSourceCache.delete(firstKey);
31
- }
32
- }
33
- return v;
34
- }
35
-
36
- function hasParentSource(key) {
37
- return parentSourceCache.has(key);
38
- }
39
-
40
- /**
41
- * Retrieve a compiled template from cache or compile it and store.
42
- * @param {string} templateStr – template source
43
- * @param {object} compileOptions – options passed to compile()
44
- * @param {function} compileFn – the original compile function from src/index.js
45
- * @returns {object} compiled template object
46
- */
47
- function getCompiled(templateStr, compileOptions, compileFn) {
48
- // Build a cache key that ignores non-serializable option values
49
- // (e.g. functions like urlHelper, custom callbacks) — those don't
50
- // affect template compilation, only render behavior.
51
- const serializable = {};
52
- for (const [k, v] of Object.entries(compileOptions || {})) {
53
- if (typeof v === 'function' || typeof v === 'undefined') continue;
54
- serializable[k] = v;
55
- }
56
- const key = JSON.stringify({ templateStr, compileOptions: serializable });
57
- if (cache.has(key)) {
58
- // Move to end to mark as recently used
59
- const value = cache.get(key);
60
- cache.delete(key);
61
- cache.set(key, value);
62
- return value;
63
- }
64
- const compiled = compileFn(templateStr, compileOptions);
65
- cache.set(key, compiled);
66
- // Trim if we exceed limit
67
- if (cache.size > CACHE_LIMIT) {
68
- const firstKey = cache.keys().next().value;
69
- cache.delete(firstKey);
70
- }
71
- return compiled;
72
- }
73
-
74
- /** Clear the cache – useful for tests */
75
- function clearCache() {
76
- cache.clear();
77
- parentSourceCache.clear();
78
- }
79
-
80
- module.exports = { getCompiled, clearCache, getParentSource, hasParentSource };
1
+ // Simple AST cache module
2
+
3
+ /**
4
+ * In‑memory LRU cache for compiled templates.
5
+ * For demo purposes we use a plain Map limited to 100 entries.
6
+ */
7
+ const CACHE_LIMIT = 100;
8
+ const cache = new Map();
9
+
10
+ /**
11
+ * Parent-source cache shared across renders. Populated by
12
+ * renderAST/renderASTAsync in src/index.js so that `{% extends %}`
13
+ * doesn't re-read the parent file from disk on every render.
14
+ */
15
+ const parentSourceCache = new Map();
16
+ const PARENT_SOURCE_LIMIT = 64;
17
+
18
+ function getParentSource(key, loader) {
19
+ if (parentSourceCache.has(key)) {
20
+ const v = parentSourceCache.get(key);
21
+ parentSourceCache.delete(key);
22
+ parentSourceCache.set(key, v);
23
+ return v;
24
+ }
25
+ const v = loader();
26
+ if (v != null) {
27
+ parentSourceCache.set(key, v);
28
+ if (parentSourceCache.size > PARENT_SOURCE_LIMIT) {
29
+ const firstKey = parentSourceCache.keys().next().value;
30
+ parentSourceCache.delete(firstKey);
31
+ }
32
+ }
33
+ return v;
34
+ }
35
+
36
+ function hasParentSource(key) {
37
+ return parentSourceCache.has(key);
38
+ }
39
+
40
+ /**
41
+ * Retrieve a compiled template from cache or compile it and store.
42
+ * @param {string} templateStr – template source
43
+ * @param {object} compileOptions – options passed to compile()
44
+ * @param {function} compileFn – the original compile function from src/index.js
45
+ * @returns {object} compiled template object
46
+ */
47
+ function getCompiled(templateStr, compileOptions, compileFn) {
48
+ // Build a cache key that ignores non-serializable option values
49
+ // (e.g. functions like urlHelper, custom callbacks) — those don't
50
+ // affect template compilation, only render behavior.
51
+ const serializable = {};
52
+ for (const [k, v] of Object.entries(compileOptions || {})) {
53
+ if (typeof v === 'function' || typeof v === 'undefined') continue;
54
+ serializable[k] = v;
55
+ }
56
+ const key = JSON.stringify({ templateStr, compileOptions: serializable });
57
+ if (cache.has(key)) {
58
+ // Move to end to mark as recently used
59
+ const value = cache.get(key);
60
+ cache.delete(key);
61
+ cache.set(key, value);
62
+ return value;
63
+ }
64
+ const compiled = compileFn(templateStr, compileOptions);
65
+ cache.set(key, compiled);
66
+ // Trim if we exceed limit
67
+ if (cache.size > CACHE_LIMIT) {
68
+ const firstKey = cache.keys().next().value;
69
+ cache.delete(firstKey);
70
+ }
71
+ return compiled;
72
+ }
73
+
74
+ /** Clear the cache – useful for tests */
75
+ function clearCache() {
76
+ cache.clear();
77
+ parentSourceCache.clear();
78
+ }
79
+
80
+ module.exports = { getCompiled, clearCache, getParentSource, hasParentSource };