Grunt task runner to compile confidence configuration files
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-confidence

Compile confidence configuration files

Getting Started

This plugin requires Grunt ~0.4.1

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-confidence --save-dev

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

grunt.loadNpmTasks('grunt-confidence');

The "confidence" task

Overview

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

grunt.initConfig({
  confidence: {
    options: {
      criteria: {
        //Criteria to be used for compiling the final config
      }
    },
    files: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.criteria

Type: Object Default value: {}

A criteria object used to compile the confidence config documents

Usage Examples

Default Options

If master_config.json contains the following:

{
  "key1": {
    "$filter": "env",
    "production": {
      "$value": true
    },
    "$default": false
  }
}

running grunt-confidence with the following

grunt.initConfig({
  confidence: {
    options: {
      criteria: { env: 'production' }
    },
    files: {
      'dest/production_config.json': 'src/master_config.json',
    },
  },
})

will produce

{key1: true}

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

v0.0.1 v0.1.0