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

@firebrandgroup/xamlator

v1.0.11

Published

Create XML output from JSON data using YAML templates.

Downloads

110

Readme

Xamlator

Create XML output from JSON data using YAML templates.

Installation

npm i @firebrandgroup/xamlator
yarn add @firebrandgroup/xamlator

Usage

import { Xamlator } from 'xamlator';
import { readFileSync } from 'fs';

const pathToTemplate = 'path/to/template.yaml';

// Create a new Xamlator instance with template string
const yamlTemplate = readFileSync(pathToTemplate, 'utf8');
const xamlator = new Xamlator({ templateString: yamlTemplate });
// or specify path to Xamlator should read the template from
const xamlator = new Xamlator({ templatePath: pathToTemplate });

// Convert JSON data to XML
xamlator.convert(/* JSON data */);

Template Syntax

Sample YAML Template

You can run a sample template using the following command which will output the generated XML to the console:

yarn example

Basic Structure

There are three main parts of the template:

# 1) Define the root element of the XML output
root: person
# 2) Define global variables
variables:
  SOME_VARIABLE: someValue
# 3) Define the elements of the XML output
elements:
  some_element: someValue

Variables

There are two types of variables, variables from the JSON data and global variables.

To use a variable from the JSON data, use the following syntax:

elements:
  some_element: ${variableName}

To use a global variable, use the following syntax:

variables:
  SOME_VARIABLE: someValue
elements:
  some_element: $${SOME_VARIABLE}

Variables also support dot-notation to access nested properties:

elements:
  some_element: ${nested.property}

Atrributes

To define attributes of an element, use the following syntax:

elements:
  # Define an element with an attribute by specifying the
  # properties of the element:
  some_element:
    value: someValue
    attributes:
      - name: someAttribute
        value: someAttributeValue

The output of the aboved YAML template will be:

<some_element someAttribute="someAttributeValue">someValue<some_element>

Structure

To define the structure of the XML output, use the following syntax:

elements:
  some_element:
    some_child_element: someValue
    another_child_element: anotherValue

The output of the aboved YAML template will be:

<some_element>
  <some_child_element>someValue</some_child_element>
  <another_child_element>anotherValue<another_child_element>
</some_element>

Conditional and Mathematical Operations

To use conditional and mathematical operations, use the following syntax:

elements:
  some_element: =SUM(1, 2)

The conditional and mathematical operations also support variables and nesting:

elements:
  some_element: =IF(=LT(${var_1}, ${var_2})), true, false)

The following operators are supported:

  • =SUM(val1, val2): Addition
  • =DIFF(val1, val2): Subtraction
  • =PROD(val1, val2): Multiplication
  • =QUOT(val1, val2): Division
  • =EQ(val1, val2): Equality
  • =LT(val1, val2): Less than
  • =LTE(val1, val2): Less than or equal
  • =GT(val1, val2): Greater than
  • =GTE(val1, val2): Greater than or equal
  • =IF(condition, trueValue, falseValue): Conditional
  • =NOT(condition, trueValue, falseValue): Negation

Development

Install Dependencies

yarn

Run Tests

yarn test
# or
yarn test:watch

Build

yarn build