(chore) older API defers to highlightAll() now

joshgoebel · Mar 17, 2021 · aa5a3e7 · aa5a3e7
1 parent e67494f
commit aa5a3e7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 17 deletions.
diff --git a/VERSION_11_UPGRADE.md b/VERSION_11_UPGRADE.md
@@ -3,6 +3,11 @@
 -  remove apache, http, nginx, properties, coffeescript from :common #2848
 
 
+### Behavior changes
+
+- `initHighlighting` and `initHighlightingOnLoad` call `highlightAll`
+- Calling `highlightAll` over and over is not guarded against
+
 ### Grammar's removed or renamed
 
 - remove the old htmlbars stub, use handlebars

diff --git a/docs/api.rst b/docs/api.rst
@@ -72,11 +72,12 @@ Accepts an object representing options with the values to updated. Other options
 ::
 
   hljs.configure({
-    tabReplace: '    ', // 4 spaces
+    noHighlightRe: /^do-not-highlightme$/i,
+    languageDetectRe: /\bgrammar-([\w-]+)\b/i, // for `grammar-swift` style CSS naming
     classPrefix: ''     // don't append class prefix
                         // … other options aren't changed
   });
-  hljs.initHighlighting();
+  hljs.highlightAll();
 
 
 ``highlightAll()``

diff --git a/src/highlight.js b/src/highlight.js
@@ -684,27 +684,16 @@ const HLJS = function(hljs) {
     options = inherit(options, userOptions);
   }
 
-  /**
-   * Highlights to all <pre><code> blocks on a page
-   *
-   * @type {Function & {called?: boolean}}
-   */
   // TODO: remove v12, deprecated
   const initHighlighting = () => {
-    if (initHighlighting.called) return;
-    initHighlighting.called = true;
-
-    logger.deprecated("10.6.0", "initHighlighting() is deprecated.  Use highlightAll() instead.");
-
-    const blocks = document.querySelectorAll('pre code');
-    blocks.forEach(highlightElement);
+    highlightAll();
+    logger.deprecated("10.6.0", "initHighlighting() deprecated.  Use highlightAll() now.");
   };
 
-  // Higlights all when DOMContentLoaded fires
   // TODO: remove v12, deprecated
   function initHighlightingOnLoad() {
-    logger.deprecated("10.6.0", "initHighlightingOnLoad() is deprecated.  Use highlightAll() instead.");
-    wantsHighlight = true;
+    highlightAll();
+    logger.deprecated("10.6.0", "initHighlightingOnLoad() deprecated.  Use highlightAll() now.");
   }
 
   let wantsHighlight = false;