🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

notes

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

notes

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

latest
Source
npmnpm
Version
0.0.4
Version published
Weekly downloads
40
33.33%
Maintainers
1
Weekly downloads
 
Created
Source

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.

Keywords

notes

FAQs

Package last updated on 05 Oct 2012

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts