Project

code_notes

0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
code notes task extracted from Rails
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 3.2.13
>= 0
 Project Readme

CodeNotes Inline docs

Extracting from Rails the rake notes, source annotation extaction task

By default, it looks for OPTIMIZE,FIXME,TODO

Installation

Add this line to your application's Gemfile:

gem 'code_notes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install code_notes

Usage

code_notes [optional: quoted regexp pattern to match annotattions. default: "OPTIMIZE|FIXME|TODO"]
rake notes
# the same as
ANNOTATION="OPTIMIZE|FIXME|TODO" rake notes:custom

By default it searches in app config db lib test spec features. More directories can be set by the comma-separated environmental variable SOURCE_ANNOTATION_DIRECTORIES

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Bitdeli Badge