svg-icon-review
v2.1.0
Published
Tool to review SVG icons automatically
Downloads
268
Readme
CLI Command
The tool can be executed with this command:
bunx svg-icon-review file1.svg file2.svg
It also supports glob file patterns to check multiple files matching the pattern like this:
bunx svg-icon-review ./images/**/*.svg
The output is a preview of how the icons look in either dark or light backgrounds:
Options
Optionally, 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:
bunx svg-icon-review --bigIcon file1.svg file2.svg
The preview will look like this:
If further help is needed, the --help
option can be used:
bunx svg-icon-review --help
Instead of "bunx" you can use "npx" if you prefer Node.js.
Development
For the development of this tool, Bun.js is used. First you have to install the dependencies:
bun install
Then you can run the tool with:
bun run start
It is going to create a preview image of the logo.svg file in the root directory.
Formatting and Linting
To format the code, run:
bun run format
To lint the code, run:
bun run lint