rdicons 0.4.0 → 0.5.0

package/README.md

@@ -19,6 +19,7 @@ rdicons add <set:name> [more...]   download icons into a folder
 rdicons search <query> [--set s]   find icons by name
 rdicons info <set:name>            show the code for one icon (every install option)
 rdicons migrate <path...> --to <set>   switch a project's icon imports to another library
+rdicons audit <path...>               which icon libraries a project uses, duplicates and licenses
 rdicons sets                       list the 19 libraries with their licenses
 ```
 
@@ -44,6 +45,16 @@ npx rdicons migrate src --to rd --write      # apply it (commit your work first)
 ```
 
 It reads the imports of `lucide-react`, `@tabler/icons-react`, `@phosphor-icons/react`, `@heroicons/react` and `react-icons` (Feather, Lucide, Tabler, Phosphor, Remix, Bootstrap, Octicons, Radix, Heroicons 2, Material) and points them at `@rdicons/react/<library>` (or `@rdicons/vue/<library>` for Vue). Icons are matched by name and by common alternative names (`home` and `house`); the names you use in your JSX stay the same. Icons with no match stay on the old import and are listed, so the project keeps building. Tabler's `stroke` prop becomes `strokeWidth`. `--ext` chooses the file types, `node_modules` and build folders are skipped.
+
+## What does the project use? `audit`
+
+```bash
+npx rdicons audit src             # read-only report
+npx rdicons audit src --strict    # exit 1 for mixed libraries, duplicates or a library that needs credit (for CI)
+npx rdicons audit src --json      # the same as JSON
+```
+
+It lists the libraries your code imports icons from (rdicons packages, `lucide-react`, Tabler, Phosphor, Heroicons, `react-icons`), how many distinct icons each one supplies, icons used from two libraries at once (`house` and `home`), the license of each library (and who you must credit for CC BY), and which of the icons from other libraries also exist in rd. Nothing is changed.
 | `--animated [mode]` | off | add the icon's animation (rd icons): `hover` (default), `parent`, `play` or `loop`. The CSS is inside the file. Other libraries have no animation and get the still icon |
 | `--speed <n>` | `1` | animation speed, `2` is twice as fast (needs `--animated`) |
 

package/dist/cli.js

@@ -2,7 +2,7 @@
 
 // src/cli.ts
 import { mkdir, writeFile as writeFile2 } from "fs/promises";
-import { join as join2, resolve as resolve2 } from "path";
+import { join as join2, resolve as resolve3 } from "path";
 
 // ../core/dist/index.js
 var STROKE_WIDTH_RE = /stroke-width="[^"]*"/g;
@@ -124,6 +124,10 @@ export function Example() {
   ];
 }
 
+// src/audit.ts
+import { readFile as readFile2 } from "fs/promises";
+import { resolve as resolve2 } from "path";
+
 // src/migrate.ts
 import { readdir, readFile, stat, writeFile } from "fs/promises";
 import { join, relative, resolve } from "path";
@@ -330,8 +334,118 @@ function formatReport(r, root) {
   return lines.join("\n");
 }
 
+// src/audit.ts
+function rdiconsSet(spec) {
+  let m = spec.match(/^@rdicons\/(?:react|vue|svelte)\/([a-z0-9-]+)$/);
+  if (m) return m[1];
+  m = spec.match(/^@rdicons\/(?:react|vue|svelte)-([a-z0-9-]+)$/);
+  if (m) return m[1];
+  return null;
+}
+var STYLE_SUFFIX2 = /-(fill|filled|solid|line|bold|thin|light|duotone|regular|outline|sharp)$/;
+function conceptOf(slug) {
+  const base = slug.replace(STYLE_SUFFIX2, "");
+  const group = ALIASES.find((g) => g.includes(base));
+  return group ? group[0] : base;
+}
+async function audit(paths, opts, deps) {
+  const exts = new Set(opts.exts);
+  const setInfo = new Map((await deps.sets()).map((s) => [s.prefix, s]));
+  const use = /* @__PURE__ */ new Map();
+  const seen = /* @__PURE__ */ new Set();
+  let files = 0, filesWithIcons = 0;
+  const note = (set, icon, file, via) => {
+    const u = use.get(set) ?? { icons: /* @__PURE__ */ new Set(), files: /* @__PURE__ */ new Set(), via };
+    u.icons.add(icon);
+    u.files.add(file);
+    u.via ||= via;
+    use.set(set, u);
+  };
+  for (const p of paths) {
+    for await (const file of walk(resolve2(p), exts)) {
+      if (seen.has(file)) continue;
+      seen.add(file);
+      files++;
+      const text = await readFile2(file, "utf8");
+      let any = false;
+      for (const m of text.matchAll(new RegExp(IMPORT.source, "g"))) {
+        const isType = !!m[1];
+        const spec = m[4];
+        if (isType) continue;
+        const names = m[2].split(",").map((x) => x.trim().replace(/^type\s+/, "").split(/\s+as\s+/)[0].trim()).filter(Boolean);
+        const rd = rdiconsSet(spec);
+        if (rd) {
+          for (const n of names) {
+            if (n === "Icon" || /^[a-z]/.test(n)) continue;
+            note(rd, kebab(n), file, true);
+            any = true;
+          }
+          continue;
+        }
+        const source = sourceFor(spec);
+        if (!source) continue;
+        for (const n of names) {
+          const slug = source.slug(n);
+          if (!slug) continue;
+          note(source.set, slug, file, false);
+          any = true;
+        }
+      }
+      if (any) filesWithIcons++;
+    }
+  }
+  const libraries = [...use.entries()].map(([set, u]) => ({ set, label: setInfo.get(set)?.label ?? set, license: setInfo.get(set)?.license ?? "see the library", viaRdicons: u.via, icons: [...u.icons].sort(), files: u.files.size })).sort((a, b) => b.icons.length - a.icons.length);
+  const totalIcons = libraries.reduce((n, l) => n + l.icons.length, 0);
+  const byConcept = /* @__PURE__ */ new Map();
+  for (const l of libraries) for (const i of l.icons) byConcept.set(conceptOf(i), [...byConcept.get(conceptOf(i)) ?? [], `${l.set}:${i}`]);
+  const duplicates = [...byConcept.entries()].filter(([, list]) => new Set(list.map((x) => x.split(":")[0])).size > 1).sort((a, b) => a[0].localeCompare(b[0]));
+  const inRd = { total: 0, animated: 0, examples: [] };
+  const others = libraries.filter((l) => l.set !== "rd");
+  if (others.length) {
+    const rdNames = new Map(await deps.names("rd"));
+    let animated = null;
+    for (const l of others) {
+      for (const i of l.icons) {
+        const hit = findIcon(i, rdNames);
+        if (!hit) continue;
+        inRd.total++;
+        animated ??= await deps.animated().catch(() => /* @__PURE__ */ new Set());
+        if (animated.has(hit.name)) inRd.animated++;
+        if (inRd.examples.length < 8) inRd.examples.push(`${l.set}:${i} -> rd:${hit.name}`);
+      }
+    }
+  }
+  const needsCredit = libraries.filter((l) => /CC[ -]BY/i.test(l.license));
+  const findings = [];
+  if (libraries.length > 1) findings.push(`Icons come from ${libraries.length} libraries (${libraries.map((l) => l.set).join(", ")}). Mixed styles are the usual reason icons look uneven; the pack builder and consistency checker on the site can line them up.`);
+  if (duplicates.length) findings.push(`${duplicates.length} icon${duplicates.length === 1 ? " is" : "s are"} used from more than one library (${duplicates.slice(0, 3).map(([c]) => c).join(", ")}${duplicates.length > 3 ? ", ..." : ""}). Pick one library for each.`);
+  for (const l of needsCredit) findings.push(`${l.label} is ${l.license}: you must credit the author wherever you ship these icons.`);
+  const fromOtherPackages = libraries.filter((l) => !l.viaRdicons);
+  if (fromOtherPackages.length) findings.push(`${fromOtherPackages.reduce((n, l) => n + l.icons.length, 0)} icons still come from other icon packages (${fromOtherPackages.map((l) => l.set).join(", ")}). \`rdicons migrate\` can move them to one rdicons library.`);
+  return { files, filesWithIcons, libraries, totalIcons, duplicates, inRd, needsCredit, findings };
+}
+function formatAudit(r) {
+  const out = [];
+  if (!r.totalIcons) return `Looked at ${r.files} file${r.files === 1 ? "" : "s"} and found no icon imports from rdicons, lucide-react, Tabler, Phosphor, Heroicons or react-icons.`;
+  out.push(`${r.totalIcons} distinct icon${r.totalIcons === 1 ? "" : "s"} in ${r.filesWithIcons} of ${r.files} files`, "");
+  const pad = Math.max(...r.libraries.map((l) => l.set.length)) + 1;
+  for (const l of r.libraries) out.push(`  ${l.set.padEnd(pad)} ${String(l.icons.length).padStart(4)} icon${l.icons.length === 1 ? " " : "s"}  ${l.license}${l.viaRdicons ? "" : "  (not through rdicons)"}`);
+  if (r.duplicates.length) {
+    out.push("", "Same icon from more than one library:");
+    for (const [c, list] of r.duplicates.slice(0, 12)) out.push(`  ${c}: ${list.join(", ")}`);
+    if (r.duplicates.length > 12) out.push(`  ... and ${r.duplicates.length - 12} more`);
+  }
+  if (r.inRd.total) {
+    out.push("", `${r.inRd.total} of the icons from other libraries also exist in rd (${r.inRd.animated} animated):`);
+    for (const e of r.inRd.examples) out.push("  " + e);
+  }
+  if (r.findings.length) out.push("", "Worth a look:", ...r.findings.map((f) => "  - " + f));
+  else out.push("", "Nothing to fix: one library, no duplicates, no attribution needed.");
+  return out.join("\n");
+}
+
 // src/cli.ts
-var VERSION = "0.4.0";
+var VERSION = "0.5.0";
 var BASE = (process.env.RDICONS_URL || "https://rdicons.vimalbhatt.com").replace(/\/$/, "");
 var HELP = `rdicons ${VERSION}: add open-source icons to your project
 
@@ -340,6 +454,7 @@ Usage
   rdicons search <query> [--set lucide]         find icons by name
   rdicons info <set:name>                       show the code to use one icon (every install option)
   rdicons migrate <path...> --to <library>      switch a project's icon imports to another library (preview first)
+  rdicons audit <path...>                       report which icon libraries a project uses, duplicates and licenses
   rdicons sets                                  list the 19 icon libraries
 
 Options for "add"
@@ -358,7 +473,14 @@ Options for "migrate"
   --write                apply the changes (without it you only get a preview)
   --ext js,ts,tsx,...    which files to look at (default js,jsx,ts,tsx,mjs,cjs,vue)
 
+Options for "audit"
+  --json                 print the result as JSON
+  --strict               exit with an error when icons come from more than one library, an icon is used from two
+                         libraries, or a library needs credit (for CI)
+  --ext js,ts,tsx,...    which files to look at (default js,jsx,ts,tsx,mjs,cjs,vue,svelte)
+
 Examples
+  npx rdicons audit src                         which libraries does this project use?
   npx rdicons migrate src --to tabler           preview: lucide-react imports -> @rdicons/react/tabler
   npx rdicons migrate src --to rd --write       apply it
   npx rdicons add lucide:house
@@ -415,7 +537,7 @@ function parseArgs(argv) {
     if (a.startsWith("--")) {
       const [k, inline] = a.slice(2).split("=");
       if (inline !== void 0) flags[k] = inline;
-      else if (k === "write") flags[k] = "true";
+      else if (k === "write" || k === "strict" || k === "json") flags[k] = "true";
       else if (k === "animated") flags[k] = MODES.includes(argv[i + 1]) ? argv[++i] : "true";
       else if (argv[i + 1] !== void 0 && !argv[i + 1].startsWith("--")) flags[k] = argv[++i];
       else flags[k] = "true";
@@ -477,7 +599,7 @@ async function cmdAdd(positional, flags) {
   if (!positional.length) fail("Which icon? For example: rdicons add lucide:house");
   const format = flags.format ?? "svg";
   if (!["svg", "jsx", "tsx"].includes(format)) fail("--format must be svg, jsx or tsx");
-  const out = resolve2(flags.out ?? "icons");
+  const out = resolve3(flags.out ?? "icons");
   const mode = flags.animated === void 0 ? null : flags.animated === "true" ? "hover" : flags.animated;
   if (mode && !MODES.includes(mode)) fail(`--animated must be one of ${MODES.join(", ")} (or just --animated for hover)`);
   const speed = flags.speed === void 0 ? 1 : Number(flags.speed);
@@ -519,6 +641,17 @@ async function cmdMigrate(positional, flags) {
   const result = await migrate(positional, { to, write: flags.write === "true", exts }, { names: (set) => getJson(`/api/names?set=${encodeURIComponent(set)}`) });
   console.log(formatReport(result, process.cwd()));
 }
+async function cmdAudit(positional, flags) {
+  if (!positional.length) fail("Which folder or file? For example: rdicons audit src");
+  const exts = (flags.ext && flags.ext !== "true" ? flags.ext : "js,jsx,ts,tsx,mjs,cjs,vue,svelte").split(",").map((x) => x.trim().replace(/^\./, "").toLowerCase());
+  const result = await audit(positional, { exts }, {
+    sets: async () => (await listSets()).map((s) => ({ prefix: s.prefix, label: s.label, license: s.license })),
+    names: (set) => getJson(`/api/names?set=${encodeURIComponent(set)}`),
+    animated: async () => new Set(Object.keys(await getJson("/api/animations?set=rd")))
+  });
+  console.log(flags.json === "true" ? JSON.stringify(result, null, 2) : formatAudit(result));
+  if (flags.strict === "true" && (result.libraries.length > 1 || result.duplicates.length > 0 || result.needsCredit.length > 0)) process.exitCode = 1;
+}
 async function main() {
   const [cmd, ...rest] = process.argv.slice(2);
   const { flags, positional } = parseArgs(rest);
@@ -529,6 +662,7 @@ async function main() {
   if (cmd === "info") return cmdInfo(positional);
   if (cmd === "add") return cmdAdd(positional, flags);
   if (cmd === "migrate") return cmdMigrate(positional, flags);
+  if (cmd === "audit") return cmdAudit(positional, flags);
   fail(`Unknown command "${cmd}". Run rdicons --help`);
 }
 main().catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rdicons",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "rdicons command line: search 78,000+ open-source icons and add them to your project as SVG, JSX or TSX. Try: npx rdicons add lucide:house",
   "keywords": ["icons", "cli", "svg", "react", "tsx", "icon-generator", "lucide", "tabler", "rdicons"],
   "license": "MIT",