isml-linter 5.39.0 → 5.39.4

package/src/util/TempRuleUtils.js

@@ -1,232 +1,232 @@
-/*
-    ===========================================================================
-    THIS FILE EXISTS ONLY TO AVOID CIRCULAR DEPENDENCY.
-    DUE TO A PRESSING BUG, IT WAS TEMPORARILY CREATED.
-    IT WILL SOON BE REMOVED.
-    ===========================================================================
-**/
-
-const path                  = require('path');
-const fs                    = require('fs');
-const Constants             = require('../Constants');
-const TreeBuilder           = require('../isml_tree/TreeBuilder');
-const ConfigUtils           = require('./ConfigUtils');
-const lowercaseFilenameRule = require('../rules/line_by_line/lowercase-filename');
-const CustomTagContainer    = require('./CustomTagContainer');
-const CustomModulesRule     = require('../rules/tree/custom-tags');
-
-const lineByLineRules = [];
-const treeRules       = [];
-
-const checkCustomTag = tag => {
-    if (Object.prototype.hasOwnProperty.call(CustomTagContainer, tag)) {
-        const attrList = CustomTagContainer[tag].attrList;
-
-        for (let i = 0; i < attrList.length; i++) {
-            const attr = attrList[i];
-            if (attr !== attr.toLowerCase()) {
-                return {
-                    line       : '',
-                    globalPos  : 0,
-                    length     : 10,
-                    lineNumber : 1,
-                    rule       : CustomModulesRule.id,
-                    message    : `Module properties need to be lower case: "${tag}" module has the invalid "${attr}" attribute`
-                };
-            }
-        }
-    }
-};
-
-const applyRuleResult = (config, ruleResult, templatePath, templateResults, rule) => {
-    if (config.autoFix && ruleResult.fixedContent) {
-        fs.writeFileSync(templatePath, ruleResult.fixedContent);
-        templateResults.fixed = true;
-    }
-    else if (ruleResult.occurrenceList && ruleResult.occurrenceList.length) {
-        const occurrenceObj    = getOccurrenceObj(rule, ruleResult.occurrenceList);
-        templateResults.errors = Object.assign(templateResults.errors, occurrenceObj.errors);
-    }
-};
-
-const applyRuleOnTemplate = (ruleArray, templatePath, root, config) => {
-    const templateResults = {
-        fixed  : false,
-        errors : {}
-    };
-
-    for (let i = 0; i < ruleArray.length; i++) {
-        const rule = ruleArray[i];
-        if (!rule.shouldIgnore(templatePath)) {
-            const ruleResults = rule.check(root, templateResults.data);
-            applyRuleResult(config, ruleResults, templatePath, templateResults, rule);
-        }
-    }
-
-    return templateResults;
-};
-
-const findNodeOfType = (node, type) => {
-    let result = null;
-
-    node.children.some( child => {
-        if (child.isOfType(type)) {
-            result = child;
-            return true;
-        } else {
-            result = findNodeOfType(child, type) || result;
-        }
-
-        return false;
-    });
-
-    return result;
-};
-
-const isTypeAmongTheFirstElements = (rootNode, type) => {
-    let result = false;
-
-    for (let i = 0; i < Constants.leadingElementsChecking; i++) {
-        result = result ||
-            rootNode.children[i] &&
-            rootNode.children[i].isOfType(type);
-    }
-
-    return result;
-};
-
-const getOccurrenceObj = (rule, occurrenceArray) => {
-    const occurrenceGroup = rule.level === 'error' ? 'errors' :
-        rule.level === 'warning' ? 'warnings' :
-            'info';
-
-    const occurrenceObj                     = {};
-    occurrenceObj[occurrenceGroup]          = {};
-    occurrenceObj[occurrenceGroup][rule.id] = [];
-
-    for (let i = 0; i < occurrenceArray.length; i++) {
-        const occurrence = occurrenceArray[i];
-        occurrenceObj[occurrenceGroup][rule.id].push(occurrence);
-    }
-
-    return occurrenceObj;
-};
-
-const checkFileName = (filename, templateContent) => {
-    const templateResults = {
-        fixed  : false,
-        errors : {}
-    };
-
-    if (lowercaseFilenameRule.isEnabled()) {
-        const ruleResult = lowercaseFilenameRule.check(filename, templateContent);
-
-        if (ruleResult) {
-            const occurrenceObj    = getOccurrenceObj(lowercaseFilenameRule, ruleResult.occurrenceList);
-            templateResults.errors = Object.assign(templateResults.errors, occurrenceObj.errors);
-        }
-    }
-
-    return templateResults;
-};
-
-const checkTreeRules = (templatePath, templateContent, config) => {
-    if (!config.disableTreeParse) {
-        const tree = TreeBuilder.build(templatePath, templateContent);
-
-        if (!tree.rootNode) {
-            throw tree.exception;
-        }
-
-        const ruleArray = getEnabledTreeRules();
-
-        return applyRuleOnTemplate(
-            ruleArray,
-            templatePath,
-            tree.rootNode,
-            config);
-    }
-};
-
-const checkLineByLineRules = (templatePath, templateContent, config) => {
-    const ruleArray = getEnabledLineRules();
-
-    return applyRuleOnTemplate(
-        ruleArray,
-        templatePath,
-        templateContent,
-        config);
-};
-
-const checkCustomModules = () => {
-    const moduleResults = {
-        errors : []
-    };
-
-    if (CustomModulesRule.isEnabled()) {
-        for (const tag in CustomTagContainer) {
-            const errorObj = checkCustomTag(tag);
-
-            if (errorObj) {
-                moduleResults.errors.push(errorObj);
-            }
-        }
-    }
-
-    return moduleResults;
-};
-
-const checkTemplate = (templatePath, content, templateName) => {
-    const config          = ConfigUtils.load();
-    const templateContent = content || fs.readFileSync(templatePath, 'utf-8');
-    const lineResults     = checkLineByLineRules(templatePath, templateContent, config);
-    const treeResults     = checkTreeRules(templatePath, templateContent, config) || { errors : [] };
-    const filenameResults = checkFileName(templateName, templateContent);
-
-    return {
-        fixed    : lineResults.fixed || treeResults.fixed,
-        treeData : treeResults.data,
-        errors   : {
-            ...lineResults.errors,
-            ...treeResults.errors,
-            ...filenameResults.errors
-        }
-    };
-};
-
-const getAvailableRulesQty = () => treeRules.length + lineByLineRules.length;
-
-const getEnabledLineRules  = () => {
-    const result = [];
-
-    for (let i = 0; i < lineByLineRules.length; i++) {
-        const rule = lineByLineRules[i];
-
-        if (rule.isEnabled() && rule.id !== 'lowercase-filename') {
-            result.push(rule);
-        }
-    }
-
-    return result;
-};
-
-const getEnabledTreeRules = () => {
-    const result = [];
-
-    for (let i = 0; i < treeRules.length; i++) {
-        const rule = treeRules[i];
-
-        if (rule.isEnabled()) {
-            result.push(rule);
-        }
-    }
-
-    return result;
-};
-
-module.exports.getAllLineRules             = () => lineByLineRules;
-module.exports.findNodeOfType              = findNodeOfType;
-module.exports.isTypeAmongTheFirstElements = isTypeAmongTheFirstElements;
-module.exports.checkTemplate               = checkTemplate;
-module.exports.checkCustomModules          = checkCustomModules;
-module.exports.getAvailableRulesQty        = getAvailableRulesQty;
+/*
+    ===========================================================================
+    THIS FILE EXISTS ONLY TO AVOID CIRCULAR DEPENDENCY.
+    DUE TO A PRESSING BUG, IT WAS TEMPORARILY CREATED.
+    IT WILL SOON BE REMOVED.
+    ===========================================================================
+**/
+
+const path                  = require('path');
+const fs                    = require('fs');
+const Constants             = require('../Constants');
+const TreeBuilder           = require('../isml_tree/TreeBuilder');
+const ConfigUtils           = require('./ConfigUtils');
+const lowercaseFilenameRule = require('../rules/line_by_line/lowercase-filename');
+const CustomTagContainer    = require('./CustomTagContainer');
+const CustomModulesRule     = require('../rules/tree/custom-tags');
+
+const lineByLineRules = [];
+const treeRules       = [];
+
+const checkCustomTag = tag => {
+    if (Object.prototype.hasOwnProperty.call(CustomTagContainer, tag)) {
+        const attrList = CustomTagContainer[tag].attrList;
+
+        for (let i = 0; i < attrList.length; i++) {
+            const attr = attrList[i];
+            if (attr !== attr.toLowerCase()) {
+                return {
+                    line       : '',
+                    globalPos  : 0,
+                    length     : 10,
+                    lineNumber : 1,
+                    rule       : CustomModulesRule.id,
+                    message    : `Module properties need to be lower case: "${tag}" module has the invalid "${attr}" attribute`
+                };
+            }
+        }
+    }
+};
+
+const applyRuleResult = (config, ruleResult, templatePath, templateResults, rule) => {
+    if (config.autoFix && ruleResult.fixedContent) {
+        fs.writeFileSync(templatePath, ruleResult.fixedContent);
+        templateResults.fixed = true;
+    }
+    else if (ruleResult.occurrenceList && ruleResult.occurrenceList.length) {
+        const occurrenceObj    = getOccurrenceObj(rule, ruleResult.occurrenceList);
+        templateResults.errors = Object.assign(templateResults.errors, occurrenceObj.errors);
+    }
+};
+
+const applyRuleOnTemplate = (ruleArray, templatePath, root, config) => {
+    const templateResults = {
+        fixed  : false,
+        errors : {}
+    };
+
+    for (let i = 0; i < ruleArray.length; i++) {
+        const rule = ruleArray[i];
+        if (!rule.shouldIgnore(templatePath)) {
+            const ruleResults = rule.check(root, templateResults.data);
+            applyRuleResult(config, ruleResults, templatePath, templateResults, rule);
+        }
+    }
+
+    return templateResults;
+};
+
+const findNodeOfType = (node, type) => {
+    let result = null;
+
+    node.children.some( child => {
+        if (child.isOfType(type)) {
+            result = child;
+            return true;
+        } else {
+            result = findNodeOfType(child, type) || result;
+        }
+
+        return false;
+    });
+
+    return result;
+};
+
+const isTypeAmongTheFirstElements = (rootNode, type) => {
+    let result = false;
+
+    for (let i = 0; i < Constants.leadingElementsChecking; i++) {
+        result = result ||
+            rootNode.children[i] &&
+            rootNode.children[i].isOfType(type);
+    }
+
+    return result;
+};
+
+const getOccurrenceObj = (rule, occurrenceArray) => {
+    const occurrenceGroup = rule.level === 'error' ? 'errors' :
+        rule.level === 'warning' ? 'warnings' :
+            'info';
+
+    const occurrenceObj                     = {};
+    occurrenceObj[occurrenceGroup]          = {};
+    occurrenceObj[occurrenceGroup][rule.id] = [];
+
+    for (let i = 0; i < occurrenceArray.length; i++) {
+        const occurrence = occurrenceArray[i];
+        occurrenceObj[occurrenceGroup][rule.id].push(occurrence);
+    }
+
+    return occurrenceObj;
+};
+
+const checkFileName = (filename, templateContent) => {
+    const templateResults = {
+        fixed  : false,
+        errors : {}
+    };
+
+    if (lowercaseFilenameRule.isEnabled()) {
+        const ruleResult = lowercaseFilenameRule.check(filename, templateContent);
+
+        if (ruleResult) {
+            const occurrenceObj    = getOccurrenceObj(lowercaseFilenameRule, ruleResult.occurrenceList);
+            templateResults.errors = Object.assign(templateResults.errors, occurrenceObj.errors);
+        }
+    }
+
+    return templateResults;
+};
+
+const checkTreeRules = (templatePath, templateContent, config) => {
+    if (!config.disableTreeParse) {
+        const tree = TreeBuilder.build(templatePath, templateContent);
+
+        if (!tree.rootNode) {
+            throw tree.exception;
+        }
+
+        const ruleArray = getEnabledTreeRules();
+
+        return applyRuleOnTemplate(
+            ruleArray,
+            templatePath,
+            tree.rootNode,
+            config);
+    }
+};
+
+const checkLineByLineRules = (templatePath, templateContent, config) => {
+    const ruleArray = getEnabledLineRules();
+
+    return applyRuleOnTemplate(
+        ruleArray,
+        templatePath,
+        templateContent,
+        config);
+};
+
+const checkCustomModules = () => {
+    const moduleResults = {
+        errors : []
+    };
+
+    if (CustomModulesRule.isEnabled()) {
+        for (const tag in CustomTagContainer) {
+            const errorObj = checkCustomTag(tag);
+
+            if (errorObj) {
+                moduleResults.errors.push(errorObj);
+            }
+        }
+    }
+
+    return moduleResults;
+};
+
+const checkTemplate = (templatePath, content, templateName) => {
+    const config          = ConfigUtils.load();
+    const templateContent = content || fs.readFileSync(templatePath, 'utf-8');
+    const lineResults     = checkLineByLineRules(templatePath, templateContent, config);
+    const treeResults     = checkTreeRules(templatePath, templateContent, config) || { errors : [] };
+    const filenameResults = checkFileName(templateName, templateContent);
+
+    return {
+        fixed    : lineResults.fixed || treeResults.fixed,
+        treeData : treeResults.data,
+        errors   : {
+            ...lineResults.errors,
+            ...treeResults.errors,
+            ...filenameResults.errors
+        }
+    };
+};
+
+const getAvailableRulesQty = () => treeRules.length + lineByLineRules.length;
+
+const getEnabledLineRules  = () => {
+    const result = [];
+
+    for (let i = 0; i < lineByLineRules.length; i++) {
+        const rule = lineByLineRules[i];
+
+        if (rule.isEnabled() && rule.id !== 'lowercase-filename') {
+            result.push(rule);
+        }
+    }
+
+    return result;
+};
+
+const getEnabledTreeRules = () => {
+    const result = [];
+
+    for (let i = 0; i < treeRules.length; i++) {
+        const rule = treeRules[i];
+
+        if (rule.isEnabled()) {
+            result.push(rule);
+        }
+    }
+
+    return result;
+};
+
+module.exports.getAllLineRules             = () => lineByLineRules;
+module.exports.findNodeOfType              = findNodeOfType;
+module.exports.isTypeAmongTheFirstElements = isTypeAmongTheFirstElements;
+module.exports.checkTemplate               = checkTemplate;
+module.exports.checkCustomModules          = checkCustomModules;
+module.exports.getAvailableRulesQty        = getAvailableRulesQty;