{"id":16610985,"url":"https://github.com/material-extensions/svg-icon-review","last_synced_at":"2025-10-29T18:30:16.763Z","repository":{"id":206792702,"uuid":"717718306","full_name":"material-extensions/svg-icon-review","owner":"material-extensions","description":"Automatically review your SVG icons","archived":false,"fork":false,"pushed_at":"2025-01-21T11:21:47.000Z","size":434,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-10T10:44:14.524Z","etag":null,"topics":["review-tools","svg"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/material-extensions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":["pkief"],"custom":["https://paypal.me/philippkief","https://buymeacoffee.com/pkief"]}},"created_at":"2023-11-12T11:18:42.000Z","updated_at":"2025-02-09T11:53:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"078d61aa-ac6c-4a64-b7e2-515788dd48ba","html_url":"https://github.com/material-extensions/svg-icon-review","commit_stats":{"total_commits":46,"total_committers":3,"mean_commits":"15.333333333333334","dds":"0.26086956521739135","last_synced_commit":"81e108321d500553d15c53c5ff12e0a6faf86da7"},"previous_names":["pkief/svg-icon-review","material-extensions/svg-icon-review"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-extensions%2Fsvg-icon-review","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-extensions%2Fsvg-icon-review/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-extensions%2Fsvg-icon-review/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/material-extensions%2Fsvg-icon-review/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/material-extensions","download_url":"https://codeload.github.com/material-extensions/svg-icon-review/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238864091,"owners_count":19543469,"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":["review-tools","svg"],"created_at":"2024-10-12T01:34:16.150Z","updated_at":"2025-10-29T18:30:16.174Z","avatar_url":"https://github.com/material-extensions.png","language":"TypeScript","funding_links":["https://github.com/sponsors/pkief","https://paypal.me/philippkief","https://buymeacoffee.com/pkief"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\r\n  \u003cbr\u003e\r\n    \u003cimg src=\"./logo.png\" alt=\"logo\" width=\"200\"\u003e\r\n  \u003cbr\u003e\u003cbr\u003e\r\n  SVG Icon Review\r\n  \u003cbr\u003e\r\n  \u003cbr\u003e\r\n\u003c/h1\u003e\r\n\r\n\u003ch4 align=\"center\"\u003eTool to review SVG icons automatically\u003c/h4\u003e\r\n\r\n## CLI Command\r\n\r\nThe tool can be executed with this command:\r\n\r\n```\r\nbunx svg-icon-review file1.svg file2.svg\r\n```\r\n\r\nIt also supports glob file patterns to check multiple files matching the pattern like this:\r\n\r\n```\r\nbunx svg-icon-review ./images/**/*.svg\r\n```\r\n\r\nThe output is a preview of how the icons look in either dark or light backgrounds:\r\n\r\n\u003cimg src=\"./images/preview.png\" alt=\"logo\" \u003e\r\n\r\n## Options\r\n\r\n### `--bigIcon`\r\n\r\nOptionally, an additional bigger icon (in size of 32x32px) will be shown in front of the preview. This is useful to see the icon in more detail. This can be done by adding the `--bigIcon` option like this:\r\n\r\n```bash\r\nbunx svg-icon-review --bigIcon file1.svg file2.svg\r\n```\r\n\r\nThe preview will look like this:\r\n\r\n\u003cimg src=\"./images/preview-big-icon.png\" alt=\"logo\" \u003e\r\n\r\n### `--silent`\r\n\r\nBy default, the tool will output a result message to the console. If you want to avoid this output, you can use the `--silent` option:\r\n\r\n```bash\r\nbunx svg-icon-review --silent file1.svg file2.svg\r\n```\r\n\r\n### `--debug`\r\n\r\nIf you want to see the debug information, you can use the `--debug` option:\r\n\r\n```bash\r\nbunx svg-icon-review --debug file1.svg file2.svg\r\n```\r\n\r\n### `--noSandbox`\r\n\r\nBy default, the tool uses a sandboxed environment to render the SVG icons. If you want to disable this sandbox, you can use the `--noSandbox` option:\r\n\r\n```bash\r\nbunx svg-icon-review --noSandbox file1.svg file2.svg\r\n```\r\n\r\nRunning without a sandbox is strongly discouraged because of security risks. Consider configuring a sandbox instead. If you absolutely trust the content you with this tool, you can launch it with the --noSandbox argument.\r\n\r\n### `--help`\r\n\r\nIf further help is needed, the `--help` option can be used:\r\n\r\n```bash\r\nbunx svg-icon-review --help\r\n```\r\n\r\n\u003e Instead of \"bunx\" you can use \"npx\" if you prefer Node.js.\r\n\r\n## Development\r\n\r\nFor the development of this tool, Bun.js is used. First you have to install the dependencies:\r\n\r\n```bash\r\nbun install\r\n```\r\n\r\nThen you can run the tool with:\r\n\r\n```bash\r\nbun run start\r\n```\r\n\r\nIt is going to create a preview image of the logo.svg file in the root directory.\r\n\r\n### Formatting and Linting\r\n\r\nTo format the code, run:\r\n\r\n```bash\r\nbun run format\r\n```\r\n\r\nTo lint the code, run:\r\n\r\n```bash\r\nbun run lint\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterial-extensions%2Fsvg-icon-review","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaterial-extensions%2Fsvg-icon-review","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterial-extensions%2Fsvg-icon-review/lists"}