SBT-plugin for finding tags (for example TODOs) in the source code of a project
Scala
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
src
.gitignore
.travis.yml
README.md
build.sbt

README.md

About

Build Status

Small SBT plugin that will contain roughly the functionality of the maven-tag-list plugin when done.

The plugin contains the task "tag-list" which performs a case insensitive search in the sources of a project for a set of keywords. The default keywords are "todo" and "fixme"

Installation

The plugin is available from the community sbt-plugins repository on bintray, add a dependency on it in your project (a common place is PROJECT_DIR/project/plugins.sbt):

addSbtPlugin("com.markatta" % "taglist-plugin" % "1.3.1")

And then this line to PROJECT_DIR/build.sbt to include the task tag-list into your project:

com.markatta.sbttaglist.TagListPlugin.tagListSettings

Configuration

The plugin uses the regular source settings for your sbt-project so it should work out of the box with non-standard directory structures etc.

1.3+:

The default tags looked for are "todo" and "fixme". To override those you can either just simply set a list of words, all of them will yield warnings in the log when found:

import com.markatta.sbttaglist.TagListPlugin

TagListPlugin.TagListKeys.tagWords := Seq("incorrect", "plainwrong", "dontcheckin")

Or if it better suits your needs you can specify each word along with a log level:

TagListPlugin.TagListKeys.tags := Set(Tag("todo", TagListPlugin.Info), Tag("fixme", TagListPlugin.Info))