grunt-merge-yaml

Merge together 2 yaml files

Getting Started

This plugin requires Grunt >=0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-merge-yaml --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-merge-yaml');

The "merge_yaml" task

Overview

In your project's Gruntfile, add a section named merge_yaml to the data object passed into grunt.initConfig().

grunt.initConfig({
  merge_yaml: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

No option available.

Usage Examples

grunt.initConfig({
  merge_yaml: {
    options: {},
    target: {
      base: 'base.yml',
      target: 'otherFile.yml',
      dest: 'combined.yml'
    }
  },
});

Example:

base.yaml:

  db: 'dev db connection'
  misc:
    foo: true
    bar: 'value'

and target.yaml:

  db: 'prod db connection'
  misc:
    foo: false
    baz: 32

are merged into combined.yaml:

  db: 'prod db connection' // from target
  misc:
    foo: false // from target
    bar: 'value' // from base
    baz: 32 // from target

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• 2016-03-17: v1.0.2: fix js-yaml reference bug
• 2016-03-10: v1.0.1: object keys defined in 2nd file only are added
• 2016-03-08: v0.1.0: first release