Download the PHP package johninamillion/todo without Composer
On this page you can find all versions of the php package johninamillion/todo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download johninamillion/todo
More information about johninamillion/todo
Files in johninamillion/todo
Package todo
Short Description A powerful CLI tool to scan your source code for open tasks — with user filtering, Git integration, and customizable reporting.
License MIT
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 todo
ToDo
A powerful CLI tool to scan your source code for open tasks.
Table of Contents
- Installation
- Features
- Usage
- Development
- License
Installation
Install the package globally or per-project via Composer:
You can also link the CLI binary directly:
Features
- Detects
BUG,FIX,TODO, andTESTannotations in comments. - Filter by:
- keyword (
--keywords) - type (
--bugs,--fixes,--testsand--todos) - user (
--useror--me)
- keyword (
- Git-aware:
- Honors .gitignore by default
- Use your Git username with
--me
- Optional flags:
--fail-on-bugs,--fail-on-fixes--display-time--include-dotfiles,--include-ignored
Usage
Scan your current directory for all relevant tags:
Options
| Option | Description |
|---|---|
[path] |
Scan a specific directory (default: current) |
--exclude=DIRS |
Comma-separated list of directories to exclude |
--keywords=... |
Comma-separated list of keywords to match |
--user=USERNAME |
Only show entries assigned to a specific user |
--me |
Use your Git username to filter results |
--bugs |
Only show entries tagged with BUG |
--fixes |
Only show entries tagged with FIX |
--tests |
Only show entries tagged with TEST |
--todos |
Only show entries tagged with TODO |
--display-time |
Show the last modification time for each entry |
--fail-on-bugs |
Return non-zero exit code if any BUGs are found |
--fail-on-fixes |
Return non-zero exit code if any FIXes are found |
--include-dotfiles |
Include hidden files (e.g., .env, .github) |
--include-ignored |
Include files ignored by .gitignore |
Example Comment Format
Works with line comments:
Also works with block comments:
Example Commands
Scan with bug-only filter:
Scan with custom keywords and show timestamps:
Scan only your assigned items (via Git):
Fail build on any FIX or BUG:
Configuration via composer.json
You may add these scripts for convenience:
Development
Analyze Code
To analyze your code for potential issues, you can run phpstan:
Apply Code-Styles
To ensure your code adheres to the coding standards, you can run the php-cs-fixer.
Run Tests
To run the tests, make sure you have installed phpunit within the dev dependencies and then run:
Check the Test Coverage:
License
This package is licensed under the MIT License. See the LICENSE file for full details.
All versions of todo with dependencies
johninamillion/php-git Version ^0.1.0
symfony/console Version ^6.2|^7.0
symfony/process Version ^6.2|^7.0