#Snapshot Testing for Pest

This package adds snapshot testing capabilities to Pest. It wraps our phpunit-snapshot-assertions package making snapshot assertions available in Pest tests.

#Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

#Installation

You can install the package via composer:

composer require spatie/pest-plugin-snapshots --dev

#Usage

use function Spatie\Snapshots\{assertMatchesSnapshot, assertMatchesJsonSnapshot};

it('can be cast to string', function () {
    $order = new Order(1);

    assertMatchesSnapshot($order->toString());
});

it('can be cast to json', function () {
    $order = new Order(1);

    assertMatchesJsonSnapshot($order->toJson());
});

You can also use an expectation:

it('can be cast to string', function () {
    $order = new Order(1);

    expect($order->toString())->toMatchSnapshot();
});

For the full list of assertions, please refer to underlying package: phpunit-snapshot-assertions.

#Testing

composer test

#Changelog

Please see CHANGELOG for more information on what has changed recently.

#Contributing

Please see CONTRIBUTING for details.

#Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.

#Credits

• Nuno Maduro
• All Contributors

#License

The MIT License (MIT). Please see License File for more information.