gplint/build/rules/allowed-tags.js

A Gherkin linter/validator written in Javascript.

import _ from 'lodash';
import { featureSpread } from './utils/gherkin.js';
export const name = 'allowed-tags';
export const availableConfigs = {
    tags: [],
    patterns: [],
};
export function run({ feature }, configuration) {
    if (!feature) {
        return [];
    }
    const mergedConfiguration = _.merge({}, availableConfigs, configuration);
    const errors = [];
    const allowedTags = mergedConfiguration.tags;
    const allowedPatterns = getAllowedPatterns(mergedConfiguration);
    checkTags(feature, allowedTags, allowedPatterns, errors);
    const { children, rules } = featureSpread(feature);
    rules.forEach(rule => {
        checkTags(rule, allowedTags, allowedPatterns, errors);
    });
    children.forEach(child => {
        if (child.scenario) {
            checkTags(child.scenario, allowedTags, allowedPatterns, errors);
            child.scenario.examples.forEach(example => {
                checkTags(example, allowedTags, allowedPatterns, errors);
            });
        }
    });
    return errors;
}
function getAllowedPatterns(configuration) {
    return configuration.patterns.map((pattern) => new RegExp(pattern));
}
function checkTags(node, allowedTags, allowedPatterns, errors) {
    node.tags
        .filter(tag => !isAllowed(tag, allowedTags, allowedPatterns))
        .forEach(tag => {
        errors.push(createError(node, tag));
    });
}
function isAllowed(tag, allowedTags, allowedPatterns) {
    return _.includes(allowedTags, tag.name)
        || allowedPatterns.some((pattern) => pattern.test(tag.name));
}
function createError(node, tag) {
    return {
        message: `Not allowed tag ${tag.name} on ${node.keyword}`,
        rule: name,
        line: tag.location.line,
        column: tag.location.column,
    };
}
export const documentation = {
    description: 'Only the listed tags are allowed.',
    configuration: [{
            name: 'tags',
            type: 'string[]',
            description: 'List of tags that should match by exact text.',
            default: availableConfigs.tags,
        }, {
            name: 'patterns',
            type: 'string[]',
            description: 'List of patterns that should match by a Regular Expression.',
            default: availableConfigs.patterns,
        }],
    examples: [{
            title: 'Example',
            description: 'Only accept tags `@watch`, `@wip` and all that starts with `@ID.` and is followed by 5 numbers.',
            config: {
                [name]: ['error', {
                        'tags': ['@watch', '@wip'],
                        'patterns': ['^@ID.[0-9]{5}$'],
                    }],
            }
        }],
};
//# sourceMappingURL=allowed-tags.js.map