toodles: Manage the TODO entries in your code

[ mit, program, project-management ] [ Propose Tags ]

See the README on GitHub at https://github.com/aviaviavi/toodles#readme


[Skip to Readme]
Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.1.0.6, 0.1.0.7, 0.1.0.8, 0.1.0.9
Dependencies aeson, base (>=4.7 && <5), blaze-html, bytestring, cmdargs, directory, filepath, http-types, megaparsec, MissingH, regex-posix, servant, servant-blaze, servant-server, strict, text, transformers, wai, warp, yaml [details]
License MIT
Copyright 2018 Avi Press
Author Avi Press
Maintainer mail@avi.press
Category Project Management
Home page https://github.com/aviaviavi/toodles#readme
Bug tracker https://github.com/aviaviavi/toodles/issues
Source repo head: git clone https://github.com/aviaviavi/toodles
Uploaded by aviaviavi at Wed Oct 10 16:45:03 UTC 2018
Distributions NixOS:0.1.0.9
Executables toodles
Downloads 239 total (239 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2018-10-10 [all 3 reports]
Hackage Matrix CI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for toodles-0.1.0.3

[back to package description]

Toodles

Build Status

Toodles scrapes your entire repository for TODO entries and organizes them so you can manage your project directly from the code. View, filter, sort, and then edit your TODO's with an easy to use web application. When you're done, commit and push your changes and share changes with your team!

Toodles Screenshot

TODO details

Specify details about your TODO's so that you can filter and sort them with ease! Specify details within parenthasis and separate with the | delimeter.

# TODO(assignee|p=1|keys=vals|#tags) 

Priority

The key p=<integer> will be interpreted as a priority number

KeyVals

Use arbitrary key value pairs <key>=<value>|<key2>=<value2>|... and design any organization scheme you wish! A good use for this is to enter dates of deadlines for TODO's that you can sort on in Toodles

Tags

A detail starting with #, eg #bug|#techdebt|#database|... will be interpreted as a tag, which can be used to label and group your TODO's.

Assign

Assign your TODO's to someone. Any plain word that will be interpreted as an assignee.

# TODO(bob) - something we need to do later

Per Project Configuration

You can configure toodles by putting a .toodles.yaml file in the root of your project. See this repo's .toodles.yaml for the full configuration spec.

Currently via config you can:

  • Set files to ignore via a list of regular expressions

Scanned Languages

Submit a PR if you'd like a language to be added. There will eventually be support for this to be user configurable

  • C/C++
  • Elixir
  • Erlang
  • Go
  • Haskell
  • Java
  • Javascript
  • Objective-C
  • Protobuf
  • Python
  • Ruby
  • Rust
  • Scala
  • Shell / Bash
  • Swift
  • Typescript
  • Yaml

Current Limitations

Due to the parser's current simplicity, Toodles won't see TODO's in multiline initiated comment. For instance in javascript

// TODO(#bug) this would be parsed

/*

 TODO(#bug) this will _not_ be picked up by toodles

*/