@coolicons/cli 5.1.0 → 5.3.0

package/README.md

@@ -2,12 +2,12 @@
 
 <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>
 
-Search [coolicons](https://coolicons.cool) and copy them into your project from the terminal: 1,258 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) and copy them into your project from the terminal: 1,550 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 delete
-npx @coolicons/cli show trash --style fill > trash.svg
-npx @coolicons/cli add trash bell --style bulk --radius round --out src/icons
+npx @coolicons/cli search date
+npx @coolicons/cli show calendar --style fill > calendar.svg
+npx @coolicons/cli add calendar bell --style bulk --radius round --out src/icons
 ```
 
 ## Commands

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"));
 
@@ -28,9 +28,9 @@ Options
   -v, --version           Show the version
 
 Examples
-  npx @coolicons/cli search delete
-  npx @coolicons/cli show trash --style fill > trash.svg
-  npx @coolicons/cli add trash bell --style bulk --radius round --out src/icons
+  npx @coolicons/cli search date
+  npx @coolicons/cli show calendar --style fill > calendar.svg
+  npx @coolicons/cli add calendar bell --style bulk --radius round --out src/icons
 `;
 
 const SHORT = { s: "style", r: "radius", o: "out", l: "limit", c: "category", h: "help", v: "version" };
@@ -69,27 +69,37 @@ function run({ command, words, options }) {
 
   if (command === "search") {
     const query = words.join(" ");
-    if (!query) throw new LookupError("search needs a query, like: coolicons search delete");
+    if (!query) throw new LookupError("search needs a query, like: coolicons search date");
     const results = search(query, Number(options.limit ?? 20));
     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;
   }
 
   if (command === "show") {
-    if (words.length !== 1) throw new LookupError("show needs exactly one name, like: coolicons show trash");
+    if (words.length !== 1) throw new LookupError("show needs exactly one name, like: coolicons show calendar");
     return out(svg(words[0], variant(options)));
   }
 
   if (command === "add") {
-    if (!words.length) throw new LookupError("add needs at least one name, like: coolicons add trash bell");
+    if (!words.length) throw new LookupError("add needs at least one name, like: coolicons add calendar bell");
     const icons = words.map(findIcon);
     const folder = path.resolve(options.out ?? "icons");
     mkdirSync(folder, { recursive: true });

package/dist/core.js

@@ -1,5 +1,5 @@
 import { readFileSync } from "node:fs";
-import { matchIcons } from "./search.js";
+import { matchIcons, scoreIcon, searchTerms } from "./search.js";
 
 export const STYLES = ["line", "duocolor", "duotone", "fill", "bulk"];
 export const RADII = ["sharp", "regular", "round"];
@@ -59,6 +59,22 @@ export function search(query, limit = 10) {
   return matchIcons(iconSet().icons, query).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) {
   const d = Array.from({ length: a.length + 1 }, (_, i) => Array.from({ length: b.length + 1 }, (_, j) => (i === 0 ? j : j === 0 ? i : 0)));
   for (let i = 1; i <= a.length; i++) {
@@ -126,7 +142,7 @@ export function usage(inputs, { framework = "react", style = "line", radius = "r
     };
   }
   if (framework === "shadcn") {
-    const items = icons.map((icon) => `${SITE}/r/${registryItem(icon, style, radius)}.json`);
+    const items = icons.map((icon) => `@coolicons/${registryItem(icon, style, radius)}`);
     const files = icons.map((icon) => `components/icons/${registryItem(icon, style, radius)}.tsx`);
     return { install: `npx shadcn@latest add ${items.join(" ")}`, code: `Adds ${files.join(", ")} exporting ${names.join(", ")}.` };
   }