gplint/build/rules/no-partially-commented-tag-lines.js

A Gherkin linter/validator written in Javascript.

import { featureSpread } from './utils/gherkin.js';
import _ from 'lodash';
export const name = 'no-partially-commented-tag-lines';
export const availableConfigs = {
    allowSeparated: true
};
export function run({ file, feature }, configuration) {
    if (!feature) {
        return [];
    }
    const mergedConfig = _.merge({}, availableConfigs, configuration);
    function checkTags(node) {
        if (mergedConfig.allowSeparated) {
            node.tags.forEach(tag => {
                if (tag.name.indexOf('#') > 0) {
                    errors.push({
                        message: 'Partially commented tag lines not allowed',
                        rule: name,
                        line: tag.location.line,
                        column: tag.location.column,
                    });
                }
            });
        }
        else {
            _.uniqBy(node.tags.map(tag => tag), 'location.line').forEach(tag => {
                if (file.lines[tag.location.line - 1].includes('#')) {
                    errors.push({
                        message: 'Partially commented tag lines not allowed',
                        rule: name,
                        line: tag.location.line,
                        column: tag.location.column,
                    });
                }
            });
        }
    }
    const errors = [];
    checkTags(feature);
    const { children, rules } = featureSpread(feature);
    rules.forEach(rule => {
        checkTags(rule);
    });
    children.forEach(child => {
        if (child.scenario) {
            checkTags(child.scenario);
            child.scenario.examples.forEach(example => {
                checkTags(example);
            });
        }
    });
    return errors;
}
export const documentation = {
    description: 'Disallows partially commented tag lines. You can configure if a comment is allowed if is separated with a space or not allowed at all.',
    configuration: [{
            name: 'allowSeparated',
            type: 'boolean',
            description: 'Configure if a comment is allowed if is separated with a space',
            default: availableConfigs.allowSeparated,
        }],
    examples: [{
            title: 'Allow separated (Default)',
            description: `The following table illustrates how it works:

| Example         | Description                         | Result  |
|-----------------|-------------------------------------|---------|
| \`@foo\`          | Without a comment                   | Valid   |
| \`@foo #comment\` | With a comment separated with space | Valid   |
| \`@foo#comment\`  | With a comment non-separated        | Invalid |`,
            config: {
                [name]: ['error', { 'allowSeparated': true }]
            }
        }, {
            title: 'Not allow separated',
            description: `The following table illustrates how it works:

| Example         | Description                         | Result  |
|-----------------|-------------------------------------|---------|
| \`@foo\`          | Without a comment                   | Valid   |
| \`@foo #comment\` | With a comment separated with space | Invalid |
| \`@foo#comment\`  | With a comment non-separated        | Invalid |
`,
            config: {
                [name]: ['error', { 'allowSeparated': false }]
            }
        }],
};
//# sourceMappingURL=no-partially-commented-tag-lines.js.map