https://github.com/alexlafroscia/yaml-merge

A super simple tool for merging YAML files
https://github.com/alexlafroscia/yaml-merge

Last synced: about 2 months ago
JSON representation

A super simple tool for merging YAML files

• Host: GitHub
• URL: https://github.com/alexlafroscia/yaml-merge
• Owner: alexlafroscia
• Created: 2016-12-12T18:55:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T17:56:53.000Z (over 1 year ago)
• Last Synced: 2024-05-08T23:12:09.450Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 525 KB
• Stars: 57
• Watchers: 3
• Forks: 19
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# `yaml-merge`

![Verify](https://github.com/alexlafroscia/yaml-merge/workflows/Verify/badge.svg)

A super simple tool for merging YAML files.

## Installation

### For the command line

```bash

npm install -g @alexlafroscia/yaml-merge

```

### For use through Node

```bash

npm install --save @alexlafroscia/yaml-merge

```

## Usage

`yaml-merge` takes a series of `yaml` files and merges them from left to right.  This means that the first file will be overwritten by properties of the second, which is overwritten by properties of the third, etc.

### Command Line

When using this tool from the command line, the output file will simply be written to `STDOUT`

```bash

yaml-merge test/fixtures/basic/a.yml test/fixtures/basic/b.yml

a:

  foo: bar

b:

  foo: bar

```

This way, you can pipe the output to whatever you want. For example, this will write the new `yaml` file to `output.yml`

```bash

yaml-merge test/fixtures/basic/a.yml test/fixtures/basic/b.yml > output.yml

```

The provided file names will be resolved relative to the current directory. So, you an provide a relative path to the files, or an absolute path -- either method works just fine.

### As a Node package

`yaml-merge` also provides a `node` package that can be consumed to get the output file programmatically.

```javascript

const resolve = require('path').resolve;

const merge = require('@alexlafroscia/yaml-merge');

const output = merge(resolve('relative/path/to/file.yml'), '/Users/you/some/other/file.yml');

console.log(output); // Prints out the resulting YAML as a string

```