Skip to content
A node.js version of Rails' "rake notes" functionality
CoffeeScript JavaScript
Branch: master
Clone or download

Latest commit

stephenb Merge pull request #9 from derhuerst/master
support case-insensitivity
Latest commit 1a8a9ee Mar 7, 2016

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Read params from local runtime config if any Aug 11, 2012
lib recompiled CoffeeScript Oct 16, 2015
node_modules first commit Jul 5, 2011
src case-insensitivity Oct 9, 2015
.notesrc Read params from local runtime config if any Aug 11, 2012
Cakefile first commit Jul 5, 2011
README.md Updating README May 16, 2012
package.json version bump Oct 5, 2012

README.md

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.

Installation:

npm install notes -g

Usage:

$ notes              # will search for notes in cwd
$ 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.
You can’t perform that action at this time.