ActiveTodo
Forget TODO comments that are sitting in your code forever
Installation
Add this line to your application's Gemfile:
gem 'activetodo'
And then execute:
$ bundle
Or install it yourself as:
$ gem install activetodo
Usage
Use anywhere in code:
# Generic TODO without deadline
TODO 'Add specs'
# Raises error after 2014-01-01
FIXME 'Certificate will expire soon', deadline: '2014-01-01'
# After 2014-02-28, does Rails.logger.warn in production, raises error in development / test
XXX 'Dirty hack, must refactor', deadline: '2014-02-28', warn_only: Rails.env.production?
TODO
, FIXME
and XXX
all have same interface: TODO(<message>, [options_hash])
You can use activetodo
with or without Rails.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request