integer-net / todo-reminder
GrumPHP Extension to remind you of undone todos
Requires
- php: ~7.1
- ext-mbstring: *
- ext-spl: *
- gitonomy/gitlib: ^1.0
- nikic/php-parser: ^4.1
Requires (Dev)
- infection/infection: ^0.13.0
- jakub-onderka/php-parallel-lint: ^1.0.0
- maglnet/composer-require-checker: ^2.0.0
- pds/skeleton: ^1.0
- phan/phan: ^2.2.4
- phpmd/phpmd: ^2.6
- phpro/grumphp: ^0.15.2
- phpstan/phpstan: ^0.11.8
- phpunit/phpunit: ^8.0
- squizlabs/php_codesniffer: ^3.2
This package is auto-updated.
Last update: 2024-10-29 04:42:13 UTC
README
A command line script that reminds of unfinished TODO comments in changed PHP files after Git commit. Intended as post-commit Git hook.
Install
Via Composer in project
composer require integer-net/todo-reminder
Via Composer globally
composer global require integer-net/todo-reminder
Usage
To check the last commit of the current repository, run
vendor/bin/todo
If you installed Todo Reminder globally,
todo --root /path/to/repository
To run the checks automatically after each commit, create a hook as .git/hooks/post-commit with content like:
#!/bin/sh exec vendor/bin/todo
Make the hook executable, so that Git can run it:
chmod +x .git/hooks/post-commit
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
composer test
Runs unit tests, mutation tests and static analysis
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email fs@integer-net.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.