Skip to content

Commit fc60649

Browse files
committed
Update the attributes and classes of code blocks
1 parent 9010b35 commit fc60649

File tree

19 files changed

+32
-32
lines changed

19 files changed

+32
-32
lines changed

src/Renderers/CodeNodeRenderer.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,18 @@ public function render(): string
7979
}
8080

8181
$numOfLines = \count(preg_split('/\r\n|\r|\n/', $highlightedCode));
82-
$lines = implode("\n", range(1, $numOfLines));
82+
$lineNumbers = implode("\n", range(1, $numOfLines));
8383

8484
return $this->templateRenderer->render(
8585
'code.html.twig',
8686
[
8787
'languages' => $languages,
88-
'lines' => $lines,
88+
'line_numbers' => $lineNumbers,
8989
'code' => $highlightedCode,
90-
// this is the number of digits of the codeblock lines-of-code
91-
// e.g. LOC = 5, digits = 1; LOC = 18, digits = 2
92-
// this is useful to tweak the code listings according to their length
93-
'numLocDigits' => strlen((string) $numOfLines),
90+
'loc' => $numOfLines,
91+
// the length of the codeblock in a semantic way (to tweak styling)
92+
// e.g. LOC = 5, length = 'sm'; LOC = 18, length = 'md'
93+
'length' => [1 => 'sm', 2 => 'md', 3 => 'lg', 4 => 'xl'][strlen((string) $numOfLines)],
9494
]
9595
);
9696
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-{{ numLocDigits }} {{ languages|map(language => "codeblock-#{language}")|join(' ') }}">
1+
<div translate="no" data-loc="{{ loc }}" class="notranslate codeblock codeblock-length-{{ length }} {{ languages|map(language => "codeblock-#{language}")|join(' ') }}">
22
<div class="codeblock-scroll">
3-
<pre class="codeblock-lines">{{ lines }}</pre>
3+
<pre class="codeblock-lines">{{ line_numbers }}</pre>
44
<pre class="codeblock-code"><code>{{ code|raw }}</code></pre>
55
</div>
66
</div>

tests/fixtures/expected/blocks/code-blocks/bash.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-bash">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-bash">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code>git <span class="hljs-built_in">clone</span> git@github.com:symfony/symfony.git</code></pre>

tests/fixtures/expected/blocks/code-blocks/html-php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-html+php codeblock-html">
1+
<div translate="no" data-loc="12" class="notranslate codeblock codeblock-length-md codeblock-html+php codeblock-html">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1
44
2

tests/fixtures/expected/blocks/code-blocks/html-twig.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html+twig codeblock-twig">
1+
<div translate="no" data-loc="2" class="notranslate codeblock codeblock-length-sm codeblock-html+twig codeblock-twig">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1
44
2</pre>

tests/fixtures/expected/blocks/code-blocks/html.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-html">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-html">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code><span class="hljs-comment">&lt;!-- some code --&gt;</span>

tests/fixtures/expected/blocks/code-blocks/ini.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-ini">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-ini">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code><span class="hljs-attr">fetch</span> = +refs/notes/*:refs/notes/*</code></pre>

tests/fixtures/expected/blocks/code-blocks/php-annotations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php-annotations codeblock-php">
1+
<div translate="no" data-loc="14" class="notranslate codeblock codeblock-length-md codeblock-php-annotations codeblock-php">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1
44
2

tests/fixtures/expected/blocks/code-blocks/php.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
1+
<div translate="no" data-loc="7" class="notranslate codeblock codeblock-length-sm codeblock-php">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1
44
2

tests/fixtures/expected/blocks/code-blocks/terminal.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-terminal codeblock-bash">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code>git <span
55
class="hljs-built_in">clone</span> git@github.com:symfony/symfony.git</code></pre>
66
</div>
77
</div>
8-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
8+
<div translate="no" data-loc="2" class="notranslate codeblock codeblock-length-sm codeblock-terminal codeblock-bash">
99
<div class="codeblock-scroll">
1010
<pre class="codeblock-lines">1
1111
2</pre>
@@ -20,7 +20,7 @@
2020
</div>
2121
</div>
2222

23-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-terminal codeblock-bash">
23+
<div translate="no" data-loc="3" class="notranslate codeblock codeblock-length-sm codeblock-terminal codeblock-bash">
2424
<div class="codeblock-scroll">
2525
<pre class="codeblock-lines">1
2626
2

tests/fixtures/expected/blocks/code-blocks/text.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-text">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-text">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code>some text</code></pre>

tests/fixtures/expected/blocks/code-blocks/twig.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-twig">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-twig">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code><span class="hljs-comment">{# some code #}</span></code></pre>

tests/fixtures/expected/blocks/code-blocks/xml.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-xml">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-xml">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code><span class="hljs-comment">&lt;!-- some code --&gt;</span>

tests/fixtures/expected/blocks/code-blocks/yaml.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
1+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-yaml">
22
<div class="codeblock-scroll">
33
<pre class="codeblock-lines">1</pre>
44
<pre class="codeblock-code"><code><span class="hljs-comment"># some code</span>

tests/fixtures/expected/blocks/directives/configuration-block.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<li data-language="php" > <span>PHP</span> </li>
55
</ul>
66
<div class="configuration-codeblock" data-language="yaml" style="">
7-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
7+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-yaml">
88
<div class="codeblock-scroll">
99
<pre class="codeblock-lines">1</pre>
1010
<pre class="codeblock-code"><code><span class="hljs-comment"># app/config/services.yml</span></code></pre>
1111
</div>
1212
</div>
1313
</div>
1414
<div class="configuration-codeblock" data-language="php" style="display: none">
15-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
15+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-php">
1616
<div class="codeblock-scroll">
1717
<pre class="codeblock-lines">1</pre>
1818
<pre class="codeblock-code"><code><span class="hljs-comment">// config/routes.php</span></code></pre>

tests/fixtures/expected/blocks/directives/note-code-block-nested.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<svg xmlns="http://www.w3.org/2000/svg" fill="none" width="24" height="24" viewBox="0 0 24 24" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M11 5H6a2 2 0 00-2 2v11a2 2 0 002 2h11a2 2 0 002-2v-5m-1.414-9.414a2 2 0 112.828 2.828L11.828 15H9v-2.828l8.586-8.586z" /></svg>
44
<span>Note</span>
55
</p><p>test</p>
6-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
6+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-php">
77
<div class="codeblock-scroll">
88
<pre class="codeblock-lines">1</pre>
99
<pre class="codeblock-code"><code><span class="hljs-comment">// code</span>

tests/fixtures/expected/blocks/directives/sidebar-code-block-nested.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div class="admonition-wrapper"><div class="admonition admonition-sidebar"><p class="sidebar-title"><span>The sidebar's title</span></p><p>some text before code block</p>
2-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
2+
<div translate="no" data-loc="1" class="notranslate codeblock codeblock-length-sm codeblock-php">
33
<div class="codeblock-scroll">
44
<pre class="codeblock-lines">1</pre>
55
<pre class="codeblock-code"><code><span class="hljs-comment">// some code</span>

tests/fixtures/expected/blocks/nodes/literal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p>here is some php code from literal:</p>
2-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
2+
<div translate="no" data-loc="7" class="notranslate codeblock codeblock-length-sm codeblock-php">
33
<div class="codeblock-scroll">
44
<pre class="codeblock-lines">1
55
2

tests/fixtures/expected/main/datetime.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h3 id="placeholder"><a class="headerlink" href="#placeholder" title="Permalink
9898
<p>If your widget option is set to <code translate="no" class="notranslate">choice</code>, then this field will be represented
9999
as a series of <code translate="no" class="notranslate">select</code> boxes. When the placeholder value is a string,
100100
it will be used as the <strong>blank value</strong> of all select boxes:</p>
101-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
101+
<div translate="no" data-loc="5" class="notranslate codeblock codeblock-length-sm codeblock-php">
102102
<div class="codeblock-scroll">
103103
<pre class="codeblock-lines">1
104104
2
@@ -176,7 +176,7 @@ <h3 id="by-reference"><a class="headerlink" href="#by-reference" title="Permalin
176176
<h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Permalink to this headline">error_bubbling</a></h3>
177177
<p><strong>default</strong>: <code translate="no" class="notranslate">false</code></p>
178178
<p>We also support code blocks!</p>
179-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
179+
<div translate="no" data-loc="3" class="notranslate codeblock codeblock-length-sm codeblock-yaml">
180180
<div class="codeblock-scroll">
181181
<pre class="codeblock-lines">1
182182
2
@@ -195,7 +195,7 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
195195
<li data-language="php" > <span>PHP</span> </li>
196196
</ul>
197197
<div class="configuration-codeblock" data-language="yaml" style="">
198-
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
198+
<div translate="no" data-loc="7" class="notranslate codeblock codeblock-length-sm codeblock-yaml">
199199
<div class="codeblock-scroll">
200200
<pre class="codeblock-lines">1
201201
2
@@ -216,7 +216,7 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
216216
</div>
217217
</div>
218218
<div class="configuration-codeblock" data-language="xml" style="display: none">
219-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-xml">
219+
<div translate="no" data-loc="20" class="notranslate codeblock codeblock-length-md codeblock-xml">
220220
<div class="codeblock-scroll">
221221
<pre class="codeblock-lines">1
222222
2
@@ -263,7 +263,7 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
263263
</div>
264264
</div>
265265
<div class="configuration-codeblock" data-language="php" style="display: none">
266-
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php">
266+
<div translate="no" data-loc="10" class="notranslate codeblock codeblock-length-md codeblock-php">
267267
<div class="codeblock-scroll">
268268
<pre class="codeblock-lines">1
269269
2

0 commit comments

Comments
 (0)