From 40120a6241013040a7de7bd163fd55d691d66a1c Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 18 Dec 2019 21:24:33 +0100 Subject: [PATCH] Fixed highlighting of search terms --- .../javascripts/modules/search/_/index.ts | 2 +- .../modules/search/highlight/index.ts | 91 +++++++++++++++++++ 2 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 src/assets/javascripts/modules/search/highlight/index.ts diff --git a/src/assets/javascripts/modules/search/_/index.ts b/src/assets/javascripts/modules/search/_/index.ts index 7b8f1c2bc..8bd947e7d 100644 --- a/src/assets/javascripts/modules/search/_/index.ts +++ b/src/assets/javascripts/modules/search/_/index.ts @@ -190,7 +190,7 @@ export class Search { */ public search(query: string): SearchResult[] { query = query - .replace(/(?:^|\s+)[+-:~^]+(?=\s+|$)/g, "") + .replace(/(?:^|\s+)[*+-:^~]+(?=\s+|$)/g, "") .trim() /* Abort early, if query is empty */ diff --git a/src/assets/javascripts/modules/search/highlight/index.ts b/src/assets/javascripts/modules/search/highlight/index.ts new file mode 100644 index 000000000..de901df6e --- /dev/null +++ b/src/assets/javascripts/modules/search/highlight/index.ts @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2016-2019 Martin Donath + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +import * as escapeRegExp from "escape-string-regexp" + +import { SearchIndexConfig } from "../_" +import { SearchDocument } from "../document" + +/* ---------------------------------------------------------------------------- + * Types + * ------------------------------------------------------------------------- */ + +/** + * Search highlight function + * + * @template T - Search document type + * + * @param document - Search document + * + * @return Highlighted document + */ +export type SearchHighlightFn = + (document: Readonly) => T + +/** + * Search highlight factory function + * + * @param query - Query string + * + * @return Search highlight function + */ +export type SearchHighlightFactoryFn = + (query: string) => SearchHighlightFn + +/* ---------------------------------------------------------------------------- + * Functions + * ------------------------------------------------------------------------- */ + +/** + * Create a search highlighter + * + * @param config - Search index configuration + * + * @return Search highlight function + */ +export function setupSearchHighlighter( + config: SearchIndexConfig +): SearchHighlightFactoryFn { + const separator = new RegExp(config.separator, "img") + const highlight = (_: unknown, data: string, term: string) => { + return `${data}${term}` + } + + /* Return factory function */ + return (query: string) => { + query = query + .replace(/[\s*+-:~^]+/g, " ") + .trim() + + /* Create search term match expression */ + const match = new RegExp(`(^|${config.separator})(${ + escapeRegExp(query).replace(separator, "|") + })`, "img") + + /* Highlight document */ + return document => ({ + ...document, + title: document.title.replace(match, highlight), + text: document.text.replace(match, highlight) + }) + } +}