Recipe file specification

Recipe file is simple Ruby script, with some exceptions.

By avoiding the DSL methods listed below, you are free to write code as you like. (e.g. write your cool code, define variables, require other files)

Special methods available within recipe file

The following methods are special variables available within recipe file.

dry_run?

Whether dry run

e.g.

unless dry_run?
  puts "This will be called when apply mode"
end

params

Passed from --params

Returns:

• Hash<Symbol, String>

e.g.

sashimi_tanpopo local --params name:sue445 --params lang:ja recipe.rb

within recipe.rb

# recipe.rb

params
#=> {name: "sue445", lang: "ja"}

update_file

Update files

# Update single file if exists
update_file "test.txt" do |content|
  content.gsub!("name", params[:name])
end

# Update multiple files if exists
update_file ".github/workflows/*.yml" do |content|
  content.gsub!(/ruby-version: "(.+)"/, %Q{ruby-version: "#{params[:ruby_version]}"})
end

# Create new file if file doesn’t exist
update_file "new_file.txt", create: true do |content|
  # content
  # # => ""

  content.replace("My name is " + params[:name])
end

Parameters:

• pattern: Path to target file (relative path from --target-dir). This supports Dir.glob pattern. (e.g. .github/workflows/*.yml)

• create (defaults to false): Whether create new file if file doesn’t exist

Yield Parameters:

• content: Content of file. If content is changed in block, file will be changed.