Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 83 lines (51 sloc) 1.765 kb
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
1 = Guard::Annotate
2
3 Annotate guard runs the annotate gem when needed
4
5 - Compatible with Annotate 2.4.x
6 - Tested on Ruby 1.8.7 & 1.9.2
7
8 == Install
9
10 Install the gem:
11
12 gem install guard-annotate
13
14 Add the gem to your Gemfile:
15 gem 'guard-annotate'
16
17 Add guard definitions to your Guardfile by running:
18
19 guard init annotate
20
21
22 == Usage
23
24 Please read the {Guard usage docs}[https://github.com/guard/guard#readme]
25
26 == Guardfile
27
28 === Standard Ruby on Rails project
29
30 guard 'annotate' do
63f6356f » cpjolicoeur
2011-05-21 update docs
31 watch( 'db/schema.rb' )
32 # Uncomment the following line if you also want to run annotate anytime
33 # a model file changes
34 #watch( 'app/models/**/*.rb' )
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
35 end
6e2c913f » rainux
2011-07-26 Provide an option :run_at_start to control if run at guard start
36
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
37
38 == Options
39
a6d0043d » cpjolicoeur
2011-05-20 allow user to set annotation positioning
40 You can disable desktop notifications with (default is notifications are enabled):
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
41
42 guard 'annotate', :notify => false do
43 ...
44 end
45
a6d0043d » cpjolicoeur
2011-05-20 allow user to set annotation positioning
46 You can customize the placement of the annotations with (default is 'before'):
47
48 guard 'annotate', :position => 'before|after' do
49 ...
50 end
6e2c913f » rainux
2011-07-26 Provide an option :run_at_start to control if run at guard start
51
8f00f3de » cpjolicoeur
2011-06-09 prep for new release
52 You can choose to also annotate your routes file with (default is false):
6e2c913f » rainux
2011-07-26 Provide an option :run_at_start to control if run at guard start
53
8f00f3de » cpjolicoeur
2011-06-09 prep for new release
54 guard 'annotate', :routes => true do
55 ...
56 end
6e2c913f » rainux
2011-07-26 Provide an option :run_at_start to control if run at guard start
57
8f00f3de » cpjolicoeur
2011-06-09 prep for new release
58 You can annotate your tests and fixtures files with (default is false):
59
60 guard 'annotate', :tests => true do
61 ...
62 end
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
63
6e2c913f » rainux
2011-07-26 Provide an option :run_at_start to control if run at guard start
64 You can disable run at start with (default is true):
65
66 guard 'annotate', :run_at_start => false do
67 ...
68 end
69
286b5662 »
2012-03-18 Enable --show-indexes option for models
70 You can annotate indexes on your models with (default is false):
71
72 guard 'annotate', :show_indexes => true
73 ...
74 end
75
2fffb05c » cpjolicoeur
2011-05-20 initial commit with bare project stub files
76 == Development
77
78 - Source hosed at {GitHub}[https://github.com/cpjolicoeur/guard-annotate]
79 - Issue/Bug/Question/Feature requests via {GitHub Issues}[http://github.com/cpjolicoeur/guard-annotate/issues]
80
81 == Authors
82
83 {Craig P Jolicoeur}[https://github.com/cpjolicoeur]
Something went wrong with that request. Please try again.