Skip to content

Commit

Permalink
updated README, fixed iniitialization
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeerickson committed Sep 13, 2020
1 parent 0305730 commit 65075c1
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 12 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ Apologies that this starts with version 0.27, but for some reason I did not have
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.29.1] -- 2020.09.16

### Changed

- Updated local `phpunit-printer.yml` to include `cd-printer-dont-format-classname` when package initialized

## [0.29.0] -- 2020.09.16

### Added
Expand Down Expand Up @@ -48,4 +54,3 @@ E-Mail: [codedungeon@gmail.com](mailto:codedungeon@gmail.com)
Twitter: [@codedungeon](http://twitter.com/codedungeon)

Website: [https://github.com/mikeerickson](https://github.com/mikeerickson)

22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CodeDungeon PHPUnit Pretty Result Printer

Version 0.28.0
Version 0.29.1
Extend the default PHPUnit Result Printer with a modern, pretty printer!

---
Expand All @@ -15,6 +15,16 @@ Installation provided via composer and can be done with the following command, t
> composer require --dev codedungeon/phpunit-result-printer
```

### Upgrading to >= 0.29.x

If you are upgrading from previous verison and have published `phpunit-printer.yml` locally, make sure add the following to the options section

```yml
...
cd-printer-dont-format-classname: false
...
```

### Execute Initialization Script (Optional)

The following steps are optional, but will provide zero configuration for implementing **phpunit-pretty-result-printer**
Expand All @@ -26,13 +36,6 @@ The following steps are optional, but will provide zero configuration for implem
> php ./vendor/codedungeon/phpunit-result-printer/src/init.php
```

#### Collision Listener
If you wish to activate the [Laravel Collision Listener](https://laravel-news.com/using-the-collision-phpunit-listener-with-laravel) when running tests, you can use the `--collision` flag

```bash
> php ./vendor/codedungeon/phpunit-result-printer/src/init.php --collision
```

#### Manual Configuration

Alternately, if you wish to configure **phpunit-pretty-result-printer** manually, you will need to update your `phpunit.xml` file as follows
Expand Down Expand Up @@ -65,6 +68,7 @@ If you have AnyBar installed, it will be enabled by default. You can disable usi
[https://github.com/tonsky/AnyBar](https://github.com/tonsky/AnyBar)

**Anybar is off by default, thus you will need to set the `cd-printer-anybar` option in the `phpunit-printer.yml` to `true` if you wish to use Anybar.

This has been done to address issues with using CI tools such as travis (please see [Issue 122](https://github.com/mikeerickson/phpunit-pretty-result-printer/issues/122) for details) **

_NOTE: AnyBar is only available with PHPUnit 7.1 or greater.
Expand Down Expand Up @@ -107,7 +111,7 @@ _\* Notice space after each marker. This makes the output a little more visually

## License

Copyright © 2017-2019 Mike Erickson
Copyright © 2017-2021 Mike Erickson
Released under the MIT license

## Credits
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "codedungeon/phpunit-result-printer",
"version": "0.29.0",
"version": "0.29.1",
"description": "PHPUnit Pretty Result Printer",
"keywords": [
"phpunit",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "phpunit-pretty-result-printer",
"version": "0.29.0",
"version": "0.29.1",
"description": "Version 0.28 Extend the default PHPUnit Result Printer with a modern, pretty printer!",
"main": "index.js",
"directories": {
Expand Down
1 change: 1 addition & 0 deletions src/phpunit-printer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ options:
cd-printer-hide-namespace: true
cd-printer-anybar: false
cd-printer-anybar-port: 1738
cd-printer-dont-format-classname: false
markers:
cd-pass: ""
cd-fail: ""
Expand Down

0 comments on commit 65075c1

Please sign in to comment.