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

yaml-blaster

v1.0.24

Published

Framework for pre-processing yaml files

Downloads

35

Readme

YAML-Blaster - Framework for processing YAML templates

This was created to ease the pain of having to use a giant single-file AWS Cloudformation template by allowing variable replacement, file loading, and loops.

Table of Contents

Installation

npm

$ npm install -g yaml-blaster

Usage

CLI

Assuming your project looks like this

project
|
+-- template.yaml
|
+-- data.yaml

From the project directory just run

$ yaml-blaster \
  -i template.yaml \  # The input template
  -d data.yaml        # A configuration file

Or from anywwhere run

$ yaml-blaster \
  -i /full/path/to/project/template.yaml \
  -d /full/path/to/project/data.yaml

To save the output to a file

$ yaml-blaster \
  -i template.yaml \
  -d data.yaml \
  -o processed.yaml

Features

Simple Variable replacement

Syntax: {{variable}} - Replace variables in the template

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MyS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: {{name}}

data.yaml

name: my-bucket-name

run

$ yaml-blaster \
  -i template.yaml \
  -d data.yaml

output

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MyS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-bucket-name

Load a file

Syntax: {{file:relative/path}} - load a file and replace it in the template

Using top-level data scope

By default, any variables in the loaded snippet will be replaced using the top-level scope of the data file.

project structure

project
|
+-- template.yaml
|
+-- data.yaml
|
+-- snippets
   |
   +-- bucket.yaml

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  {{file:sub-templates/bucket.yaml}}

snippets/bucket.yaml

{{logicalName}}:
  Type: AWS::S3::Bucket
  Properties:
    BucketName: {{bucketName}}

data.yaml

logicalName: MyS3Bucket
bucketName: my-s3-bucket

output

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MyS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName:my-s3-bucket

Using specific data scope

Syntax: {{path.to.value, file:relative/path}} - load a file and replace variables under a specific scope

project structure

project
|
+-- template.yaml
|
+-- data.yaml
|
+-- snippets
   |
   +-- bucket.yaml

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  {{bucket1, file:sub-templates/bucket.yaml}}
  {{bucket2, file:sub-templates/bucket.yaml}}

snippets/bucket.yaml

{{logicalName}}:
  Type: AWS::S3::Bucket
  Properties:
    BucketName: {{bucketName}}

data.yaml

bucket1:
  logicalName: MyFirstS3Bucket
  bucketName: my-s3-bucket-1
bucket2:
  logicalName: MySecondS3Bucket
  bucketName: my-s3-bucket-2

output

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MyFirstS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-s3-bucket-1
  MySecondS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-s3-bucket-2

Loops

Syntax: {{for:path.to.array, file:relative/path}} - add n number of instances of a snippet by referring to an array in the data file

project structure

project
|
+-- template.yaml
|
+-- data.yaml
|
+-- snippets
   |
   +-- bucket.yaml

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  {{for:buckets, file:sub-templates/bucket.yaml}}

snippets/bucket.yaml

{{logicalName}}:
  Type: AWS::S3::Bucket
  Properties:
    BucketName: {{bucketName}}

data.yaml

buckets:
  - logicalName: MyFirstS3Bucket
    bucketName: my-s3-bucket-1
  - logicalName: MySecondS3Bucket
    bucketName: my-s3-bucket-2

output

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  MyFirstS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-s3-bucket-1
  MySecondS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-s3-bucket-2