convert-svg-core-test

A Node.js package for testing SVG converters implementing using convert-svg-core. This package is not intended for general use and, instead, provides core support for testing SVG converters.

Install

Install using npm:

npm install --save-dev convert-svg-core-test

You'll need to have at least Node.js v22 or newer.

If you're looking to create a converter for a new format, we'd urge you to consider contributing to this framework so that it can be easily integrated and maintained. Read the Contributors section for information on how you can contribute.

Usage

Take a look at the tests for existing SVG converters under the packages directory for examples on how to use this package.

Testing

Testing your SVG converter actually works is just as important as implementing it. Since convert-svg-core contains a lot of the conversion logic, a convert-svg-core-test package is available to make testing implementations even easier. Again, take a look at the tests for existing SVG converters under the packages directory for examples.

Environment

This package supports the use of a CONVERT_SVG_TEST_OPTIONS environment variable to act as a base for the options passed to the TestRunner constructor. This can make it easier to temporarily change test options during testing. For example;

CONVERT_SVG_TEST_OPTIONS='{"retainOutputFiles": true}' npm test

macOS

⚠️ Heads up!

If you develop using macOS it's important to note that, due to a noticeable reduction in the quality of output files when running on macOS, you will be expected to use some slightly different npm run-scripts. These use Docker under-the-hood primarily to ensure more consistent test outputs. Most notably, these run-scripts include:

Bugs

If you have any problems with this package or would like to see changes currently in development, you can do so here.

Contributors

If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!

A list of all contributors can be found in AUTHORS.md.

License

Copyright © 2025 neocotic

See LICENSE.md for more information on our MIT license.