direct-dev/lib/tools/walker-plugins/forbidden-blocks.js

Yandex Direct dev tools

'use strict';

const lodash = require('lodash');
const teamcity = require('../../utils/teamcity');

const reporters = {
    console: str => console.log(str),
    teamcity: str => teamcity.write('message', { text: str, status: 'ERROR' })
};

/**
 * Проверяет, что в проекте нет блоков с именами из заданного списка
 */
class TestBundler {

    /**
     * @param config - Настройки плаигна
     * @param config.names - Массив запрещенных названий блоков
     * @param config.reporter - Формат вывода результата: console|teamcity
     * @param config.throwError - Завершать ли процесс с ошибкой
     */
    constructor(config = {}) {
        let names = [].concat(config.names || []);
        this.names = lodash.keyBy(names);

        this.reporter = reporters[config.reporter] || reporters.console;
        this.throwError = !!config.throwError;
    }

    /**
     * Формирует результат для отдельного блока
     * @param {Object} blockData - Информация о блоке
     * @param {String} blockName - Название блока
     * @return {*}
     */
    eachBlock(blockData, blockName) {
        return this.names[blockName] && blockName;
    }

    /**
     * Формирует общий результат для всех блоков
     * @param {Object[]} data - Массив объектов, полученных из метода "eachBlock"
     */
    allBlocks(data) {
        if (data.length) {
            this.reporter(`forbidden block names: ${data.join(', ')}`);
            this.throwError && process.exit(1);
        }
    }
}

module.exports = TestBundler;