Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k00ni/todolo
List all TODOs, FIXMEs etc. on the terminal. No need to search them manually anymore.
https://github.com/k00ni/todolo
cli todo todolist
Last synced: about 1 month ago
JSON representation
List all TODOs, FIXMEs etc. on the terminal. No need to search them manually anymore.
- Host: GitHub
- URL: https://github.com/k00ni/todolo
- Owner: k00ni
- License: mit
- Created: 2020-07-27T16:13:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-18T12:05:18.000Z (over 4 years ago)
- Last Synced: 2024-05-18T07:02:58.450Z (6 months ago)
- Topics: cli, todo, todolist
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todolo
[](https://travis-ci.com/k00ni/todolo)
[](https://scrutinizer-ci.com/g/k00ni/todolo/?branch=master)
[](https://scrutinizer-ci.com/g/k00ni/todolo/?branch=master)
## 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:**
```php
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:
```php
return [
'dirs_to_check' => [
'src',
],
];
```
### show_empty_dir
If set to `true` it will show empty dirs in the output later on.
Example:
```php
return [
'show_empty_dir' => true,
];
```
### show_files_with_no_todos
If set to `true` it will show files which have no TODOs inside.
Example:
```php
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:
```php
return [
'show_no_files_info' => true,
];
```