isml-linter/src/rules/tree/custom-tags.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 CustomTagContainer = require('../../util/CustomTagContainer');

const ruleId      = require('path').basename(__filename).slice(0, -3);
const description = 'Invalid custom tag';

const Rule = Object.create(TreeRulePrototype);

Rule.init(ruleId, description);

Rule.addError = function(node, message) {
    return this.getError(
        node.head.trim(),
        node.lineNumber,
        node.columnNumber,
        node.globalPos,
        node.head.trim().length,
        message
    );
};

Rule.check = function(node, data) {

    const occurrenceList = this.checkChildren(node, data);

    if (data) {
        const isUsedButNotDeclared = !data.moduleDefinition && data.customModuleArray && data.customModuleArray.length > 0;

        if (node.head.indexOf('template="util/modules"') >= 0) {
            const isUnnecessaryDefinition = data.moduleDefinition && !data.customModuleArray;

            if (isUnnecessaryDefinition) {
                const error = this.addError(node, 'Unnecessary inclusion of the modules template');
                occurrenceList.push(error);
            }
        }

        if (isUsedButNotDeclared && node.isCustomIsmlTag()) {
            const error = this.addError(node,
                CustomTagContainer[node.getType()] ?
                    `Custom tag "${node.getType()}" could not be identified. Maybe you forgot to include the modules template?` :
                    `Unknown tag "${node.getType()}". Maybe you forgot to add it to util/modules template?`
            );

            occurrenceList.push(error);
        }
    }

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

module.exports = Rule;