kab/lib/config.js

Know About Better - test your code

/**
 * @file 配置文件解析
 * @author chris<wfsr@foxmail.com>
 */

var path = require('path');
var util  = require('./util');
var log  = require('./log');

/**
 * 默认配置
 *
 * @type {Object}
 */
var defaultOptions = {

    // base path, that will be used to resolve files and exclude
    basePath: '../',

    requireConfig: {
        baseUrl: './src',
        urlArgs: 'v=' + (+new Date()).toString(36),
        paths: {
            test: '../test'
        }
    },

    qrcode: true,

    // frameworks to use
    frameworks: ['jasmine', 'esl'],

    coverageReporter: {
        // text-summary | text | html | json | teamcity | cobertura | lcov
        // lcovonly | none | teamcity
        type: 'text|html',
        dir: 'test/coverage/',
        exclude: []
    },

    // web server port
    port: 8120,


    // enable / disable watching file and executing tests whenever any file changes
    watch: true,


    // If browser does not capture in given timeout [ms], kill it
    captureTimeout: 60000,


    // Continuous Integration mode
    // if true, it capture browsers, run tests and exit
    singleRun: true
};


var config;
var userConfig;
var configFile = path.resolve(process.cwd(), 'test/config.js');

/**
 * 调整 karma 的配置项以便兼容
 *
 * @param {Object} config karma 配置对象
 */
function comb(config) {
    log.trace('检测到使用 karma 配置文件，执行兼容处理...');
    var files = [];
    config.files.forEach(function (file) {

        // 对象方式只取 pattern 属性值
        var pattern = typeof file === 'string' ? file : file.pattern;

        // 只保留样式及 spec 的 js
        if (/(test\/.*spec|\.css|\.less|\.sass|\.styl)/i.test(pattern)) {
            files.push(pattern);
        }
        else {
            log.warn('移除文件匹配规则：%s', JSON.stringify(file));
        }
    });
    config.files = files;

    var reporter = config.coverageReporter;
    if (reporter && reporter.type && reporter.type.indexOf('text') < 0) {
        reporter.type += '|text';
        log.trace('增加控制台报告输出');
    }
    log.trace('兼容处理完成');
}

/**
 * 合并配置，用户配置优先
 *
 * @param {Object} options 用户配置数据
 */
function merge(options) {

    // 处理测试页面的 require.config 配置
    // 优先级低到高：edp-test 默认配置 -> 项目 module.conf -> config.js 配置
    var requireConfig = require('./require-config');
    requireConfig.merge(config.requireConfig, requireConfig.readFromProject());

    if (options.requireConfig) {
        requireConfig.merge(config.requireConfig, options.requireConfig);
        delete options.requireConfig;
    }

    util.extend(config, options);
}

// 语法糖
Object.defineProperty(module.exports, 'config', {

    /**
     * getter 获取配置
     *
     * @return {Object} 配置对象
     */
    get: function () {
        if (!userConfig) {
            try {
                userConfig = require(configFile);
            }
            catch (e) {
                userConfig = {
                    noUserConfig: true
                };
            }
        }

        if (!config) {
            config = Object.create(defaultOptions);

            // 兼容 karma 的配置方式
            if (typeof userConfig === 'function') {
                userConfig({set: merge});
                comb(config);
            }
            else {
                merge(userConfig);
            }
        }
        return config;
    },

    /**
     * setter 设置配置
     *
     * @param {string|Object|Function} value 设置用户配置文件地址、对象或 Karma 方式的配置函数
     */
    set: function (value) {
        if (typeof value === 'string') {
            configFile = value;
            userConfig = null;
        }
        else {
            userConfig = value;
        }
        config = null;
    }
});