Giter Club home page Giter Club logo

watnow's Introduction

Watnow

Watnow finds and lists your project TODOs and FIXMEs.
It basically does what the Rails’ rake notes does, but in a more generic way.

Installation

$ gem install watnow

Usage

$ watnow

Help

$ watnow --help

Usage: watnow [options]

-h, --help               show this message
-v, --version            display version
-d, --directory DIR      directory DIR to scan (defaults: ./)

watnow commands:
open <ID>    open annotation ID in your editor
remove <ID>  remove annotation ID

Commands

open

Opens an annotation in your $EDITOR focused on the annotation line.

$ watnow open 13

remove

Removes the annotation line from its file.
(Make sure there is nothing else on that line)

$ watnow remove 13

Features

Mentions

# TODO @rafBM: Update user form
# TODO Update user controller @rafBM
[ 2 ] TODO: Update user form [ @rafBM ]
[ 1 ] TODO: Update user controller [ @rafBM ]

Priority

Exclamation mark (!) preceded by a whitespace. (/\s(!+)\s?/)

# TODO !!!: This is level 3 urgent
# TODO @rafBM: Just do it !
# TODO: This is not a priority!!
# TODO !!!!!!!!!!!!! @EtienneLem: This is a nicolas-cage-level urgent task
[ 3 ]  TODO: This is not a priority!!
[ 2 ]  TODO: Just do it [ @rafBM - ! ]
[ 1 ]  TODO: This is level 3 urgent [ !!! ]
[ 4 ]  TODO: This is a nicolas-cage-level urgent task [ @EtienneLem - !!!!!!!!!!!!! ]

Super color-friendly

(Seriously, I’m open to color suggestions…) color-friendly

Watnow config

Override defaults in ~/.watnowconfig. Supported options are:

username  (String)    | A username so that you can be mentioned in TODOs  | Default: ''
color     (Boolean)   | Enable/disable colored output                     | Default: true
patterns  (Array)     | An array of string/regex that you want to monitor | Default: []

Use YAML syntax:

username: EtienneLem
color: false
patterns: [potato, ba(na)+]

Contribution

My Ruby skills are far from exemplary, please teach me.

watnow's People

Contributors

etiennelem avatar

Stargazers

Simon Thiboutôt avatar  avatar Rafael Masson avatar Rémi Prévost avatar

Watchers

Rafael Masson avatar  avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.