2017 © Pedro PelĂĄez
 

library php_todo

Looks into the code using a user-defined list of to-do phrases and stops commit if the total amount increased or is above a threshold.

image

nilportugues/php_todo

Looks into the code using a user-defined list of to-do phrases and stops commit if the total amount increased or is above a threshold.

  • Sunday, March 6, 2016
  • by nilportugues
  • Repository
  • 2 Watchers
  • 8 Stars
  • 9,826 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 0 % Grown

The README.md

PHP To-do Finder

Scrutinizer Code Quality SensioLabsInsight Latest Stable Version Total Downloads License Donate, (*1)

Why

Keep the @todo count for each commit., (*2)

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

Purpose is to keep the @todo list low and forcing cleaning the code or resolving them., (*4)

Based on the ideas of:, (*5)

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

Installation

Use Composer to install the package:, (*6)

$ composer require --dev nilportugues/php_todo

Usage

It is really this simple:, (*7)

$ 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., (*8)

A configuration for instance, should formatted as follows:, (*9)

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:, (*10)

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

Contribute

Contributions to the package are always welcome!, (*11)

Support

Get in touch with me using one of the following means:, (*12)

Authors

License

The code base is licensed under the MIT license., (*13)

The Versions

06/03 2016

dev-master

9999999-dev http://nilportugues.com

Looks into the code using a user-defined list of to-do phrases and stops commit if the total amount increased or is above a threshold.

  Sources   Download

MIT

The Requires

 

The Development Requires

function hook git php functions checker fixer forbidden

10/11 2015

1.0.0

1.0.0.0 http://nilportugues.com

Looks into the code using a user-defined list of to-do phrases and stops commit if the total amount increased or is above a threshold.

  Sources   Download

MIT

The Requires

 

The Development Requires

function hook git php functions checker fixer forbidden