k00ni/todolo

Keep track of TODOs all over your files by listing them on the terminal.

0.1.2 2020-08-07 13:58 UTC

Requires

• php: ^7.1
• ext-iconv: *
• symfony/console: ^4.4 || ^5.1
• symfony/polyfill-php80: ^1.18

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16.3
• phpstan/phpstan: ^0.12.33
• phpunit/phpunit: ^7 || ^8 || ^9

MIT

• Konrad Abicht

README

About

Todolo helps you to keep track of TODO, FIXME etc. all over your files. It shows a list of files with all related TODO messages on the terminal.

We are following semantic versioning (https://semver.org/) but until we reach 1.0.0 breaking changes are possible. Upgrade introductions will be described in an UPGRADE file.

Installation

Please install k00ni/todolo with composer.

Usage

Run

vendor/bin/todolo

in the root folder of your project. If files in your src folder contain TODO's like

// TODO foobar

it may print something like the following on the terminal:

-----------------------------------------------------
tests/Integration/TodoFinderTest.php
-----------------------------------------------------
- TODO 1
- FIXME 2
- Foobar

-----------------------------------------------------
tests/Integration/Helper/OutputHelperTest.php
-----------------------------------------------------
No TODOs found.
-----------------------------------------------------

Config

Complete config example:

return [
    'dirs_to_check' => [
        'src',
    ],
    // show
    'show_empty_dir' => false,
    'show_files_with_no_todos' => false,
    'show_no_files_info' => true,
];

dirs_to_check

List all folders you wanna include in the TODO collection.

Example:

return [
    'dirs_to_check' => [
        'src',
    ],
];

show_empty_dir

If set to true it will show empty dirs in the output later on.

Example:

return [
    'show_empty_dir' => true,
];

show_files_with_no_todos

If set to true it will show files which have no TODOs inside.

Example:

return [
    'show_files_with_no_todos' => true,
];

show_no_files_info

If set to true it will show info if a dir has no files inside.

Example:

return [
    'show_no_files_info' => true,
];