Gradle Todo Plugin

A Gradle plugin for finding // TODO comments.

License

License

Categories

Categories

Gradle Build Tools Auto Application Layer Libs Code Generators
GroupId

GroupId

com.autoscout24.gradle
ArtifactId

ArtifactId

gradle-todo-plugin
Last Version

Last Version

1.0
Release Date

Release Date

Type

Type

jar
Description

Description

Gradle Todo Plugin
A Gradle plugin for finding // TODO comments.
Project URL

Project URL

https://github.com/AutoScout24/gradle-todo-plugin
Source Code Management

Source Code Management

https://github.com/AutoScout24/gradle-todo-plugin

Download gradle-todo-plugin

How to add to project

<!-- https://jarcasting.com/artifacts/com.autoscout24.gradle/gradle-todo-plugin/ -->
<dependency>
    <groupId>com.autoscout24.gradle</groupId>
    <artifactId>gradle-todo-plugin</artifactId>
    <version>1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.autoscout24.gradle/gradle-todo-plugin/
implementation 'com.autoscout24.gradle:gradle-todo-plugin:1.0'
// https://jarcasting.com/artifacts/com.autoscout24.gradle/gradle-todo-plugin/
implementation ("com.autoscout24.gradle:gradle-todo-plugin:1.0")
'com.autoscout24.gradle:gradle-todo-plugin:jar:1.0'
<dependency org="com.autoscout24.gradle" name="gradle-todo-plugin" rev="1.0">
  <artifact name="gradle-todo-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.autoscout24.gradle', module='gradle-todo-plugin', version='1.0')
)
libraryDependencies += "com.autoscout24.gradle" % "gradle-todo-plugin" % "1.0"
[com.autoscout24.gradle/gradle-todo-plugin "1.0"]

Dependencies

compile (1)

Group / Artifact Type Version
de.felixschulze.teamcity : teamcity-status-message-helper jar 1.0.2

Project Modules

There are no modules declared in this project.

gradle-todo-plugin Build Status Maven Central License MIT

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.

com.autoscout24.gradle

AutoScout24

Versions

Version
1.0
0.2.0
0.1.0