Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow guards to specify their templates #369

Merged
merged 2 commits into from Dec 2, 2012
Merged

allow guards to specify their templates #369

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00fbc16
allow guards to specify their templates
schmurfy Dec 1, 2012
1a5e714
added inline doc for template method
schmurfy Dec 1, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/guard/guard.rb
View file
Open in desktop
Expand Up @@ -58,6 +58,15 @@ def initialize(watchers = [], options = {})
@watchers, @options = watchers, options
end

# Specify the source for the Guardfile template.
# Each Guard plugin can redefine this method to add its own logic.
#
# @param [String] The plugin name
#
def self.template(name)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add inline documentation as for the other methods? Thanks!

File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
end

# Initialize the Guard plugin. This will copy the Guardfile template inside the Guard plugin gem.
# The template Guardfile must be located within the Gem at `lib/guard/guard-name/templates/Guardfile`.
#
Expand All @@ -68,7 +77,7 @@ def self.init(name)
::Guard::UI.info "Guardfile already includes #{ name } guard"
else
content = File.read('Guardfile')
guard = File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
guard = template(name)

File.open('Guardfile', 'wb') do |f|
f.puts(content)
Expand Down