rdicons 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2026 rdicons contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+The icon sets bundled at build time are third-party works under their own
+licenses (see THIRD_PARTY_NOTICES.md). The MIT license above covers this
+repository's source code only.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# rdicons (CLI)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Add open-source icons to any project from the terminal. No install needed:
+
+```bash
+npx rdicons add lucide:house
+```
+
+That writes `icons/lucide-house.svg`. Want a React component instead?
+
+```bash
+npx rdicons add tabler:bell ph:heart --format tsx --out src/icons --color "#4f46e5" --size 20
+```
+
+## Commands
+
+```
+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 sets                       list the 19 libraries with their licenses
+```
+
+| Option (add) | Default | |
+|---|---|---|
+| `--format` | `svg` | `svg`, `jsx` or `tsx` |
+| `--out` | `./icons` | output folder |
+| `--color` | keeps `currentColor` | any CSS color |
+| `--size` | `24` | px |
+| `--stroke` | the icon's own | stroke width (outline icons) |
+| `--padding` | `0` | extra space around the icon |
+| `--background` | none | solid background |
+
+Icons come from https://rdicons.vimalbhatt.com (set `RDICONS_URL` to use another address). Needs Node 18+.
+
+Each library keeps its own license (MIT, ISC, Apache-2.0, and CC BY 4.0 for Solar, which requires credit). Run `rdicons sets` to see them.
+
+Prefer components in React? See [`@rdicons/react`](https://www.npmjs.com/package/@rdicons/react). MIT licensed.

package/dist/cli.js

@@ -0,0 +1,275 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import { mkdir, writeFile } from "fs/promises";
+import { join, resolve } from "path";
+
+// ../core/dist/index.js
+var STROKE_WIDTH_RE = /stroke-width="[^"]*"/g;
+function supportsStrokeWidth(body) {
+  return /stroke-width="/.test(body);
+}
+function buildSvg(icon, opts = {}) {
+  const { color = "#000000", strokeWidth = null, size = 24, background = null, padding = 0, keepCurrentColor = false } = opts;
+  const w = icon.width || 24;
+  const h = icon.height || 24;
+  let body = icon.body;
+  if (!keepCurrentColor) body = body.replace(/currentColor/g, color);
+  if (strokeWidth != null && supportsStrokeWidth(body)) {
+    body = body.replace(STROKE_WIDTH_RE, `stroke-width="${strokeWidth}"`);
+  }
+  const vbX = -padding;
+  const vbY = -padding;
+  const vbW = w + padding * 2;
+  const vbH = h + padding * 2;
+  const px = Math.round(size * vbW / Math.max(vbW, vbH));
+  const py = Math.round(size * vbH / Math.max(vbW, vbH));
+  const bg = background ? `<rect x="${vbX}" y="${vbY}" width="${vbW}" height="${vbH}" fill="${background}"/>` : "";
+  return `<svg xmlns="http://www.w3.org/2000/svg" width="${px}" height="${py}" viewBox="${vbX} ${vbY} ${vbW} ${vbH}">${bg}${body}</svg>`;
+}
+var JSX_ATTRS = {
+  class: "className",
+  "stroke-width": "strokeWidth",
+  "stroke-linecap": "strokeLinecap",
+  "stroke-linejoin": "strokeLinejoin",
+  "stroke-miterlimit": "strokeMiterlimit",
+  "stroke-opacity": "strokeOpacity",
+  "stroke-dasharray": "strokeDasharray",
+  "stroke-dashoffset": "strokeDashoffset",
+  "fill-rule": "fillRule",
+  "fill-opacity": "fillOpacity",
+  "clip-rule": "clipRule",
+  "clip-path": "clipPath",
+  "stop-color": "stopColor",
+  "stop-opacity": "stopOpacity",
+  "xmlns:xlink": "xmlnsXlink",
+  "xlink:href": "xlinkHref"
+};
+function svgToJsx(svg, componentName2 = "Icon") {
+  const jsx = svg.replace(/\s([a-zA-Z:-]+)=/g, (_m, attr) => ` ${JSX_ATTRS[attr] ?? attr}=`);
+  return `export function ${componentName2}(props: React.SVGProps<SVGSVGElement>) {
+  return (
+    ${jsx.replace("<svg ", "<svg {...props} ")}
+  )
+}`;
+}
+function toPascalCase(name) {
+  const pascal = name.split(/[^a-zA-Z0-9]+/).filter(Boolean).map((p) => p[0].toUpperCase() + p.slice(1)).join("");
+  if (!pascal) return "Icon";
+  return /^[0-9]/.test(pascal) ? "Icon" + pascal : pascal;
+}
+var libPackage = (set) => `@rdicons/react-${set}`;
+function propsString(o = {}) {
+  const p = [];
+  if (o.size && o.size !== 24) p.push(`size={${o.size}}`);
+  if (o.color) p.push(`color="${o.color}"`);
+  if (o.strokeWidth != null) p.push(`strokeWidth={${o.strokeWidth}}`);
+  if (o.animate) p.push(o.animate === "hover" ? "animate" : `animate="${o.animate}"`);
+  return p.length ? " " + p.join(" ") : "";
+}
+function componentName(icon) {
+  if (icon.c) return icon.c;
+  const p = icon.n.split(/[^a-zA-Z0-9]+/).filter(Boolean).map((x) => x[0].toUpperCase() + x.slice(1)).join("");
+  return /^[0-9]/.test(p) ? "Icon" + p : p || "Icon";
+}
+function cliFlags(o = {}) {
+  const f = [];
+  if (o.color) f.push(`--color "${o.color}"`);
+  if (o.size && o.size !== 24) f.push(`--size ${o.size}`);
+  if (o.strokeWidth != null) f.push(`--stroke ${o.strokeWidth}`);
+  return f.length ? " " + f.join(" ") : "";
+}
+function snippetsFor(icon, o = {}) {
+  const C = componentName(icon);
+  const props = propsString(o);
+  const pkg = libPackage(icon.s);
+  return [
+    {
+      id: "lib",
+      title: `React: only ${icon.s}`,
+      note: "Smallest install: just this one library.",
+      install: `npm install ${pkg}`,
+      lang: "tsx",
+      code: `import { ${C} } from '${pkg}'
+
+export function Example() {
+  return <${C}${props} />
+}`
+    },
+    {
+      id: "all",
+      title: "React: all libraries",
+      note: "One package with every library. Only the icons you import are bundled.",
+      install: "npm install @rdicons/react",
+      lang: "tsx",
+      code: `import { ${C} } from '@rdicons/react/${icon.s}'
+
+export function Example() {
+  return <${C}${props} />
+}`
+    },
+    {
+      id: "cli",
+      title: "Just this one icon",
+      note: "Copies the icon into your project as a file. Nothing to install, works with any framework.",
+      install: `npx rdicons add ${icon.s}:${icon.n} --format tsx --out src/icons${cliFlags(o)}`,
+      lang: "tsx",
+      code: `import { ${C} } from './icons/${C}'
+
+export function Example() {
+  return <${C} />
+}`
+    }
+  ];
+}
+
+// src/cli.ts
+var VERSION = "0.1.0";
+var BASE = (process.env.RDICONS_URL || "https://rdicons.vimalbhatt.com").replace(/\/$/, "");
+var HELP = `rdicons ${VERSION}: add open-source icons to your project
+
+Usage
+  rdicons add <set:name> [more...] [options]   download icons into a folder
+  rdicons search <query> [--set lucide]         find icons by name
+  rdicons info <set:name>                       show the code to use one icon (every install option)
+  rdicons sets                                  list the 19 icon libraries
+
+Options for "add"
+  --format svg|jsx|tsx   output type (default svg)
+  --out <dir>            folder to write into (default ./icons)
+  --color <css color>    recolor the icon (default: keeps currentColor)
+  --size <px>            width/height (default 24)
+  --stroke <number>      stroke width for outline icons
+  --padding <number>     extra space around the icon (viewBox units)
+  --background <color>   solid background behind the icon
+
+Examples
+  npx rdicons add lucide:house
+  npx rdicons add tabler:bell ph:heart --format tsx --out src/icons --color "#4f46e5"
+  npx rdicons search "arrow right" --set lucide
+
+Icons keep their original license, shown by "rdicons sets". Site: ${BASE}
+`;
+var CliError = class extends Error {
+};
+function fail(msg) {
+  throw new CliError(msg);
+}
+async function getJson(path) {
+  let res;
+  try {
+    res = await fetch(BASE + path, { headers: { "user-agent": `rdicons-cli/${VERSION}` }, signal: AbortSignal.timeout(15e3) });
+  } catch (e) {
+    fail(`Could not reach ${BASE} (${e instanceof Error ? e.message : e}). Check your internet connection, or set RDICONS_URL.`);
+  }
+  if (!res.ok) fail(`${BASE}${path} answered ${res.status}`);
+  return await res.json();
+}
+function parseArgs(argv) {
+  const flags = {};
+  const positional = [];
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a.startsWith("--")) {
+      const [k, inline] = a.slice(2).split("=");
+      if (inline !== void 0) flags[k] = inline;
+      else if (argv[i + 1] !== void 0 && !argv[i + 1].startsWith("--")) flags[k] = argv[++i];
+      else flags[k] = "true";
+    } else positional.push(a);
+  }
+  return { flags, positional };
+}
+async function listSets() {
+  const data = await getJson("/api/sets");
+  return Array.isArray(data) ? data : data.sets;
+}
+async function cmdSets() {
+  const sets = await listSets();
+  const pad = Math.max(...sets.map((s) => s.prefix.length));
+  for (const s of sets) {
+    const note = s.license.startsWith("CC BY") ? " (credit the author)" : "";
+    console.log(`${s.prefix.padEnd(pad)}  ${s.label.padEnd(24)} ${String(s.total).padStart(6)} icons  ${s.license}${note}`);
+  }
+}
+async function cmdSearch(positional, flags) {
+  const q = positional.join(" ");
+  if (!q) fail('Tell me what to search for, e.g. rdicons search "arrow right"');
+  const limit = Math.min(Number(flags.limit ?? 20) || 20, 120);
+  const data = await getJson(
+    `/api/icons?q=${encodeURIComponent(q)}&set=${encodeURIComponent(flags.set ?? "")}&limit=${limit}`
+  );
+  if (!data.items.length) return console.log("No icons found.");
+  for (const it of data.items) console.log(`${it.s}:${it.n}`);
+  console.log(`
+${data.total.toLocaleString()} match${data.total === 1 ? "" : "es"}. Add one with: rdicons add ${data.items[0].s}:${data.items[0].n}`);
+}
+async function fetchIcon(ref) {
+  const i = ref.indexOf(":");
+  if (i < 1) fail(`"${ref}" should look like set:name, for example lucide:house`);
+  const set = ref.slice(0, i);
+  const name = ref.slice(i + 1);
+  const data = await getJson(`/api/icons?set=${encodeURIComponent(set)}&q=${encodeURIComponent(name)}&limit=120`);
+  const hit = data.items.find((x) => x.n === name);
+  if (!hit) {
+    const near = data.items.slice(0, 5).map((x) => `${x.s}:${x.n}`);
+    fail(`No icon "${ref}".${near.length ? ` Did you mean: ${near.join(", ")}?` : ` Try: rdicons search ${name}`}`);
+  }
+  return hit;
+}
+async function cmdInfo(positional) {
+  if (!positional[0]) fail("Which icon? For example: rdicons info lucide:house");
+  const it = await fetchIcon(positional[0]);
+  const [lib, all, one] = snippetsFor(it);
+  console.log(`${it.s}:${it.n}   (React component: ${it.c ?? toPascalCase(it.n)})
+`);
+  for (const [i, sn] of [lib, all, one].entries()) {
+    console.log(`${i + 1}) ${sn.title}${sn.note ? " - " + sn.note : ""}`);
+    if (sn.install) console.log(`   $ ${sn.install}`);
+    console.log(sn.code.split("\n").map((l) => "   " + l).join("\n") + "\n");
+  }
+  console.log('Run "rdicons sets" to see the license of this library (some need attribution).');
+}
+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 = resolve(flags.out ?? "icons");
+  await mkdir(out, { recursive: true });
+  for (const ref of positional) {
+    const it = await fetchIcon(ref);
+    const svg = buildSvg(
+      { body: it.b, width: it.w ?? 24, height: it.h ?? 24 },
+      {
+        color: flags.color,
+        keepCurrentColor: flags.color === void 0,
+        size: flags.size ? Number(flags.size) : 24,
+        strokeWidth: flags.stroke ? Number(flags.stroke) : null,
+        padding: flags.padding ? Number(flags.padding) : 0,
+        background: flags.background ?? null
+      }
+    );
+    const comp = it.c ?? toPascalCase(it.n);
+    const file = format === "svg" ? `${it.s}-${it.n}.svg` : `${comp}.${format}`;
+    const text = format === "svg" ? svg + "\n" : svgToJsx(svg, comp) + "\n";
+    await writeFile(join(out, file), text, "utf8");
+    console.log(`\u2713 ${it.s}:${it.n} -> ${join(flags.out ?? "icons", file)}`);
+  }
+  console.log('\nTip: run "rdicons sets" to see each library license (some need attribution).');
+}
+async function main() {
+  const [cmd, ...rest] = process.argv.slice(2);
+  const { flags, positional } = parseArgs(rest);
+  if (!cmd || cmd === "help" || cmd === "--help" || cmd === "-h" || flags.help) return console.log(HELP);
+  if (cmd === "--version" || cmd === "-v" || cmd === "version") return console.log(VERSION);
+  if (cmd === "sets") return cmdSets();
+  if (cmd === "search") return cmdSearch(positional, flags);
+  if (cmd === "info") return cmdInfo(positional);
+  if (cmd === "add") return cmdAdd(positional, flags);
+  fail(`Unknown command "${cmd}". Run rdicons --help`);
+}
+main().catch((e) => {
+  console.error(`
+Error: ${e instanceof Error ? e.message : String(e)}
+`);
+  process.exitCode = 1;
+});

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "rdicons",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.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",
+  "author": "rdicons contributors",
+  "homepage": "https://rdicons.vimalbhatt.com/docs/cli",
+  "repository": { "type": "git", "url": "git+https://github.com/DevHydeOut/rdicons-lib.git" },
+  "bugs": { "url": "https://github.com/DevHydeOut/rdicons-lib/issues" },
+  "type": "module",
+  "bin": { "rdicons": "./dist/cli.js" },
+  "main": "./dist/cli.js",
+  "files": ["dist", "README.md", "LICENSE"],
+  "engines": { "node": ">=18" },
+  "publishConfig": { "access": "public" },
+  "scripts": {
+    "build": "tsup",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "@rdicons/core": "*",
+    "tsup": "^8.5.0",
+    "typescript": "^5.6.0"
+  }
+}