module.exports = {
    // the pretty/formatted name of the step, only used for display
    name: 'Hello Step',
 
    // a description of your step, used to help clients understand
    // what it does and its sideeffects
    description: 'Says hello',
    
    options: {
        // define options here so people don't have to look through
        // your code to find them. `step-runner` will handle extracting
        // and validating the presence of all the options
        'name': 'Name to say hello to'
    },
 
    // the action function is given an options parameter and a callback
    action: function(opt, cb) {
        // use the options defined above (given a client has provided them)
        // form the `opt` parameter
        console.log('Hello %s!', opt.name);
        cb();
    }
}

var StepRunner = require('../lib/step-runner');
 
module.exports = function(cb) {
    var stepRunner = new StepRunner({
        verbose: this.verbose
    });
    
    // you could alternately use promises to control flow
    stepRunner.runStep('increment-version', {
        packagePath: __dirname + '/../package.json'
    }, function() {
        stepRunner.runStep('git-add', {
            files: ['package.json']
        }, function() {
            stepRunner.runStep('git-commit', {
                commitMessage: 'Release ' + this['increment-version'].oldVersion,
            }, function() {
                cb();
            });
        });
    });
}

// ./lib/steps/number-maker.js
module.exports = {
    name: 'Number Maker',
    description: 'Adds a random number to the context',
    options: {},
    action: function(opt, cb) {
        // setting `this[something]` in a step will make it available in your script later
        this.number = Math.random() * 1000;
    }
}

stepRunner.runStep('number-maker', {}, function() {
    // access the context values in your script:
    console.log('give me a number... %s', this['number-maker'].number);
    
    // say some other step needs a number to configure...
    stepRunner.runStep('something-else', {
        'number-input': this['number-maker'].number
    }, function() {
        // the context can be accessed later, as well
        console.log('i still have this number: %s!', this['number-maker'].number);
        // ... do something
    });
});