isml-linter/src/rules/tree/align-isset.js

ISML Linter is a tool for examining if your project's templates follow a specified set of rules defined by your dev team. The available rules can be roughly grouped into:

const TreeRulePrototype = require('../prototypes/TreeRulePrototype');

const ruleId      = require('path').basename(__filename).slice(0, -3);
const description = 'Tag attributes are not column-aligned';

const Rule = Object.create(TreeRulePrototype);

Rule.init(ruleId, description);

Rule.check = function(node, data) {

    const occurrenceList          = this.checkChildren(node, data);
    const issetChildren           = getConsecutiveIssetTagChildren(node);
    const attrPosContainer        = getCorrectAttributePositions(issetChildren);
    const alignmentoccurrenceList = this.checkAttributesAlignments(issetChildren, attrPosContainer);

    occurrenceList.push(...alignmentoccurrenceList);

    return node.isRoot() ?
        { occurrenceList } :
        occurrenceList;
};

const getConsecutiveIssetTagChildren = node => {
    const issetChildren = new Set();

    for (let i = 1; i < node.children.length; i++) {
        const prevChild = node.children[i - 1];
        const child     = node.children[i];

        if (prevChild.isOfType('isset') && child.isOfType('isset')) {
            issetChildren.add(prevChild);
            issetChildren.add(child);
        } else if (!child.isOfType('isset') && issetChildren.length > 0) {
            break;
        }
    }

    return issetChildren;
};

const getCorrectAttributePositions = issetChildren => {

    const attrPosContainer = {};
    for (const issetNode of issetChildren) {

        const attrArray = issetNode.getAttributeList();
        for (let i = 0; i < attrArray.length; i++) {

            const attr = attrArray[i];
            if (!attrPosContainer[attr.name] || attr.localPos > attrPosContainer[attr.name]) {
                attrPosContainer[attr.name] = attr.localPos;
            }
        }
    }

    return attrPosContainer;
};

Rule.checkAttributesAlignments = function(issetChildren, attrPosContainer) {
    const occurrenceList = [];

    for (const issetNode of issetChildren) {
        const attrArray = issetNode.getAttributeList();

        for (let i = 0; i < attrArray.length; i++) {
            const attr = attrArray[i];
            if (attr.localPos !== attrPosContainer[attr.name]) {
                const error = this.getError(
                    issetNode.head.trim(),
                    issetNode.lineNumber,
                    issetNode.columnNumber,
                    issetNode.globalPos,
                    issetNode.head.trim().length,
                    description
                );

                occurrenceList.push(error);
                break;
            }
        }
    }

    return occurrenceList;
};

module.exports = Rule;