New release

Co-authored-by: aider (gemini/gemini-2.5-pro) <aider@aider.chat>

README.md

@@ -1,23 +1,88 @@
-# Omnisearch for Obsidian
+# Tannersearch for Obsidian
 
-[![Sponsor me](https://img.shields.io/badge/%E2%9D%A4%20Like%20this%20plugin%3F-Sponsor%20me!-ff69b4)](https://github.com/sponsors/scambier)  
+This is a fork of [obsidian-omnisearch](https://github.com/scambier/obsidian-omnisearch) (by [@scambier](https://github.com/scambier)) with the following changes:
-![Obsidian plugin](https://img.shields.io/endpoint?url=https%3A%2F%2Fscambier.xyz%2Fobsidian-endpoints%2Fomnisearch.json)
-![GitHub release (latest by date and asset)](https://img.shields.io/github/downloads/scambier/obsidian-omnisearch/latest/main.js)  
-![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch)
-![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch?include_prereleases&label=BRAT%20beta)
 
-> 🏆 Winner of the _[2023 Gems of the Year](https://obsidian.md/blog/2023-goty-winners/)_ in the "Existing plugin" category 🏆
+When opening a result, the cursor placement prioritizes note titles over headings over content
+- this means if the note's name matches your search, it opens at the top instead of on a random match in the middle of the note
+
+Search terms aren't split on apostrophes
+- searching for "Sun's BBQ" searches for ["Sun's", "BBQ"] instead of ["Sun", "s", "BBQ"]
+
+Search terms less than 3 characters long or common words are ignored
+- ignored words: "a", "an", "the", "and", "or", "but", "if", "in", "on", "at", "by", "for", "with", "to", "from", "of", "is", "it", "that", "this"
+
+Excerpt highlighting fixes
+- words with apostrophes weren't being highlighted
+- excerpt with blank lines were sometimes shown incorrectly
+- fixed match index calculations when diacritics were removed
+
+The first line of a paragraph is ranked like Heading 3 if it ends in a colon
+- for example,
+
+```
+Japan trip:
+- passport
+- cash
+- umbrella
+```
+
+... "Japan trip:" is indexed and ranked the same as "### Japan trip"
+
+If the first paragraph of a note contains a line like "aka other name", then "other name" is ranked like H1
+- for example,
+
+```
+see also: [[Travel General]]
+Aka: packing list
+
+content
+```
+
+... "packing list" is indexed and ranked the same as "# packing list". Note that "Aka:" isn't case or colon sensitive.
 
 
----
+### Fork Installation
+
+Ensure the original Omnisearch plugin is installed, see instructions below.
+
+Download main.js into your `.obsidian/plugins/omnisearch` directory, example:
+
+```
+$ cd ~/notes/.obsidian/plugins/omnisearch
+$ mv main.js main.js.bak
+$ wget https://raw.githubusercontent.com/tannercollin/obsidian-tannersearch/refs/heads/master/dist/main.js
+```
+
+In Obsidian, open Settings > Community Plugins. Disable and enable Omnisearch.
+
+Open Settings > Omnisearch. Scroll to bottom. Click "Clear cache" data.
+
+Restart Obsidian.
+
+Note: on mobile you'll have to use some sort of sync or downloader and move the main.js over to your vault.
+
+### Building the Fork
+
+If you'd rather build the fork yourself:
+
+```
+$ git clone https://github.com/tannercollin/obsidian-tannersearch.git
+$ cd obsidian-tannersearch/
+$ npm install --legacy-peer-deps
+$ npm run build
+```
+
+Then copy `dist/main.js` as above.
+
+
+
+# Original README
 
 **Omnisearch** is a search engine that "_just works_".  
 It always instantly shows you the most relevant results, thanks to its smart weighting algorithm.
 
 Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/minisearch) library. This free plugin is totally unrelated to the omnisearch.ai paid product.
 
-![](https://raw.githubusercontent.com/scambier/obsidian-omnisearch/master/images/omnisearch.gif)
-
 ## Documentation
 
 https://publish.obsidian.md/omnisearch/Index
@@ -72,5 +137,3 @@ Omnisearch is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-p
 
 To all people who donate through [Ko-Fi](https://ko-fi.com/scambier)
 or [Github Sponsors](https://github.com/sponsors/scambier) ❤
-
-![JetBrains logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)

src/repositories/documents-repository.ts

@@ -233,6 +233,12 @@ export class DocumentsRepository {
     const headings2 = metadata ? extractHeadingsFromCache(metadata, 2) : []
     const headings3 = metadata ? extractHeadingsFromCache(metadata, 3) : []
 
+    const akaHeadings: string[] = content
+      .split(/\n\s*\n/)[0]
+      .split('\n')
+      .map(line => line.match(/^aka:?\s*(.+)$/i)?.[1]?.trim())
+      .filter((heading): heading is string => !!heading)
+
     const lines = content.split('\n')
     const colonHeadings: string[] = []
     for (let i = 0; i < lines.length; i++) {
@@ -263,7 +269,7 @@ export class DocumentsRepository {
       tags: tags,
       unmarkedTags: tags.map(t => t.replace('#', '')),
       aliases: getAliasesFromMetadata(metadata).join(''),
-      headings1: headings1.join(' '),
+      headings1: [...headings1, ...akaHeadings].join(' '),
       headings2: headings2.join(' '),
       headings3: [...headings3, ...colonHeadings].join(' '),
     }

src/search/search-engine.ts

@@ -166,11 +166,12 @@ export class SearchEngine {
     logVerbose(JSON.stringify(searchTokens, null, 1))
     let results = this.minisearch.search(searchTokens, {
       prefix: term => term.length >= options.prefixLength,
-      // length <= 3: no fuzziness
+      bm25: {b: 0.2, d: 0.5, k: 1.2},
-      // length <= 5: fuzziness of 10%
+      // length <= 4: no fuzziness
-      // length > 5: fuzziness of 20%
+      // length <= 5: 1/2 fuzziness
+      // length > 5: full fuzziness
       fuzzy: term =>
-        term.length <= 3 ? 0 : term.length <= 5 ? fuzziness / 2 : fuzziness,
+        term.length <= 4 ? 0 : term.length <= 5 ? fuzziness / 2 : fuzziness,
       boost: {
         basename: settings.weightBasename,
         aliases: settings.weightBasename,

src/search/tokenizer.ts

@@ -41,7 +41,7 @@ export class Tokenizer {
       }
 
       // Remove duplicates
-      // tokens = [...new Set(tokens)]
+      tokens = [...new Set(tokens)]
       
       // Remove empty tokens
       tokens = tokens.filter(Boolean)
@@ -107,7 +107,9 @@ export class Tokenizer {
   }
 
   private tokenizeWords(text: string, { skipChs = false } = {}): string[] {
-    const tokens = text.split(BRACKETS_AND_SPACE)
+    const tokens = text
+      .split(BRACKETS_AND_SPACE)
+      .map(t => t.replace(/[.,:;!?]+$/, ''))
     if (skipChs) return tokens
     return this.tokenizeChsWord(tokens)
   }

src/tools/text-processing.ts

@@ -25,7 +25,9 @@ export class TextProcessor {
     try {
       return text.replace(
         new RegExp(
-          `(${matches.map(item => escapeRegExp(item.match)).join('|')})`,
+          `(${matches
+            .map(item => escapeRegExp(escapeHTML(item.match)))
+            .join('|')})`,
           'giu'
         ),
         `<span class="${highlightClass}">$1</span>`
@@ -47,7 +49,7 @@ export class TextProcessor {
     strings.sort((a, b) => b.length - a.length)
 
     const joined = `(${strings
-      .map(s => `\\b${escapeRegExp(s)}\\b|${escapeRegExp(s)}`)
+      .map(s => `(?<!\\w)${escapeRegExp(s)}(?!\\w)`)
       .join('|')})`
 
     return new RegExp(`${joined}`, 'gui')
@@ -82,9 +84,16 @@ export class TextProcessor {
       }
       const matchStartIndex = match.index
       const matchEndIndex = matchStartIndex + match[0].length
-      const originalMatch = originalText
+
-        .substring(matchStartIndex, matchEndIndex)
+      // If `ignoreDiacritics` is on, `text` may have a different length than `originalText`,
-        .trim()
+      // making `match.index` unreliable for `originalText`.
+      // We use `match[0]`, which is the matched term (but without diacritics).
+      const originalMatchBeforeTrim = this.plugin.settings.ignoreDiacritics
+        ? match[0]
+        : originalText.substring(matchStartIndex, matchEndIndex)
+
+      const originalMatch = originalMatchBeforeTrim.trim()
+
       if (originalMatch && match.index >= 0) {
         matches.push({ match: originalMatch, offset: match.index })
       }
@@ -126,18 +135,18 @@ export class TextProcessor {
         content = content.slice(0, excerptAfter)
       }
       if (settings.renderLineReturnInExcerpts) {
+        const last = content.lastIndexOf('\n', pos - from)
+
+        if (last > 0) {
+          content = content.slice(last)
+        }
+
         const lineReturn = new RegExp(/(?:\r\n|\r|\n)/g)
         // Remove multiple line returns
         content = content
           .split(lineReturn)
           .filter(l => l)
           .join('\n')
-
-        const last = content.lastIndexOf('\n', pos - from)
-
-        if (last > 0) {
-          content = content.slice(last)
-        }
       }
 
       content = escapeHTML(content)