https://github.com/whatthejeff/nyancat-phpunit-resultprinter

Nyan Cat result printer for PHPUnit
https://github.com/whatthejeff/nyancat-phpunit-resultprinter

nyan-cat php phpunit printer tests

Last synced: 4 days ago
JSON representation

Nyan Cat result printer for PHPUnit

• Host: GitHub
• URL: https://github.com/whatthejeff/nyancat-phpunit-resultprinter
• Owner: whatthejeff
• License: mit
• Created: 2013-02-15T11:11:21.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2019-01-24T15:38:39.000Z (about 6 years ago)
• Last Synced: 2025-01-22T10:05:30.826Z (11 days ago)
• Topics: nyan-cat, php, phpunit, printer, tests
• Language: PHP
• Homepage:
• Size: 1.19 MB
• Stars: 284
• Watchers: 6
• Forks: 22
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

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:

 * [ANSICON](https://github.com/adoxa/ansicon)

 * [ConEmu](https://github.com/Maximus5/ConEmu)

## Installation

The recommended way to install the Nyan Cat result printer for PHPUnit is

[through composer](http://getcomposer.org). Just create a `composer.json` file

and run the `composer install` command to install it:

~~~json

{

    "require-dev": {

        "whatthejeff/nyancat-phpunit-resultprinter": "^2.0"

    }

}

~~~

Once installed, add the following attributes to the `` 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 `` element in your `phpunit.xml` file:

    bootstrap="vendor/autoload.php"

## Tests

[![Build Status](https://travis-ci.org/whatthejeff/nyancat-phpunit-resultprinter.png?branch=master)](https://travis-ci.org/whatthejeff/nyancat-phpunit-resultprinter)

To run the test suite, you need [composer](http://getcomposer.org).

    $ composer install

    $ composer test

## Acknowledgements

The Nyan Cat result printer for PHPUnit was __heavily__ inspired by the

glorious [mocha/nyan.js](https://github.com/visionmedia/mocha/blob/master/lib/reporters/nyan.js).

## License

The Nyan Cat result printer for PHPUnit is licensed under the [MIT license](LICENSE).