gplint/build/rules/name-length.js

A Gherkin linter/validator written in Javascript.

import _ from 'lodash';
import { featureSpread } from './utils/gherkin.js';
export const name = 'name-length';
export const availableConfigs = {
    'Feature': 70,
    'Rule': 70,
    'Step': 70,
    'Scenario': 70
};
function test(stepText, location, configuration, type, errors) {
    if (stepText && (stepText.length > configuration[type])) {
        errors.push({ message: `${type} name is too long. Length of ${stepText.length} is longer than the maximum allowed: ${configuration[type]}`,
            rule: name,
            line: location.line,
            column: location.column,
        });
    }
}
function testSteps(node, mergedConfiguration, errors) {
    node.steps.forEach(step => {
        // Check Step name length
        test(step.text, step.location, mergedConfiguration, 'Step', errors);
    });
}
export function run({ feature }, configuration) {
    if (!feature) {
        return [];
    }
    const errors = [];
    const mergedConfiguration = _.merge(availableConfigs, configuration);
    // Check Feature name length
    test(feature.name, feature.location, mergedConfiguration, 'Feature', errors);
    const { children, rules } = featureSpread(feature);
    rules.forEach(rule => {
        test(rule.name, rule.location, mergedConfiguration, 'Rule', errors);
    });
    children.forEach(child => {
        if (child.background) {
            testSteps(child.background, mergedConfiguration, errors);
        }
        else {
            test(child.scenario.name, child.scenario.location, mergedConfiguration, 'Scenario', errors);
            testSteps(child.scenario, mergedConfiguration, errors);
        }
    });
    return errors;
}
export const documentation = {
    description: 'Allows restricting length of Feature/Scenario/Step names. The default is 70 characters for each of these',
    configuration: [{
            name: 'feature',
            type: 'number',
            description: 'Defines de maximum line length for Feature level.',
            default: availableConfigs.Feature,
        }, {
            name: 'rule',
            type: 'number',
            description: 'Defines de maximum line length for Rule level.',
            default: availableConfigs.Rule,
        }, {
            name: 'Step',
            type: 'number',
            description: 'Defines de maximum line length for Step level.',
            default: availableConfigs.Step,
        }, {
            name: 'scenario',
            type: 'number',
            description: 'Defines de maximum line length for Scenario level.',
            default: availableConfigs.Scenario,
        }],
    examples: [{
            title: 'Example',
            description: 'Configure length for Feature, Scenario and Step',
            config: {
                [name]: ['error', { 'Feature': 30, 'Scenario': 50, 'Step': 100 }],
            }
        }],
};
//# sourceMappingURL=name-length.js.map