https://github.com/blackflux/yaml-boost

Yaml Parser with various additions.
https://github.com/blackflux/yaml-boost

Last synced: about 1 month ago
JSON representation

Yaml Parser with various additions.

• Host: GitHub
• URL: https://github.com/blackflux/yaml-boost
• Owner: blackflux
• License: mit
• Created: 2018-03-16T22:35:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T12:22:20.000Z (11 months ago)
• Last Synced: 2024-08-15T10:21:53.646Z (about 1 month ago)
• Language: JavaScript
• Size: 3.5 MB
• Stars: 25
• Watchers: 2
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yaml-Boost

[![Build Status](https://circleci.com/gh/blackflux/yaml-boost.png?style=shield)](https://circleci.com/gh/blackflux/yaml-boost)

[![Test Coverage](https://img.shields.io/coveralls/blackflux/yaml-boost/master.svg)](https://coveralls.io/github/blackflux/yaml-boost?branch=master)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=blackflux/yaml-boost)](https://dependabot.com)

[![Dependencies](https://david-dm.org/blackflux/yaml-boost/status.svg)](https://david-dm.org/blackflux/yaml-boost)

[![NPM](https://img.shields.io/npm/v/yaml-boost.svg)](https://www.npmjs.com/package/yaml-boost)

[![Downloads](https://img.shields.io/npm/dt/yaml-boost.svg)](https://www.npmjs.com/package/yaml-boost)

[![Semantic-Release](https://github.com/blackflux/js-gardener/blob/master/assets/icons/semver.svg)](https://github.com/semantic-release/semantic-release)

[![Gardener](https://github.com/blackflux/js-gardener/blob/master/assets/badge.svg)](https://github.com/blackflux/js-gardener)

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

Useful for loading improved [serverless](https://serverless.com/) configuration. For yaml loading this package uses [js-yaml](https://github.com/nodeca/js-yaml).

## Getting Started

    $ npm install --save yaml-boost

## Api

### resolve(refPath, content, vars)

Resolve content with variables at given refPath.

### async load(filePath, vars = {})

Load filePath with given variables.

Note that this function is asynchronous.

### dump

As provided by `js-yaml` through `safeDump`

## Usage

```js

import { load } from 'yaml-boost';

load('config.yaml');

```

Matching `yaml.dump()` function is also available.

### Variable and File Resolution

Works identical to how this is defined for serverless [here](https://serverless.com/framework/docs/providers/aws/guide/variables/).

Both `yml` and `yaml` file endings are supported.

#### Extensions

##### Bake variables when loading files

```yaml

${file(./path/to/file.yml), key1=value1&key2=value2}

```

##### Reference Packages

You can reference packages by using

```yaml

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

```

##### Reference Js files

Reference js instead of yaml files.

```yaml

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

```

The reference file needs to export simple object containing configuration

```js

export default {};

```

##### Reference Function inside Js file

Reference function inside js file.

```yaml

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

```

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

```js

export default (args) => ({ args });

```

##### Relative File References

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

```yaml

${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:

```yaml

data:

  - list entry one

<<<:

  - data:

      - list entry two

  - other: things

```

results in

```yaml

data:

  - list entry one

  - list entry two

other: things

```

## Serverless Example

Define `serverless.js` as

```js

import path from 'path';

import minimist from 'minimist';

import { load } from 'yaml-boost';

const cfg = await load(path.join(__dirname, 'serverless.core.yml'), minimist(process.argv.slice(2)));

export default cfg;

```

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