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.

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

work around syntaxhighlighter bug causing empty blocks on perlsecret #3228

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

haarg
Copy link
Member

@haarg haarg commented Nov 13, 2024

perlsecret.pod has some code blocks that are very short. The syntax highlighter has a bug when it attempts to strip blocks, which ends up entirely erasing short code block content. The CDATA stripping is only enabled when the useScriptTags option is enabled, which we don't need or want. Work around the bug by disabling useScriptTags.

This bug had previously been fixed by patching the vendor library to fix the CDATA stripping. That change was lost in the conversion to node_modules.

Previously reported as #1228 and fixed by #2292.

perlsecret.pod has some code blocks that are very short. The syntax
highlighter has a bug when it attempts to strip <![CDATA[ ]]> blocks,
which ends up entirely erasing short code block content. The CDATA
stripping is only enabled when the useScriptTags option is enabled,
which we don't need or want. Work around the bug by disabling
useScriptTags.

This bug had previously been fixed by patching the vendor library to fix
the CDATA stripping. That change was lost in the conversion to
node_modules.
Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.14%. Comparing base (73dc5d1) to head (16f077c).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3228      +/-   ##
==========================================
+ Coverage   73.10%   73.14%   +0.04%     
==========================================
  Files          69       69              
  Lines        2398     2398              
  Branches      338      338              
==========================================
+ Hits         1753     1754       +1     
  Misses        517      517              
+ Partials      128      127       -1     

see 1 file with indirect coverage changes

@haarg haarg merged commit 31450e0 into master Nov 13, 2024
11 checks passed
@haarg haarg deleted the haarg/fix-perlsecret-again branch November 13, 2024 18:02
@abraxxa
Copy link
Contributor

abraxxa commented Nov 13, 2024

You rock @haarg ! Thank you very much! 🤩

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants