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 🙏

© 2021 – Pkg Stats / Ryan Hefner

yaml-boost

v2.0.1

Published

Yaml Parser with additional functionality.

Downloads

27,796

Readme

Yaml-Boost

Build Status Test Coverage Dependabot Status Dependencies NPM Downloads Semantic-Release Gardener

Basic Yaml Loading with additional functionality, i.e. resolve file depedencies, resolve variables, deep merge hierachies.

Useful for loading improved serverless configuration. For yaml loading this package uses js-yaml.

Getting Started

$ npm install --save yaml-boost

Api

resolve(refPath, content, vars)

Resolve content with variables at given refPath.

load(filePath, vars = {})

Load filePath with given variables.

dump

As provided by js-yaml through safeDump

Usage

const yaml = require('yaml-boost');

yaml.load('config.yaml');

Matching yaml.dump() function is also available.

Variable and File Resolution

Works identical to how this is defined for serverless here.

Both yml and yaml file endings are supported.

Extensions

Bake variables when loading files
${file(./path/to/file.yml), key1=value1&key2=value2}
Reference Packages

You can reference packages by using

${require(PACKAGE):path.to.key.in.module}
Reference Js files

Reference js instead of yaml files.

${file(./path/to/file.js)}

The reference file needs to export simple object containing configuration

module.exports = {};
Reference Function inside Js file

Reference function inside js file.

${fileFn(./path/to/file.js)}

The reference file needs to export simple function returning an object. Available variables are passed in.

module.exports = (args) => ({ args });
Relative File References

Once can reference files relative to the current file by using ^ as a prefix like so

${file(^/subfolder/of/current/file.yml)}
Deep Merge

Analogue to the << yaml syntax we can use <<< to deep merge into the current nesting level. This is helpful when merging files into already existing hierarchies.

Example:

data:
  - list entry one

<<<:
  - data:
      - list entry two
  - other: things

results in

data:
  - list entry one
  - list entry two
other: things

Serverless Example

Define serverless.js as

const path = require('path');
const minimist = require('minimist');
const yaml = require('yaml-boost');

module.exports = yaml.load(path.join(__dirname, 'serverless.core.yml'), minimist(process.argv.slice(2)));

Then instead of defining serverless.yml, define your config in serverless.core.yml.