STOP LOOSING YOUR TODOS. MAKE A COMMITMENT TO QUALITY, DILIGENCE, AND FOLLOW-THROUGH. TODOs ARE NO LONGER OPTIONAL. THEY'RE NO LONGER SOMETHING TO FORGET. THEY'RE HERE, THEY'RE NOW, AND THEY'RE YOUR RESPONSIBILITY.
ToDoMe works by scanning your Java/Kotlin/Groovy code for any TODO comments. But it doesn't stop there. It checks for a due date in every TODO. If it finds a TODO without a due date, your build fails. Brutal? Yes. Effective? Absolutely.
In addition, ToDoMe can list all your TODOs, filtered by assignee and sorted by due date. This makes it easy to manage your tasks and prioritize your work.
Include the following to your build.gradle:
plugins {
id 'com.yahorbarkouski.todome' version '1.0.3'
}Or if you're using kotlin DSL:
plugins {
id("com.yahorbarkouski.todome") version "1.0.3"
}Run the Gradle sync task to download the plugin and integrate it into your project.
The plugin provides a todome for additional configuration options, so you can specify different due date prefixes and the date format to use:
todome {
// default is 'due to'
dueDatePrefixes = ['due to', 'deadline']
// default is 'dd.MM.yyyy'
dateFormat = 'd MMM yyyy'
}Run the verifyTodos task to check your code for TODOs without due dates. If any are found, your build will fail. No way to ignore.
./gradlew verifyTodos
List your TODOs, filtered by assignee and sorted by due date using the listTodos task. You can specify an assignee and sort order as command line properties. If not, the default assignee is "all" and the default sort order is "desc".
./gradlew listTodos -Passignee=yahor -Psort=asc
To check overdue TODOs, use the listTodos task with -Poverdue=true flag. The task will fail, if there are any overdue TODOs, so either do them or get ready to be ashamed in code review.
./gradlew listTodos -Passignee=yahor -Poverdue=true
Every TODO is a promise. A promise to your code, to your users, and to yourself. With ToDoMe, you're going to keep those promises. So, roll up your sleeves, buckle down, and get to work. Your TODOs are waiting.