{"id":14985427,"url":"https://github.com/nilportugues/php-todo-finder","last_synced_at":"2025-04-11T15:31:49.228Z","repository":{"id":57027222,"uuid":"45631450","full_name":"nilportugues/php-todo-finder","owner":"nilportugues","description":"[Git hook] Do not allow commits if the total amount of to-do increased or is above a user-defined threshold.","archived":false,"fork":false,"pushed_at":"2016-03-06T10:17:28.000Z","size":15,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T15:33:55.418Z","etag":null,"topics":["ci","comment","comments","composer","continuous-integration","git","git-hook","git-hooks","hook","php","php7","quality","quality-control"],"latest_commit_sha":null,"homepage":"http://nilportugues.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nilportugues.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-05T18:37:59.000Z","updated_at":"2022-02-12T07:24:45.000Z","dependencies_parsed_at":"2022-08-23T16:30:14.645Z","dependency_job_id":null,"html_url":"https://github.com/nilportugues/php-todo-finder","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-todo-finder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-todo-finder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-todo-finder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-todo-finder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nilportugues","download_url":"https://codeload.github.com/nilportugues/php-todo-finder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248431559,"owners_count":21102218,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","comment","comments","composer","continuous-integration","git","git-hook","git-hooks","hook","php","php7","quality","quality-control"],"created_at":"2024-09-24T14:10:57.294Z","updated_at":"2025-04-11T15:31:48.885Z","avatar_url":"https://github.com/nilportugues.png","language":"PHP","funding_links":["https://paypal.me/nilportugues"],"categories":[],"sub_categories":[],"readme":"# PHP To-do Finder\n\n[![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)\n[![SensioLabsInsight](https://insight.sensiolabs.com/projects/de4fc897-e1bc-4ab2-9ac2-b3518538fad1/mini.png)](https://insight.sensiolabs.com/projects/de4fc897-e1bc-4ab2-9ac2-b3518538fad1)\n[![Latest Stable Version](https://poser.pugx.org/nilportugues/php_todo/v/stable)](https://packagist.org/packages/nilportugues/php_todo)\n[![Total Downloads](https://poser.pugx.org/nilportugues/php_todo/downloads)](https://packagist.org/packages/nilportugues/php_todo)\n[![License](https://poser.pugx.org/nilportugues/php_todo/license)](https://packagist.org/packages/nilportugues/php_todo)\n[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://paypal.me/nilportugues)\n\n## Why\nKeep the @todo count for each commit.\n\nDo not allow commits if the total amount of @todo increased or is above a user-defined threshold.\n\nPurpose is to keep the @todo list low and forcing cleaning the code or resolving them.\n\n**Based on the ideas of:**\n\n- http://jezenthomas.com/using-git-to-manage-todos/\n\n## Installation\n\nUse [Composer](https://getcomposer.org) to install the package:\n\n```\n$ composer require --dev nilportugues/php_todo\n```\n\n## Usage\n\nIt is really this simple:\n\n```\n$ php bin/php_todo find \u003cpath/to/directory\u003e\n```\n\n### Configuration file\n\n- Define the todo annotations to look for in the code.\n- Define the amount of @todo that will be tolerated.\n\nWhen run the first time, if no `php_todo_finder.yml` file is found you will have to create it.\n\nA configuration for instance, should formatted as follows:\n\n```yml\ntodo_finder:\n  total_allowed: 5\n  expressions:\n    - @todo\n    - TODO\n    - refactor\n    - FIX ME\n```\n\nYou can specify an alternate location for the configuration file by passing in the `-c` parameter. Example:\n\n```\n$  php bin/php_todo find -c configs/php_todo_finder.yml src/\n```\n\n\n\n## Contribute\n\nContributions to the package are always welcome!\n\n* Report any bugs or issues you find on the [issue tracker](https://github.com/nilportugues/php_todo_finder/issues/new).\n* You can grab the source code at the package's [Git repository](https://github.com/nilportugues/php_todo_finder).\n\n\n## Support\n\nGet in touch with me using one of the following means:\n\n - Emailing me at \u003ccontact@nilportugues.com\u003e\n - Opening an [Issue](https://github.com/nilportugues/php_todo_finder/issues/new)\n\n\n## Authors\n\n* [Nil Portugués Calderó](http://nilportugues.com)\n* [The Community Contributors](https://github.com/nilportugues/php_todo_finder/graphs/contributors)\n\n\n## License\nThe code base is licensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilportugues%2Fphp-todo-finder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnilportugues%2Fphp-todo-finder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilportugues%2Fphp-todo-finder/lists"}