Say goodbye to your todos
When writing code, it's really REALLY easy to put a TODO
in your code as a
reminder to look at something later on. In small projects, you'll see those reminders
every time you open up the relevant files. In big projects with multiple contributors,
these can get unwieldly.
Without a proper strategy to work through them, your todos will only ever expand. Toodaloo extracts these into a central file which can be tracked.
docker run \
-it \
--rm \
-v /path/to/dir:/data \
ghcr.io/mrsimonemms/toodaloo
go install github.com/mrsimonemms/toodaloo@latest
Scan a project
Usage:
toodaloo scan [flags]
Flags:
--git-files get files from the git tree
--glob string glob pattern - ignored if files provided as arguments (default "**/*")
-h, --help help for scan
--ignore-paths strings ignore scanning these files (default [.git/**/*])
-o, --output string output type (default "yaml")
-s, --save-path string save report to path - use "-" to output to stdout (default ".toodaloo.yaml")
-t, --tags strings todo tags (default [fixme,todo,@todo])
Global Flags:
-d, --directory string working directory (default "/workspaces/toodaloo")
-l, --log-level string log level: trace, debug, info, warning, error, fatal, panic (default "info")
A supported pre-commit hook is provided to scan repos.
repos:
- repo: https://github.com/mrsimonemms/toodaloo
rev: "" # Use the ref you want to point at
hooks:
- id: scan
This will generate a Markdown formatted file
at toodaloo.md
. It also only scans files in the git tree.
If using in CI, you will need to clone the whole Git history for the "get author" functionality to work