Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: preserve language attribute for code blocks #247

Merged
merged 4 commits into from
Jul 19, 2022
Merged

feat: preserve language attribute for code blocks #247

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3c9d92
test: add failing test for language attribute
miketheman Jul 13, 2022
c3680e8
feat: preserve lang attribute in markdown
miketheman Jul 13, 2022
7f67b9a
test: update tests to include preserved `lang`
miketheman Jul 13, 2022
d00aa2e
Merge branch 'main' into miketheman/preserve-lang-attribute-200
di Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions readme_renderer/clean.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"h6": ["align"],
"code": ["class"],
"p": ["align", "class"],
"pre": ["lang"],
"ol": ["start"],
"input": ["type", "checked", "disabled"],
}
Expand Down
2 changes: 1 addition & 1 deletion readme_renderer/markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def replacer(match: Match[Any]) -> str:

highlighted = pygments.highlight(code, lexer, formatter)

return f'<pre>{highlighted}</pre>'
return f'<pre lang="{lang}">{highlighted}</pre>'

result = code_expr.sub(replacer, html)

Expand Down
4 changes: 2 additions & 2 deletions tests/fixtures/test_CommonMark_008.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p>Here is some Python code for a <code>Dog</code>:</p>
<pre><span class="k">class</span> <span class="nc">Dog</span><span class="p">(</span><span class="n">Animal</span><span class="p">):</span>
<pre lang="python3"><span class="k">class</span> <span class="nc">Dog</span><span class="p">(</span><span class="n">Animal</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>

Expand All @@ -9,7 +9,7 @@
<span class="n">dog</span> <span class="o">=</span> <span class="n">Dog</span><span class="p">(</span><span class="s1">&#39;Fido&#39;</span><span class="p">)</span>
</pre>
<p>and then here is some bash:</p>
<pre><span class="k">if</span> <span class="o">[</span> <span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span> <span class="o">=</span> <span class="s2">&quot;--help&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<pre lang="bash"><span class="k">if</span> <span class="o">[</span> <span class="s2">&quot;</span><span class="nv">$1</span><span class="s2">&quot;</span> <span class="o">=</span> <span class="s2">&quot;--help&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nb">echo</span> <span class="s2">&quot;OK&quot;</span>
<span class="k">fi</span>
</pre>
Expand Down
4 changes: 2 additions & 2 deletions tests/fixtures/test_GFM_doublequotes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<p>This is normal text.</p>
<pre><code>This is code text.
</code></pre>
<pre><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<pre lang="python3"><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;This is a docstring.&quot;&quot;&quot;</span>
<span class="k">pass</span>
</pre>
<pre><span class="kd">func</span><span class="w"> </span><span class="nx">ThisIsGo</span><span class="p">(){</span><span class="w"></span>
<pre lang="go"><span class="kd">func</span><span class="w"> </span><span class="nx">ThisIsGo</span><span class="p">(){</span><span class="w"></span>
<span class="w"> </span><span class="k">return</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre>
6 changes: 4 additions & 2 deletions tests/fixtures/test_GFM_highlight.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<p>This is normal text.</p>
<pre><code>This is code text.
</code></pre>
<pre><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<pre lang="python3"><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<span class="k">pass</span>
</pre>
<pre><span class="kd">func</span><span class="w"> </span><span class="nx">ThisIsGo</span><span class="p">(){</span><span class="w"></span>
<pre lang="go"><span class="kd">func</span><span class="w"> </span><span class="nx">ThisIsGo</span><span class="p">(){</span><span class="w"></span>
<span class="w"> </span><span class="k">return</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre>
<pre lang="abc">An unknown code fence block
</pre>
4 changes: 4 additions & 0 deletions tests/fixtures/test_GFM_highlight.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ func ThisIsGo(){
return
}
```

```abc
An unknown code fence block
```
2 changes: 1 addition & 1 deletion tests/fixtures/test_GFM_highlight_default_py.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<pre><span class="k">async</span> <span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<pre lang="python3"><span class="k">async</span> <span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<span class="k">pass</span>

<span class="nb">print</span><span class="p">(</span><span class="k">await</span> <span class="n">this_is_python</span><span class="p">())</span>
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/test_GFM_malicious_pre.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p>This is normal text.</p>
<pre><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<pre lang="python3"><span class="k">def</span> <span class="nf">this_is_python</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;This is a docstring.&quot;&quot;&quot;</span>
<span class="k">pass</span>
<span class="o">&lt;</span><span class="n">script</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;text/javascript&quot;</span><span class="o">&gt;</span><span class="n">alert</span><span class="p">(</span><span class="s1">&#39;I am evil.&#39;</span><span class="p">);</span><span class="o">&lt;/</span><span class="n">script</span><span class="o">&gt;</span>
Expand Down