Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nilportugues/php-todo-finder

[Git hook] Do not allow commits if the total amount of to-do increased or is above a user-defined threshold.
https://github.com/nilportugues/php-todo-finder

ci comment comments composer continuous-integration git git-hook git-hooks hook php php7 quality quality-control

Last synced: 23 days ago
JSON representation

[Git hook] Do not allow commits if the total amount of to-do increased or is above a user-defined threshold.

Host: GitHub
URL: https://github.com/nilportugues/php-todo-finder
Owner: nilportugues
License: mit
Created: 2015-11-05T18:37:59.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2016-03-06T10:17:28.000Z (over 8 years ago)
Last Synced: 2024-09-30T22:41:01.143Z (about 1 month ago)
Topics: ci, comment, comments, composer, continuous-integration, git, git-hook, git-hooks, hook, php, php7, quality, quality-control
Language: PHP
Homepage: http://nilportugues.com
Size: 14.6 KB
Stars: 12
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # PHP To-do Finder

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nilportugues/php_todo_finder/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nilportugues/php_todo_finder/?branch=master)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/de4fc897-e1bc-4ab2-9ac2-b3518538fad1/mini.png)](https://insight.sensiolabs.com/projects/de4fc897-e1bc-4ab2-9ac2-b3518538fad1)

[![Latest Stable Version](https://poser.pugx.org/nilportugues/php_todo/v/stable)](https://packagist.org/packages/nilportugues/php_todo)

[![Total Downloads](https://poser.pugx.org/nilportugues/php_todo/downloads)](https://packagist.org/packages/nilportugues/php_todo)

[![License](https://poser.pugx.org/nilportugues/php_todo/license)](https://packagist.org/packages/nilportugues/php_todo)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://paypal.me/nilportugues)

## 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](https://getcomposer.org) to install the package:

```

$ composer require --dev nilportugues/php_todo

```

## Usage

It is really this simple:

```

$ php bin/php_todo find 

```

### 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:

```yml

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](https://github.com/nilportugues/php_todo_finder/issues/new).

* You can grab the source code at the package's [Git repository](https://github.com/nilportugues/php_todo_finder).

## Support

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

 - Emailing me at 

 - Opening an [Issue](https://github.com/nilportugues/php_todo_finder/issues/new)

## Authors

* [Nil Portugués Calderó](http://nilportugues.com)

* [The Community Contributors](https://github.com/nilportugues/php_todo_finder/graphs/contributors)

## License

The code base is licensed under the [MIT license](LICENSE).