2017 © Pedro Peláez
 

library tombstone

Dead code detection with tombstones for PHP

image

scheb/tombstone

Dead code detection with tombstones for PHP

  • Thursday, March 2, 2017
  • by Scheb
  • Repository
  • 2 Watchers
  • 81 Stars
  • 24,194 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 10 Versions
  • 9 % Grown

The README.md

scheb/tombstone

Implements the concept of tombstones for dead code detection in PHP., (*1)

The library provides you with a toolbox to place, track and evaluate tombstones in your code., (*2)

Build Status Code Coverage Latest Stable Version Monthly Downloads Total Downloads License, (*3)

Logo, (*4)

What are Tombstones?

To get the basic idea, watch David Schnepper's 5 minute talk from Velocity Santa Clara 2014., (*5)

Tombstone Youtube Video , (*6)

When you want to identify and clean-up dead code in a project, static code analysis tools are the weapon of choice. But these tools have some limitations, especially in a dynamic language like PHP:, (*7)

  • They can only tell you, if a piece of code is referenced, not if it's actually used
  • They cannot resolve dynamic or generated call paths

Tombstones provide a way to track if a piece of code is actually invoked. They are executable markers in your code, that you can place where you suspect dead code. Then, you collect tombstone invocations on production. After a while, the logs will tell you, which tombstones are dead and which ones aren't (the so called "vampires")., (*8)

Installation

The library consists of multiple components, that need to be installed and configured independently:, (*9)

Read how to install scheb/tombstone-logger for placing and logging tombstones in your code., (*10)

Read how to install scheb/tombstone-analyzer, which takes log data from scheb/tombstone-logger to generate reports in various formats. For example an HTML report:, (*11)

Dashboard view Code view, (*12)

Security

For information about the security policy and know security issues, see SECURITY.md., (*13)

Contributing

Want to contribute to this project? See CONTRIBUTING.md., (*14)

License

This software is available under the MIT license., (*15)

Acknowledgments

The library is heavily inspired by Nestoria.com's implementation of the tombstone concept., (*16)

Thanks to Jordi Boggiano for creating Monolog, from where I lend the handler/formatter concept., (*17)

The tombstone graphic is based on a licensed illustration by "lemonadeserenade"., (*18)

Support Me

I'm developing this library since 2015. I love to hear from people using it, giving me the motivation to keep working on my open source projects., (*19)

If you want to let me know you're finding it useful, please consider giving it a star ⭐ on GitHub., (*20)

If you love my work and want to say thank you, you can help me out for a beer 🍻️ via PayPal., (*21)

The Versions

02/03 2017

dev-master

9999999-dev https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

05/12 2016

0.8.0

0.8.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

13/01 2016

0.7.0

0.7.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

06/09 2015

0.6.0

0.6.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

23/08 2015

0.5.0

0.5.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

23/08 2015

0.4.1

0.4.1.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

22/08 2015

0.4.0

0.4.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

22/08 2015

0.3.0

0.3.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code

19/08 2015

0.2.0

0.2.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

by Christian Scheb

tombstone dead code

19/08 2015

0.1.0

0.1.0.0 https://github.com/scheb/tombstone

Dead code detection with tombstones for PHP

  Sources   Download

MIT

The Requires

 

The Development Requires

by Christian Scheb

tombstone dead code