Download the PHP package nilportugues/php_todo without Composer
On this page you can find all versions of the php package nilportugues/php_todo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nilportugues/php_todo
More information about nilportugues/php_todo
Files in nilportugues/php_todo
Package php_todo
Short Description 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.
License MIT
Homepage http://nilportugues.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php_todo
PHP To-do Finder
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:
Installation
Use Composer to install the package:
Usage
It is really this simple:
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:
You can specify an alternate location for the configuration file by passing in the -c parameter. Example:
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 [email protected]
- Opening an Issue
Authors
License
The code base is licensed under the MIT license.
