Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coderabbi/phpumoji
PHPUnit Emoji Result Printer
https://github.com/coderabbi/phpumoji
emoji php phpunit
Last synced: 2 months ago
JSON representation
PHPUnit Emoji Result Printer
- Host: GitHub
- URL: https://github.com/coderabbi/phpumoji
- Owner: coderabbi
- License: mit
- Created: 2017-07-06T08:43:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-11T19:08:10.000Z (about 7 years ago)
- Last Synced: 2024-10-14T06:02:07.084Z (2 months ago)
- Topics: emoji, php, phpunit
- Language: PHP
- Size: 25.4 KB
- Stars: 74
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - coderabbi/phpumoji - PHPUnit Emoji Result Printer (PHP)
README
# phpumoji
PHPUnit Emoji Result Printer
[](https://travis-ci.org/coderabbi/phpumoji)
[](https://scrutinizer-ci.com/g/coderabbi/phpumoji/?branch=master)
[](https://styleci.io/repos/96408449)
[](https://github.com/php-pds/skeleton)
## Install
Via Composer
``` bash
$ composer require coderabbi/phpumoji --dev
```
To enable PHPUnit emoji output, add the following two lines to the opening element of your `phpunit.xml`:
``` php
printerFile="vendor/coderabbi/phpumoji/src/EmojiPrinter.php"
printerClass="Coderabbi\Phpumoji\EmojiPrinter"
```
## Usage
Usage of PHPUnit is unchanged with coderabbi/phpumoji.
## Options
### Select a Different Emojiset
If you wish to select an emojiset for PHPUnit emoji output, add the following additional line to the opening element of your `phpunit.xml`, specifying your selection:
``` php
emojiset="phpumoji"
```
### Create a Custom Emojiset
The default emojiset is 'phpumoji'; currently that is the only emojiset available (soon, grasshopper... :sunglasses:).
If, however, you wish to create your own emojiset for PHPUnit emoji output, simply place an `.emojifile` in your project root and define your emojiset in the following format:
``` ini
[phpumoji]
error = bomb
failure = poop
incomplete = construction
risky= game_die
skipped = see_no_evil
pass = elephant
[weird]
error = no_entry
failure = red_flag
incomplete = question
risky= clown
skipped = ghost
pass = monkey
```
Note that the values in the emojiset are snake-cased emoji short codes *without the opening and closing colons*; most existing short codes are supported, a list of supported shortcodes will be added soon.
You may choose to override one or more of the packaged emojisets (as in the case of "phumoji", above, which overrides the default emojiset), or you may define your own (as in the case of "weird", above).
Don't forget to update the opening element of your `phpunit.xml` with `emojiset=""`, just as you would to select one of the non-default packaged emojisets.
The order of precedence is the specified emojiset in `.emojifile`, the specified emojiset from the packaged emojisets, the "phpumoji" emojiset from your `.emojifile`, and finally the the "phpumoji" emojiset from the packaged emojisets.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Yitzchok Willroth](https://github.com/coderabbi)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.