Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

# Created by https://www.gitignore.io/api/node

### Node ###
# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules
jspm_packages

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history
63 changes: 45 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,59 @@ to put comments in your code and then have them annotated across your whole proj

### Installation:


npm install notes -g
```sh
$ npm install notes -g
```

### Usage:

$ notes # will search for notes in cwd
$ notes lib/ test/ # will search only in lib and test
```sh
$ 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.
```text
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.
```text
* /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.
```

### Development:

#### Build Project

```sh
$ npm install # install all dependencies

$ npm run -s build # build the project
# OR
$ npm i -g nodemon # install nodemon globally
$ npm run -s build:watch # watch src/ dir for changes
```

#### Test the Project

```sh
$ npm link # make globally available
$ notes # use the `notes` app
```
8 changes: 4 additions & 4 deletions lib/notes.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion node_modules/.bin/cake

This file was deleted.

1 change: 0 additions & 1 deletion node_modules/.bin/coffee

This file was deleted.

11 changes: 0 additions & 11 deletions node_modules/coffee-script/.npmignore

This file was deleted.

22 changes: 0 additions & 22 deletions node_modules/coffee-script/LICENSE

This file was deleted.

48 changes: 0 additions & 48 deletions node_modules/coffee-script/README

This file was deleted.

78 changes: 0 additions & 78 deletions node_modules/coffee-script/Rakefile

This file was deleted.

7 changes: 0 additions & 7 deletions node_modules/coffee-script/bin/cake

This file was deleted.

7 changes: 0 additions & 7 deletions node_modules/coffee-script/bin/coffee

This file was deleted.

Loading