ryanplasma/peridot-emoji-reporter

An emoji reporter for the Peridot testing framework

Peridot Emoji Reporter

Derived from Peridot Dot Reporter, _(*1)

, _(*2)

Requirements:

• PHP 7+
• Terminal that supports emojis - i.e. iTerm2

Usage

I recommend installing the reporter to your project via composer:, _(*3)

$ composer require --dev ryanplasma/peridot-emoji-reporter:~1.0

You can register the reporter via your peridot.php file., _(*4)

<?php

use Evenement\EventEmitterInterface;
use Peridot\Reporter\Emoji\EmojiReporter;
use Peridot\Reporter\Emoji\EmojiReporterPlugin;
use Spatie\Emoji\Emoji;

return function(EventEmitterInterface $emitter) {
    (new EmojiReporterPlugin($emitter))->register();

    $emitter->on('emoji.start', function (EmojiReporter $reporter) {
        // The next 3 lines are optional - use them to change the default emojis
        $reporter->setPassEmoji(Emoji::smilingCatFaceWithHeartShapedEyes());
        $reporter->setFailEmoji(Emoji::noEntry());
        $reporter->setPendingEmoji(Emoji::alienMonster());
    });
};

Default Emojis are: * :pizza: for passing tests * :poop: for failing tests * :hear_no_evil: for pending tests, _(*5)

See above example for how to customize what emojis are used., _(*6)

Running reporter tests

You can run the reporter specs and also preview the reporter in action like so:, _(*7)

$ vendor/bin/peridot specs/ -r emoji