chore(parser) deprecate fixMarkup and add console warning

joshgoebel · joshgoebel · commit 621ba9de596c · 2020-09-04T21:40:31.000-04:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -8,6 +8,10 @@ New themes:
 
 - *Gradient Light* by [Samia Ali]()
 
+Deprecations:
+
+- `fixMarkup` is now deprecated and will be removed in v11.0. (#2534) [Josh Goebel][]
+
 Big picture:
 
 - Add simple Vue plugin for basic use cases (#2544) [Josh Goebel][]
diff --git a/src/highlight.js b/src/highlight.js
@@ -848,12 +848,19 @@ const HLJS = function(hljs) {
     });
   }
 
-  /* Interface definition */
+  /* fixMarkup is deprecated and will be removed entirely in v11 */
+  function deprecate_fixMarkup(arg) {
+    console.warn("fixMarkup is deprecated and will be removed entirely in v11.0")
+    console.warn("Please see https://github.com/highlightjs/highlight.js/issues/2534")
+
+    return fixMarkup(arg)
+  }
 
+  /* Interface definition */
   Object.assign(hljs, {
     highlight,
     highlightAuto,
-    fixMarkup,
+    fixMarkup: deprecate_fixMarkup,
     highlightBlock,
     configure,
     initHighlighting,
