README

broccoli-descriptive-merge-trees

Copy multiple trees on top of each other, resulting in a single merged tree.

This is purely a convenience package for a common pattern used in Ember-CLI. All Credit for this goes to the Ember CLI contributors and broccoli-merge-trees author, Jo Liss.

Installation

npm install --save-dev broccoli-descriptive-merge-trees

Usage

var mergeTrees = require('broccoli-descriptive-merge-trees');

var outputTree = mergeTrees(inputTrees, options);

inputTrees: An array of trees
options: A hash of options

Options

overwrite: By default, broccoli-merge-trees throws an error when a file exists in multiple trees. If you pass { overwrite: true }, the resulting tree will contain the version of the file as it exists in the last input tree that contains it.

Example

If this is your Brocfile.js:

var mergeTrees = require('broccoli-merge-trees');

module.exports = mergeTrees(['public', 'scripts']);

And your project contains these files:

.
├─ public
│  ├─ index.html
│  └─ images
│     └─ logo.png
├─ scripts
│  └─ app.js
├─ Brocfile.js
…

Then running broccoli build the-output will generate this folder:

the-output
├─ app.js
├─ index.html
└─ images
   └─ logo.png

The parent folders, public and scripts in this case, are not included in the output. The output tree contains only the files within each folder, all mixed together.

Contributing

Clone this repo and run the tests like so:

npm install
npm test

Issues and pull requests are welcome. If you change code, be sure to re-run npm test. Oftentimes it's useful to add or update tests as well.

Usage no npm install needed!