Utility code to load config of a plugin

[ringods]

First of all, thanks for writing gulp-chef.

I am writing a gulp-ccr-layouts plugin similar to what metalsmith-layouts provides.

In this plugin, I want to write tests also validating the different configuration options. Once you start with a JSON Schema using the 'oneOf' option, it makes sense to validate the different code paths.

Is it possible to have a utility function available that loads the config according the schema in my plugin and have it available as a hash afterwards?

[ringods]

@amobiz are you still working on gulp-chef? Not much activity in commits, issues or Gitter. :-/

[amobiz]

Wow! Thank you for using gulp-chef.

The loaded config is here, but not exposed currently. Maybe you can try to expose the config yourself in some way that fits your need? But be aware that the processed config is not pure JSON, it contains functions.

Plugins are called with processed config in it's context. Maybe you can test it this way:

var myPlugin = require('myPlugin');
function myTestPlugin() {
  assert(this.config.value === 'oneOfTheValue');
}
myTestPlugin.schema = myPlugin.schema;
myTestPlugin.type = myPlugin.type;
var config = {
  myPlugin: {
    task: myTestPlugin,  // specify the task
    // other configs for myPlugin...
  }
};
var registry = chef(config);
var task = registry.get('myPlugin');
task();

Also, maybe you can take a look at gulp-ccr-config-helper. This helper try to help plugin to validate user's config (but not processed) specific to the plugin.

Actually, I was planning to write:

1. A test-bad/framework that load config to help writing plugins,
2. Exporting the processed config, and
3. May be rewrite entirely, becomes a config processor.

But due to the limited user base, the plans are paused. Sorry.

Hope you can understand my poor English.

Please don't hesitate to contact me if you have any further questions.