Implemented support for AND search with quotation marks

This commit is contained in:
squidfunk 2020-06-28 12:05:15 +02:00
parent e2d8a0e3ca
commit 83bba6bee4
7 changed files with 33 additions and 11 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1,6 +1,6 @@
{ {
"assets/javascripts/bundle.js": "assets/javascripts/bundle.38f5c9b5.min.js", "assets/javascripts/bundle.js": "assets/javascripts/bundle.8db80c2a.min.js",
"assets/javascripts/bundle.js.map": "assets/javascripts/bundle.38f5c9b5.min.js.map", "assets/javascripts/bundle.js.map": "assets/javascripts/bundle.8db80c2a.min.js.map",
"assets/javascripts/vendor.js": "assets/javascripts/vendor.de50e36d.min.js", "assets/javascripts/vendor.js": "assets/javascripts/vendor.de50e36d.min.js",
"assets/javascripts/vendor.js.map": "assets/javascripts/vendor.de50e36d.min.js.map", "assets/javascripts/vendor.js.map": "assets/javascripts/vendor.de50e36d.min.js.map",
"assets/javascripts/worker/search.js": "assets/javascripts/worker/search.9b3611bd.min.js", "assets/javascripts/worker/search.js": "assets/javascripts/worker/search.9b3611bd.min.js",

View File

@ -183,7 +183,7 @@
</div> </div>
{% block scripts %} {% block scripts %}
<script src="{{ 'assets/javascripts/vendor.de50e36d.min.js' | url }}"></script> <script src="{{ 'assets/javascripts/vendor.de50e36d.min.js' | url }}"></script>
<script src="{{ 'assets/javascripts/bundle.38f5c9b5.min.js' | url }}"></script> <script src="{{ 'assets/javascripts/bundle.8db80c2a.min.js' | url }}"></script>
{%- set translations = {} -%} {%- set translations = {} -%}
{%- for key in [ {%- for key in [
"clipboard.copy", "clipboard.copy",

View File

@ -40,8 +40,24 @@ export type SearchTransformFn = (value: string) => string
/** /**
* Default transformation function * Default transformation function
* *
* Rogue control characters are filtered before handing the query to the * 1. Search for terms in quotation marks and prepend a `+` modifier to denote
* search index, as `lunr` will throw otherwise. * that the resulting document must contain all terms, converting the query
* to and `AND` query (as opposed to the default `OR` behavior). While users
* may expected terms enclosed in quotation marks to map to span queries,
* i.e. for which order is important, `lunr` doesn't support them, so the
* best we can do is to convert the terms to an `AND` query.
*
* 2. Replace control characters which are not located at the beginning of the
* query or preceded by white space, or are not followed by a non-whitespace
* character or are at the end of the query string. Furthermore, filter
* unmatched quotation marks.
*
* 3. Trim excess whitespace from left and right.
*
* 4. Append a wildcard to the end of every word to make every word a prefix
* query in order to provide a good type-ahead experience, by adding an
* asterisik (wildcard) in between terms, which can be denoted by whitespace,
* any non-control character, or a word boundary.
* *
* @param value - Query value * @param value - Query value
* *
@ -49,7 +65,13 @@ export type SearchTransformFn = (value: string) => string
*/ */
export function defaultTransform(value: string): string { export function defaultTransform(value: string): string {
return value return value
.replace(/(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") .split(/"([^"]+)"/) /* => 1 */
.trim() .map((terms, i) => i & 1
.replace(/\s+|(?![^\x00-\x7F]|^)$|\b$/g, "* ") ? terms.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g, " +")
: terms
)
.join("")
.replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") /* => 2 */
.trim() /* => 3 */
.replace(/\s+|(?![^\x00-\x7F]|^)$|\b$/g, "* ") /* => 4 */
} }