Bugfix/spaces in headings (#6)

* Fix README typos
* Add failing test for code-block text replacement behaviour
* Change implementation to make test pass
* Update the example to demonstrate the bug fix
* Add screenshot to the readme

Author: stijn-dejongh

README.md

@@ -6,7 +6,9 @@ Simple Glossary for Docsify that replaces occurrences of words in text with link
 Forked from [TheGreenToaster/docsify-glossary](https://github.com/TheGreenToaster/docsify-glossary) as the original
 project was unmaintained for over 3 years, to address a couple of usability issues with the original script.
 
-An example usage can be found here [./example](./example), it is deployed automatically to this [github page](https://stijn-dejongh.github.io/docsify-glossary/#/).
+An example usage can be found here [./example](./example), it is deployed automatically to this [GitHub page](https://stijn-dejongh.github.io/docsify-glossary/#/).
+
+![Example of the glossary replacements](./example_output.png)
 
 ## Installation
 
@@ -19,9 +21,9 @@ An example usage can be found here [./example](./example), it is deployed automa
 1. Create a `_glossary.md` file in the root directory
 2. Populate the `_glossary.md` file with terms.
 
-## Plugim Usage
+## Plugin Usage
 
-* Terms must be predicated with a consistent markdown heading to get recognized by the glossary (see configuration)
+* Terms must be predicated with a consistent Markdown heading to get recognized by the glossary (see configuration)
 * Terms are replaced with links in the order that they appear in the glossary file.
   * This is especially relevant for nested terminology ( e.g. _API_ and _API Usage_)
 
@@ -41,10 +43,13 @@ We recommend using [Node Version Manager](https://npm.github.io/installation-set
 
 Once the code has been built, you can launch the example website illustrating the use of the glossary.
 In order to do so: 
-3. Go to [http://localhost:3000/]()
+
+1. Go to [http://localhost:3000/]()
+2. copy the latest version of the code into the example website: `cp ./dist/@stijn-dejongh/docsify-glossary* ./example`
+3. Run `docsify serve example`
 
 ## Changelog
-Simple Glossary for Docsify
+
 An overview of all the changes made to this codebase can be found in the [CHANGELOG](./CHANGELOG.md) file included in this repository.
 
 ## TODO list
@@ -54,9 +59,8 @@ An overview of all the changes made to this codebase can be found in the [CHANGE
 * [x] make glossary file name/location configurable, see [feature request #1](https://github.com/TheGreenToaster/docsify-glossary/issues/1)
 * [x] make terminology heading depth configurable, see [feature request #1](https://github.com/TheGreenToaster/docsify-glossary/issues/1)
 * [x] fix issue with terminology replacements in page headers/titles, see: [bug report #6](https://github.com/TheGreenToaster/docsify-glossary/issues/6)
-* [ ] fix issue with terminology replacements in code blocks, see: [bug report #4](https://github.com/TheGreenToaster/docsify-glossary/issues/4)
+* [x] fix issue with terminology replacements in code blocks, see: [bug report #4](https://github.com/TheGreenToaster/docsify-glossary/issues/4)
 * [x] fix issue with multiple word terms, see: [bug report #13]([bug report #13](https://github.com/TheGreenToaster/docsify-glossary/issues/13))
 
 
-1. copy the latest version of the code into the example website: `cp ./dist/@stijn-dejongh/docsify-glossary* ./example`
-2. Run `docsify serve example`
+

example/README.md

@@ -5,6 +5,16 @@ Mizzen galleon aye Pirate Round capstan grapple jolly boat American Main tackle
 Yellow Jack case shot Nelsons folly ye interloper gangway Sink me heave to capstan lanyard. Starboard bucko long boat chase spike gunwalls piracy log aft brigantine. Skysail piracy fathom sheet gangway transom boom Spanish Main tackle pressgang.
 
 Crack Jennys tea cup Buccaneer broadside Cat o'nine tails weigh anchor bilge water scurvy jolly boat crimp haul wind. Grog take a caulk brigantine spanker haul wind knave Yellow Jack bounty poop deck red ensign. Hogshead scourge of the seven seas interloper Admiral of the Black draught pillage black spot trysail hang the jib marooned.  
-  
-  
+
+Here is some code to help the English pirate hunters find the notorious pirate Jack Rackham:
+```java
+public void findJackRakham() {
+    for(Pirate pirate : islandPopulation.getPirates()) {
+        // The infamous pirate admiral Jack Rackham? Oh look, there he is!
+        return pirate.hasFirstName("Jack") && pirate.hasLastName("Rackham");
+    }
+}
+```
+
+
 Yellow Jack was an Admiral, Admiral, Admiral. (This Admiral line was added to demonstrate multiple replacements, as mentioned in [issue nr 13](https://github.com/TheGreenToaster/docsify-glossary/issues/13))

example/_glossary.md

@@ -6,10 +6,19 @@
 
 A commander of a fleet or naval squadron, or a naval officer of very high rank.
 
-## B - X
+## B - I
 
 Nothing here....
 
+## J
+
+### Jack Rackham
+
+Jack Rackham was a gentleman pirate with flamboyant fashion sense and a way with female pirates who were dressed like men– notably, Anne Bonny and Mary Read.
+
+
+## K - X
+
 ## Y
 
 ### Yellow Jack

example/docsify-glossary.js

@@ -9,7 +9,10 @@ this["@stijn-dejongh/docsify-glossary"] = this["@stijn-dejongh/docsify-glossary"
 
 this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
     "use strict";
-    function replaceTermInLine(term, contentLine, linkId) {
+    function replaceTermInLine(term, contentLine, linkId, config) {
+        if (isTitle(contentLine) && !config.replaceTitleTerms) {
+            return contentLine;
+        }
         var re = new RegExp("\\s(".concat(term, ")[\\s$]"), "ig");
         var reFullStop = new RegExp("\\s(".concat(term, ")."), "ig");
         var reComma = new RegExp("\\s(".concat(term, "),"), "ig");
@@ -20,11 +23,17 @@ this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
     function isTitle(line) {
         return line.trim().startsWith("#");
     }
-    function replaceTerm(content, term, linkId) {
-        var contentLines = content.split("\n");
+    function replaceTerm(content, term, linkId, config) {
         var processedText = "";
-        contentLines.forEach((function(line, _index) {
-            var replacedLine = line.trim().length > 0 ? replaceTermInLine(term, line + " ", linkId).trimEnd() : line;
+        var codeBlockContext = false;
+        content.split("\n").forEach((function(line, _index) {
+            if (line.trim().startsWith("```")) {
+                codeBlockContext = !codeBlockContext;
+            }
+            var replacedLine = line;
+            if (line.trim().length > 0 && !codeBlockContext) {
+                replacedLine = replaceTermInLine(term, line + " ", linkId, config).trimEnd();
+            }
             processedText += replacedLine + "\n";
         }));
         return processedText;
@@ -35,7 +44,7 @@ this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
             console.log("Adding links for terminology: ".concat(terms));
         }
         for (var term in terms) {
-            textWithReplacements = replaceTerm(textWithReplacements, term, terms[term]);
+            textWithReplacements = replaceTerm(textWithReplacements, term, terms[term], config);
         }
         return textWithReplacements;
     }
@@ -117,6 +126,7 @@ this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
             _defineProperty(this, "terminologyHeading", "");
             _defineProperty(this, "glossaryLocation", "");
             _defineProperty(this, "debug", false);
+            _defineProperty(this, "replaceTitleTerms", true);
             this.terminologyHeading = DEFAULT_TERM_HEADING;
             this.glossaryLocation = DEFAULT_GLOSSARY_FILE_NAME;
         }
@@ -138,6 +148,12 @@ this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
                 this.debug = enableDebug;
                 return this;
             }
+        }, {
+            key: "withTitleTermReplacement",
+            value: function withTitleTermReplacement(enableTitleTermReplacement) {
+                this.replaceTitleTerms = enableTitleTermReplacement;
+                return this;
+            }
         }, {
             key: "build",
             value: function build() {
@@ -147,8 +163,8 @@ this["@stijn-dejongh/docsify-glossary"].js = function(exports) {
         return GlossaryConfigurationBuilder;
     }();
     function configFromYaml(configurationYaml) {
-        var _configurationYaml$te, _configurationYaml$gl, _configurationYaml$de;
-        return (new GlossaryConfigurationBuilder).withTermHeading((_configurationYaml$te = configurationYaml.terminologyHeading) !== null && _configurationYaml$te !== void 0 ? _configurationYaml$te : DEFAULT_TERM_HEADING).withGlossaryLocation((_configurationYaml$gl = configurationYaml.glossaryLocation) !== null && _configurationYaml$gl !== void 0 ? _configurationYaml$gl : DEFAULT_GLOSSARY_FILE_NAME).withDebugEnabled((_configurationYaml$de = configurationYaml.debug) !== null && _configurationYaml$de !== void 0 ? _configurationYaml$de : false).build();
+        var _configurationYaml$te, _configurationYaml$gl, _configurationYaml$de, _configurationYaml$re;
+        return (new GlossaryConfigurationBuilder).withTermHeading((_configurationYaml$te = configurationYaml.terminologyHeading) !== null && _configurationYaml$te !== void 0 ? _configurationYaml$te : DEFAULT_TERM_HEADING).withGlossaryLocation((_configurationYaml$gl = configurationYaml.glossaryLocation) !== null && _configurationYaml$gl !== void 0 ? _configurationYaml$gl : DEFAULT_GLOSSARY_FILE_NAME).withDebugEnabled((_configurationYaml$de = configurationYaml.debug) !== null && _configurationYaml$de !== void 0 ? _configurationYaml$de : false).withTitleTermReplacement((_configurationYaml$re = configurationYaml.replaceTitleTerms) !== null && _configurationYaml$re !== void 0 ? _configurationYaml$re : true).build();
     }
     function defaultGlossifyConfig() {
         return (new GlossaryConfigurationBuilder).build();

example/docsify-glossary.min.js

@@ -1,6 +1,6 @@
 function replaceTermInLine(term, contentLine, linkId, config) {
     if(isTitle(contentLine) && !config.replaceTitleTerms) {
-        // Intentially not combined in the return statement, to avoid superfluous calculations
+        // Intentionally not combined in the return statement, to avoid superfluous calculations
         return contentLine;
     }
 
@@ -23,13 +23,21 @@ function isTitle(line) {
 }
 
 export function replaceTerm(content, term, linkId, config) {
-    let contentLines = content.split('\n');
     let processedText = '';
 
-    contentLines.forEach( (line, _index) => {
-        let replacedLine = line.trim().length > 0 ? replaceTermInLine(term, line + ' ', linkId, config).trimEnd() : line;
+    let codeBlockContext = false;
+    content.split('\n').forEach( (line, _index) => {
+        if(line.trim().startsWith('```')) {
+            codeBlockContext = !codeBlockContext;
+        }
+
+        let replacedLine = line;
+        if(line.trim().length > 0 && !codeBlockContext) {
+            replacedLine = replaceTermInLine(term, line + ' ', linkId, config).trimEnd();
+        }
         processedText += replacedLine + '\n';
     });
+
     return processedText;
 }