waldyrious / tmpl-cli

Simple, pipeable template rendering on the command-line

tmpl-cli

Simple, pipeable template rendering on the command-line

Consumes a JSON object from stdin and makes its properties available in a template.

Prints the rendered template to stdout.

Template can be of any type, although the README demonstrates use with Markdown files.

Assuming a template README.tmpl.md:

# {{name}}

> {{description}}

Version: {{version}}

$ cat package.json | tmpl README.tmpl.md

# tmpl-cli

> Simple, pipeable template rendering on the command-line

Version: 0.1.2

install

npm install -g tmpl-cli

usage

Usage: tmpl <path-to-template>

Example:
  cat data.json | tmpl README.tmpl.md > README.md

example

Let's say you have a list of your module's dependencies in deps.json and want to create a markdown table out of it and include it in markdown file deps.md.

Here's your template, deps.tmpl.md:

#### My project's dependencies

{{table}}

We use markdown-table-cli to format deps.json into a table, and ramda-cli to wrap the table in JSON:

cat deps.json \
  | md-table \
  | R -i raw --slurp unlines '-> table: it' \
  | tmpl deps.tmpl.md

output

My project's dependencies

package	version
JSONStream	1.0.4
lodash.template	3.6.1
minimist	1.1.1
through2-map	1.4.0