isml-linter 5.39.1 → 5.40.0

package/src/rules/line_by_line/no-isscript.js

@@ -1,34 +1,34 @@
-const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-
-const ruleId         = require('path').basename(__filename).slice(0, -3);
-const description    = 'Avoid putting logic into ISML';
-const occurrenceText = '<isscript>';
-
-const Rule = Object.create(SingleLineRulePrototype);
-
-Rule.init(ruleId, description);
-
-Rule.isBroken = function(line) { return line.indexOf(occurrenceText) >= 0; };
-
-Rule.getColumnNumber = function(line) {
-    return Math.max(line.indexOf(occurrenceText), 0) + 1;
-};
-
-Rule.getFirstOccurrence = function(line) {
-
-    let result = null;
-
-    if (this.isBroken(line)) {
-
-        const matchPos = line.indexOf(occurrenceText);
-
-        result = {
-            globalPos : matchPos,
-            length      : occurrenceText.length
-        };
-    }
-
-    return result;
-};
-
-module.exports = Rule;
+const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
+
+const ruleId         = require('path').basename(__filename).slice(0, -3);
+const description    = 'Avoid putting logic into ISML';
+const occurrenceText = '<isscript>';
+
+const Rule = Object.create(SingleLineRulePrototype);
+
+Rule.init(ruleId, description);
+
+Rule.isBroken = function(line) { return line.indexOf(occurrenceText) >= 0; };
+
+Rule.getColumnNumber = function(line) {
+    return Math.max(line.indexOf(occurrenceText), 0) + 1;
+};
+
+Rule.getFirstOccurrence = function(line) {
+
+    let result = null;
+
+    if (this.isBroken(line)) {
+
+        const matchPos = line.indexOf(occurrenceText);
+
+        result = {
+            globalPos : matchPos,
+            length      : occurrenceText.length
+        };
+    }
+
+    return result;
+};
+
+module.exports = Rule;

package/src/rules/line_by_line/no-space-only-lines.js

@@ -1,47 +1,47 @@
-const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-const Constants               = require('../../Constants');
-
-const ruleId      = require('path').basename(__filename).slice(0, -3);
-const description = 'Line contains only blank spaces';
-
-const Rule = Object.create(SingleLineRulePrototype);
-
-Rule.init(ruleId, description);
-
-Rule.isBroken = function(line) { return line !== '' && line !== '\r' && line !== Constants.EOL && !/\S/.test(line); };
-
-Rule.getColumnNumber = function() {
-    return 1;
-};
-
-Rule.getFixedContent = function(templateContent) {
-    const GeneralUtils = require('../../util/GeneralUtils');
-
-    const activeLineBreak = GeneralUtils.getActiveLineBreak();
-    const lineArray       = templateContent.split(Constants.EOL);
-    const result          = [];
-
-    for (let i = 0; i < lineArray.length; i++) {
-        const line = lineArray[i];
-
-        result.push(line.trim() ? line : line.trim());
-    }
-
-    return result.join(activeLineBreak);
-};
-
-Rule.getFirstOccurrence = function(line) {
-
-    let result = null;
-
-    if (this.isBroken(line)) {
-        result = {
-            globalPos : 0,
-            length      : line.length + 1
-        };
-    }
-
-    return result;
-};
-
-module.exports = Rule;
+const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
+const Constants               = require('../../Constants');
+
+const ruleId      = require('path').basename(__filename).slice(0, -3);
+const description = 'Line contains only blank spaces';
+
+const Rule = Object.create(SingleLineRulePrototype);
+
+Rule.init(ruleId, description);
+
+Rule.isBroken = function(line) { return line !== '' && line !== '\r' && line !== Constants.EOL && !/\S/.test(line); };
+
+Rule.getColumnNumber = function() {
+    return 1;
+};
+
+Rule.getFixedContent = function(templateContent) {
+    const GeneralUtils = require('../../util/GeneralUtils');
+
+    const activeLineBreak = GeneralUtils.getActiveLineBreak();
+    const lineArray       = templateContent.split(Constants.EOL);
+    const result          = [];
+
+    for (let i = 0; i < lineArray.length; i++) {
+        const line = lineArray[i];
+
+        result.push(line.trim() ? line : line.trim());
+    }
+
+    return result.join(activeLineBreak);
+};
+
+Rule.getFirstOccurrence = function(line) {
+
+    let result = null;
+
+    if (this.isBroken(line)) {
+        result = {
+            globalPos : 0,
+            length      : line.length + 1
+        };
+    }
+
+    return result;
+};
+
+module.exports = Rule;

package/src/rules/line_by_line/no-tabs.js

@@ -1,38 +1,38 @@
-const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-const IndentRule              = require('../tree/indent');
-const GeneralUtils            = require('../../util/GeneralUtils');
-
-const ruleId      = require('path').basename(__filename).slice(0, -3);
-const description = 'Tab detected';
-
-const Rule = Object.create(SingleLineRulePrototype);
-
-Rule.init(ruleId, description);
-
-Rule.isBroken = function(line) { return line.indexOf('\t') >= 0; };
-
-Rule.getColumnNumber = function(line) {
-    return Math.max(line.indexOf('  '), 0) + 1;
-};
-
-Rule.getFixedContent = function(templateContent) {
-    const indent       = IndentRule.getIndentation();
-    const fixedContent = templateContent.replace(/\t/g, indent);
-    return GeneralUtils.applyActiveLineBreaks(fixedContent);
-};
-
-Rule.getFirstOccurrence = function(line) {
-
-    let result = null;
-
-    if (this.isBroken(line)) {
-        result = {
-            globalPos : line.indexOf('\t'),
-            length      : 1
-        };
-    }
-
-    return result;
-};
-
-module.exports = Rule;
+const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
+const IndentRule              = require('../tree/indent');
+const GeneralUtils            = require('../../util/GeneralUtils');
+
+const ruleId      = require('path').basename(__filename).slice(0, -3);
+const description = 'Tab detected';
+
+const Rule = Object.create(SingleLineRulePrototype);
+
+Rule.init(ruleId, description);
+
+Rule.isBroken = function(line) { return line.indexOf('\t') >= 0; };
+
+Rule.getColumnNumber = function(line) {
+    return Math.max(line.indexOf('  '), 0) + 1;
+};
+
+Rule.getFixedContent = function(templateContent) {
+    const indent       = IndentRule.getIndentation();
+    const fixedContent = templateContent.replace(/\t/g, indent);
+    return GeneralUtils.applyActiveLineBreaks(fixedContent);
+};
+
+Rule.getFirstOccurrence = function(line) {
+
+    let result = null;
+
+    if (this.isBroken(line)) {
+        result = {
+            globalPos : line.indexOf('\t'),
+            length      : 1
+        };
+    }
+
+    return result;
+};
+
+module.exports = Rule;

package/src/rules/line_by_line/no-trailing-spaces.js

@@ -1,52 +1,52 @@
-const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-const Constants               = require('../../Constants');
-const ParseUtils              = require('../../isml_tree/ParseUtils');
-
-const ruleId      = require('path').basename(__filename).slice(0, -3);
-const description = 'Blank space at the end of the line detected';
-
-const Rule = Object.create(SingleLineRulePrototype);
-
-Rule.init(ruleId, description);
-
-Rule.isBroken = function(line) { return (line.endsWith(' ') || line.endsWith(' \r')) && line.replace(/\s/g, '').length; };
-
-Rule.getColumnNumber = function(line) {
-    const revertPosition = ParseUtils.getNextNonEmptyCharPos(line.split('').reverse().join(''));
-    return Math.max(line.length - revertPosition, 0) + 1;
-};
-
-Rule.getFixedContent = function(templateContent) {
-    const GeneralUtils = require('../../util/GeneralUtils');
-
-    const activeLineBreak = GeneralUtils.getActiveLineBreak();
-    const lineArray       = GeneralUtils.toLF(templateContent).split(Constants.EOL);
-    const result          = [];
-
-    for (let i = 0; i < lineArray.length; i++) {
-        const line = lineArray[i];
-
-        result.push(line.replace(/\s+$/g, ''));
-    }
-
-    return result.join(activeLineBreak);
-};
-
-Rule.getFirstOccurrence = function(line) {
-
-    let result = null;
-
-    if (this.isBroken(line)) {
-
-        const matchPos = /(\t|\s)*$/.exec(line).index;
-
-        result = {
-            globalPos : matchPos,
-            length      : line.length - matchPos
-        };
-    }
-
-    return result;
-};
-
-module.exports = Rule;
+const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
+const Constants               = require('../../Constants');
+const ParseUtils              = require('../../isml_tree/ParseUtils');
+
+const ruleId      = require('path').basename(__filename).slice(0, -3);
+const description = 'Blank space at the end of the line detected';
+
+const Rule = Object.create(SingleLineRulePrototype);
+
+Rule.init(ruleId, description);
+
+Rule.isBroken = function(line) { return (line.endsWith(' ') || line.endsWith(' \r')) && line.replace(/\s/g, '').length; };
+
+Rule.getColumnNumber = function(line) {
+    const revertPosition = ParseUtils.getNextNonEmptyCharPos(line.split('').reverse().join(''));
+    return Math.max(line.length - revertPosition, 0) + 1;
+};
+
+Rule.getFixedContent = function(templateContent) {
+    const GeneralUtils = require('../../util/GeneralUtils');
+
+    const activeLineBreak = GeneralUtils.getActiveLineBreak();
+    const lineArray       = GeneralUtils.toLF(templateContent).split(Constants.EOL);
+    const result          = [];
+
+    for (let i = 0; i < lineArray.length; i++) {
+        const line = lineArray[i];
+
+        result.push(line.replace(/\s+$/g, ''));
+    }
+
+    return result.join(activeLineBreak);
+};
+
+Rule.getFirstOccurrence = function(line) {
+
+    let result = null;
+
+    if (this.isBroken(line)) {
+
+        const matchPos = /(\t|\s)*$/.exec(line).index;
+
+        result = {
+            globalPos : matchPos,
+            length      : line.length - matchPos
+        };
+    }
+
+    return result;
+};
+
+module.exports = Rule;

package/src/rules/prototypes/RulePrototype.js

@@ -1,79 +1,79 @@
-const ConfigUtils  = require('../../util/ConfigUtils');
-const GeneralUtils = require('../../util/GeneralUtils');
-const Constants    = require('../../Constants');
-
-const RulePrototype = {
-
-    init(id, description) {
-        this.id          = id;
-        this.description = description;
-        this.level       = 'errors';
-        this.result      = {
-            occurrenceList : []
-        };
-    },
-
-    getError(line, lineNumber, columnNumber, globalPos, length, description) {
-        return {
-            line,
-            globalPos,
-            length,
-            lineNumber,
-            columnNumber,
-            rule       : this.id,
-            level      : this.getConfigs().level || Constants.occurrenceLevels.ERROR,
-            message    : description || this.description
-        };
-    },
-
-    isEnabled() {
-        const config = ConfigUtils.load();
-        return config && config.rules && this.id in config.rules;
-    },
-
-    shouldIgnore(templatePath) {
-        const ignoreArray = this.getConfigs().ignore;
-
-        if (ignoreArray) {
-            return ignoreArray.some( ignore => {
-                return templatePath.includes(ignore);
-            });
-        }
-
-        return false;
-    },
-
-    getDefaultAttrs() {
-        return {};
-    },
-
-    getConfigs() {
-        const config             = ConfigUtils.load();
-        const ruleDefaultConfigs = this.getDefaultAttrs();
-        const indentRuleValue    = config.rules['indent'] && config.rules['indent'].value;
-
-        return {
-            ...ruleDefaultConfigs,
-            ...config.rules[this.id],
-            autoFix        : config.autoFix,
-            indent         : indentRuleValue || 4,
-            linebreakStyle : GeneralUtils.getActiveLineBreak()
-        };
-    },
-
-    checkChildren(node, data) {
-        const occurrenceList = [];
-
-        for (let i = 0; i < node.children.length; i++) {
-            const childrenOccurrenceList = this.check(node.children[i], data);
-
-            if (childrenOccurrenceList) {
-                occurrenceList.push(...childrenOccurrenceList);
-            }
-        }
-
-        return occurrenceList;
-    }
-};
-
-module.exports = RulePrototype;
+const ConfigUtils  = require('../../util/ConfigUtils');
+const GeneralUtils = require('../../util/GeneralUtils');
+const Constants    = require('../../Constants');
+
+const RulePrototype = {
+
+    init(id, description) {
+        this.id          = id;
+        this.description = description;
+        this.level       = 'errors';
+        this.result      = {
+            occurrenceList : []
+        };
+    },
+
+    getError(line, lineNumber, columnNumber, globalPos, length, description) {
+        return {
+            line,
+            globalPos,
+            length,
+            lineNumber,
+            columnNumber,
+            rule       : this.id,
+            level      : this.getConfigs().level || Constants.occurrenceLevels.ERROR,
+            message    : description || this.description
+        };
+    },
+
+    isEnabled() {
+        const config = ConfigUtils.load();
+        return config && config.rules && this.id in config.rules;
+    },
+
+    shouldIgnore(templatePath) {
+        const ignoreArray = this.getConfigs().ignore;
+
+        if (ignoreArray) {
+            return ignoreArray.some( ignore => {
+                return templatePath.includes(ignore);
+            });
+        }
+
+        return false;
+    },
+
+    getDefaultAttrs() {
+        return {};
+    },
+
+    getConfigs() {
+        const config             = ConfigUtils.load();
+        const ruleDefaultConfigs = this.getDefaultAttrs();
+        const indentRuleValue    = config.rules['indent'] && config.rules['indent'].value;
+
+        return {
+            ...ruleDefaultConfigs,
+            ...config.rules[this.id],
+            autoFix        : config.autoFix,
+            indent         : indentRuleValue || 4,
+            linebreakStyle : GeneralUtils.getActiveLineBreak()
+        };
+    },
+
+    checkChildren(node, data) {
+        const occurrenceList = [];
+
+        for (let i = 0; i < node.children.length; i++) {
+            const childrenOccurrenceList = this.check(node.children[i], data);
+
+            if (childrenOccurrenceList) {
+                occurrenceList.push(...childrenOccurrenceList);
+            }
+        }
+
+        return occurrenceList;
+    }
+};
+
+module.exports = RulePrototype;

package/src/rules/prototypes/SingleLineRulePrototype.js

@@ -1,47 +1,47 @@
-const RulePrototype = require('./RulePrototype');
-const ConfigUtils   = require('../../util/ConfigUtils');
-const Constants     = require('../../Constants');
-const GeneralUtils  = require('../../util/GeneralUtils');
-
-const SingleLineRulePrototype = Object.create(RulePrototype);
-
-SingleLineRulePrototype.check = function(templateContent, data = { isCrlfLineBreak : false }) {
-
-    const config         = ConfigUtils.load();
-    const lineArray      = GeneralUtils.toLF(templateContent).split(Constants.EOL);
-    const occurrenceList = [];
-    let globalPos        = 0;
-
-    for (let lineNumber = 0; lineNumber < lineArray.length; lineNumber++) {
-        const line       = lineArray[lineNumber];
-        const occurrence = this.getFirstOccurrence(line);
-
-        if (occurrence) {
-            let occurrenceGlobalPos = globalPos + occurrence.globalPos;
-            const columnNumber      = this.getColumnNumber(line);
-
-            if (data.isCrlfLineBreak) {
-                occurrenceGlobalPos += lineNumber;
-            }
-
-            const error = this.getError(line, lineNumber + 1, columnNumber, occurrenceGlobalPos, occurrence.length);
-
-            occurrenceList.push(error);
-        }
-
-        globalPos += line.length + 1;
-    }
-
-    if (occurrenceList.length &&
-        config.autoFix &&
-        this.getFixedContent) {
-        return {
-            occurrenceList,
-            fixedContent : this.getFixedContent(templateContent)
-        };
-    }
-
-    return { occurrenceList };
-};
-
-module.exports = SingleLineRulePrototype;
+const RulePrototype = require('./RulePrototype');
+const ConfigUtils   = require('../../util/ConfigUtils');
+const Constants     = require('../../Constants');
+const GeneralUtils  = require('../../util/GeneralUtils');
+
+const SingleLineRulePrototype = Object.create(RulePrototype);
+
+SingleLineRulePrototype.check = function(templateContent, data = { isCrlfLineBreak : false }) {
+
+    const config         = ConfigUtils.load();
+    const lineArray      = GeneralUtils.toLF(templateContent).split(Constants.EOL);
+    const occurrenceList = [];
+    let globalPos        = 0;
+
+    for (let lineNumber = 0; lineNumber < lineArray.length; lineNumber++) {
+        const line       = lineArray[lineNumber];
+        const occurrence = this.getFirstOccurrence(line);
+
+        if (occurrence) {
+            let occurrenceGlobalPos = globalPos + occurrence.globalPos;
+            const columnNumber      = this.getColumnNumber(line);
+
+            if (data.isCrlfLineBreak) {
+                occurrenceGlobalPos += lineNumber;
+            }
+
+            const error = this.getError(line, lineNumber + 1, columnNumber, occurrenceGlobalPos, occurrence.length);
+
+            occurrenceList.push(error);
+        }
+
+        globalPos += line.length + 1;
+    }
+
+    if (occurrenceList.length &&
+        config.autoFix &&
+        this.getFixedContent) {
+        return {
+            occurrenceList,
+            fixedContent : this.getFixedContent(templateContent)
+        };
+    }
+
+    return { occurrenceList };
+};
+
+module.exports = SingleLineRulePrototype;