README

Requirements

The Nyan Cat result printer for PHPUnit requires:

PHP 7+.
PHPUnit 6+.
A terminal emulator with support for ANSI escape sequences, including color and cursor control.

Use version ^1.3 to support PHPUnit 4.8+ / 5+.

NOTE: By default, the Windows console does not support ANSI escape sequences. If you'd like to use the Nyan Cat result printer on Windows, you may want to try one of the following solutions:

Installation

The recommended way to install the Nyan Cat result printer for PHPUnit is through composer. Just create a composer.json file and run the composer install command to install it:

{
    "require-dev": {
        "whatthejeff/nyancat-phpunit-resultprinter": "^2.0"
    }
}

Once installed, add the following attributes to the <phpunit> element in your phpunit.xml file:

printerFile="vendor/whatthejeff/nyancat-phpunit-resultprinter/src/NyanCat/PHPUnit/ResultPrinter.php"
printerClass="NyanCat\PHPUnit\ResultPrinter"

NOTE: If PHPUnit was not installed via composer, you also need to include the composer autoloader. One easy way to do this is to add the following attribute to the <phpunit> element in your phpunit.xml file:

bootstrap="vendor/autoload.php"

Tests

To run the test suite, you need composer.

$ composer install
$ composer test

Acknowledgements

The Nyan Cat result printer for PHPUnit was heavily inspired by the glorious mocha/nyan.js.

License

The Nyan Cat result printer for PHPUnit is licensed under the MIT license.

whatthejeff / nyancat-phpunit-resultprinter

Maintainers

Details