A Crystal library for rendering multiple template files. Forked from the excellent https://github.com/mosop/teeplate
This version of teeplate was forked so we could upgrade Lucky to 0.30.0
Add this to your application's shard.yml
:
dependencies:
teeplate:
github: luckyframework/teeplate
- ECR
require "teeplate"
Let's make our crystal init
template.
- spec/
- spec_helper.cr.ecr
- {{file}}_spec.cr.ecr
- src/
- {{file}}/
- version.cr.ecr
- {{file}}.cr.ecr
- {{file}}/
- .gitignore
- .travis.yml
- LICENSE.ecr
- README.md.ecr
- shard.yml.ecr
# shard.yml.ecr
name: <%= @file %>
version: 0.1.0
authors:
- <%= @author %>
license: MIT
class CrystalInitTemplate < Teeplate::FileTree
directory "#{__DIR__}/path/to/template"
@file : String
@class : String
@author : String
@year : Int32
def initialize(@file, @class, @author, @year)
end
end
template = CrystalInitTemplate.new("teeplate", "Teeplate", "mosop", 2016)
template.render "/path/to/output"
- spec/
- spec_helper.cr
- teeplate_spec.cr
- src/
- teeplate/
- version.cr
- teeplate.cr
- teeplate/
- .gitignore
- .travis.yml
- LICENSE
- README.md
- shard.yml
# shard.yml
name: teeplate
version: 0.1.0
authors:
- mosop
license: MIT
If a file already exists, Teeplate skips rendering the file. To force overwriting, set the :force
option:
class Template < Teeplate::FileTree
directory "/path/to/template"
@face : String
def initialize(@face)
end
end
Template.new(":)").render("/path/to/output")
Template.new(":(").render("/path/to/output", force: true) # files may be overwritten
Template.new(":P").render("/path/to/output") # nothing happens
If the :interactive
option is true, Teeplate prompts us to select whether to overwrite an existing file.
shard.yml already exists...
overwrite(o)/keep(k)/diff(d)/overwrite all(a)/keep all(n) ?
You can print a list of rendered files. To enable it, set true to the :list
option and call #render.
template = BrandNewCrystalInitTemplate.new("teeplate", "Teeplate", "mosop", 2017)
template.render "/path/to/overwrite", list: true
Output example:
modified .gitignore
identical .travis.yml
new Dockerfile
skipped LICENSE
skipped README.md
skipped shard.yml
modified spec/spec_helper.cr
skipped spec/teeplate_spec.cr
skipped src/teeplate/version.cr
skipped src/teeplate.cr
You can colorize the output by the :color
option.
template.render "/path/to/overwrite", list: true, color: true
- Merge on overwriting
- v0.3.0
- Quit on overwriting
- Rendering with append mode (see the issue)
- Teeplate::FileTree#render prints a list of rendered files with the :list option.
- v0.2.0
- (Breaking Change) FileTree#initialize does not receive an output directory. Instead, FileTree#render does.
- Diff on overwriting confirmation
- Overwrite All / Keep All on overwriting confirmation
- v0.1.3
- :interactive option to select whether to overwrite existing files
- v0.1.2
- :force option to overwrite output files if they exist