https://github.com/xijo/toadie

TODO Reporter
https://github.com/xijo/toadie

Last synced: about 2 months ago
JSON representation

TODO Reporter

• Host: GitHub
• URL: https://github.com/xijo/toadie
• Owner: xijo
• License: mit
• Created: 2012-11-11T04:08:52.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2016-01-08T14:51:49.000Z (almost 9 years ago)
• Last Synced: 2024-10-31T13:13:38.710Z (about 2 months ago)
• Language: Ruby
• Size: 80.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Toadie

Toadie greps your (ruby) source code for TODO tags and associate them with your team members.

It's meant to be part of a CI process, so everyone should be able to find her/his open TODOs.

[![Build Status](https://secure.travis-ci.org/xijo/toadie.png?branch=master)](https://travis-ci.org/xijo/toadie) [![Gem Version](https://badge.fury.io/rb/toadie.png)](http://badge.fury.io/rb/toadie)

## Features

 - grep rb, erb, haml, slim and feature files

 - uses git blame to find the author

 - configurable author tags associate TODO with persons in duty

 - provides html report

## Installation

Add this line to your application's Gemfile:

    gem 'toadie', require: false

And then execute:

    $ bundle

## Usage

Just run toadie in the root of your application:

    $ toadie

It will produce the html output into a folder called 'toadie', having a index.html file in there:

    $ open toadie/index.html

## Configuration

### Configure team members

By default you will not need to configure any team members. Toadie will detect authors by using git and display TODOs accordingly.

However, to have multiple mail addresses or assignment tags for each team member create a `.toadie.json` file.

You can specify team members like this:

```json

{

  "authors": [

    {

      "name": "Jean-Luc Picard",

      "emails": ["[email protected]", "[email protected]"],

      "nicknames": ["captain", "picard", "jean-luc"]

    },

    {

      "name": "William T. Riker",

      "emails": ["[email protected]"],

      "nicknames": ["riker", "will", "no1"]

    }

  ]

}

```

The given nicknames will be used to find TODOs assigned to this person. For example Picard writes:

```ruby

# TODO no1 meet me in my room

```

The TODO will be assigned to Riker.

### Configure file extensions

By default toadie will try to find any TODOs in the given directory. Sometimes it might be helpful to reduce this search to files with a specific file ending. This can be done by setting the `file_extensions` configuration option:

```json

{

  "file_extensions": ["rb", "js", "py"]

}

```

This example will only search for ruby, python and javascript files and skips e.g. log files.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## Todos (haha)

1. Make output directory/format configurable

2. Do a little benchmarking and profiling

3. Refine descriptions and texts

4. Detect multiline TODOs

5. Support more languages

6. Link source to github