@wkovacs64/add-icon 0.1.0-dev.b5c05efe → 0.1.0-dev.e2dd6945

package/README.md

@@ -14,58 +14,27 @@ npm install @wkovacs64/add-icon
 Or use it directly with npx without installing:
 
 ```bash
-npx @wkovacs64/add-icon heroicons:arrow-up-circle
+npx @wkovacs64/add-icon <icon> [options]
 ```
 
 ## Usage
 
 ### Basic Usage
 
-Download an icon:
+Download an icon to the specified directory:
 
 ```bash
-npx @wkovacs64/add-icon heroicons:arrow-up-circle
-```
-
-Specify an output directory:
-
-```bash
-npx @wkovacs64/add-icon heroicons:arrow-up-circle --output-dir ./my-icons
+npx @wkovacs64/add-icon heroicons:arrow-up-circle --output-dir ./app/assets/svg-icons
 ```
 
 ### Transformations
 
-The tool fetches SVG icons directly from the Iconify API with width and height attributes removed automatically. You can add custom transformations for more advanced modifications.
-
-### Custom Transformations
-
-You can write custom transforms in either JavaScript or TypeScript!
+The tool fetches SVG icons directly from the Iconify API with width and height attributes removed automatically. You can optionally provide a transform file using either JavaScript or TypeScript containing custom transformations for more advanced modifications.
 
-#### JavaScript Transform
-
-Create a custom transform file (e.g., `my-transform.js`):
-
-```js
-/**
- * Custom transform to add a title element to SVG
- * @param {Object} args - Transform arguments
- * @param {string} args.svg - SVG content
- * @param {string} args.iconName - Icon name (e.g., 'heroicons:arrow-up-circle')
- * @param {string} args.prefix - Icon set prefix (e.g., 'heroicons')
- * @param {string} args.name - Icon name without prefix (e.g., 'arrow-up-circle')
- * @returns {string} - Transformed SVG
- */
-export default function addTitle(args) {
-  const titleElement = `<title>${args.iconName}</title>`;
-  return args.svg.replace(/<svg([^>]*)>/, `<svg$1>${titleElement}`);
-}
-```
-
-#### TypeScript Transform
-
-Create a custom transform file (e.g., `my-transform.ts`) that will be imported directly:
+#### TypeScript Transform Example
 
 ```ts
+// my-transform.ts
 import type { TransformArgs } from '@wkovacs64/add-icon';
 
 /**
@@ -82,37 +51,17 @@ export default function addTitle(args: TransformArgs): string {
 Then use it with the CLI:
 
 ```bash
-# JavaScript transform
-npx @wkovacs64/add-icon heroicons:arrow-up-circle --transform ./my-transform.js
-
-# TypeScript transform
 npx @wkovacs64/add-icon heroicons:arrow-up-circle --transform ./my-transform.ts
 ```
 
-## Configuration File
+### Configuration File
 
 You can create a configuration file in your project root, using either JavaScript (`add-icon.config.js`) or TypeScript (`add-icon.config.ts`).
 
-### JavaScript Configuration
-
-```js
-// Define custom transform
-function addCustomAttribute(args) {
-  return args.svg.replace(/<svg/, `<svg data-icon="${args.iconName}"`);
-}
-
-export default {
-  outputDir: './assets/icons',
-  transforms: [addCustomAttribute],
-};
-```
-
-### TypeScript Configuration
-
-You can create a TypeScript configuration file and the tool will import it directly:
+#### TypeScript Configuration Example
 
 ```ts
-import type { IconifyConfig, TransformArgs } from '@wkovacs64/add-icon';
+import type { Config, TransformArgs, TransformFunction } from '@wkovacs64/add-icon';
 
 // Define custom transform
 function addCustomAttribute(args: TransformArgs): string {
@@ -122,70 +71,11 @@ function addCustomAttribute(args: TransformArgs): string {
 const config = {
   outputDir: './assets/icons',
   transforms: [addCustomAttribute],
-} satisfies IconifyConfig;
+} satisfies Config;
 
 export default config;
 ```
 
-> **Note:** TypeScript configuration and transform files are compiled in-memory using esbuild, without creating temporary JavaScript files. This provides a seamless TypeScript experience with no extra build steps.
-
-## Using as a Library
-
-You can also use iconify-cli as a library in your own projects:
-
-### JavaScript
-
-```js
-import { downloadIcon } from '@wkovacs64/add-icon';
-
-// Create custom transform
-function addCustomAttribute(args) {
-  return args.svg.replace(/<svg/, `<svg data-custom="${args.iconSet}"`);
-}
-
-// Download an icon with transforms
-async function downloadCustomIcon() {
-  const iconPath = await downloadIcon('heroicons:heart', {
-    outputDir: './icons',
-    transforms: [addCustomAttribute],
-  });
-
-  console.log(`Icon saved to: ${iconPath}`);
-}
-
-downloadCustomIcon();
-```
-
-### TypeScript
-
-```ts
-import { downloadIcon, type TransformArgs } from '@wkovacs64/add-icon';
-
-// Create custom transform
-const addCustomAttribute = (args: TransformArgs): string => {
-  return args.svg.replace(/<svg/, `<svg data-custom="${args.iconSet}"`);
-};
-
-// Download an icon with transforms
-async function downloadCustomIcon(): Promise<void> {
-  try {
-    const iconPath = await downloadIcon('heroicons:heart', {
-      outputDir: './icons',
-      transforms: [addCustomAttribute],
-    });
-
-    console.log(`Icon saved to: ${iconPath}`);
-  } catch (error) {
-    console.error(
-      'Error downloading icon:',
-      error instanceof Error ? error.message : String(error),
-    );
-  }
-}
-
-downloadCustomIcon();
-```
-
 ## License
 
 MIT

package/dist/config.d.ts

@@ -1,11 +1,11 @@
-import type { IconifyConfig } from './types.js';
+import type { Config } from './types.js';
 /**
  * Default configuration
  */
-export declare const defaultConfig: IconifyConfig;
+export declare const defaultConfig: Config;
 /**
  * Loads configuration from file if it exists
  * @param configPath - Path to config file
  * @returns Configuration object
  */
-export declare function loadConfig(configPath?: string): Promise<IconifyConfig>;
+export declare function loadConfig(configPath?: string): Promise<Config>;

package/dist/iconify.d.ts

@@ -1,4 +1,4 @@
-import type { IconifyConfig } from './types.js';
+import type { Config } from './types.js';
 /**
  * Parses an icon reference into iconSet and iconName
  * @param iconReference - Reference in format 'iconSet:iconName'
@@ -14,4 +14,4 @@ export declare function parseIconReference(iconReference: string): {
  * @param config - Configuration options
  * @returns Path to saved icon file
  */
-export declare function downloadIcon(iconReference: string, config: IconifyConfig): Promise<string>;
+export declare function downloadIcon(iconReference: string, config: Config): Promise<string>;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import type { IconTransform, TransformArgs } from './types.js';
-export type { IconTransform, TransformArgs };
+import type { TransformFunction, TransformArgs, Config } from './types.js';
+export type { TransformFunction, TransformArgs, Config };
 export { downloadIcon, parseIconReference } from './iconify.js';
+export { loadConfig, defaultConfig } from './config.js';
 export declare function runCli(): void;

package/dist/index.js

@@ -6,6 +6,7 @@ import { importModule } from './import-module.js';
 import { getPackageInfo } from './package-info.js';
 // Re-export other useful functions
 export { downloadIcon, parseIconReference } from './iconify.js';
+export { loadConfig, defaultConfig } from './config.js';
 // Create CLI program
 const program = new Command();
 // Set up the program with package info

package/dist/types.d.ts

@@ -12,13 +12,13 @@ export type TransformArgs = {
 /**
  * SVG transformation function type
  */
-export type IconTransform = (args: TransformArgs) => Promise<string> | string;
+export type TransformFunction = (args: TransformArgs) => Promise<string> | string;
 /**
- * Configuration options for the Iconify CLI
+ * Configuration options for the add-icon CLI
  */
-export type IconifyConfig = {
+export type Config = {
     /** Directory to output icons */
     outputDir: string;
     /** Array of transform functions to apply to icons */
-    transforms?: IconTransform[];
+    transforms?: TransformFunction[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wkovacs64/add-icon",
-  "version": "0.1.0-dev.b5c05efe",
+  "version": "0.1.0-dev.e2dd6945",
   "description": "CLI tool to download and transform icons from Iconify",
   "keywords": [
     "iconify",