Yaml-Boost


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

$3

Resolve content with variables at given refPath.

$3

Load filePath with given variables.

Note that this function is asynchronous.

$3

As provided by js-yaml through safeDump

Usage

``js
import { load } from 'yaml-boost';

load('config.yaml');
`

Matching yaml.dump() function is also available.

$3

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

`js
export default {};
`

##### 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.

`js
export default (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


`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`.