search fire star recently

kilt

Abstraction layer for template engines

0.6.0 Latest release released
jeromegn/kilt
115 14 2

Kilt Build Status Dependency Status devDependency Status

Generic templating interface for Crystal.

Goal

Simplify developers' lives by abstracting template rendering for multiple template languages.

Supported out of the box

| Language | File extensions | Required libraries | Maintainer | | -------- | --------------- | ------------------ | ---------- | | ECR | .ecr | none (part of the stdlib) | | | Mustache | .mustache | crustache | @MakeNowJust | | Slang | .slang | slang | @jeromegn | | Temel | .temel | temel | @f | | Crikey | .crikey | crikey | @domgetter | | Liquid | .liquid | liquid | @docelic | | Jbuilder | .jbuilder | jbuilder | @shootingfly | | Water | .water | water | @shootingfly |

See also: Registering your own template engine.

Installation

Add this to your application's shard.yml:

dependencies:
  kilt:
    github: jeromegn/kilt

  # Any other template languages Crystal shard

Usage

  • Kilt essentially adds two macros Kilt.embed and Kilt.file, the code is really simple.
  • Add template language dependencies, as listed in the support table above.

Both macros take a filename and a io_name (the latter defaults to "__kilt_io__")

Example

require "kilt"

# For slang, add:
require "kilt/slang"

# With a Class

class YourView
  Kilt.file("path/to/template.ecr") # Adds a to_s method
end
puts YourView.new.to_s # => <compiled template>


# Embedded

str = Kilt.render "path/to/template.slang"

# or

str = String.build do |__kilt_io__|
  Kilt.embed "path/to/template.slang"
end

puts str # => <compiled template>

Registering your own template engine

Use Kilt.register_engine(extension, embed_command) macro:

require "kilt"

module MyEngine
  macro embed(filename, io_name)
    # ....
  end
end

Kilt.register_engine("myeng", MyEngine.embed)

This can be part of your own my-engine library: in this case it should depend on kilt directly, or this could be a part of adapter library, like: kilt-my-engine, which will depend on both kilt and my-engine.

Contributing

Please contribute your own "adapter" if you create a template language for Crystal that's not yet supported here!

  1. Fork it ( https://github.com/jeromegn/kilt/fork )
  2. Create your feature branch (git checkout -b my-awesome-template-language)
  3. Commit your changes (git commit -am 'Add my-awesome-template-language')
  4. Push to the branch (git push origin my-awesome-template-language)
  5. Create a new Pull Request

Contributors

kilt:
  github: jeromegn/kilt
  version: ~> 0.6.0

Authors

  • Jerome Gravel-Niquet

License

MIT

Crystal

none

Dependencies 0

Development Dependencies 6

Dependents 13

Show all 13 dependents
Last synced .