{"id":17843634,"url":"https://github.com/0fatihyildiz/icon-transpiler","last_synced_at":"2025-09-01T18:40:52.416Z","repository":{"id":259116537,"uuid":"876356550","full_name":"0fatihyildiz/icon-transpiler","owner":"0fatihyildiz","description":"Transpile Iconify is a command-line tool that transforms SVG files into JSON format for use with Iconify.","archived":false,"fork":false,"pushed_at":"2024-10-23T17:47:38.000Z","size":31,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-24T01:56:35.835Z","etag":null,"topics":["cli","iconify","json","svg","transpiler"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0fatihyildiz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-21T20:37:58.000Z","updated_at":"2024-10-23T17:48:04.000Z","dependencies_parsed_at":"2024-10-23T05:23:43.780Z","dependency_job_id":null,"html_url":"https://github.com/0fatihyildiz/icon-transpiler","commit_stats":null,"previous_names":["0fatihyildiz/icon-transpiler"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0fatihyildiz%2Ficon-transpiler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0fatihyildiz%2Ficon-transpiler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0fatihyildiz%2Ficon-transpiler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0fatihyildiz%2Ficon-transpiler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0fatihyildiz","download_url":"https://codeload.github.com/0fatihyildiz/icon-transpiler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221735048,"owners_count":16872223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","iconify","json","svg","transpiler"],"created_at":"2024-10-27T21:26:23.832Z","updated_at":"2025-09-01T18:40:52.411Z","avatar_url":"https://github.com/0fatihyildiz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Transpile Iconify\n\n![Coverage](https://img.shields.io/badge/coverage-92.1%25-brightgreen)\n\nTranspile Iconify is a command-line tool that transforms SVG files into JSON format for use with Iconify.\n\n## Features\n\n- Convert SVG icons to Iconify JSON format\n- Clean and optimize SVG files using @iconify/tools\n- Configurable expected sizes and validation\n- Multiple icon sets processing in a single run\n- Custom prefixes for icon sets\n\n## Installation\n\n```bash\n# Install globally\nnpm install -g transpile-iconify\n\n# Or run with npx\nnpx transpile-iconify\n```\n\n## Usage\n\n```bash\ntranspile-iconify --config=iconify.config.js\n```\n\n### Options\n\n- `--config`: Path to configuration file (default: 'iconify.config.json')\n\n## Configuration File\n\nCreate a JavaScript or JSON configuration file that defines your icon sets:\n\n```js\n// iconify.config.js\nmodule.exports = [\n  {\n    sourceDir: './path/to/icons',\n    targetFile: './dist/icons.json',\n    prefix: 'custom-icons',\n    expectedSize: 24,\n    iconSetInfo: {\n      name: 'Custom Icon Set',\n      author: {\n        name: 'Your Name',\n        url: 'https://example.com'\n      },\n      license: {\n        title: 'MIT',\n        url: 'https://opensource.org/licenses/MIT'\n      }\n    }\n  },\n  // You can add more icon sets here\n];\n```\n\n### Configuration Options\n\nEach icon set configuration supports these properties:\n\n- `sourceDir`: Directory containing SVG icon files\n- `targetFile`: Output JSON file path\n- `prefix`: Icon set prefix used in Iconify\n- `expectedSize` (optional): Validates that icons have the expected dimensions\n- `iconSetInfo`: Metadata about the icon set (name, author, license, etc.)\n\n## How It Works\n\n1. The tool reads your configuration file\n2. For each icon set in the configuration:\n   - Imports SVG files from the specified directory\n   - Cleans and optimizes SVG content\n   - Validates dimensions if expectedSize is provided\n   - Converts colors to `currentColor` for proper theming\n   - Exports to Iconify JSON format\n\n## Output Format\n\nThe generated JSON files follow the Iconify JSON format:\n\n```json\n{\n  \"prefix\": \"custom-icons\",\n  \"icons\": {\n    \"icon-name\": {\n      \"body\": \"\u003cpath d=\\\"...\\\" fill=\\\"currentColor\\\"/\u003e\",\n      \"width\": 24,\n      \"height\": 24\n    }\n  }\n}\n```\n\n## Test Coverage\n\nThis project uses `vitest` for testing. To generate a coverage report, run the following command:\n\n```bash\npnpm test\n```\n\nThe coverage report will be available in the `coverage/` directory. Open `coverage/index.html` in your browser to view detailed coverage information.\n\n## Author\n\n0fatihyildiz\n\n## Keywords\n\n- svg\n- json\n- iconify\n- cli\n- transpiler\n\n## Dependencies\n\n- @iconify/tools: For SVG cleaning and optimization\n- cheerio: HTML/XML parser and manipulator\n- cleye: For command-line argument parsing\n- glob: File pattern matching\n- xml2js: XML to JavaScript object converter\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0fatihyildiz%2Ficon-transpiler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0fatihyildiz%2Ficon-transpiler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0fatihyildiz%2Ficon-transpiler/lists"}