tdg
TODO get - tool to extract todo tasks from source code
About
This tool generates json from comments contained in the source code. Main use-case for it is to create automatic issues based on TODO/FIXME/BUG/HACK comments. This tool supports additional tag information in the comment (Category, Issue etc.).
There are two useful applications in project management automation: converting TODOs into GitHub Issues and synchronization with Kanboard using tdg-import plugin.
Example of the comment (everything but the first line is optional):
// TODO: This is title of the issue to create
// category=SomeCategory issue=123 estimate=30m author=alias
// This is a multiline description of the issue
// that will be in the "Body" property of the commentSample generated json (if run in this repository root as tdg -verbose -blame):
{
"root": "/Users/ribtoks/Projects/go/src/github.com/ribtoks/tdg",
"branch": "master",
"author": "Taras Kushnir",
"project": "tdg",
"comments": [
{
"type": "TODO",
"title": "This is title of the issue to create",
"body": "This is a multiline description of the issue\nthat will be in the \"Body\" property of the comment",
"file": "README.md",
"line": 20,
"issue": 123,
"author": "alias",
"commitHash": "8a9e18b1e0fecf5e94203db058ca5110d05aaf29",
"committerEmail": "foo@bar.com",
"category": "SomeCategory",
"estimate": 0.5
}
]
}Supported comments: //, /*, #, %, ;; (adding new supported comments is trivial).
Install
As simple as
go install github.com/ribtoks/tdg/cmd/tdg@latestBuild
As simple as
make buildUsage
-exclude value
Exclude pattern (can be specified multiple times)
-help
Show help
-include value
Include pattern (can be specified multiple times)
-log string
Path to the logfile (default "tdg.log")
-min-chars int
Include comments with more chars than this (default 30)
-min-words int
Skip comments with less than minimum words (default 3)
-root string
Path to the the root of source code (default "./")
-blame
Get commit hash and commiter email of the comments
-stdout
Duplicate logs to stdout
-verbose
Output human-readable jsonExamples:
With include pattern and verbose flag
tdg -root ~/Projects/xpiks-root/xpiks/src/ -include "\.(cpp|h)$" -verboseInclude pattern is a regexp. With verbose flag you get human-readable json and log output in stdout. Without verbose flag this tool could be used as input for smth else like curl.
With blame flag
tdg -blame -verboseIncludes the commit hash and committer email in comment json. Adds these fields per comment:
14a15,16
> "commitHash": "8a9e18b1e0fecf5e94203db058ca5110d05aaf29",
> "committerEmail": "foo@bar.com",How to contribute
- Fork tdg repository on GitHub
- Clone your fork locally
- Configure the upstream repo (
git remote add upstream git@github.com:ribtoks/tdg.git) - Create local branch (
git checkout -b your_feature) - Work on your feature
- Build and Run tests (
go tests -v) - Push the branch to GitHub (
git push origin your_feature) - Send a pull request on GitHub