scheb/tombstone-analyzer

Generates reports based on the logs from scheb/tombstone

0.3.0 2016-12-05 21:10 UTC

README

Report generation for the Tombstones created with the scheb/tombstone library.

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads License

Tombstone Youtube Video

Inspired by: http://devblog.nestoria.com/post/115930183873/tombstones-for-dead-code

WARNING: The library is still work in progress. BC breaks will certainly happen as long as there is no stable release.

Installation

Install via composer

$ composer require scheb/tombstone-analyzer

Composer automatically creates an executable binary vendor/bin/tombstone.

Usage

Execute the tool on the command line to show the help dialog:

$ tombstone

Basic usage:

$ tombstone /path/to/php/sources /path/to/tombstone/logs

Generate a HTML report:

$ tombstone /path/to/php/sources /path/to/tombstone/logs --report-html=/report/target/directory

Contribute

You're welcome to contribute to this library by creating a pull requests or feature request in the issues section. For pull requests, please follow these guidelines:

  • Symfony code style
  • PHP7.1 type hints for everything (including: return types, void, nullable types)
  • Please add/update test cases
  • Test methods should be named [method]_[scenario]_[expected result]

To run the test suite install the dependencies with composer install and then execute bin/phpunit.

Acknowledgments

Thanks to Sebastian Bergmann for letting me re-use parts of his code and the template files.

License

This library is available under the MIT license.