mako-config/README.md

# mako-config

> A helper for loading mako build config from a file.

[![npm version](https://img.shields.io/npm/v/mako-config.svg)](https://www.npmjs.com/package/mako-config)
[![npm dependencies](https://img.shields.io/david/makojs/config.svg)](https://david-dm.org/makojs/config)
[![npm dev dependencies](https://img.shields.io/david/dev/makojs/config.svg)](https://david-dm.org/makojs/config#info=devDependencies)
[![build status](https://img.shields.io/travis/makojs/config.svg)](https://travis-ci.org/makojs/config)

This helper encapsulates the logic for loading a mako build configuration file, allowing easier
use amongst different tools.

## Usage

This module is a simple function loads and normalizes mako configuration files:

```js
var load = require('mako-config');

load('/path/to/file.json').then(function (config) {
  // config.entries
  // config.plugins
});
```

## Configuration File Structure

### entries

This will be an array of glob patterns that will be resolved to form a single list of entry files.
The patterns will all be resolved relative to the config file's location.

```json
{
  "entries": [
    "index.{js,css}",
    "pages/**/index.{js,css}",
    "public/**"
  ]
}
```

### plugins

This will be an array of plugins to load, they can either be installed modules or point to local
modules of your own:

```json
{
  "plugins": [
    "mako-browser",
    "./local-plugin.js"
  ]
}
```

By default, no arguments will be passed during initialization. To change this, use an array:

```json
{
  "plugins": [
    [ "mako-browser", { "output": "dist" } ]
  ]
}
```

## API

### load(file, [overrides])

This function accepts `file` as an absolute path to the configuration file. The `overrides`
is a list of entries that will override the ones specified in the config file.

It returns a promise that resolves with an object. It will contain the following keys:

 - `entries`: an array of absolute file paths to all the matched entry files
 - `plugins`: an array of the initialized plugin functions

### load.sync(file, [overrides])

The same arguments are accepted, and the same result is returned synchronously.