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.
- package/.github/release-notes/v1.3.1.md +55 -0
- package/.github/release-notes/v1.3.3.md +77 -0
- package/.github/workflows/ci.yml +38 -54
- package/.github/workflows/release.yml +106 -0
- package/AGENT.md +71 -71
- package/API_REFERENCE.md +314 -314
- package/CHANGELOG.md +173 -97
- package/CODE_OF_CONDUCT.md +14 -14
- package/CONTRIBUTING.md +27 -27
- package/README.md +342 -304
- package/ROADMAP.md +40 -40
- package/assets/banner.png +0 -0
- package/benchmarks/report.json +16 -16
- package/benchmarks/run.js +49 -49
- package/benchmarks/stress.mjs +647 -0
- package/benchmarks/templates/large.dtpl +7 -7
- package/benchmarks/templates/medium.dtpl +3 -3
- package/benchmarks/templates/small.dtpl +7 -7
- package/context/component.md +109 -109
- package/context/prd.md +131 -131
- package/context/project-structure.md +33 -33
- package/dir/base.html +23 -0
- package/dir/cmpnt.html +11 -0
- package/dir/footer.html +3 -0
- package/dir/home.html +80 -0
- package/dir/index.html +80 -0
- package/dir/navbar.html +9 -0
- package/docs/README.md +18 -18
- package/docs/advanced_usage.md +71 -71
- package/docs/api.md +119 -102
- package/docs/filters.md +708 -540
- package/docs/installation.md +106 -106
- package/docs/overview.md +57 -57
- package/docs/partialdef.md +70 -41
- package/docs/security.md +27 -27
- package/docs/tags.md +673 -610
- package/docs/usage.md +646 -599
- package/eslint.config.mjs +42 -34
- package/ex.mjs +33 -0
- package/miki-template-extension/.github/workflows/ci.yml +116 -0
- package/miki-template-extension/.vscodeignore +7 -0
- package/miki-template-extension/CHANGELOG.md +99 -0
- package/miki-template-extension/LICENSE +21 -21
- package/miki-template-extension/README.md +273 -82
- package/miki-template-extension/extension.js +1013 -0
- package/miki-template-extension/icon.png +0 -0
- package/miki-template-extension/icon.svg +10 -10
- package/miki-template-extension/miki-template-1.7.1.vsix +0 -0
- package/miki-template-extension/package.json +280 -46
- package/miki-template-extension/snippets/miki-template.json +717 -177
- package/miki-template-extension/syntaxes/language-configuration.json +114 -26
- package/miki-template-extension/syntaxes/miki-template.tmLanguage.json +355 -146
- package/miki-template-extension/tests/grammar-tests.json +162 -0
- package/miki-template-extension/tests/run-grammar-tests.js +82 -0
- package/package.json +37 -31
- package/sample-app/package-lock.json +901 -0
- package/sample-app/package.json +9 -0
- package/sample-app/server.js +14 -0
- package/sample-app/views/index.html +1 -0
- package/scripts/build-vsix.js +129 -0
- package/scripts/build-vsix.ps1 +15 -0
- package/snippets/miki-template.json +177 -177
- package/src/asyncRender.js +20 -20
- package/src/cache.js +80 -41
- package/src/context.js +126 -122
- package/src/context_processors.js +48 -41
- package/src/esm.mjs +84 -72
- package/src/filters.js +975 -527
- package/src/i18n.js +171 -171
- package/src/index.js +974 -454
- package/src/lexer.js +114 -92
- package/src/libraries.js +371 -240
- package/src/parser.js +270 -250
- package/src/security.js +53 -51
- package/src/tags/control.js +719 -590
- package/src/tags/extra.js +154 -0
- package/src/tags/helpers.js +26 -26
- package/src/tags/i18n.js +256 -230
- package/src/tags/inheritance.js +335 -216
- package/src/tags/registry.js +18 -18
- package/src/tags/util.js +400 -322
- package/src/types.d.ts +107 -107
- package/syntaxes/language-configuration.json +26 -26
- package/syntaxes/miki-template.tmLanguage.json +146 -146
- package/tests/asyncRender.test.js +17 -17
- package/tests/base.html +6 -6
- package/tests/child.html +3 -3
- package/tests/context_processors.test.js +13 -13
- package/tests/esm.test.mjs +61 -26
- package/tests/filters.test.js +254 -99
- package/tests/include_security.test.js +9 -9
- package/tests/integration/README.md +32 -0
- package/tests/integration/features.test.cjs +1681 -0
- package/tests/integration/features.test.mjs +1697 -0
- package/tests/integration/templates/base.miki +6 -0
- package/tests/integration/templates/child.miki +6 -0
- package/tests/integration/templates/index.html +17 -0
- package/tests/lexer.test.js +45 -45
- package/tests/parser.test.js +57 -55
- package/tests/partial.html +1 -1
- package/tests/partialdef.test.js +79 -40
- package/tests/production_checks.js +57 -57
- package/tests/security.test.js +28 -28
- package/tests/tags.test.js +233 -203
- package/miki-template-1.2.0.vsix +0 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
{
|
|
2
|
+
"grammarTests": [
|
|
3
|
+
{
|
|
4
|
+
"name": "Basic template structure",
|
|
5
|
+
"input": "{% extends \"base.html\" %}\n{% block content %}\n{{ title }}\n{% endblock %}",
|
|
6
|
+
"expectedTokens": [
|
|
7
|
+
{ "line": 0, "scope": "meta.tag.django" },
|
|
8
|
+
{ "line": 0, "scope": "entity.name.tag.django" },
|
|
9
|
+
{ "line": 1, "scope": "meta.tag.django" },
|
|
10
|
+
{ "line": 2, "scope": "meta.variable.django" },
|
|
11
|
+
{ "line": 2, "scope": "support.function.django" }
|
|
12
|
+
]
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"name": "If/else/endif tags",
|
|
16
|
+
"input": "{% if user.is_authenticated %}\n <p>Hello</p>\n{% else %}\n <p>Login</p>\n{% endif %}",
|
|
17
|
+
"expectedTags": ["if", "else", "endif"]
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"name": "For loop with empty",
|
|
21
|
+
"input": "{% for item in items %}\n {{ item }}\n{% empty %}\n No items\n{% endfor %}",
|
|
22
|
+
"expectedTags": ["for", "empty", "endfor"]
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "Filter chain",
|
|
26
|
+
"input": "{{ name|lower|capfirst|truncatewords:10 }}",
|
|
27
|
+
"expectedFilters": ["lower", "capfirst", "truncatewords"]
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "Comment block",
|
|
31
|
+
"input": "{# This is a comment #}",
|
|
32
|
+
"scope": "comment.block.django"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "Prettier ignore",
|
|
36
|
+
"input": "{# prettier-ignore #}",
|
|
37
|
+
"scope": "meta.prettier-ignore.django"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "Include with context",
|
|
41
|
+
"input": "{% include \"partial.html\" with user=user %}",
|
|
42
|
+
"expectedTags": ["include"]
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "Partialdef and partial",
|
|
46
|
+
"input": "{% partialdef card %}\n<div>{{ title }}</div>\n{% endpartialdef %}\n{% partial card %}",
|
|
47
|
+
"expectedTags": ["partialdef", "endpartialdef", "partial"]
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "i18n tags",
|
|
51
|
+
"input": "{% trans \"Hello\" %}\n{% blocktrans with name=user.name %}\n {{ name }}\n{% endblocktrans %}",
|
|
52
|
+
"expectedTags": ["trans", "blocktrans", "endblocktrans"]
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "Operators",
|
|
56
|
+
"input": "{% if user.age >= 18 and user.is_verified or user.is_admin %}",
|
|
57
|
+
"expectedOperators": ["and", "or"]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "Cycle tag",
|
|
61
|
+
"input": "{% cycle 'odd' 'even' as marker silent %}",
|
|
62
|
+
"expectedTags": ["cycle"]
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "Widthratio",
|
|
66
|
+
"input": "{% widthratio this_value max_value 100 %}",
|
|
67
|
+
"expectedTags": ["widthratio"]
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "Cache tag",
|
|
71
|
+
"input": "{% cache 500 my_key %}\n{{ content }}\n{% endcache %}",
|
|
72
|
+
"expectedTags": ["cache", "endcache"]
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "Spaceless",
|
|
76
|
+
"input": "{% spaceless %}\n <p> </p>\n{% endspaceless %}",
|
|
77
|
+
"expectedTags": ["spaceless", "endspaceless"]
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"name": "Autoescape",
|
|
81
|
+
"input": "{% autoescape off %}\n{{ html|safe }}\n{% endautoescape %}",
|
|
82
|
+
"expectedTags": ["autoescape", "endautoescape"]
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "With block",
|
|
86
|
+
"input": "{% with user.profile as profile %}\n {{ profile.name }}\n{% endwith %}",
|
|
87
|
+
"expectedTags": ["with", "endwith"]
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"name": "Regroup",
|
|
91
|
+
"input": "{% regroup items by category as grouped %}\n{% for group in grouped %}\n {{ group.grouper }}\n{% endfor %}",
|
|
92
|
+
"expectedTags": ["regroup"]
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "Block.super",
|
|
96
|
+
"input": "{% block content %}\n {{ block.super }}\n{% endblock %}",
|
|
97
|
+
"expectedTokens": [{ "scope": "variable.other.django" }]
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "CSRF token",
|
|
101
|
+
"input": "{% csrf_token %}",
|
|
102
|
+
"expectedTags": ["csrf_token"]
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "Static tag",
|
|
106
|
+
"input": "{% static \"css/style.css\" %}",
|
|
107
|
+
"expectedTags": ["static"]
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"name": "URL tag",
|
|
111
|
+
"input": "{% url \"home\" user.id %}",
|
|
112
|
+
"expectedTags": ["url"]
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "Debug tag",
|
|
116
|
+
"input": "{% debug %}",
|
|
117
|
+
"expectedTags": ["debug"]
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "Verbatim",
|
|
121
|
+
"input": "{% verbatim %}\n {{ not_a_variable }}\n {% not_a_tag %}\n{% endverbatim %}",
|
|
122
|
+
"expectedTags": ["verbatim", "endverbatim"]
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"name": "Filter block",
|
|
126
|
+
"input": "{% filter upper %}\n {{ name }}\n{% endfilter %}",
|
|
127
|
+
"expectedTags": ["filter", "endfilter"]
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "Template tag symbol",
|
|
131
|
+
"input": "{% templatetag openblock %}",
|
|
132
|
+
"expectedTags": ["templatetag"]
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "Addtoblock",
|
|
136
|
+
"input": "{% addtoblock css %}\n.selector { color: red; }\n{% endaddtoblock %}",
|
|
137
|
+
"expectedTags": ["addtoblock", "endaddtoblock"]
|
|
138
|
+
}
|
|
139
|
+
],
|
|
140
|
+
"validationTests": [
|
|
141
|
+
{
|
|
142
|
+
"name": "Unclosed if tag",
|
|
143
|
+
"input": "{% if condition %}\n content\n{% endfor %}",
|
|
144
|
+
"expectedErrors": ["Unclosed tag: {% if %}"]
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"name": "Mismatched tags",
|
|
148
|
+
"input": "{% if condition %}\n content\n{% endfor %}",
|
|
149
|
+
"expectedErrors": ["Mismatched tag: expected {% endif %} but found {% endfor %}"]
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"name": "Extends not first",
|
|
153
|
+
"input": "{% if true %}\n{% extends \"base.html\" %}\n{% endif %}",
|
|
154
|
+
"expectedErrors": ["{% extends %} must be the first tag"]
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"name": "Tag after extends",
|
|
158
|
+
"input": "{% extends \"base.html\" %}\n{% if true %}\n{% include \"other.html\" %}\n{% endif %}",
|
|
159
|
+
"expectedErrors": []
|
|
160
|
+
}
|
|
161
|
+
]
|
|
162
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
const fs = require('fs');
|
|
2
|
+
const path = require('path');
|
|
3
|
+
|
|
4
|
+
const grammarTests = JSON.parse(fs.readFileSync(__dirname + '/grammar-tests.json', 'utf8'));
|
|
5
|
+
|
|
6
|
+
let passed = 0;
|
|
7
|
+
let failed = 0;
|
|
8
|
+
|
|
9
|
+
console.log('Running grammar tests...\n');
|
|
10
|
+
|
|
11
|
+
grammarTests.grammarTests.forEach(test => {
|
|
12
|
+
try {
|
|
13
|
+
console.log(`Test: ${test.name}`);
|
|
14
|
+
|
|
15
|
+
if (test.input) {
|
|
16
|
+
console.log(` Input: ${test.input.substring(0, 50)}${test.input.length > 50 ? '...' : ''}`);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
if (test.expectedTags) {
|
|
20
|
+
const missing = test.expectedTags.filter(tag => !test.input.includes(`{% ${tag}`));
|
|
21
|
+
if (missing.length > 0) {
|
|
22
|
+
console.log(` FAIL: Missing tags: ${missing.join(', ')}`);
|
|
23
|
+
failed++;
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
if (test.expectedFilters) {
|
|
29
|
+
const missing = test.expectedFilters.filter(f => !test.input.includes(`|${f}`));
|
|
30
|
+
if (missing.length > 0) {
|
|
31
|
+
console.log(` FAIL: Missing filters: ${missing.join(', ')}`);
|
|
32
|
+
failed++;
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
if (test.expectedOperators) {
|
|
38
|
+
const missing = test.expectedOperators.filter(op => !test.input.includes(op));
|
|
39
|
+
if (missing.length > 0) {
|
|
40
|
+
console.log(` FAIL: Missing operators: ${missing.join(', ')}`);
|
|
41
|
+
failed++;
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
console.log(' PASS');
|
|
47
|
+
passed++;
|
|
48
|
+
} catch (err) {
|
|
49
|
+
console.log(` ERROR: ${err.message}`);
|
|
50
|
+
failed++;
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
console.log('\nValidation tests...\n');
|
|
55
|
+
|
|
56
|
+
grammarTests.validationTests.forEach(test => {
|
|
57
|
+
try {
|
|
58
|
+
console.log(`Test: ${test.name}`);
|
|
59
|
+
console.log(` Input: ${test.input.substring(0, 50)}${test.input.length > 50 ? '...' : ''}`);
|
|
60
|
+
|
|
61
|
+
// Simple validation checks
|
|
62
|
+
if (test.input.includes('{% extends') && test.input.indexOf('{% extends') > 0) {
|
|
63
|
+
const firstNonWhitespace = test.input.match(/^\s*({%)/);
|
|
64
|
+
if (firstNonWhitespace && firstNonWhitespace.index > 0) {
|
|
65
|
+
console.log(` PASS: Detected extends not first`);
|
|
66
|
+
passed++;
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
console.log(' PASS');
|
|
71
|
+
passed++;
|
|
72
|
+
} catch (err) {
|
|
73
|
+
console.log(` ERROR: ${err.message}`);
|
|
74
|
+
failed++;
|
|
75
|
+
}
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
console.log(`\n========================================`);
|
|
79
|
+
console.log(`Tests: ${passed} passed, ${failed} failed`);
|
|
80
|
+
console.log(`========================================`);
|
|
81
|
+
|
|
82
|
+
process.exit(failed > 0 ? 1 : 0);
|
package/package.json
CHANGED
|
@@ -1,31 +1,37 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "miki-template",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Django-Style template engine for Node.js and Express",
|
|
5
|
-
"main": "src/index.js",
|
|
6
|
-
"exports": {
|
|
7
|
-
".": {
|
|
8
|
-
"import": "./src/esm.mjs",
|
|
9
|
-
"require": "./src/index.js",
|
|
10
|
-
"default": "./src/index.js"
|
|
11
|
-
}
|
|
12
|
-
},
|
|
13
|
-
"scripts": {
|
|
14
|
-
"test": "node -e \"const fs=require('fs');const path=require('path');const
|
|
15
|
-
"bench": "node benchmarks/run.js"
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "miki-template",
|
|
3
|
+
"version": "1.3.6",
|
|
4
|
+
"description": "Django-Style template engine for Node.js and Express",
|
|
5
|
+
"main": "src/index.js",
|
|
6
|
+
"exports": {
|
|
7
|
+
".": {
|
|
8
|
+
"import": "./src/esm.mjs",
|
|
9
|
+
"require": "./src/index.js",
|
|
10
|
+
"default": "./src/index.js"
|
|
11
|
+
}
|
|
12
|
+
},
|
|
13
|
+
"scripts": {
|
|
14
|
+
"test": "node -e \"const fs=require('fs');const path=require('path');function walk(d){const out=[];for(const e of fs.readdirSync(d,{withFileTypes:true})){const p=path.join(d,e.name);if(e.isDirectory())out.push(...walk(p));else if(/\\\\.test\\\\.(cjs|mjs|js)$/.test(e.name))out.push(p);}return out;}const files=walk('tests');require('child_process').execSync('node --test '+files.join(' '),{stdio:'inherit'})\"",
|
|
15
|
+
"bench": "node benchmarks/run.js",
|
|
16
|
+
"release:patch": "npm version patch --no-git-tag-version -m \"chore(release): v%s\" && git push origin main",
|
|
17
|
+
"release:minor": "npm version minor --no-git-tag-version -m \"chore(release): v%s\" && git push origin main",
|
|
18
|
+
"release:major": "npm version major --no-git-tag-version -m \"chore(release): v%s\" && git push origin main"
|
|
19
|
+
},
|
|
20
|
+
"keywords": [
|
|
21
|
+
"django",
|
|
22
|
+
"template",
|
|
23
|
+
"engine",
|
|
24
|
+
"express",
|
|
25
|
+
"nodejs",
|
|
26
|
+
"esm"
|
|
27
|
+
],
|
|
28
|
+
"author": "",
|
|
29
|
+
"license": "MIT",
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"date-fns": "^3.6.0",
|
|
32
|
+
"he": "^1.2.0"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"express": "^5.2.1"
|
|
36
|
+
}
|
|
37
|
+
}
|