todo_r 0.5.0

Simple rust command line utility that keeps track of your todo comments in code
docs.rs failed to build todo_r-0.5.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: todo_r-0.4.0

Todo_r

Build Status

Find all your notes with one command!

Todo_r is a simple rust command line utility that keeps track of your todo items in code. It is pronounced "todoer" like someone that does todos.

Find all your notes with one command!

A lot is adapted from leasot but runs much faster.

Installation

The latest release can be downloaded from the releases page.

Features

  • Reads TODO comments that are on their own line.
// TODO: do this
/* TODO: do that */
-  Note: comments that are not on their own line are __not__ supported.
  • User references are tracked and can be found using --user flag.
// TODO(user1): item
// TODO: tagging @user2 and @user3
// TODO(user1): @user3 both are also found!

Comments 1 and 3 are found with todor -u user1.

  • Custom tags can be searched using the -t flag.
  • Interactive mode for deleting comments is launched using the -d flag.
  • If files are not provided for input, todo_r searches the entire git repository.
    • .gitignore files are respected
    • More ignores can be added using .todorignore files that use the same syntax
    • If you are not using git, you can instead use a .todor file in the root directory

Config files

Create a .todor file in the root of your workspace with todor init.

.todor files can also used as a config file to set custom tags, comments types, output styles, etc.

Language support

Filetype Extensions Comment Types
C/C++ .c,.h,.cpp //,/* */
C# .cs //,/* */
CoffeeScript .coffee #
Go .go //,/* */
Haskell .hs --
HTML .html,.htm <!-- -->
Java .java //,/* */
JavaScript .js,.es,.es6 //,/* */
Obj-C/C++ .m,.mm //,/* */
Less .less //,/* */
Markdown .md <!-- -->
Perl .pl,.pm #
PHP .php //,/* */
Python .py #,""" """
Ruby .rb #
Rust .rs //,/* */
Sass .sass,scss //,/* */
Scala .scala //,/* */
Shell .sh,.bash,.zsh #
SQL .sql --,/* */
Stylus .styl //,/* */
Swift .swift //,/* */
TeX .tex %
TypeScript .ts,.tsx //,/* */
YAML .yaml,.yml #

written by Lavi Blumberg