Squashed commit of the following:

commit ac82511ddd17d5472ae3cfea9bbad9754f5a4d62 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Sat Oct 22 08:23:42 2022 +0200 Screw that cache, seriously. commit 8ba40d1be73daaaffea09e07bc56c339266db9b6 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Fri Oct 21 22:36:48 2022 +0200 Stuff commit 27b8fd7dc809be9714a109d3a458eb1276a47e2e Author: Simon Cambier <simon.cambier@protonmail.com> Date: Fri Oct 21 22:22:20 2022 +0200 Moved files commit fb1349c914907e586e103ca54fb04b9ddd45ef5d Author: Simon Cambier <simon.cambier@protonmail.com> Date: Thu Oct 20 22:25:29 2022 +0200 Removed duplicate code commit e7371138e60cbe4155cfd4fb44e3ee1d2e3ee088 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Thu Oct 20 21:50:09 2022 +0200 Moved a bunch of files commit 2ee1b2a0e799d4b41ab3a444d8cc44dfff5b5623 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Thu Oct 20 21:32:21 2022 +0200 Removed useless code commit 76c530dfb9adbad1bbe9079de2330fe43a044249 Author: Simon Cambier <simon.cambier@protonmail.com> Date: Thu Oct 20 20:44:11 2022 +0200 Split file reading and indexing
2022-10-22 08:25:34 +02:00
parent 1376cea282
commit c2ecdd79ad
25 changed files with 338 additions and 403 deletions
--- a/src/tools/utils.ts
+++ b/src/tools/utils.ts
@@ -0,0 +1,203 @@
+import { type CachedMetadata, Platform } from 'obsidian'
+import type { SearchMatch } from '../globals'
+import {
+  excerptAfter,
+  excerptBefore,
+  highlightClass,
+  isSearchMatch,
+  regexLineSplit,
+  regexStripQuotes,
+  regexYaml,
+} from '../globals'
+import { settings } from '../settings'
+import { type BinaryLike, createHash } from 'crypto'
+import { md5 } from 'pure-md5'
+
+export function highlighter(str: string): string {
+  return `<span class="${highlightClass}">${str}</span>`
+}
+
+export function escapeHTML(html: string): string {
+  return html
+    .replaceAll('&', '&amp;')
+    .replaceAll('<', '&lt;')
+    .replaceAll('>', '&gt;')
+    .replaceAll('"', '&quot;')
+    .replaceAll("'", '&#039;')
+}
+
+export function splitLines(text: string): string[] {
+  return text.split(regexLineSplit).filter(l => !!l && l.length > 2)
+}
+
+export function removeFrontMatter(text: string): string {
+  // Regex to recognize YAML Front Matter (at beginning of file, 3 hyphens, than any charecter, including newlines, then 3 hyphens).
+  return text.replace(regexYaml, '')
+}
+
+export function wait(ms: number): Promise<void> {
+  return new Promise(resolve => {
+    setTimeout(resolve, ms)
+  })
+}
+
+// https://stackoverflow.com/a/3561711
+export function escapeRegex(str: string): string {
+  return str.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')
+}
+
+/**
+ * Returns the positions of all occurences of `val` inside of `text`
+ * https://stackoverflow.com/a/58828841
+ * @param text
+ * @param regex
+ * @returns
+ */
+export function getAllIndices(text: string, regex: RegExp): SearchMatch[] {
+  return [...text.matchAll(regex)]
+    .map(o => ({ match: o[0], offset: o.index }))
+    .filter(isSearchMatch)
+}
+
+export function stringsToRegex(strings: string[]): RegExp {
+  if (!strings.length) return /^$/g
+  return new RegExp(strings.map(s => `(${escapeRegex(s)})`).join('|'), 'gi')
+}
+
+export function extractHeadingsFromCache(
+  cache: CachedMetadata,
+  level: number
+): string[] {
+  return (
+    cache.headings?.filter(h => h.level === level).map(h => h.heading) ?? []
+  )
+}
+
+export function loopIndex(index: number, nbItems: number): number {
+  return (index + nbItems) % nbItems
+}
+
+export function makeExcerpt(content: string, offset: number): string {
+  const pos = offset ?? -1
+  if (pos > -1) {
+    const from = Math.max(0, pos - excerptBefore)
+    const to = Math.min(content.length, pos + excerptAfter)
+    content =
+      (from > 0 ? '…' : '') +
+      content.slice(from, to).trim() +
+      (to < content.length - 1 ? '…' : '')
+  }
+  return escapeHTML(content)
+}
+
+/**
+ * splits a string in words or "expressions in quotes"
+ * @param str
+ * @returns
+ */
+export function splitQuotes(str: string): string[] {
+  return (
+    str
+      .match(/"(.*?)"/g)
+      ?.map(s => s.replace(/"/g, ''))
+      .filter(q => !!q) ?? []
+  )
+}
+
+export function stripSurroundingQuotes(str: string): string {
+  return str.replace(regexStripQuotes, '')
+}
+
+function mapAsync<T, U>(
+  array: T[],
+  callbackfn: (value: T, index: number, array: T[]) => Promise<U>
+): Promise<U[]> {
+  return Promise.all(array.map(callbackfn))
+}
+
+/**
+ * https://stackoverflow.com/a/53508547
+ * @param array
+ * @param callbackfn
+ * @returns
+ */
+export async function filterAsync<T>(
+  array: T[],
+  callbackfn: (value: T, index: number, array: T[]) => Promise<boolean>
+): Promise<T[]> {
+  const filterMap = await mapAsync(array, callbackfn)
+  return array.filter((value, index) => filterMap[index])
+}
+
+/**
+ * A simple function to strip bold and italic markdown chars from a string
+ * @param text
+ * @returns
+ */
+export function stripMarkdownCharacters(text: string): string {
+  return text.replace(/(\*|_)+(.+?)(\*|_)+/g, (match, p1, p2) => p2)
+}
+
+export function getAliasesFromMetadata(
+  metadata: CachedMetadata | null
+): string[] {
+  const arrOrString = metadata?.frontmatter?.aliases ?? []
+  return (
+    Array.isArray(arrOrString) ? arrOrString : arrOrString.toString().split(',')
+  )
+    .map(s => (s ? s.trim() : s))
+    .filter(s => !!s)
+}
+
+export function getTagsFromMetadata(metadata: CachedMetadata | null): string[] {
+  const arrOrString = metadata?.frontmatter?.tags ?? []
+  const fromFrontMatter = (
+    Array.isArray(arrOrString) ? arrOrString : arrOrString.split(',')
+  )
+    .map(s => (s ? s.trim() : s))
+    .filter(s => !!s)
+  const fromBody = (metadata?.tags ?? []).map(t => t.tag)
+
+  return [...fromFrontMatter, ...fromBody].map(t =>
+    t[0] !== '#' ? '#' + t : t
+  )
+}
+
+/**
+ * https://stackoverflow.com/a/37511463
+ */
+export function removeDiacritics(str: string): string {
+  return str.normalize('NFD').replace(/\p{Diacritic}/gu, '')
+}
+
+export function getCtrlKeyLabel(): 'ctrl' | '⌘' {
+  return Platform.isMacOS ? '⌘' : 'ctrl'
+}
+
+export function isFileIndexable(path: string): boolean {
+  return (
+    (settings.PDFIndexing && path.endsWith('.pdf')) || isFilePlaintext(path)
+  )
+}
+
+export function isFilePlaintext(path: string): boolean {
+  return getPlaintextExtensions().some(t => path.endsWith(`.${t}`))
+}
+
+export function getPlaintextExtensions(): string[] {
+  return [...settings.indexedFileTypes, 'md']
+}
+
+export function getExtension(path: string): string {
+  const split = path.split('.')
+  return split[split.length - 1]
+}
+
+export function makeMD5(data: BinaryLike): string {
+  if (Platform.isMobileApp) {
+    // A node-less implementation, but since we're not hashing the same data
+    // (arrayBuffer vs stringified array) the hash will be different
+    return md5(data.toString())
+  }
+  return createHash('md5').update(data).digest('hex')
+}