Skip to content

Search source code files for TODO, FIXME, or OPTIMI(S|Z)E annotations via the CLI

License

Notifications You must be signed in to change notification settings

r3to/source-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

source-notes

Search files for TODO, FIXME, or OPTIMI(S|Z)E annotations within a directory's source code files displaying the file name, line number, annotation type, and remaining annotation description.

Current files types include in the searach are

  • *.js
  • *.coffee
  • *.iced
  • *.styl
  • *.jade

Example

To run source-notes on any files located in test:

source-notes test

yielding:

source-notes screenshot

Installation

With npm do:

npm install -g source-notes

License

The MIT License (MIT)

Copyright (c) 2014 Akiva Levy akiva@sixthirteen.co

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Search source code files for TODO, FIXME, or OPTIMI(S|Z)E annotations via the CLI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published