@coolicons/cli 5.2.0 → 5.4.0

package/README.md

@@ -1,8 +1,8 @@
 # @coolicons/cli
 
-<a href="https://coolicons.cool"><img src="https://raw.githubusercontent.com/krystonschwarze/coolicons/main/.github/assets/banner.png" alt="coolicons: Every icon for your next project. Free, wherever you build." width="100%"></a>
+<a href="https://coolicons.cool/?ref=npm-cli"><img src="https://raw.githubusercontent.com/krystonschwarze/coolicons/main/.github/assets/banner.png" alt="coolicons: Every icon for your next project. Free, wherever you build." width="100%"></a>
 
-Search [coolicons](https://coolicons.cool) and copy them into your project from the terminal: 1,324 icons in five styles and three corner radii. No install, no dependencies, no network. The whole set ships inside the package.
+Search [coolicons](https://coolicons.cool/?ref=npm-cli) and copy them into your project from the terminal: 1,751 icons in five styles and three corner radii. No install, no dependencies, no network. The whole set ships inside the package.
 
 ```sh
 npx @coolicons/cli search date
@@ -14,7 +14,7 @@ npx @coolicons/cli add calendar bell --style bulk --radius round --out src/icons
 
 | Command | |
 | --- | --- |
-| `search <query>` | Find icons by name or meaning, ranked like the search on coolicons.cool |
+| `search <query>` | Find icons by name or meaning, ranked like the search on coolicons.cool. Corrects typos like `calender` when nothing matches |
 | `show <name>` | Print one icon's SVG to stdout |
 | `add <name...>` | Write SVG files into a folder |
 | `list` | Print every icon name |

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
-import { component, findIcon, iconSet, LookupError, RADII, search, STYLES, svg } from "./core.js";
+import { component, findIcon, iconSet, LookupError, RADII, search, searchPartial, STYLES, svg } from "./core.js";
 
 const { version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
 
@@ -70,15 +70,26 @@ function run({ command, words, options }) {
   if (command === "search") {
     const query = words.join(" ");
     if (!query) throw new LookupError("search needs a query, like: coolicons search date");
-    const results = search(query, Number(options.limit ?? 20));
+    const { icons: results, corrected, query: used } = search(query, Number(options.limit ?? 20));
+    if (corrected.length) say(`Results for "${used}"`);
     if (options.json) return out(JSON.stringify(results.map((icon) => ({ ...icon, component: component(icon) })), null, 2));
+    const rows = (icons) => {
+      const width = Math.max(...icons.map((icon) => icon.name.length));
+      for (const icon of icons) out(`${icon.name.padEnd(width)}  ${component(icon)}  ${icon.category}${icon.missing?.length ? `  weak: no ${icon.missing.join(", ")}` : ""}${icon.keywords.length ? `  ${icon.keywords.join(", ")}` : ""}`);
+    };
     if (!results.length) {
-      say(`No icon matches "${query}".`);
+      const partial = searchPartial(query, Number(options.limit ?? 20));
+      if (partial.length && !partial[0].missing.length) {
+        rows(partial);
+        say(`${partial.length} of ${iconSet().icons.length} icons`);
+        return;
+      }
+      say(`No icon matches "${query}".${partial.length ? " Weak matches by some words, check that they fit:" : ""}`);
+      if (partial.length) rows(partial);
       process.exitCode = 1;
       return;
     }
-    const width = Math.max(...results.map((icon) => icon.name.length));
-    for (const icon of results) out(`${icon.name.padEnd(width)}  ${component(icon)}  ${icon.category}${icon.keywords.length ? `  ${icon.keywords.join(", ")}` : ""}`);
+    rows(results);
     say(`${results.length} of ${iconSet().icons.length} icons`);
     return;
   }

package/dist/core.js

@@ -1,5 +1,5 @@
 import { readFileSync } from "node:fs";
-import { matchIcons } from "./search.js";
+import { matchIconsCorrected, scoreIcon, searchTerms } from "./search.js";
 
 export const STYLES = ["line", "duocolor", "duotone", "fill", "bulk"];
 export const RADII = ["sharp", "regular", "round"];
@@ -56,7 +56,24 @@ export function checkVariant(style = "line", radius = "regular") {
 }
 
 export function search(query, limit = 10) {
-  return matchIcons(iconSet().icons, query).slice(0, limit);
+  const result = matchIconsCorrected(iconSet().icons, query);
+  return { ...result, icons: result.icons.slice(0, limit) };
+}
+
+const FILLER = new Set(["a", "an", "and", "as", "for", "icon", "icons", "in", "of", "on", "or", "the", "to", "with"]);
+
+export function searchPartial(query, limit = 10) {
+  const terms = searchTerms(query).filter((term) => !FILLER.has(term));
+  if (!terms.length) return [];
+  return iconSet()
+    .icons.map((icon) => {
+      const scores = terms.map((term) => scoreIcon(icon, [term]));
+      return { icon, matched: terms.filter((_, i) => scores[i]), rank: scores.reduce((sum, score) => sum + score, 0) };
+    })
+    .filter((entry) => entry.matched.length)
+    .sort((a, b) => b.matched.length - a.matched.length || b.rank - a.rank || a.icon.name.length - b.icon.name.length || a.icon.name.localeCompare(b.icon.name))
+    .slice(0, limit)
+    .map(({ icon, matched }) => ({ ...icon, missing: terms.filter((term) => !matched.includes(term)) }));
 }
 
 function distance(a, b) {
@@ -74,7 +91,7 @@ function distance(a, b) {
 export function suggest(input, limit = 5) {
   const name = toName(input);
   if (!name) return [];
-  const found = search(name.replaceAll("-", " "), limit).map((icon) => icon.name);
+  const found = search(name.replaceAll("-", " "), limit).icons.map((icon) => icon.name);
   if (found.length >= limit) return found;
   const near = iconSet()
     .icons.map((icon) => ({ name: icon.name, cost: distance(name, icon.name) }))