re-svg-pack 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Garik Harutyunyan
+
+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 OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,135 @@
+# re-svg
+
+A modern CLI tool and library for generating icon fonts from SVG files. 
+
+## Features
+
+- **CLI command**: `icon-gen` - Generate icon fonts from SVG folders directly from terminal
+- **Library API**: Programmatic access to icon font generation
+- **Multiple formats**: Generates WOFF2, WOFF, TTF, and EOT fonts
+- **CSS output**: Automatic CSS stylesheet generation for easy font usage
+- **TypeScript**: Full TypeScript support with type definitions
+
+## Installation
+
+### Global CLI
+
+```bash
+npm install -g re-svg
+```
+
+Then use the CLI:
+
+```bash
+icon-gen --input ./icons --output ./fonts
+```
+
+### As a Library
+
+```bash
+npm install re-svg
+```
+
+Then use programmatically:
+
+```typescript
+import { generateIconFont } from 're-svg';
+
+await generateIconFont({
+  inputDir: './icons',
+  outputDir: './fonts',
+  fontName: 'my-icons'
+});
+```
+
+## CLI Usage
+
+```bash
+icon-gen --input <path> --output <path> [options]
+```
+
+### Required Arguments
+
+- `--input, -i <path>` — Directory containing SVG files to convert
+- `--output, -o <path>` — Directory where generated fonts will be saved
+
+### Optional Arguments
+
+- `--name, -n <name>` — Font family name (default: `re-svg-icons`)
+- `--formats, -f <formats>` — Comma-separated list of font formats (default: `woff2,woff,ttf`)
+  - Available: `woff2`, `woff`, `ttf`, `eot`
+
+### Examples
+
+```bash
+# Basic usage with defaults
+icon-gen --input ./my-icons --output ./dist
+
+# Custom font name and specific formats
+icon-gen -i ./icons -o ./fonts -n "custom-icons" -f "woff2,ttf"
+
+# Help
+icon-gen --help
+```
+
+## Library API
+
+### `generateIconFont(config)`
+
+Generate icon fonts programmatically.
+
+```typescript
+import { generateIconFont } from 're-svg';
+
+interface IconFontConfig {
+  inputDir: string;           // Required: Input SVG directory
+  outputDir: string;          // Required: Output directory
+  fontName?: string;          // Optional: Font family name (default: 're-svg-icons')
+  formats?: string[];         // Optional: Font formats array (default: ['woff2', 'woff', 'ttf'])
+  fontsUrl?: string;          // Optional: CSS font URL path
+}
+
+const config: IconFontConfig = {
+  inputDir: './icons',
+  outputDir: './dist',
+  fontName: 'my-icons',
+  formats: ['woff2', 'ttf']
+};
+
+await generateIconFont(config);
+```
+
+## System Requirements
+
+### fontforge
+
+`re-svg` requires `fontforge` to be installed on your system:
+
+- **macOS**: `brew install fonttools`
+- **Ubuntu/Debian**: `sudo apt-get install fontforge`
+- **Windows**: Included with Node.js build tools. If missing, install via [FontForge releases](https://fontforge.org/en-US/downloads/)
+
+## v0.1.0 Scope
+
+This is the minimal viable product (MVP) version of re-svg. It focuses on:
+
+- ✅ Simple CLI interface for font generation
+- ✅ Basic library wrapper around Fantasticon
+- ✅ Standard font formats (WOFF2, WOFF, TTF, EOT)
+- ✅ CSS stylesheet generation
+
+Future versions will include:
+
+- Custom templates
+- Icon aliasing
+- SCSS/LESS stylesheet support
+- Multiple font variants
+- Icon metadata export
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.

package/lib/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const package_json_1 = require("../package.json");
+const index_1 = require("./index");
+async function main() {
+    commander_1.program
+        .name('icon-gen')
+        .description('Generate icon fonts from SVG files')
+        .version(package_json_1.version);
+    commander_1.program
+        .requiredOption('-i, --input <path>', 'Input directory containing SVG files')
+        .requiredOption('-o, --output <path>', 'Output directory for generated fonts')
+        .option('-n, --name <name>', 'Font family name', 're-svg-icons')
+        .option('-f, --formats <formats>', 'Comma-separated font formats (woff2,woff,ttf,eot)', 'woff2,woff,ttf,eot')
+        .option('--fonts-url <url>', 'CSS font URL path', '')
+        .action(async (options) => {
+        try {
+            const fontTypes = options.formats.split(',').map((f) => f.trim());
+            console.log(`Generating icon font from: ${options.input}`);
+            console.log(`Output directory: ${options.output}`);
+            console.log(`Font name: ${options.name}`);
+            console.log(`Formats: ${fontTypes.join(', ')}`);
+            await (0, index_1.generateIconFont)({
+                inputDir: options.input,
+                outputDir: options.output,
+                name: options.name,
+                fontTypes,
+                fontsUrl: options.fontsUrl
+            });
+            console.log('✓ Icon font generated successfully!');
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                console.error('✗ Error:', error.message);
+            }
+            else {
+                console.error('✗ Unknown error occurred');
+            }
+            process.exit(1);
+        }
+    });
+    commander_1.program.parse(process.argv);
+}
+main().catch((error) => {
+    console.error('Fatal error:', error);
+    process.exit(1);
+});

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+export interface IconFontConfig {
+    inputDir: string;
+    outputDir: string;
+    name?: string;
+    fontTypes?: string[];
+    assetTypes?: string[];
+    fontsUrl?: string;
+}
+/**
+ * Generate icon fonts from SVG files
+ * @param config Configuration for icon font generation
+ * @throws Error if inputDir doesn't exist or SVG files cannot be processed
+ */
+export declare function generateIconFont(config: IconFontConfig): Promise<void>;
+export default generateIconFont;

package/lib/index.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIconFont = generateIconFont;
+const fantasticon_1 = require("fantasticon");
+const fs_1 = require("fs");
+/**
+ * Generate icon fonts from SVG files
+ * @param config Configuration for icon font generation
+ * @throws Error if inputDir doesn't exist or SVG files cannot be processed
+ */
+async function generateIconFont(config) {
+    const { inputDir, outputDir, name = 're-svg-icons', fontTypes = [fantasticon_1.FontAssetType.WOFF2, fantasticon_1.FontAssetType.WOFF, fantasticon_1.FontAssetType.TTF, fantasticon_1.FontAssetType.EOT], assetTypes = [fantasticon_1.OtherAssetType.CSS, fantasticon_1.OtherAssetType.JSON, fantasticon_1.OtherAssetType.HTML], fontsUrl = './' } = config;
+    // Validate input directory exists
+    try {
+        await fs_1.promises.access(inputDir);
+    }
+    catch (error) {
+        throw new Error(`Input directory does not exist: ${inputDir}`);
+    }
+    // Create output directory if it doesn't exist
+    try {
+        await fs_1.promises.mkdir(outputDir, { recursive: true });
+    }
+    catch (error) {
+        throw new Error(`Cannot create output directory: ${outputDir}`);
+    }
+    try {
+        await (0, fantasticon_1.generateFonts)({
+            inputDir,
+            outputDir,
+            name,
+            fontTypes: fontTypes,
+            assetTypes: assetTypes,
+            fontsUrl
+        });
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`Font generation failed: ${error.message}`);
+        }
+        throw error;
+    }
+}
+exports.default = generateIconFont;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "re-svg-pack",
+  "version": "0.1.0",
+  "description": "A CLI tool and library for generating icon fonts from SVG files.",
+  "license": "MIT",
+  "author": "Garik Harutyunyan",
+  "homepage": "https://github.com/GarikHarutyunyan/re-svg",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GarikHarutyunyan/re-svg.git"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "bin": {
+    "icon-gen": "lib/cli.js"
+  },
+  "files": [
+    "lib",
+    "types",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build && npm run test:pack",
+    "test:pack": "npm pack --dry-run"
+  },
+  "keywords": [
+    "svg",
+    "icon",
+    "font",
+    "icon-font",
+    "cli",
+    "fantasticon"
+  ],
+  "dependencies": {
+    "fantasticon": "^2.0.0",
+    "commander": "^11.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "@types/node": "^20.10.6"
+  },
+  "overrides": {
+    "fantasticon": {
+      "glob": "7.2.0"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}