isml-linter 5.39.1 → 5.40.0

package/src/util/CustomTagContainer.js

@@ -1,45 +1,45 @@
-const fs        = require('fs');
-const path      = require('path');
-const Constants = require('../Constants');
-
-const templatePath       = path.join(Constants.specTemplateDir, 'util', 'modules.isml');
-const customTagContainer = {};
-
-if (fs.existsSync(templatePath)) {
-    const ismoduleTagArray = fs
-        .readFileSync(templatePath, 'utf-8')
-        .replace(new RegExp(Constants.OS_EOL, 'g'), '')
-        .split('/>');
-
-    for (let j = 0; j < ismoduleTagArray.length; j++) {
-        const ismoduleTag = ismoduleTagArray[j];
-
-        if (ismoduleTag) {
-
-            const attrArray = ismoduleTag
-                .replace(/\t/g, ' ')
-                .split(' ')
-                .slice(1)
-                . filter( line => line );
-
-            const tag       = {
-                attrList : []
-            };
-
-            for (let i = 0; i < attrArray.length; i++) {
-                const stringifiedAttr = attrArray[i];
-
-                const attr = stringifiedAttr.split('=');
-                const val  = attr[1].substring(1, attr[1].length - 1);
-
-                attr[0] === 'attribute' ?
-                    tag.attrList.push(val) :
-                    tag[attr[0]] = val;
-            }
-
-            customTagContainer['is' + tag.name] = tag;
-        }
-    }
-}
-
-module.exports = customTagContainer;
+const fs        = require('fs');
+const path      = require('path');
+const Constants = require('../Constants');
+
+const templatePath       = path.join(Constants.specTemplateDir, 'util', 'modules.isml');
+const customTagContainer = {};
+
+if (fs.existsSync(templatePath)) {
+    const ismoduleTagArray = fs
+        .readFileSync(templatePath, 'utf-8')
+        .replace(new RegExp(Constants.OS_EOL, 'g'), '')
+        .split('/>');
+
+    for (let j = 0; j < ismoduleTagArray.length; j++) {
+        const ismoduleTag = ismoduleTagArray[j];
+
+        if (ismoduleTag) {
+
+            const attrArray = ismoduleTag
+                .replace(/\t/g, ' ')
+                .split(' ')
+                .slice(1)
+                . filter( line => line );
+
+            const tag       = {
+                attrList : []
+            };
+
+            for (let i = 0; i < attrArray.length; i++) {
+                const stringifiedAttr = attrArray[i];
+
+                const attr = stringifiedAttr.split('=');
+                const val  = attr[1].substring(1, attr[1].length - 1);
+
+                attr[0] === 'attribute' ?
+                    tag.attrList.push(val) :
+                    tag[attr[0]] = val;
+            }
+
+            customTagContainer['is' + tag.name] = tag;
+        }
+    }
+}
+
+module.exports = customTagContainer;

package/src/util/ExceptionUtils.js

@@ -1,136 +1,149 @@
-const Constants   = require('../Constants');
-const ConfigUtils = require('../util/ConfigUtils');
-
-const types = {
-    UNKNOWN_ERROR                    : 'UNKNOWN_ERROR',
-    UNCLOSED_DEPRECATED_ISML_COMMENT : 'UNCLOSED_DEPRECATED_ISML_COMMENT',
-    INVALID_TEMPLATE                 : 'INVALID_TEMPLATE',
-    INVALID_CHARACTER                : 'INVALID_CHARACTER',
-    RULE_ERROR                       : 'RULE_ERROR',
-    NO_CONFIG                        : 'NO_CONFIG',
-};
-
-// TODO: This function is originally from ConsoleUtils,
-// but it is here to avoid circular dependency;
-const displayVerboseMessage = (message, depth = 0) => {
-    const config    = ConfigUtils.load();
-    let indentation = '';
-
-    for (let i = 0; i < depth; i++) {
-        indentation += '    ';
-    }
-
-    if (config.verbose) {
-        console.log(indentation + message);
-    }
-};
-
-const unbalancedElementError = (elementType, lineNumber, globalPos, length, templatePath) => {
-    return {
-        message      : `Unbalanced <${elementType}> element`,
-        templatePath : templatePath,
-        globalPos,
-        length,
-        lineNumber   : lineNumber,
-        isCustom     : true,
-        type         : types.INVALID_TEMPLATE
-    };
-};
-
-const ruleApplianceError = (rule, originalError, templatePath) => {
-    displayVerboseMessage(originalError.stack);
-
-    return {
-        message      : `An error happened while applying rule "${rule.id}" to ${templatePath}`,
-        ruleID       : rule.id,
-        originalError,
-        lineNumber   : 0,
-        templatePath : templatePath,
-        isCustom     : true,
-        type         : types.RULE_ERROR
-    };
-};
-
-const unexpectedClosingElementError = (elementType, lineNumber, globalPos, length, templatePath) => {
-    return {
-        message      : `Unexpected </${elementType}> element`,
-        templatePath : templatePath,
-        globalPos,
-        length,
-        lineNumber   : lineNumber,
-        isCustom     : true,
-        type         : types.INVALID_TEMPLATE
-    };
-};
-
-const unbalancedQuotesError = (elementType, lineNumber, globalPos, length, templatePath) => {
-    return {
-        message      : `Unbalanced quotes in <${elementType}> element`,
-        templatePath : templatePath,
-        globalPos,
-        length,
-        lineNumber   : lineNumber,
-        isCustom     : true,
-        type         : types.INVALID_TEMPLATE
-    };
-};
-
-const unclosedDeprecatedIsmlComment = (lineNumber, globalPos, length, templatePath) => {
-    return {
-        message      : '"<!---" element not correctly closed: use "--->" instead of "-->"',
-        templatePath : templatePath,
-        globalPos,
-        length,
-        lineNumber   : lineNumber,
-        isCustom     : true,
-        type         : types.UNCLOSED_DEPRECATED_ISML_COMMENT
-    };
-};
-
-const invalidCharacterError = (character, lineNumber, globalPos, length, templatePath) => {
-    return {
-        message      : `Invalid character "${character}" found`,
-        templatePath : templatePath,
-        globalPos,
-        length,
-        lineNumber   : lineNumber,
-        isCustom     : true,
-        type         : types.INVALID_CHARACTER
-    };
-};
-
-const noConfigError = () => {
-    return {
-        message  : `No configuration found. Please run the following command: ${Constants.EOL}${Constants.EOL}\t./node_modules/.bin/isml-linter --init${Constants.EOL}${Constants.EOL}`,
-        isCustom : true
-    };
-};
-
-const noEslintConfigError = () => {
-    return {
-        message  : 'No eslint configuration found. Please add an ESLint configuration file and try again.',
-        isCustom : true
-    };
-};
-
-const emptyException = () => {
-    return {
-        isCustom : true
-    };
-};
-
-const isLinterException = e => e && e.isCustom;
-
-module.exports = {
-    unbalancedQuotesError,
-    ruleApplianceError,
-    unclosedDeprecatedIsmlComment,
-    unbalancedElementError,
-    unexpectedClosingElementError,
-    invalidCharacterError,
-    noConfigError,
-    noEslintConfigError,
-    emptyException,
-    isLinterException,
-    types
-};
+const Constants   = require('../Constants');
+const ConfigUtils = require('../util/ConfigUtils');
+
+const types = {
+    UNKNOWN_ERROR                    : 'UNKNOWN_ERROR',
+    UNCLOSED_DEPRECATED_ISML_COMMENT : 'UNCLOSED_DEPRECATED_ISML_COMMENT',
+    INVALID_TEMPLATE                 : 'INVALID_TEMPLATE',
+    INVALID_CHARACTER                : 'INVALID_CHARACTER',
+    RULE_ERROR                       : 'RULE_ERROR',
+    NO_CONFIG                        : 'NO_CONFIG',
+};
+
+// TODO: This function is originally from ConsoleUtils,
+// but it is here to avoid circular dependency;
+const displayVerboseMessage = (message, depth = 0) => {
+    const config    = ConfigUtils.load();
+    let indentation = '';
+
+    for (let i = 0; i < depth; i++) {
+        indentation += '    ';
+    }
+
+    if (config.verbose) {
+        console.log(indentation + message);
+    }
+};
+
+const unbalancedElementError = (elementType, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `Unbalanced <${elementType}> element`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.INVALID_TEMPLATE
+    };
+};
+
+const ruleApplianceError = (rule, originalError, templatePath) => {
+    displayVerboseMessage(originalError.stack);
+
+    return {
+        message      : `An error happened while applying rule "${rule.id}" to ${templatePath}`,
+        ruleID       : rule.id,
+        originalError,
+        lineNumber   : 0,
+        templatePath : templatePath,
+        isCustom     : true,
+        type         : types.RULE_ERROR
+    };
+};
+
+const unexpectedClosingElementError = (elementType, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `Unexpected </${elementType}> element`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.INVALID_TEMPLATE
+    };
+};
+
+const unbalancedQuotesError = (elementType, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `Unbalanced quotes in <${elementType}> element`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.INVALID_TEMPLATE
+    };
+};
+
+const unclosedDeprecatedIsmlComment = (lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : '"<!---" element not correctly closed: use "--->" instead of "-->"',
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.UNCLOSED_DEPRECATED_ISML_COMMENT
+    };
+};
+
+const invalidCharacterError = (character, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `Invalid character "${character}" found`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.INVALID_CHARACTER
+    };
+};
+
+const parseError = (elementType, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `An unexpected error happened while parsing element ${elementType} at ${templatePath}:${lineNumber}.`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.UNKNOWN_ERROR
+    };
+};
+
+const noConfigError = () => {
+    return {
+        message  : `No configuration found. Please run the following command: ${Constants.EOL}${Constants.EOL}\t./node_modules/.bin/isml-linter --init${Constants.EOL}${Constants.EOL}`,
+        isCustom : true
+    };
+};
+
+const noEslintConfigError = () => {
+    return {
+        message  : 'No eslint configuration found. Please add an ESLint configuration file and try again.',
+        isCustom : true
+    };
+};
+
+const emptyException = () => {
+    return {
+        isCustom : true
+    };
+};
+
+const isLinterException = e => e && e.isCustom;
+
+module.exports = {
+    parseError,
+    unbalancedQuotesError,
+    ruleApplianceError,
+    unclosedDeprecatedIsmlComment,
+    unbalancedElementError,
+    unexpectedClosingElementError,
+    invalidCharacterError,
+    noConfigError,
+    noEslintConfigError,
+    emptyException,
+    isLinterException,
+    types
+};

package/src/util/FileUtils.js

@@ -1,79 +1,79 @@
-const path        = require('path');
-const Constants   = require('./../Constants');
-const rootPath    = Constants.clientIsmlLinterDir;
-const fs          = require('fs');
-const ConfigUtils = require('./ConfigUtils');
-
-const saveToJsonFile = (filePath, fileName, content) => {
-    createDirIfDoesNotExist(filePath);
-    const fullPath = path.join(filePath, fileName);
-
-    fs.writeFileSync(fullPath, JSON.stringify(content, null, 4));
-};
-
-const saveToFile = (filePath, fileName, content) => {
-    createDirIfDoesNotExist(filePath);
-    const fullPath = path.join(filePath, fileName);
-
-    fs.writeFileSync(fullPath, JSON.stringify(content, null, 4));
-};
-
-const deleteFile = filePath => {
-    if (fileExists(filePath)) {
-        fs.unlinkSync(path.join(filePath));
-    }
-};
-
-const createDirIfDoesNotExist = dirPath => {
-    if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath);
-    }
-};
-
-const createClientDir = (dirName, dirPath = rootPath) => {
-    if (!fs.existsSync(path.join(dirPath, dirName))) {
-        fs.mkdirSync(path.join(dirPath, dirName));
-    }
-};
-
-const deleteDirectoryRecursively = dirPath => {
-    if (fs.existsSync(dirPath)) {
-        const fileArray = fs.readdirSync(dirPath);
-
-        for (let i = 0; i < fileArray.length; i++) {
-            const file    = fileArray[i];
-            const curPath = path.join(dirPath, file);
-
-            if (fs.lstatSync(curPath).isDirectory()) {
-                deleteDirectoryRecursively(curPath);
-            } else {
-                fs.unlinkSync(curPath);
-            }
-        }
-
-        fs.rmdirSync(dirPath);
-
-        return true;
-    }
-
-    return false;
-};
-
-const isIgnored = filePath => {
-    const config = ConfigUtils.load();
-
-    return config.ignore && config.ignore.some( ignoredPath => {
-        return filePath.indexOf(ignoredPath) >= 0;
-    });
-};
-
-const fileExists = filePath => fs.existsSync(filePath);
-
-module.exports.saveToFile                 = saveToFile;
-module.exports.saveToJsonFile             = saveToJsonFile;
-module.exports.fileExists                 = fileExists;
-module.exports.createDirIfDoesNotExist    = createDirIfDoesNotExist;
-module.exports.deleteFile                 = deleteFile;
-module.exports.deleteDirectoryRecursively = deleteDirectoryRecursively;
-module.exports.createClientDir            = createClientDir;
-module.exports.isIgnored                  = isIgnored;
+const path        = require('path');
+const Constants   = require('./../Constants');
+const rootPath    = Constants.clientIsmlLinterDir;
+const fs          = require('fs');
+const ConfigUtils = require('./ConfigUtils');
+
+const saveToJsonFile = (filePath, fileName, content) => {
+    createDirIfDoesNotExist(filePath);
+    const fullPath = path.join(filePath, fileName);
+
+    fs.writeFileSync(fullPath, JSON.stringify(content, null, 4));
+};
+
+const saveToFile = (filePath, fileName, content) => {
+    createDirIfDoesNotExist(filePath);
+    const fullPath = path.join(filePath, fileName);
+
+    fs.writeFileSync(fullPath, JSON.stringify(content, null, 4));
+};
+
+const deleteFile = filePath => {
+    if (fileExists(filePath)) {
+        fs.unlinkSync(path.join(filePath));
+    }
+};
+
+const createDirIfDoesNotExist = dirPath => {
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath);
+    }
+};
+
+const createClientDir = (dirName, dirPath = rootPath) => {
+    if (!fs.existsSync(path.join(dirPath, dirName))) {
+        fs.mkdirSync(path.join(dirPath, dirName));
+    }
+};
+
+const deleteDirectoryRecursively = dirPath => {
+    if (fs.existsSync(dirPath)) {
+        const fileArray = fs.readdirSync(dirPath);
+
+        for (let i = 0; i < fileArray.length; i++) {
+            const file    = fileArray[i];
+            const curPath = path.join(dirPath, file);
+
+            if (fs.lstatSync(curPath).isDirectory()) {
+                deleteDirectoryRecursively(curPath);
+            } else {
+                fs.unlinkSync(curPath);
+            }
+        }
+
+        fs.rmdirSync(dirPath);
+
+        return true;
+    }
+
+    return false;
+};
+
+const isIgnored = filePath => {
+    const config = ConfigUtils.load();
+
+    return config.ignore && config.ignore.some( ignoredPath => {
+        return filePath.indexOf(ignoredPath) >= 0;
+    });
+};
+
+const fileExists = filePath => fs.existsSync(filePath);
+
+module.exports.saveToFile                 = saveToFile;
+module.exports.saveToJsonFile             = saveToJsonFile;
+module.exports.fileExists                 = fileExists;
+module.exports.createDirIfDoesNotExist    = createDirIfDoesNotExist;
+module.exports.deleteFile                 = deleteFile;
+module.exports.deleteDirectoryRecursively = deleteDirectoryRecursively;
+module.exports.createClientDir            = createClientDir;
+module.exports.isIgnored                  = isIgnored;

package/src/util/GeneralUtils.js

@@ -1,60 +1,60 @@
-const path        = require('path');
-const Constants   = require('../Constants');
-const ConfigUtils = require('./ConfigUtils');
-
-const isObject = item => {
-    return item && typeof item === 'object' && !Array.isArray(item);
-};
-
-const mergeDeep  = (target, ...sources) => {
-    if (!sources.length) {
-        return target;
-    }
-
-    const source = sources.shift();
-
-    if (isObject(target) && isObject(source)) {
-        for (const key in source) {
-            if (isObject(source[key])) {
-                if (!target[key]) Object.assign(target, { [key]: {} });
-                mergeDeep(target[key], source[key]);
-            } else {
-                Object.assign(target, { [key]: source[key] });
-            }
-        }
-    }
-
-    return mergeDeep(target, ...sources);
-};
-
-const getActiveLineBreak = () => {
-    const config          = ConfigUtils.load();
-    const configLineBreak = config.linebreakStyle && Constants.lineBreak[config.linebreakStyle];
-
-    return configLineBreak || Constants.EOL;
-};
-
-module.exports.formatTemplatePath = filePath => {
-    return filePath.replace(/\//g, path.sep);
-};
-
-module.exports.toLF = content => {
-    return content.replace(/\r\n/g, '\n');
-};
-
-module.exports.applyActiveLineBreaks = content => {
-    const activeLineBreak = getActiveLineBreak();
-
-    return content
-        .replace(new RegExp(Constants.lineBreak.windows, 'g'), activeLineBreak)
-        .replace(new RegExp(Constants.lineBreak.unix, 'g'), activeLineBreak);
-};
-
-module.exports.parseISOString = isoString => {
-    const isoArray = isoString.split(/\D+/);
-    return new Date(Date.UTC(isoArray[0], --isoArray[1], isoArray[2], isoArray[3], isoArray[4], isoArray[5], isoArray[6]));
-};
-
-module.exports.getActiveLineBreak = getActiveLineBreak;
-
-module.exports.mergeDeep = mergeDeep;
+const path        = require('path');
+const Constants   = require('../Constants');
+const ConfigUtils = require('./ConfigUtils');
+
+const isObject = item => {
+    return item && typeof item === 'object' && !Array.isArray(item);
+};
+
+const mergeDeep  = (target, ...sources) => {
+    if (!sources.length) {
+        return target;
+    }
+
+    const source = sources.shift();
+
+    if (isObject(target) && isObject(source)) {
+        for (const key in source) {
+            if (isObject(source[key])) {
+                if (!target[key]) Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            } else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+
+    return mergeDeep(target, ...sources);
+};
+
+const getActiveLineBreak = () => {
+    const config          = ConfigUtils.load();
+    const configLineBreak = config.linebreakStyle && Constants.lineBreak[config.linebreakStyle];
+
+    return configLineBreak || Constants.EOL;
+};
+
+module.exports.formatTemplatePath = filePath => {
+    return filePath.replace(/\//g, path.sep);
+};
+
+module.exports.toLF = content => {
+    return content.replace(/\r\n/g, '\n');
+};
+
+module.exports.applyActiveLineBreaks = content => {
+    const activeLineBreak = getActiveLineBreak();
+
+    return content
+        .replace(new RegExp(Constants.lineBreak.windows, 'g'), activeLineBreak)
+        .replace(new RegExp(Constants.lineBreak.unix, 'g'), activeLineBreak);
+};
+
+module.exports.parseISOString = isoString => {
+    const isoArray = isoString.split(/\D+/);
+    return new Date(Date.UTC(isoArray[0], --isoArray[1], isoArray[2], isoArray[3], isoArray[4], isoArray[5], isoArray[6]));
+};
+
+module.exports.getActiveLineBreak = getActiveLineBreak;
+
+module.exports.mergeDeep = mergeDeep;

package/src/util/NativeExtensionUtils.js

@@ -1,6 +1,6 @@
-if (!String.prototype.replaceAll) {
-    String.prototype.replaceAll = function(search, replacement) {
-        const target = this;
-        return target.split(search).join(replacement);
-    };
-}
+if (!String.prototype.replaceAll) {
+    String.prototype.replaceAll = function(search, replacement) {
+        const target = this;
+        return target.split(search).join(replacement);
+    };
+}