=====
NodeJS Note tracker command line utility inspired by Rails Rake Notes
Notey is a nodejs command line utility inspired by the notes rake task available for Rails. It retrieves all properly formatted notes from a directory / directories no matter how many levels deep. See a list of currently supported note formats.
$ npm install -g notey
Notey accepts an infinite number of directories & files to look inside. When called by itself with no arguments, it will default to the current working directory.
For example specifying the multiple directories:
$ notey my_dir another_dir
# output:
my_dir/core.scss:
* [Line 1] [TODO] add more fonts
* [Line 5] [TODO] remove font below
another_dir/stuff.js:
* [Line 4] [TODO] rename module
* [Line 12] [TODO] refactor
* [Line 23] [TODO] include new algorithm
another_dir/things.go
* [Line 134] [TODO] remove unused struct
Or not specifying any directories
$ notey
# output:
User/person/dev/project/src/app/app.js:
* [Line 4] [TODO] update routes
* [Line 13] [TODO] add headers for CORS
* [Line 28] [TODO] update resolves
* [Line 39] [TODO] change fallback url
User/person/dev/project/src/app/controllers/main-controller.js:
* [Line 14] [TODO] make var more descriptive
User/person/dev/project/src/app/controllers/main-controller.spec.js:
* [Line 5] [TODO] remove hard-coded value
* [Line 33] [TODO] make expectation more dynamic
Warning: Only notes w/ a trailing ':' will be considered valid.
- C-Style Languages (C, JS, Go, Java, etc)
- HTML
Note: For all languages especially non-listed ones, single line comments for notes are highly recommended.
- TODO
- FIXME
- OPTIMIZE
Examples:
bad
// todo: this is bad
// Todo: this is bad
// ToDo: this is bad
// todo this is bad
// TODO this is bad
// fixme: this is bad
// Fixme: this is bad
// FixMe: this is bad
// fixme this is bad
// FIXME this is bad
// optimize: this is bad
// Optimize: this is bad
// OptiMize: this is bad
// optimize this is bad
// OPTIMIZE this is bad
good
// TODO: abstract into function
// FIXME: change type
// OPTIMIZE: sorting algorithm
/**
* TODO: change to camelCase
*/
<!-- FIXME: add href -->
/* OPTIMIZE: things */
Notey is tested using Mocha and ShouldJS
$ mocha
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent