search-algoritm 1.1.3 → 1.2.0

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+
+---
+## [1.2.0] - 2026-02-25
+### Added
+- Search now includes **filename** in addition to title and description.
+- Fuzzy matching and token-based scoring are applied to filenames as well.
+- Improved relevance calculation when query matches filename, title, or description.
+- Module normalization continues to support accent-insensitive search and stopword filtering.
+
 ---
 ## [1.1.3] - 2025-12-04
 ### Error

package/README.md

@@ -7,7 +7,7 @@
 [![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue?logo=github)](https://github.com/FelixLind1/SearchAlgoritm)
 
 A lightweight Node.js library for **fuzzy searching** arrays of objects.  
-It calculates relevance scores based on how well a query matches the `title` and `description` of each item.  
+It calculates relevance scores based on how well a query matches the `title`, `description`, and `file` of each item.  
 
 **Features:**
 
@@ -15,7 +15,7 @@ It calculates relevance scores based on how well a query matches the `title` and
 - **Accent-insensitive** searches (`é → e`)  
 - Token-based word matching for partial or multi-word queries  
 - Multi-word sequence detection (`"mac pro"` → `"MacBook Pro"`)  
-- Weighted scoring: title matches are more important than description  
+- Weighted scoring: **title > description ≈ file**  
 - Stopword filtering for more relevant results  
 
 ---
@@ -85,7 +85,7 @@ app.listen(PORT, () => {
 });
 ```
 
-✅ Fast searches using in-memory cache. Ideal for **medium to large datasets** where performance matters.
+✅ Fast searches using in-memory cache. Ideal for **medium to large datasets**.
 
 ---
 
@@ -125,7 +125,7 @@ app.listen(PORT, () => {
 });
 ```
 
-✅ Reads JSON on each request. Best for **small datasets** or when data changes frequently.
+✅ Reads JSON on each request. Best for **small datasets** or frequently changing data.
 
 ---
 
@@ -176,7 +176,8 @@ async function initSearch() {
         ? results.map(item => `
             <li class="result-item">
               <strong>${item.title}</strong><br>
-              <span>${item.description}</span>
+              <span>${item.description}</span><br>
+              <em>File: ${item.file}</em>
             </li>
           `).join('')
         : `<li class="no-result">No matches found</li>`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "search-algoritm",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Simple and lightweight fuzzy search algoritm for titles and descriptions.",
   "main": "index.js",
   "scripts": {

package/src/searchAlgoritm.js

@@ -1,4 +1,3 @@
-// searchAlgoritm.js
 console.log('[searchAlgoritm] 🔍 Module loaded');
 
 /**
@@ -98,7 +97,7 @@ const matchScore = (text, query) => {
 
 /**
  * Compute weighted score for an item
- * Title is weighted higher than description
+ * Title is weighted highest, then description and file equally
  * @param {object} item 
  * @param {string} query 
  * @returns {number}
@@ -106,7 +105,10 @@ const matchScore = (text, query) => {
 const calculateItemScore = (item, query) => {
   const title = item._lcTitle ?? normalize(item.title);
   const desc = item._lcDesc ?? normalize(item.description);
-  return matchScore(title, query) * 3 + matchScore(desc, query);
+  const file = item._lcFile ?? normalize(item.file ?? '');
+
+  // Weight: title *3, description *1.5, file *1.5
+  return matchScore(title, query) * 3 + matchScore(desc, query) * 1.5 + matchScore(file, query) * 1.5;
 };
 
 /**
@@ -125,6 +127,7 @@ const searchAlgoritm = (query, dataList, enableLog = false) => {
   dataList.forEach(item => {
     item._lcTitle ??= normalize(item.title);
     item._lcDesc ??= normalize(item.description);
+    item._lcFile ??= normalize(item.file ?? ''); // include file
   });
 
   const results = dataList