Finds TODO and FIXME annotations that past-you left in the code for future-you to deal with
composer require-dev blinktag/laravel-lazydev:dev-master
'providers' => [
// ...
Blinktag\Providers\FindTodosServiceProvider::class,
],
The package will be autodiscovered
If you wish to change the strings this tool searches for, publish the configuration and then edit the value of find_strings
in config/findtodos.php
. Each term should be separated by a pipe character
php artisan vendor:publish --tag=findtodos
Add comments in your code that begin with TODO, or FIXME, like so:
<?php
...
public function calculateStore(int $total)
{
...
// TODO: This method is broken when the input is a negative value
...
}
...
You can then find these comments later on using the command
php artistan find:todos
...
/Users/blinktag/Sites/compucorp/app/User.php
TODO Line 53: Refactor this once permissions have been fleshed out
/Users/blinktag/Sites/compucorp/app/Ticket.php
FIXME Line 109: This method is broken when the input is a negative value