andreaswittig / gradle-todo-plugin

A Gradle plugin for finding // TODO comments

gradle-todo-plugin

A Gradle plugin for finding // TODO comments.

Basic usage

Add to your build.gradle

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.autoscout24.gradle:gradle-todo-plugin:1.0'
    }
}

apply plugin: 'com.autoscout24.gradle.todo'

Advanced usage

Add to your build.gradle

todo {
    teamCityLog = true
    todoPattern = "//[\t\s]*TODO(.*)"
    todoSuffixPattern =  '(someText|otherText)(.*)'
    failIfFound = true
    sourceFolder = "your source folder"
    fileExtensions = ["java", "groovy"]
}

• teamCityLog: Add features for TeamCity
• todoPattern: Regex for TODO
• todoSuffixPattern: Regex suffix for TODO
• failIfFound: Fail build if TODO found
• sourceFolder: Folder name for your sources
• fileExtensions: List of file extension for searching for TODOs

Changelog

Releases

License

gradle-todo-plugin is available under the MIT license. See the LICENSE file for more info.