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

@koerber/yaml

v1.0.5

Published

Simple extension to JS-YAML

Downloads

1

Readme

Simple YAML parser wrapper with extensions

This simply wraps the js-yaml package providing a parse(...) convenience method to parse files synchronously, and adding a couple of useful tags.

Usage

Very simply:

const { parse } = require('@koerber/yaml')
let parsed = parse('my_file.yml')

An optional second argument to the parse(...) function allows to specify the base schema for parsing (defaulting to DEFAULT_SAFE_SCHEMA).

The module also exposes dump(...) as an alias to js-yaml's safeDump(...).

The !include tag

The !include tag will include another YAML file in the current one. For example:

object:
  <<: !include other.yml

Given the contents of other.yml as:

foo: bar

And noting the use of the <<: merging tag in this example, the resulting parsed JSON will be:

"object" {
  "foo": "bar"
}

The !include tag can be used also in included documents, and will resolve file names relative to the real path of the document where the tag is specified (in other words, symlinks are followed).

The !merge tag

The !merge tag merges arrays of arrays into one single array. For example:

array: !merge
  -
    - one
    - two
  -
    - three
    - four
  - five
  -
    - six
    - seven

Will be parsed as the following JSON:

{
  "array": [
    "one",
    "two",
    "three",
    "four",
    "five",
    "six",
    "seven"
  ]
}

This is quite useful when used with references where a file like the following:

base: &base
  - a
  - b
merged: !merge
  - *base
  - c

Will be parsed as the following JSON:

{
  "base": [ "a", "b" ],
  "merged": [ "a", "b", "c" ]
}

Ultimately, this can also be used in conjunction with !include whereas:

!merge
- !include other.yml
- baz

Given the following contents for other.yml:

- foo
- bar

Will be parsed as the following JSON:

[ "foo", "bar", "baz" ]

The !join tag

The !join tag joins array members into a string. For example:

joined: !join
  - One
  - Two
  - Three

Will be parsed as the following JSON:

{ "joined": "OneTwoThree" }

The same output can be expected for the following YAML syntax:

joined: !join [ One, Two, Three ]

License

This work is licensed under the MIT License Agreement