From 14b89105dc10eeb3b9b48abf16eda2b9420c64a0 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 31 Jul 2022 17:54:23 +0000
Subject: [PATCH] refactor: move search utils to util.js
---
layouts/partials/search.html | 14 +
assets/js/search.js | 207 -------------------------
assets/js/util.js | 207 +++++++++++++++++++++++++
layouts/partials/head.html | 9
4 files changed, 224 insertions(+), 213 deletions(-)
diff --git a/assets/js/search.js b/assets/js/search.js
index d32d985..d296e65 100644
--- a/assets/js/search.js
+++ b/assets/js/search.js
@@ -1,115 +1,4 @@
-// code from https://github.com/danestves/markdown-to-text
-const removeMarkdown = (
- markdown,
- options = {
- listUnicodeChar: false,
- stripListLeaders: true,
- gfm: true,
- useImgAltText: false,
- preserveLinks: false,
- },
-) => {
- let output = markdown || ""
- output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "")
-
- try {
- if (options.stripListLeaders) {
- if (options.listUnicodeChar)
- output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, options.listUnicodeChar + " $1")
- else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1")
- }
- if (options.gfm) {
- output = output
- .replace(/\n={2,}/g, "\n")
- .replace(/~{3}.*\n/g, "")
- .replace(/~~/g, "")
- .replace(/`{3}.*\n/g, "")
- }
- if (options.preserveLinks) {
- output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
- }
- output = output
- .replace(/<[^>]*>/g, "")
- .replace(/^[=\-]{2,}\s*$/g, "")
- .replace(/\[\^.+?\](\: .*?$)?/g, "")
- .replace(/(#{1,6})\s+(.+)\1?/g, "<b>$2</b>")
- .replace(/\s{0,2}\[.*?\]: .*?$/g, "")
- .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
- .replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "<a>$1</a>")
- .replace(/!?\[\[\S[^\[\]\|]*(?:\|([^\[\]]*))?\S\]\]/g, "<a>$1</a>")
- .replace(/^\s{0,3}>\s?/g, "")
- .replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
- .replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
- .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
- .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
- .replace(/(`{3,})(.*?)\1/gm, "$2")
- .replace(/`(.+?)`/g, "$1")
- .replace(/\n{2,}/g, "\n\n")
- .replace(/\[![a-zA-Z]+\][-\+]? /g, "")
- } catch (e) {
- console.error(e)
- return markdown
- }
- return output
-}
-// -----
-
-const highlight = (content, term) => {
- const highlightWindow = 20
-
- // try to find direct match first
- const directMatchIdx = content.indexOf(term)
- if (directMatchIdx !== -1) {
- const h = highlightWindow / 2
- const before = content.substring(0, directMatchIdx).split(" ").slice(-h)
- const after = content
- .substring(directMatchIdx + term.length, content.length - 1)
- .split(" ")
- .slice(0, h)
- return (
- (before.length == h ? `...${before.join(" ")}` : before.join(" ")) +
- `<span class="search-highlight">${term}</span>` +
- after.join(" ")
- )
- }
-
- const tokenizedTerm = term.split(/\s+/).filter((t) => t !== "")
- const splitText = content.split(/\s+/).filter((t) => t !== "")
- const includesCheck = (token) =>
- tokenizedTerm.some((term) => token.toLowerCase().startsWith(term.toLowerCase()))
-
- const occurrencesIndices = splitText.map(includesCheck)
-
- // calculate best index
- let bestSum = 0
- let bestIndex = 0
- for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
- const window = occurrencesIndices.slice(i, i + highlightWindow)
- const windowSum = window.reduce((total, cur) => total + cur, 0)
- if (windowSum >= bestSum) {
- bestSum = windowSum
- bestIndex = i
- }
- }
-
- const startIndex = Math.max(bestIndex - highlightWindow, 0)
- const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
- const mappedText = splitText
- .slice(startIndex, endIndex)
- .map((token) => {
- if (includesCheck(token)) {
- return `<span class="search-highlight">${token}</span>`
- }
- return token
- })
- .join(" ")
- .replaceAll('</span> <span class="search-highlight">', " ")
- return `${startIndex === 0 ? "" : "..."}${mappedText}${
- endIndex === splitText.length ? "" : "..."
- }`
-}
-
-;(async function () {
+; (async function() {
const encoder = (str) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])+/)
const contentIndex = new FlexSearch.Document({
cache: true,
@@ -138,25 +27,6 @@
})
}
- const resultToHTML = ({ url, title, content, term }) => {
- const text = removeMarkdown(content)
- const resultTitle = highlight(title, term)
- const resultText = highlight(text, term)
- return `<button class="result-card" id="${url}">
- <h3>${resultTitle}</h3>
- <p>${resultText}</p>
- </button>`
- }
-
- const redir = (id, term) => {
- // SPA navigation
- window.Million.navigate(
- new URL(`${BASE_URL.replace(/\/$/g, "")}${id}#:~:text=${encodeURIComponent(term)}/`),
- ".singlePage",
- )
- closeSearch()
- }
-
const formatForDisplay = (id) => ({
id,
url: id,
@@ -164,16 +34,7 @@
content: content[id].content,
})
- const source = document.getElementById("search-bar")
- const results = document.getElementById("results-container")
- let term
- source.addEventListener("keyup", (e) => {
- if (e.key === "Enter") {
- const anchor = document.getElementsByClassName("result-card")[0]
- redir(anchor.id, term)
- }
- })
- source.addEventListener("input", (e) => {
+ registerHandlers((e) => {
term = e.target.value
const searchResults = contentIndex.search(term, [
{
@@ -195,68 +56,6 @@
}
const allIds = new Set([...getByField("title"), ...getByField("content")])
const finalResults = [...allIds].map(formatForDisplay)
-
- // display
- if (finalResults.length === 0) {
- results.innerHTML = `<button class="result-card">
- <h3>No results.</h3>
- <p>Try another search term?</p>
- </button>`
- } else {
- results.innerHTML = finalResults
- .map((result) =>
- resultToHTML({
- ...result,
- term,
- }),
- )
- .join("\n")
- const anchors = [...document.getElementsByClassName("result-card")]
- anchors.forEach((anchor) => {
- anchor.onclick = () => redir(anchor.id, term)
- })
- }
- })
-
- const searchContainer = document.getElementById("search-container")
-
- function openSearch() {
- if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
- source.value = ""
- results.innerHTML = ""
- searchContainer.style.display = "block"
- source.focus()
- } else {
- searchContainer.style.display = "none"
- }
- }
-
- function closeSearch() {
- searchContainer.style.display = "none"
- }
-
- document.addEventListener("keydown", (event) => {
- if (event.key === "k" && (event.ctrlKey || event.metaKey)) {
- event.preventDefault()
- openSearch()
- }
- if (event.key === "Escape") {
- event.preventDefault()
- closeSearch()
- }
- })
-
- const searchButton = document.getElementById("search-icon")
- searchButton.addEventListener("click", (evt) => {
- openSearch()
- })
- searchButton.addEventListener("keydown", (evt) => {
- openSearch()
- })
- searchContainer.addEventListener("click", (evt) => {
- closeSearch()
- })
- document.getElementById("search-space").addEventListener("click", (evt) => {
- evt.stopPropagation()
+ displayResults(finalResults)
})
})()
diff --git a/assets/js/util.js b/assets/js/util.js
new file mode 100644
index 0000000..c465238
--- /dev/null
+++ b/assets/js/util.js
@@ -0,0 +1,207 @@
+// code from https://github.com/danestves/markdown-to-text
+const removeMarkdown = (
+ markdown,
+ options = {
+ listUnicodeChar: false,
+ stripListLeaders: true,
+ gfm: true,
+ useImgAltText: false,
+ preserveLinks: false,
+ },
+) => {
+ let output = markdown || ""
+ output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "")
+
+ try {
+ if (options.stripListLeaders) {
+ if (options.listUnicodeChar)
+ output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, options.listUnicodeChar + " $1")
+ else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1")
+ }
+ if (options.gfm) {
+ output = output
+ .replace(/\n={2,}/g, "\n")
+ .replace(/~{3}.*\n/g, "")
+ .replace(/~~/g, "")
+ .replace(/`{3}.*\n/g, "")
+ }
+ if (options.preserveLinks) {
+ output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
+ }
+ output = output
+ .replace(/<[^>]*>/g, "")
+ .replace(/^[=\-]{2,}\s*$/g, "")
+ .replace(/\[\^.+?\](\: .*?$)?/g, "")
+ .replace(/(#{1,6})\s+(.+)\1?/g, "<b>$2</b>")
+ .replace(/\s{0,2}\[.*?\]: .*?$/g, "")
+ .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
+ .replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "<a>$1</a>")
+ .replace(/!?\[\[\S[^\[\]\|]*(?:\|([^\[\]]*))?\S\]\]/g, "<a>$1</a>")
+ .replace(/^\s{0,3}>\s?/g, "")
+ .replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
+ .replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
+ .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
+ .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
+ .replace(/(`{3,})(.*?)\1/gm, "$2")
+ .replace(/`(.+?)`/g, "$1")
+ .replace(/\n{2,}/g, "\n\n")
+ .replace(/\[![a-zA-Z]+\][-\+]? /g, "")
+ } catch (e) {
+ console.error(e)
+ return markdown
+ }
+ return output
+}
+
+const highlight = (content, term) => {
+ const highlightWindow = 20
+
+ // try to find direct match first
+ const directMatchIdx = content.indexOf(term)
+ if (directMatchIdx !== -1) {
+ const h = highlightWindow / 2
+ const before = content.substring(0, directMatchIdx).split(" ").slice(-h)
+ const after = content
+ .substring(directMatchIdx + term.length, content.length - 1)
+ .split(" ")
+ .slice(0, h)
+ return (
+ (before.length == h ? `...${before.join(" ")}` : before.join(" ")) +
+ `<span class="search-highlight">${term}</span>` +
+ after.join(" ")
+ )
+ }
+
+ const tokenizedTerm = term.split(/\s+/).filter((t) => t !== "")
+ const splitText = content.split(/\s+/).filter((t) => t !== "")
+ const includesCheck = (token) =>
+ tokenizedTerm.some((term) => token.toLowerCase().startsWith(term.toLowerCase()))
+
+ const occurrencesIndices = splitText.map(includesCheck)
+
+ // calculate best index
+ let bestSum = 0
+ let bestIndex = 0
+ for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
+ const window = occurrencesIndices.slice(i, i + highlightWindow)
+ const windowSum = window.reduce((total, cur) => total + cur, 0)
+ if (windowSum >= bestSum) {
+ bestSum = windowSum
+ bestIndex = i
+ }
+ }
+
+ const startIndex = Math.max(bestIndex - highlightWindow, 0)
+ const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
+ const mappedText = splitText
+ .slice(startIndex, endIndex)
+ .map((token) => {
+ if (includesCheck(token)) {
+ return `<span class="search-highlight">${token}</span>`
+ }
+ return token
+ })
+ .join(" ")
+ .replaceAll('</span> <span class="search-highlight">', " ")
+ return `${startIndex === 0 ? "" : "..."}${mappedText}${endIndex === splitText.length ? "" : "..."
+ }`
+}
+
+// Common utilities for search
+const resultToHTML = ({ url, title, content, term }) => {
+ const text = removeMarkdown(content)
+ const resultTitle = highlight(title, term)
+ const resultText = highlight(text, term)
+ return `<button class="result-card" id="${url}">
+ <h3>${resultTitle}</h3>
+ <p>${resultText}</p>
+ </button>`
+}
+
+const redir = (id, term) => {
+ // SPA navigation
+ window.Million.navigate(
+ new URL(`${BASE_URL.replace(/\/$/g, "")}${id}#:~:text=${encodeURIComponent(term)}/`),
+ ".singlePage",
+ )
+ closeSearch()
+}
+
+function openSearch() {
+ const source = document.getElementById("search-bar")
+ const results = document.getElementById("results-container")
+ const searchContainer = document.getElementById("search-container")
+ if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
+ source.value = ""
+ results.innerHTML = ""
+ searchContainer.style.display = "block"
+ source.focus()
+ } else {
+ searchContainer.style.display = "none"
+ }
+}
+
+function closeSearch() {
+ const searchContainer = document.getElementById("search-container")
+ searchContainer.style.display = "none"
+}
+
+const registerHandlers = (onInputFn) => {
+ const source = document.getElementById("search-bar")
+ const searchContainer = document.getElementById("search-container")
+ let term
+ source.addEventListener("keyup", (e) => {
+ if (e.key === "Enter") {
+ const anchor = document.getElementsByClassName("result-card")[0]
+ redir(anchor.id, term)
+ }
+ })
+ source.addEventListener("input", onInputFn)
+ document.addEventListener("keydown", (event) => {
+ if (event.key === "k" && (event.ctrlKey || event.metaKey)) {
+ event.preventDefault()
+ openSearch()
+ }
+ if (event.key === "Escape") {
+ event.preventDefault()
+ closeSearch()
+ }
+ })
+
+ const searchButton = document.getElementById("search-icon")
+ searchButton.addEventListener("click", (_) => {
+ openSearch()
+ })
+ searchButton.addEventListener("keydown", (_) => {
+ openSearch()
+ })
+ searchContainer.addEventListener("click", (_) => {
+ closeSearch()
+ })
+ document.getElementById("search-space").addEventListener("click", (evt) => {
+ evt.stopPropagation()
+ })
+}
+
+const displayResults = (finalResults) => {
+ const results = document.getElementById("results-container")
+ if (finalResults.length === 0) {
+ results.innerHTML = `<button class="result-card">
+ <h3>No results.</h3>
+ <p>Try another search term?</p>
+ </button>`
+ } else {
+ results.innerHTML = finalResults
+ .map((result) =>
+ resultToHTML({
+ ...result,
+ term,
+ }),
+ )
+ .join("\n")
+ const anchors = [...document.getElementsByClassName("result-card")]
+ anchors.forEach((anchor) => {
+ anchor.onclick = () => redir(anchor.id, term)
+ })
+ }
+}
diff --git a/layouts/partials/head.html b/layouts/partials/head.html
index 60db998..acc2efd 100644
--- a/layouts/partials/head.html
+++ b/layouts/partials/head.html
@@ -40,10 +40,13 @@
<link href="{{$lightSyntax.Permalink}}" rel="stylesheet" id="theme-link">
<!-- Base scripts -->
- {{ $darkMode := resources.Get "js/darkmode.js" | resources.ExecuteAsTemplate "js/darkmode.js" . | resources.Fingerprint "md5" | resources.Minify }}
- <script src="{{$darkMode.Permalink}}"></script>
+ {{$scripts := (slice "js/darkmode.js" "js/util.js")}}
+ {{range $scripts}}
+ {{$scriptname := .}}
+ {{ $s := resources.Get $scriptname | resources.ExecuteAsTemplate $scriptname . | resources.Fingerprint "md5" | resources.Minify }}
+ <script src="{{$s.Permalink}}"></script>
+ {{end}}
{{partial "katex.html" .}}
-
<script src="https://unpkg.com/@floating-ui/core@0.7.3"></script>
<script src="https://unpkg.com/@floating-ui/dom@0.5.4"></script>
diff --git a/layouts/partials/search.html b/layouts/partials/search.html
index f727184..5b0bbb7 100644
--- a/layouts/partials/search.html
+++ b/layouts/partials/search.html
@@ -1,10 +1,12 @@
<div id="search-container">
- <div id="search-space">
- <input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search" placeholder="Search for something...">
- <div id="results-container">
- </div>
+ <div id="search-space">
+ <input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search"
+ placeholder="Search for something...">
+ <div id="results-container">
</div>
+ </div>
</div>
-<script src="https://cdn.jsdelivr.net/npm/flexsearch@0.7.21/dist/flexsearch.bundle.js" integrity="sha256-i3A0NZGkhsKjVMzFxv3ksk0DZh3aXqu0l49Bbh0MdjE=" crossorigin="anonymous" defer></script>
-{{ $js := resources.Get "js/search.js" | resources.Fingerprint "md5" | resources.Minify }}
+<script src="https://cdn.jsdelivr.net/npm/flexsearch@0.7.21/dist/flexsearch.bundle.js"
+ integrity="sha256-i3A0NZGkhsKjVMzFxv3ksk0DZh3aXqu0l49Bbh0MdjE=" crossorigin="anonymous" defer></script>
+{{ $js := resources.Get "js/search.js" | resources.Fingerprint "md5" | resources.Minify }}
<script defer src="{{ $js.Permalink }}"></script>
--
Gitblit v1.10.0