tempered: A dead-simple shell interpolation templating utility

[ bsd3, library, program, templating ] [ Propose Tags ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.2.0
Dependencies base (>=4.9 && <5), containers, directory, filepath, mtl, optparse-applicative, parsec, process, tempered, yaml [details]
License BSD-3-Clause
Copyright 2017 Chris Penner
Author Chris Penner
Maintainer christopher.penner@gmail.com
Category Templating
Home page https://github.com/ChrisPenner/tempered#readme
Source repo head: git clone https://github.com/ChrisPenner/tempered
Uploaded by ChrisPenner at 2017-04-29T22:26:29Z
Distributions
Executables tempered
Downloads 1636 total (8 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-04-29 [all 1 reports]

Readme for tempered-0.2.0

[back to package description]

Tempered

Hackage

A dead-simple templating utility for simple shell interpolation. Use at your own risk and only on trusted templates.

$ tempered --help
Tempered - Templating engine based on shell interpolation

Usage: tempered [templates]
  Interpolate templates to stdout

Available options:
  templates                The templates to interpolate
  -h,--help                Show this help text

Here's a simple use-case:

{{ # inside "post.md" }}
# My Blog Post

by {{ echo $AUTHOR }}
Published on {{ date +'%B %d, %Y' }}

Here's my blog post!

---
{{ cat ./footer.md | tr 'a-z' 'A-Z' }}
{{ # inside "footer.md" }}
Copyright 2017 Chris Penner
Check me out on twitter @chrislpenner!
See you next time!

Then we can render the template with tempered ./post.md to get:

# My Blog Post

by Chris Penner
Published on April 22, 2017

Here's my blog post!

---
COPYRIGHT 2017 CHRIS PENNER
CHECK ME OUT ON TWITTER @CHRISLPENNER!
SEE YOU NEXT TIME!

If you want you can add a shebang to the top of your template and just run it as an executable, tempered will strip the shebang for you automagically:

test.txt

#!/path/to/tempered
interpolate {{ echo $THIS }}
$ chmod +x test.txt
$ export THIS="that"
$ ./test.txt
interpolate that

Examples Here

Installation

Mac and Linux binaries are provided HERE;

Homebrew On Mac

brew update
brew install ChrisPenner/tools/tempered

Stack

If you're familiar with Haskell Stack:

stack update && stack install tempered

FAQ

There's really not much to it; parses the file and runs anything inside {{ }} as a shell expression and pipes stdout into its spot. If you're clever you can do pretty much anything you want with this.

Variables?

Sure; It's bash.

Hello, my name is {{echo $USER}}

You can set up environment overrides in env.yaml, tempered looks up through the file-system to find an env.yaml from the cwd NOT the template location.

Here's an example env.yaml; we can do simple strings or commands here; just make sure to quote any entries that start with {{ or the YAML parser gets mad.

env.yaml

PROJECT: Tempered
DATE: "{{ date +'%B %d, %Y' }}"

Then you can use them just like normal variables.

For Loops?

It's bash; go for it:

{{ for i in 99 98 97 ; do
    cat <<EOF
$i bottles of beer on the wall
EOF
done }}

output:

99 bottles of beer on the wall
98 bottles of beer on the wall
97 bottles of beer on the wall

__: command not found?

Chances are you're forgetting to echo an env-var; {{ $TITLE }} will try to run the contents of $TITLE as a command, you want {{ echo "$TITLE" }}.

Isn't this whole thing a security risk?

Probably.