The docsify-lunr-search from kiwicom

docsify-lunr-search's People

Contributors

Stargazers

Watchers

docsify-lunr-search's Issues

[BUG] Leveraging "+" Lunr Operator

Context

Lunr leverages "+" as a word prefix to indicate it must be present within a document. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”:

idx.search("+foo bar -baz")

This particular plugin layers additional functionality after the Lunr search. It leverages the query to highlight the resultant matches.

The bug

The query is fed directly into the RegExp constructor which causes a failure for a query of the form "+foo" with the following error:

Bug location:

docsify-lunr-search/search.js

Line 142 in 8745b0a

var regEx = new RegExp("(" + query + ")", "ig");

        if (body != "") {
          var regEx = new RegExp("(" + query + ")", "ig"); // <---- This is where the bug occurs
          content += escapeHtml(body.substring(start, end)).replace(
            regEx, ("<em class=\"search-keyword\">$1</em>")) + "...";
        }

Potential Fix

A quick hack might be to remove + from the query string:

    if (query) {
          var escapedQuery = query.replace(/\+/g, "");

          if (escapedQuery) {
            var queryParts = escapedQuery.split(" ");

            var substring = body.substring(start, end);
            for (var i = 0; i < queryParts.length; i++) {
              var queryPart = queryParts[i];
              var regEx = new RegExp("(" + queryPart + ")", "ig");
              substring = substring.replace(
                regEx, ("<em class=\"search-keyword\">$1</em>"));
            }
            
            content += substring + "...";
          }
        }