Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dasch/todotask

A simple ToDo task that extracts TODO items from your Ruby source
https://github.com/dasch/todotask

Last synced: 24 days ago
JSON representation

A simple ToDo task that extracts TODO items from your Ruby source

Awesome Lists containing this project

README

        

ToDoTask
========

A simple Rake command that extracts and displays `TODO` items from your source code.

Usage
-----

Simply create a new `ToDoTask` in your Rakefile:

ToDoTask.new

Running `rake todo` will now output all `TODO` items in your `lib/` and `test/`
directories. Say you have a file `test/foomatic/foo.rb` with the contents

class Monkey
# TODO: Make this lazy monkey do something!
# TODO: Also, can we make it dance?
end

When you run `rake todo`, you'll see

$ rake todo
test/foomatic/foo.rb:
* TODO: Make this lazy monkey do something! (line 2)
* TODO: Also, can we make it dance? (line 3)

ToDo items: 2

Installation
------------

Simply run `gem install todotask`.

Contributors
------------

* Daniel Schierbeck ([dasch](http://github.com/dasch))
* Nils Jonsson ([njonsson](http://github.com/njonsson))