https://github.com/0fatihyildiz/icon-transpiler
Transpile Iconify is a command-line tool that transforms SVG files into JSON format for use with Iconify.
https://github.com/0fatihyildiz/icon-transpiler
cli iconify json svg transpiler
Last synced: about 1 month ago
JSON representation
Transpile Iconify is a command-line tool that transforms SVG files into JSON format for use with Iconify.
- Host: GitHub
- URL: https://github.com/0fatihyildiz/icon-transpiler
- Owner: 0fatihyildiz
- Created: 2024-10-21T20:37:58.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-10-23T17:47:38.000Z (12 months ago)
- Last Synced: 2024-10-24T01:56:35.835Z (12 months ago)
- Topics: cli, iconify, json, svg, transpiler
- Language: TypeScript
- Homepage:
- Size: 30.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Transpile Iconify
Transpile Iconify is a command-line tool that transforms SVG files into JSON format for use with Iconify.
## Features
- Convert SVG icons to Iconify JSON format
- Clean and optimize SVG files using @iconify/tools
- Configurable expected sizes and validation
- Multiple icon sets processing in a single run
- Custom prefixes for icon sets
## Installation
```bash
# Install globally
npm install -g transpile-iconify
# Or run with npx
npx transpile-iconify
```
## Usage
```bash
transpile-iconify --config=iconify.config.js
```
### Options
- `--config`: Path to configuration file (default: 'iconify.config.json')
## Configuration File
Create a JavaScript or JSON configuration file that defines your icon sets:
```js
// iconify.config.js
module.exports = [
{
sourceDir: './path/to/icons',
targetFile: './dist/icons.json',
prefix: 'custom-icons',
expectedSize: 24,
iconSetInfo: {
name: 'Custom Icon Set',
author: {
name: 'Your Name',
url: 'https://example.com'
},
license: {
title: 'MIT',
url: 'https://opensource.org/licenses/MIT'
}
}
},
// You can add more icon sets here
];
```
### Configuration Options
Each icon set configuration supports these properties:
- `sourceDir`: Directory containing SVG icon files
- `targetFile`: Output JSON file path
- `prefix`: Icon set prefix used in Iconify
- `expectedSize` (optional): Validates that icons have the expected dimensions
- `iconSetInfo`: Metadata about the icon set (name, author, license, etc.)
## How It Works
1. The tool reads your configuration file
2. For each icon set in the configuration:
- Imports SVG files from the specified directory
- Cleans and optimizes SVG content
- Validates dimensions if expectedSize is provided
- Converts colors to `currentColor` for proper theming
- Exports to Iconify JSON format
## Output Format
The generated JSON files follow the Iconify JSON format:
```json
{
"prefix": "custom-icons",
"icons": {
"icon-name": {
"body": "",
"width": 24,
"height": 24
}
}
}
```
## Test Coverage
This project uses `vitest` for testing. To generate a coverage report, run the following command:
```bash
pnpm test
```
The coverage report will be available in the `coverage/` directory. Open `coverage/index.html` in your browser to view detailed coverage information.
## Author
0fatihyildiz
## Keywords
- svg
- json
- iconify
- cli
- transpiler
## Dependencies
- @iconify/tools: For SVG cleaning and optimization
- cheerio: HTML/XML parser and manipulator
- cleye: For command-line argument parsing
- glob: File pattern matching
- xml2js: XML to JavaScript object converter
## License
MIT