TodoTracker is a simple gem, which is used for maitaining a list of pending TODO's from your code. You can generate html as well as text report to keep track. Currently it scans your entire project folder, but i am working on next release where you would be able to blacklist & whitelist specific files & folder too.
Add this line to your application's Gemfile:
gem 'todo_tracker'
And then execute:
$ bundle
Or install it yourself as:
$ gem install todo_tracker
How to create a todo in any ruby file:
.
.
<%= some code %>
.
.
#TODO I have to refractor this logic later
.
.
To generate text report
todo_tracker --html
To generate html report
todo_tracker --text
Pending TODO's:
Todo (1): I have to refractor this logic later #=> Actual todo/task to be done
Line: 6 #=> line number
Filename: app/controllers/application_controller.rb #=> file name with relative path
Generated on: 22-Jul-2015-01:57 PM UTC #=> Report generation timestamp (In UTC time)
Bug reports and pull requests are welcome on GitHub at https://github.com/CraftApps/todo_tracker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.