index.js

/*jslint node: true, vars: true */

'use strict';

var util = require('util');
var assert = require('assert');

var test = global.test || global.it;

if (!test) {
    throw new Error("'mocha' must be required before 'mocha-testdata'");
}

function noCasesFailingTest(title) {
    return [
        test(title, function () {
            assert.fail('mocha-testdata used without test data');
        })
    ];
}

function testData(async) {
    var args = Array.prototype.slice.call(arguments, 1);
    if (args.length === 0) {
        return {
            it: noCasesFailingTest,
            test: noCasesFailingTest
        };
    }
    if (args.length === 1 && Array.isArray(args[0])) {
        args = args[0];
    }

    function formatTitle(title, value) {
        var valueFmt;
        if (typeof value === 'function') {
            valueFmt = value.name ? value.name + '()' : '[function]';
        } else if (typeof value === 'object') {
            if (value && typeof value.description === 'string') {
                valueFmt = value.description;
            } else {
                valueFmt = util.inspect(value);
            }
        } else {
            valueFmt = value;
        }
        return title + ' <' + valueFmt + '>';
    }

    function testWithData(title, fn) {
        return args.map(function (arg) {
            return test(formatTitle(title, arg), function () {
                return fn.apply(this, Array.isArray(arg) ? arg : [arg]);
            });
        });
    }

    function testWithDataAsync(title, fn) {
        return args.map(function (arg) {
            return test(formatTitle(title, arg), function (done) {
                return fn.apply(this, Array.isArray(arg) ? [done].concat(arg) : [done, arg]);
            });
        });
    }

    var defineTest = async ? testWithDataAsync : testWithData;

    return {
        it: defineTest,
        test: defineTest
    };
}

module.exports = testData.bind(null, false);
module.exports.async = testData.bind(null, true);

// named exports as per TypeScript typings
module.exports.given = module.exports;
module.exports.givenAsync = module.exports.async;