Skip to content

awebdev/node-notes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-notes is a node.js version of Rails' "rake notes" functionality. It allows you to put comments in your code and then have them annotated across your whole project. Uses local .gitignore to ignore files or default ignore list.

Installation:

npm install notes -g

Usage:

$ notes              # will search for notes in cwd
$ notes .            # will search for notes in cwd considers .gitignore to ignore files
$ notes lib/ test/   # will search only in lib and test

What It Does:

For example, if a file contained these lines somewhere in it:

code...
# NOTE: This line should get annoated by Notes.
# OPTIMIZE Make things faster!

more code...
# TODO: Annotate your tasks.

yet more code...
# FIXME: Keep up with things to fix.

Those comments would be annotated as:

* /path/to/my/file
Line 8:    ✐ NOTE This line should get annoated by Notes.
Line 9:   ↘ OPTIMIZE Make things faster!
Line 10:   ✓ TODO Annotate your tasks.
Line 11:   ☂ FIXME Keep up with things to fix.

About

A node.js version of Rails' "rake notes" functionality

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 87.3%
  • JavaScript 12.7%