(fix) fixMarkup would rarely destroy markup when useBR was enabled (#2532)

Author: joshgoebel

CHANGES.md

@@ -9,6 +9,7 @@ Parser Engine:
 - (enh) Added `on:end` callback for modes (#2261) [Josh Goebel][]
 - (enh) Added ability to programatically ignore begin and end matches (#2261) [Josh Goebel][]
 - (enh) Added `END_SAME_AS_BEGIN` mode to replace `endSameAsBegin` parser attribute (#2261) [Josh Goebel][]
+- (fix) `fixMarkup` would rarely destroy markup when `useBR` was enabled (#2532) [Josh Goebel][]
 
 Deprecations:
 

src/highlight.js

@@ -32,7 +32,7 @@ const HLJS = function(hljs) {
   var SAFE_MODE = true;
 
   // Regular expressions used throughout the highlight.js library.
-  var fixMarkupRe = /((^(<[^>]+>|\t|)+|(?:\n)))/gm;
+  var fixMarkupRe = /(^(<[^>]+>|\t|)+|\n)/gm;
 
   var LANGUAGE_NOT_FOUND = "Could not find the language '{}', did you forget to load/include a language module?";
 
@@ -540,13 +540,13 @@ const HLJS = function(hljs) {
       return value;
     }
 
-    return value.replace(fixMarkupRe, function(match, p1) {
-      if (options.useBR && match === '\n') {
-        return '<br>';
+    return value.replace(fixMarkupRe, match => {
+      if (match === '\n') {
+        return options.useBR ? '<br>' : match;
       } else if (options.tabReplace) {
-        return p1.replace(/\t/g, options.tabReplace);
+        return match.replace(/\t/g, options.tabReplace);
       }
-      return '';
+      return match;
     });
   }
 

test/api/fixmarkup.js

@@ -5,11 +5,21 @@ const hljs   = require('../../build');
 
 describe('.fixmarkup()', () => {
   after(() => {
-    hljs.configure({ useBR: false })
-  })
+    hljs.configure({ useBR: false });
+  });
+
+  it('should not strip HTML from beginning of strings', () => {
+    hljs.configure({ useBR: true });
+    const value = '<span class="hljs-attr">"some"</span>: \n <span class="hljs-string">"json"</span>';
+    const result = hljs.fixMarkup(value);
+
+    result.should.equal(
+      '<span class="hljs-attr">"some"</span>: <br> <span class="hljs-string">"json"</span>'
+    );
+  });
 
   it('should not add "undefined" to the beginning of the result (#1452)', () => {
-    hljs.configure({ useBR: true })
+    hljs.configure({ useBR: true });
     const value = '{ <span class="hljs-attr">"some"</span>: \n <span class="hljs-string">"json"</span> }';
     const result = hljs.fixMarkup(value);