npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-template-engine

v2.2.9

Published

Lightweight tool for parsing json templates

Downloads

1

Readme

Install

npm install json-template-engine

Usage

const template = {
  simpleText: "bar",
  condition: {
    command: "if",
    inputs: [
      {
        name:"condition",
        value: "{{condition.enable}}"
      }
    ],
    outputs: [
      {
        name: "then",
        template: { data: "condition then" }
      },
      {
        name: "else",
        template: { data: "condition else" }
      }
    ]
  },
  each: {
    command: "each",
    inputs: [
      {
          name: "values",
          value: "#range(3, 0)"
      }
    ],
    outputs: {
      name: "iteration",
      template: "value: {{iteration.value}}; index: {{iteration.index}}"
    }
  }
};
const data = {
  condition: {
    enable: false
  }
};

const JSONTemplateEngine = require("json-template-engine");
const JsonParser = new JSONTemplateEngine({
 keyHelper: "command" // change key for helper, default 'command'
});

JsonParser.compile(template, data).then(result => {
  console.log(result);
});

/* print result
    {
      simpleText: 'bar',
      condition: { data: 'condition else' },
      each: [ 'value: 0; index: 0', 'value: 1; index: 1', 'value: 2; index: 2' ]
    }
*/

Helpers

In the library there is the possibility of implementing 2 types of helpers.

  1. Helpers for changing the structure of templates. Out of the box there is an "if" and "each" helper.
  2. Function helpers (asynchronous functions are also supported). The default range helper is available, which generates an array of elements.

You can register by calling the methods JsonParser.registerHelper (<directive>, <handler>) and JsonParser.registerFunctionHelper (<directive>, <handler>), respectively.

Example

For example, I will give registration of helpers "range" and "if".

const ifHelper = async (inputs, outputs, data, utils) => {
    const condition = inputs.find(input => input.name === "condition");
    if (condition === undefined || outputs === undefined) {
       return undefined;
    }
    const outputName = condition.value ? "then" : "else";
    const output = outputs.find(e => e.name === outputName);
    if (output) {
      return await utils.parse(output.template, data);
    }
    return undefined;
};

const rangeFunctionHelper = async (size = 0, startAt = 0) => {
  return Array.from(Array(size).keys()).map(i => i + startAt);
};

const JSONTemplateEngine = require("json-template-engine");
const JsonParser = new JSONTemplateEngine();
JsonParser.registerHelper("if", ifHelper); // The name of the helper must begin with the symbol "#".
JsonParser.registerFunctionHelper("range", rangeFunctionHelper); // The name of the helper must begin with the symbol "#".