phpvisualdebt/phpvisualdebt

Static Analyzer which Question Everything what is leaving Visual Debt behind Edit Add topics

1.0.4 2017-06-01 12:52 UTC

README

Static Analyzer following QDD which Questions Everything that is leaving Visual Debt behind.

Feel free to interpret QDD however you want! It could be Question Driven Development as well as Question Disaster Development!

PHP 7.0 Build Status Latest Stable Version Total Downloads License Coverage Status

Features

This tool provides static analysis for source code following best QDD practices.

  • interface questioner - asks a question for justification of single interface usage
  • final keyword - asks a question for need of a keyword
  • scalar typehints and return types questioner - asks a question if one of type declarations before PHP7 was used

Installation

Install with Composer

composer require phpvisualdebt/phpvisualdebt

Or download phpvisualdebt.phar from last release.

Usage

Analyzing code:

bin/phpvisualdebt

Screenshoot for Question Everything

For those who are not sure to question everything, there is an additional option --question which defaults to everything. Possible values are a comma separated list of: final, interface or/and typehint.

bin/phpvisualdebt --question=final,interface

Screenshoot for Question Almost-Everything

License

The MIT License (MIT)

Copyright (c) 2017 Michał Brzuchalski michal.brzuchalski@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.