ehn(api): add unregisterLanguage method

CHANGES.md

@@ -14,12 +14,17 @@ Language grammar improvements:
 - enh(php) Add `mixed` to list of keywords (#2997) [Ayesh][]
 - enh(php) Add support binary, octal, hex and scientific numerals with underscore separator support (#2997) [Ayesh][]
 
+API:
+
+- enh(api) add `unregisterLanguage` method (#3009) [Antoine du Hamel][]
+
 [Stef Levesque]: https://github.com/stef-levesque
 [Josh Goebel]: https://github.com/joshgoebel
 [John Cheung]: https://github.com/Real-John-Cheung
 [xDGameStudios]: https://github.com/xDGameStudios
 [Ayesh]: https://github.com/Ayesh
 [Vyron Vasileiadis]: https://github.com/fedonman
+[Antoine du Hamel]: https://github.com/aduh95
 
 ## Version 10.6.0
 

docs/api.rst

@@ -125,6 +125,14 @@ Adds new language to the library under the specified name. Used mostly internall
   to use common regular expressions defined within it.
 
 
+``unregisterLanguage(languageName)``
+------------------------------------
+
+Removes a language and its aliases from the library. Used mostly internally.
+
+* ``languageName``: a string with the name of the language being removed.
+
+
 ``registerAliases(alias|aliases, {languageName})``
 --------------------------------------------------
 

src/highlight.js

@@ -814,6 +814,20 @@ const HLJS = function(hljs) {
     }
   }
 
+  /**
+   * Remove a language grammar module
+   *
+   * @param {string} languageName
+   */
+  function unregisterLanguage(languageName) {
+    delete languages[languageName];
+    for(const alias of Object.keys(aliases)) {
+      if(aliases[alias] === languageName) {
+        delete aliases[alias];
+      }
+    }
+  }
+
   /**
    * @returns {string[]} List of language internal names
    */
@@ -916,6 +930,7 @@ const HLJS = function(hljs) {
     initHighlighting,
     initHighlightingOnLoad,
     registerLanguage,
+    unregisterLanguage,
     listLanguages,
     getLanguage,
     registerAliases,

test/api/index.js

@@ -12,6 +12,7 @@ describe('hljs', function() {
   require('./keywords');
   require('./number');
   require('./registerAlias');
+  require('./unregisterLanguage');
   require('./starters');
   require('./underscoreIdent');
 });

test/api/unregisterLanguage.js

@@ -0,0 +1,38 @@
+"use strict";
+
+const hljs = require("../../build");
+
+let grammar = function () {
+  return {
+    contains: [{ beginKeywords: "class" }],
+  };
+};
+
+describe(".unregisterLanguage()", () => {
+  beforeEach(() => {
+    hljs.registerLanguage("test", grammar);
+  });
+
+  it("should remove an existing language", () => {
+    hljs.unregisterLanguage("test");
+    const result = hljs.getLanguage("test");
+
+    (result == null).should.be.true();
+  });
+
+  it("should remove an existing language and its aliases", () => {
+    hljs.registerAliases(["jquery", "jqueryui"], {
+      languageName: "test",
+    });
+
+    {
+        const result = hljs.getLanguage("jquery");
+        (result == null).should.be.false();
+    }
+    hljs.unregisterLanguage("test");
+    {
+        const result = hljs.getLanguage("jquery");
+        (result == null).should.be.true();
+    }
+  });
+});

types/index.d.ts

@@ -24,6 +24,7 @@ interface PublicApi {
     initHighlightingOnLoad: () => void
     highlightAll: () => void
     registerLanguage: (languageName: string, language: LanguageFn) => void
+    unregisterLanguage: (languageName: string) => void
     listLanguages: () => string[]
     registerAliases: (aliasList: string | string[], { languageName } : {languageName: string}) => void
     getLanguage: (languageName: string) => Language | undefined