The SensioLabs DeprecationDetector runs a static code analysis against your project's source code to find usages of deprecated methods, classes and interfaces. For Symfony projects, it also detects usages of deprecated services.
It identifies the use of deprecated code thanks to the
Please note this tool is in a very early stage of development. Expect bugs and quirks.
The command works in three steps:
- Scanning your vendor libraries for defined deprecations and cache them as a
- Finding usages of those deprecations from your ruleset.
- Output with the affected code parts.
For a system-wide installation via Composer, you can run:
$ composer global require sensiolabs-de/deprecation-detector
Make sure you have
~/.composer/vendor/bin/ in your
PATH and you will be able to call the
You can download the PHAR file available on the releases page:
curl -OL https://github.com/sensiolabs-de/deprecation-detector/releases/download/0.1.0-alpha4/deprecation-detector.phar php deprecation-detector.phar
Clone the repository
$ git clone firstname.lastname@example.org:sensiolabs-de/deprecation-detector.git
$ composer install
Create phar archive with Box (optional)
$ box build
Provided you created the phar archive, if you want to call the deprecation-detector globally, it needs to be placed in your
PATH. For example with:
$ chmod a+x deprecation-detector.phar $ mv deprecation-detector.phar /usr/local/bin/deprecation-detector
Otherwise you can call
To use the DeprecationDetector you need to provide the
source and the
$ deprecation-detector check src/ vendor/ $ deprecation-detector check src/ composer.lock $ deprecation-detector check src/ .rules/some_generated_rule_set
There are different output formats available, by default the output is printed in the commandline.
$ deprecation-detector check src/ vendor/ --log-html deprecationlog.html
You can get a list of all options and arguments by running
$ deprecation-detector check --help
The default output might not fit into the cli. If that is the case you can set the output to a list by setting
$ deprecation-detector check src/ vendor/ --output=simple
Excluding deprecated method calls
You can exclude deprecated method calls by using the
filter-methods option. This option takes a comma separated list of method references to exclude.
$ deprecation-detector check --filter-methods=MyClass::method,Foo::bar src/ vendor/
This will exclude all deprecated calls to MyClass::method and Foo::bar.
Currently, the SensioLabs DeprecationDetector is in a very early state. Pull requests are welcome!