Skip to content

Commit 2e834c8

Browse files
RunDevelopmentRunDevelopment
authored
Tests: Added .html.test files for replace .js language tests (#3148)
1 parent ae8888a commit 2e834c8

20 files changed

+370
-129
lines changed

‎package-lock.json

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
"mocha": "^6.2.0",
6262
"node-fetch": "^2.6.0",
6363
"npm-run-all": "^4.1.5",
64+
"prettier": "^2.4.1",
6465
"pump": "^3.0.0",
6566
"refa": "^0.9.1",
6667
"regexp-ast-analysis": "^0.2.4",

‎test-suite.html

+13-6
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,21 @@ <h2 id="writing-tests-explaining-the-simplified-token-stream">Explaining the sim
165165
<section id="writing-specific-tests">
166166
<h1>Writing specific tests</h1>
167167

168-
<p>Sometimes, using the token stream tests is not powerful enough. By creating a test file with the file extension <code>.js</code> instead of <code>.test</code>, you can make Prism highlight arbitrary pieces of code and check their HTML results.</p>
168+
<p>Sometimes, using the token stream tests is not powerful enough. By creating a test file with the file extension <code>.html.test</code> instead of <code>.test</code>, you can make Prism highlight arbitrary pieces of code and check their HTML results.</p>
169169
<p>The language is determined by the folder containing the test file lies, as explained in the previous section.</p>
170170
<p>The structure of your test file will look like this, for example:</p>
171-
<pre><code>module.exports = {
172-
'&amp;#x278a;': '&lt;span class="token entity" title="&amp;#x278a;">&amp;amp;#x278a;&lt;/span>',
173-
'&amp;#182;': '&lt;span class="token entity" title="&amp;#182;">&amp;amp;#182;&lt;/span>',
174-
};</code></pre>
175-
<p>The keys are the codes which will be highlighted by Prism. The values are the expected results, as HTML.</p>
171+
<pre><code class="language-html">&amp;amp;
172+
&amp;#x41;
173+
174+
----------------------------------------------------
175+
176+
&lt;span class="token entity named-entity" title="&amp;amp;">&amp;amp;amp;&lt;/span>
177+
&lt;span class="token entity" title="&amp;#x41;">&amp;amp;#x41;&lt;/span>
178+
179+
----------------------------------------------------
180+
181+
This is a comment explaining this test case.
182+
</code></pre>
176183
</section>
177184

178185
<section id="test-runner-tests">

‎tests/helper/test-case.js

+81-33
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
const fs = require('fs');
44
const { assert } = require('chai');
5+
const Prettier = require('prettier');
56
const PrismLoader = require('./prism-loader');
67
const TokenStreamTransformer = require('./token-stream-transformer');
78

@@ -217,6 +218,81 @@ class TokenizeJSONRunner {
217218
}
218219
}
219220

221+
/**
222+
* @implements {Runner<string>}
223+
*/
224+
class HighlightHTMLRunner {
225+
/**
226+
* @param {Prism} Prism
227+
* @param {string} code
228+
* @param {string} language
229+
* @returns {string}
230+
*/
231+
run(Prism, code, language) {
232+
const env = {
233+
element: {},
234+
language,
235+
grammar: Prism.languages[language],
236+
code,
237+
};
238+
239+
Prism.hooks.run('before-highlight', env);
240+
env.highlightedCode = Prism.highlight(env.code, env.grammar, env.language);
241+
Prism.hooks.run('before-insert', env);
242+
env.element.innerHTML = env.highlightedCode;
243+
Prism.hooks.run('after-highlight', env);
244+
Prism.hooks.run('complete', env);
245+
246+
return env.highlightedCode;
247+
}
248+
/**
249+
* @param {string} actual
250+
* @returns {string}
251+
*/
252+
print(actual) {
253+
return Prettier.format(actual, {
254+
printWidth: 100,
255+
tabWidth: 4,
256+
useTabs: true,
257+
htmlWhitespaceSensitivity: 'ignore',
258+
filepath: 'fake.html',
259+
});
260+
}
261+
/**
262+
* @param {string} actual
263+
* @param {string} expected
264+
* @returns {boolean}
265+
*/
266+
isEqual(actual, expected) {
267+
return this.normalize(actual) === this.normalize(expected);
268+
}
269+
/**
270+
* @param {string} actual
271+
* @param {string} expected
272+
* @param {(firstDifference: number) => string} message
273+
* @returns {void}
274+
*/
275+
assertEqual(actual, expected, message) {
276+
// We don't calculate the index of the first difference because it's difficult.
277+
assert.deepEqual(this.normalize(actual), this.normalize(expected), message(0));
278+
}
279+
280+
/**
281+
* Normalizes the given HTML by removing all leading spaces and trailing spaces. Line breaks will also be normalized
282+
* to enable good diffing.
283+
*
284+
* @param {string} html
285+
* @returns {string}
286+
*/
287+
normalize(html) {
288+
return html
289+
.replace(/</g, '\n<')
290+
.replace(/>/g, '>\n')
291+
.replace(/[ \t]*[\r\n]\s*/g, '\n')
292+
.trim();
293+
}
294+
}
295+
220296

221297
module.exports = {
222298
TestCaseFile,
@@ -238,7 +314,11 @@ module.exports = {
238314
* @param {"none" | "insert" | "update"} updateMode
239315
*/
240316
runTestCase(languageIdentifier, filePath, updateMode) {
241-
this.runTestCaseWithRunner(languageIdentifier, filePath, updateMode, new TokenizeJSONRunner());
317+
if (/\.html\.test$/i.test(filePath)) {
318+
this.runTestCaseWithRunner(languageIdentifier, filePath, updateMode, new HighlightHTMLRunner());
319+
} else {
320+
this.runTestCaseWithRunner(languageIdentifier, filePath, updateMode, new TokenizeJSONRunner());
321+
}
242322
},
243323

244324
/**
@@ -347,38 +427,6 @@ module.exports = {
347427
mainLanguage: mainLanguage
348428
};
349429
},
350-
351-
/**
352-
* Runs the given pieces of codes and asserts their result.
353-
*
354-
* Code is provided as the key and expected result as the value.
355-
*
356-
* @param {string} languageIdentifier
357-
* @param {object} codes
358-
*/
359-
runTestsWithHooks(languageIdentifier, codes) {
360-
const usedLanguages = this.parseLanguageNames(languageIdentifier);
361-
const Prism = PrismLoader.createInstance(usedLanguages.languages);
362-
// the first language is the main language to highlight
363-
364-
for (const code in codes) {
365-
if (codes.hasOwnProperty(code)) {
366-
const env = {
367-
element: {},
368-
language: usedLanguages.mainLanguage,
369-
grammar: Prism.languages[usedLanguages.mainLanguage],
370-
code: code
371-
};
372-
Prism.hooks.run('before-highlight', env);
373-
env.highlightedCode = Prism.highlight(env.code, env.grammar, env.language);
374-
Prism.hooks.run('before-insert', env);
375-
env.element.innerHTML = env.highlightedCode;
376-
Prism.hooks.run('after-highlight', env);
377-
Prism.hooks.run('complete', env);
378-
assert.equal(env.highlightedCode, codes[code]);
379-
}
380-
}
381-
}
382430
};
383431

384432
/**

‎tests/helper/test-discovery.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
const fs = require('fs');
44
const path = require('path');
55

6-
const SUPPORTED_TEST_FILE_EXT = new Set(['.js', '.test']);
7-
86
module.exports = {
97

108
/**
@@ -95,7 +93,7 @@ module.exports = {
9593
getAllFiles(src) {
9694
return fs.readdirSync(src)
9795
.filter(fileName => {
98-
return SUPPORTED_TEST_FILE_EXT.has(path.extname(fileName))
96+
return path.extname(fileName) === '.test'
9997
&& fs.statSync(path.join(src, fileName)).isFile();
10098
})
10199
.map(fileName => {

‎tests/languages/asciidoc/entity_feature.html.test

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
&#x278a;
2+
&#182;
3+
4+
----------------------------------------------------
5+
6+
<span class="token entity" title="&#x278a;">&amp;#x278a;</span>
7+
<span class="token entity" title="&#182;">&amp;#182;</span>

‎tests/languages/asciidoc/entity_feature.js

-4
This file was deleted.

‎tests/languages/groovy/issue1049.html.test

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"&amp;"
2+
"&amp;&amp;"
3+
"&lt;"
4+
"&lt;&lt;"
5+
"&amp;lt;"
6+
"&gt;"
7+
8+
----------------------------------------------------
9+
10+
<span class="token string gstring">"&amp;amp;"</span>
11+
<span class="token string gstring">"&amp;amp;&amp;amp;"</span>
12+
<span class="token string gstring">"&amp;lt;"</span>
13+
<span class="token string gstring">"&amp;lt;&amp;lt;"</span>
14+
<span class="token string gstring">"&amp;amp;lt;"</span>
15+
<span class="token string gstring">"&amp;gt;"</span>

‎tests/languages/groovy/issue1049.js

-8
This file was deleted.

‎tests/languages/groovy/string-interpolation_feature.html.test

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
// Double quoted: interpolation
2+
"$foo"
3+
"${42}"
4+
5+
// Triple double quoted: interpolation
6+
"""$foo"""
7+
"""${42}"""
8+
9+
// Slashy string: interpolation
10+
/$foo/
11+
/${42}/
12+
13+
// Dollar slashy string: interpolation
14+
$/$foo/$
15+
$/${42}/$
16+
17+
// Double quoted: no interpolation (escaped)
18+
"\$foo \${42}"
19+
20+
// Triple double quoted: no interpolation (escaped)
21+
"""\$foo \${42}"""
22+
23+
// Slashy string: no interpolation (escaped)
24+
/\$foo \${42}/
25+
26+
// Dollar slashy string: no interpolation (escaped)
27+
$/$$foo $${42}/$
28+
29+
// Single quoted string: no interpolation
30+
'$foo ${42}'
31+
32+
// Triple single quoted string: no interpolation
33+
'''$foo ${42}'''
34+
35+
----------------------------------------------------
36+
37+
<span class="token comment">// Double quoted: interpolation</span>
38+
<span class="token string gstring">
39+
"
40+
<span class="token expression">
41+
<span class="token punctuation">$</span>
42+
foo
43+
</span>
44+
"
45+
</span>
46+
<span class="token string gstring">
47+
"
48+
<span class="token expression">
49+
<span class="token punctuation">$</span>
50+
<span class="token punctuation">{</span>
51+
<span class="token number">42</span>
52+
<span class="token punctuation">}</span>
53+
</span>
54+
"
55+
</span>
56+
57+
<span class="token comment">// Triple double quoted: interpolation</span>
58+
<span class="token string gstring">
59+
"""
60+
<span class="token expression">
61+
<span class="token punctuation">$</span>
62+
foo
63+
</span>
64+
"""
65+
</span>
66+
<span class="token string gstring">
67+
"""
68+
<span class="token expression">
69+
<span class="token punctuation">$</span>
70+
<span class="token punctuation">{</span>
71+
<span class="token number">42</span>
72+
<span class="token punctuation">}</span>
73+
</span>
74+
"""
75+
</span>
76+
77+
<span class="token comment">// Slashy string: interpolation</span>
78+
<span class="token string regex">
79+
/
80+
<span class="token expression">
81+
<span class="token punctuation">$</span>
82+
foo
83+
</span>
84+
/
85+
</span>
86+
<span class="token string regex">
87+
/
88+
<span class="token expression">
89+
<span class="token punctuation">$</span>
90+
<span class="token punctuation">{</span>
91+
<span class="token number">42</span>
92+
<span class="token punctuation">}</span>
93+
</span>
94+
/
95+
</span>
96+
97+
<span class="token comment">// Dollar slashy string: interpolation</span>
98+
<span class="token string gstring">
99+
$/
100+
<span class="token expression">
101+
<span class="token punctuation">$</span>
102+
foo
103+
</span>
104+
/$
105+
</span>
106+
<span class="token string gstring">
107+
$/
108+
<span class="token expression">
109+
<span class="token punctuation">$</span>
110+
<span class="token punctuation">{</span>
111+
<span class="token number">42</span>
112+
<span class="token punctuation">}</span>
113+
</span>
114+
/$
115+
</span>
116+
117+
<span class="token comment">// Double quoted: no interpolation (escaped)</span>
118+
<span class="token string gstring">"\$foo \${42}"</span>
119+
120+
<span class="token comment">// Triple double quoted: no interpolation (escaped)</span>
121+
<span class="token string gstring">"""\$foo \${42}"""</span>
122+
123+
<span class="token comment">// Slashy string: no interpolation (escaped)</span>
124+
<span class="token string regex">/\$foo \${42}/</span>
125+
126+
<span class="token comment">// Dollar slashy string: no interpolation (escaped)</span>
127+
<span class="token string gstring">$/$$foo $${42}/$</span>
128+
129+
<span class="token comment">// Single quoted string: no interpolation</span>
130+
<span class="token string">'$foo ${42}'</span>
131+
132+
<span class="token comment">// Triple single quoted string: no interpolation</span>
133+
<span class="token string">'''$foo ${42}'''</span>

0 commit comments

Comments
 (0)