README

Why

Keep the @todo count for each commit.

Do not allow commits if the total amount of @todo increased or is above a user-defined threshold.

Purpose is to keep the @todo list low and forcing cleaning the code or resolving them.

Based on the ideas of:

• http://jezenthomas.com/using-git-to-manage-todos/

Installation

Use Composer to install the package:

$ composer require --dev nilportugues/php_todo

Usage

It is really this simple:

$ php bin/php_todo find <path/to/directory>

Configuration file

• Define the todo annotations to look for in the code.
• Define the amount of @todo that will be tolerated.

When run the first time, if no php_todo_finder.yml file is found you will have to create it.

A configuration for instance, should formatted as follows:

todo_finder:
  total_allowed: 5
  expressions:
    - @todo
    - TODO
    - refactor
    - FIX ME

You can specify an alternate location for the configuration file by passing in the -c parameter. Example:

$  php bin/php_todo find -c configs/php_todo_finder.yml src/

Contribute

Contributions to the package are always welcome!

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's Git repository.

Support

Get in touch with me using one of the following means:

• Emailing me at contact@nilportugues.com
• Opening an Issue

Authors

• Nil Portugués Calderó
• The Community Contributors

License

The code base is licensed under the MIT license.