isml-linter 5.42.0 → 5.42.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [5.42.1] - 2023-01-28
+
+### Fixed
+ - Keep template original linebreak if one is not explictly set in the ISML Linter configuration file. It was forcing a Unix linebreak;
+ 
 ## [5.42.0] - 2023-01-25
 
 ### Added
@@ -1059,6 +1064,7 @@
 ### Added
 - Linter is published;
 
+[5.42.1]: https://github.com/FabiowQuixada/isml-linter/compare/v5.42.0...v5.42.1
 [5.42.0]: https://github.com/FabiowQuixada/isml-linter/compare/v5.41.0...v5.42.0
 [5.41.0]: https://github.com/FabiowQuixada/isml-linter/compare/v5.40.5...v5.41.0
 [5.40.5]: https://github.com/FabiowQuixada/isml-linter/compare/v5.40.4...v5.40.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isml-linter",
-  "version": "5.42.0",
+  "version": "5.42.1",
   "author": "Fabiow Quixadá <ftquixada@gmail.com>",
   "license": "MIT",
   "main": "src/publicApi.js",

package/src/isml_tree/IsmlNode.js

@@ -6,6 +6,7 @@ const SfccTagContainer = require('../enums/SfccTagContainer');
 const ParseUtils       = require('./ParseUtils');
 const MaskUtils        = require('./MaskUtils');
 const ExceptionUtils   = require('../util/ExceptionUtils');
+const GeneralUtils     = require('../util/GeneralUtils');
 
 let ID_COUNTER = 0;
 
@@ -383,24 +384,11 @@ class IsmlNode {
         return rootNode;
     }
 
-    toString(stream = '') {
+    toString() {
 
-        if (!this.isContainer() && this.isEmpty() && !this.isLastChild()) {
-            return stream;
-        }
-
-        if (!this.isRoot() && !this.isContainer()) {
-            stream += this.head;
-        }
-
-        for (let i = 0; i < this.children.length; i++) {
-            const child = this.children[i];
-            stream      = child.toString(stream);
-        }
+        let stream = privateToString(this);
 
-        if (!this.isRoot() && !this.isContainer()) {
-            stream += this.tail;
-        }
+        stream = GeneralUtils.applyLineBreak(stream, this.getRoot().tree.originalLineBreak);
 
         return stream;
     }
@@ -429,6 +417,27 @@ class IsmlNode {
  * will be available for use only within IsmlNode methods;
 */
 
+const privateToString = (node, stream = '') => {
+    if (!node.isContainer() && node.isEmpty() && !node.isLastChild()) {
+        return stream;
+    }
+
+    if (!node.isRoot() && !node.isContainer()) {
+        stream += node.head;
+    }
+
+    for (let i = 0; i < node.children.length; i++) {
+        const child = node.children[i];
+        stream      = privateToString(child, stream);
+    }
+
+    if (!node.isRoot() && !node.isContainer()) {
+        stream += node.tail;
+    }
+
+    return stream;
+};
+
 const getAttributes = node => {
     const trimmedHead              = node.head.trim();
     const nodeHead                 = trimmedHead.substring(1, trimmedHead.length - 1);

package/src/isml_tree/ParseUtils.js

@@ -275,6 +275,7 @@ const getNextClosingTagOrExpressionEndPos = content => {
 };
 
 const getInitialState = (templateContent, templatePath, isCrlfLineBreak) => {
+    // TODO Check if "GeneralUtils.toLF" can be removed;
     const originalContent       = GeneralUtils.toLF(templateContent);
     const originalShadowContent = MaskUtils.maskIgnorableContent(originalContent, null, templatePath);
 

package/src/isml_tree/TreeBuilder.js

@@ -32,6 +32,10 @@ const parse = (content, templatePath, isCrlfLineBreak, isEmbeddedNode) => {
 
     ParseUtils.checkBalance(rootNode, templatePath);
 
+    rootNode.tree = {
+        originalLineBreak : GeneralUtils.getFileLineBreakStyle(content),
+    };
+
     return rootNode;
 };
 
@@ -203,15 +207,17 @@ const build = (templatePath, content, isCrlfLineBreak) => {
 
     const ParseStatus = require('../enums/ParseStatus');
 
-    const result = {
+    const templateContent = content || fs.readFileSync(templatePath, 'utf-8');
+    const result          = {
+        originalLineBreak : GeneralUtils.getFileLineBreakStyle(templateContent),
         templatePath,
         status : ParseStatus.NO_ERRORS
     };
 
     try {
-        const templateContent = GeneralUtils.toLF(content || fs.readFileSync(templatePath, 'utf-8'));
-        result.rootNode       = parse(templateContent, templatePath, isCrlfLineBreak);
-        result.data           = postProcess(result.rootNode);
+        const formattedTemplateContent = templateContent;
+        result.rootNode                = parse(formattedTemplateContent, templatePath, isCrlfLineBreak);
+        result.data                    = postProcess(result.rootNode);
 
         result.rootNode.tree = result;
 

package/src/rules/line_by_line/max-lines.js

@@ -1,5 +1,4 @@
 const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-const Constants               = require('../../Constants');
 const GeneralUtils            = require('../../util/GeneralUtils');
 
 const ruleId      = require('path').basename(__filename).slice(0, -3);
@@ -21,8 +20,9 @@ Rule.getColumnNumber = function() {
 
 Rule.check = function(templateContent) {
 
+    const lineBreak      = GeneralUtils.getFileLineBreakStyle(templateContent);
     const maxLines       = this.getConfigs().max;
-    const lineArray      = GeneralUtils.toLF(templateContent).split(Constants.EOL);
+    const lineArray      = templateContent.split(lineBreak);
     const columnNumber   = this.getColumnNumber();
     const occurrenceList = [];
 

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

@@ -17,9 +17,9 @@ Rule.getColumnNumber = function() {
 Rule.getFixedContent = function(templateContent) {
     const GeneralUtils = require('../../util/GeneralUtils');
 
-    const activeLineBreak = GeneralUtils.getActiveLineBreak();
-    const lineArray       = templateContent.split(Constants.EOL);
-    const result          = [];
+    const lineBreak = GeneralUtils.getFileLineBreakStyle(templateContent);
+    const lineArray = templateContent.split(lineBreak);
+    const result    = [];
 
     for (let i = 0; i < lineArray.length; i++) {
         const line = lineArray[i];
@@ -27,7 +27,7 @@ Rule.getFixedContent = function(templateContent) {
         result.push(line.trim() ? line : line.trim());
     }
 
-    return result.join(activeLineBreak);
+    return GeneralUtils.applyLineBreak(result.join(lineBreak));
 };
 
 Rule.getFirstOccurrence = function(line) {

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

@@ -16,9 +16,11 @@ Rule.getColumnNumber = function(line) {
 };
 
 Rule.getFixedContent = function(templateContent) {
+    const lineBreak    = GeneralUtils.getFileLineBreakStyle(templateContent);
     const indent       = IndentRule.getIndentation();
     const fixedContent = templateContent.replace(/\t/g, indent);
-    return GeneralUtils.applyActiveLineBreaks(fixedContent);
+
+    return GeneralUtils.applyLineBreak(fixedContent, lineBreak);
 };
 
 Rule.getFirstOccurrence = function(line) {

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

@@ -1,5 +1,4 @@
 const SingleLineRulePrototype = require('../prototypes/SingleLineRulePrototype');
-const Constants               = require('../../Constants');
 const ParseUtils              = require('../../isml_tree/ParseUtils');
 
 const ruleId      = require('path').basename(__filename).slice(0, -3);
@@ -19,9 +18,9 @@ Rule.getColumnNumber = function(line) {
 Rule.getFixedContent = function(templateContent) {
     const GeneralUtils = require('../../util/GeneralUtils');
 
-    const activeLineBreak = GeneralUtils.getActiveLineBreak();
-    const lineArray       = GeneralUtils.toLF(templateContent).split(Constants.EOL);
-    const result          = [];
+    const lineBreak = GeneralUtils.getFileLineBreakStyle(templateContent);
+    const lineArray = templateContent.split(lineBreak);
+    const result    = [];
 
     for (let i = 0; i < lineArray.length; i++) {
         const line = lineArray[i];
@@ -29,7 +28,7 @@ Rule.getFixedContent = function(templateContent) {
         result.push(line.replace(/\s+$/g, ''));
     }
 
-    return result.join(activeLineBreak);
+    return GeneralUtils.applyLineBreak(result.join(lineBreak), lineBreak);
 };
 
 Rule.getFirstOccurrence = function(line) {

package/src/rules/prototypes/SingleLineRulePrototype.js

@@ -1,14 +1,14 @@
 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 lineBreak      = GeneralUtils.getFileLineBreakStyle(templateContent);
     const config         = ConfigUtils.load();
-    const lineArray      = GeneralUtils.toLF(templateContent).split(Constants.EOL);
+    const lineArray      = templateContent.split(lineBreak);
     const occurrenceList = [];
     let globalPos        = 0;
 

package/src/rules/prototypes/TreeRulePrototype.js

@@ -65,20 +65,4 @@ TreeRulePrototype.return = function(node, occurrenceList, config) {
     }
 };
 
-TreeRulePrototype.fix = function(stream = '') {
-
-    if (!this.isRoot() && !this.isContainer()) {
-        stream += this.head;
-    }
-
-    for (let i = 0; i < this.children.length; i++) {
-        const node = this.children[i];
-        stream     = node.isBroken() ?
-            node.toString(stream) :
-            this.getFixedContent(node, stream);
-    }
-
-    return stream;
-};
-
 module.exports = TreeRulePrototype;

package/src/rules/tree/eslint-to-isscript.js

@@ -2,7 +2,6 @@ const TreeRulePrototype = require('../prototypes/TreeRulePrototype');
 const ParseUtils        = require('../../isml_tree/ParseUtils');
 const Constants         = require('../../Constants');
 const ConfigUtils       = require('../../util/ConfigUtils');
-const GeneralUtils      = require('../../util/GeneralUtils');
 
 const ruleId          = require('path').basename(__filename).slice(0, -3);
 const description     = 'Not eslint-valid';
@@ -121,7 +120,7 @@ Rule.getFixedContent = function(node) {
         node.head = reIndent(content, ismlOffset);
     }
 
-    return GeneralUtils.applyActiveLineBreaks(node.toString());
+    return node.toString();
 };
 
 const unindent = (content, indentSize) => {

package/src/rules/tree/indent.js

@@ -161,10 +161,11 @@ Rule.isQuoteClosingCharBroken = function(node) {
                     '';
 
             if (message) {
-                const line = node
+                const lineBreak = node.getRoot().tree.originalLineBreak;
+                const line      = node
                     .getRoot()
                     .toString()
-                    .split(Constants.EOL)[lineNumber - 1];
+                    .split(lineBreak)[lineNumber - 1];
 
                 result.push({
                     quoteChar    : attribute.quoteChar,

package/src/rules/tree/leading-iscache.js

@@ -1,7 +1,6 @@
 const TreeRulePrototype = require('../prototypes/TreeRulePrototype');
 const RuleUtils         = require('../../util/TempRuleUtils');
 const Constants         = require('../../Constants');
-const GeneralUtils      = require('../../util/GeneralUtils');
 
 const TAG_TYPE    = 'iscache';
 const ruleId      = require('path').basename(__filename).slice(0, -3);
@@ -33,7 +32,7 @@ Rule.getFixedContent = function(rootNode) {
         }
     }
 
-    return GeneralUtils.applyActiveLineBreaks(rootNode.toString());
+    return rootNode.toString();
 };
 
 module.exports = Rule;

package/src/rules/tree/leading-iscontent.js

@@ -1,7 +1,6 @@
 const TreeRulePrototype = require('../prototypes/TreeRulePrototype');
 const Constants         = require('../../Constants');
 const RuleUtils         = require('../../util/TempRuleUtils');
-const GeneralUtils      = require('../../util/GeneralUtils');
 
 const TAG_TYPE    = 'iscontent';
 const ruleId      = require('path').basename(__filename).slice(0, -3);
@@ -29,7 +28,7 @@ Rule.getFixedContent = function(rootNode) {
         }
     }
 
-    return GeneralUtils.applyActiveLineBreaks(rootNode.toString());
+    return rootNode.toString();
 };
 
 module.exports = Rule;

package/src/rules/tree/no-iselse-slash.js

@@ -1,6 +1,5 @@
 const TreeRulePrototype = require('../prototypes/TreeRulePrototype');
 const MaskUtils         = require('../../isml_tree/MaskUtils');
-const GeneralUtils      = require('../../util/GeneralUtils');
 
 const ruleId      = require('path').basename(__filename).slice(0, -3);
 const description = 'Slash is not allowed for "iselse" nor "iselseif" tags';
@@ -29,7 +28,7 @@ Rule.getFixedContent = function(node) {
         this.getFixedContent(child);
     }
 
-    return GeneralUtils.applyActiveLineBreaks(node.toString());
+    return node.toString();
 };
 
 module.exports = Rule;

package/src/rules/tree/one-element-per-line.js

@@ -2,7 +2,6 @@ const TreeRulePrototype = require('../prototypes/TreeRulePrototype');
 const IndentRule        = require('../tree/indent');
 const ConfigUtils       = require('../../util/ConfigUtils');
 const Constants         = require('../../Constants');
-const GeneralUtils      = require('../../util/GeneralUtils');
 const TreeBuilder       = require('../../isml_tree/TreeBuilder');
 
 const ruleId      = require('path').basename(__filename).slice(0, -3);
@@ -42,7 +41,7 @@ Rule.getFixedContent = rootNode => {
     const newRootNode       = TreeBuilder.build(null, stringifiedTree).rootNode;
     const partialFixContent = IndentRule.getFixedContent(newRootNode);
 
-    return GeneralUtils.applyActiveLineBreaks(partialFixContent);
+    return partialFixContent;
 };
 
 const addLineBreaks = node => {

package/src/util/ConsoleUtils.js

@@ -126,6 +126,8 @@ const displayUnknownErrors = lintResult => {
     return partialSum;
 };
 
+const getPluralTermString = (singularTerm, qty) => `${qty} ${singularTerm}${qty > 1 ? 's' : ''}`;
+
 const displayOccurrenceList = lintResult => {
 
     displayUnparseableErrors(lintResult);
@@ -148,19 +150,19 @@ const displayOccurrenceList = lintResult => {
         console.log(Constants.EOL + chalk`{bold Linted ${lintResult.totalTemplatesQty} templates in ${lintResult.elapsedTime} seconds.}`);
 
         if (occurrenceList.error.qty > 0) {
-            console.log(chalk`{bold ${occurrenceList.error.qty} error(s) found.}`);
+            console.log(chalk`{bold ${getPluralTermString('error', occurrenceList.error.qty)} found.}`);
         }
 
         if (occurrenceList.warning.qty > 0) {
-            console.log(chalk`{bold ${occurrenceList.warning.qty} warning(s) found.}`);
+            console.log(chalk`{bold ${getPluralTermString('warning', occurrenceList.warning.qty)} found.}`);
         }
 
         if (occurrenceList.info.qty > 0) {
-            console.log(chalk`{bold ${occurrenceList.info.qty} info(s) found.}`);
+            console.log(chalk`{bold ${getPluralTermString('info', occurrenceList.info.qty)} found.}`);
         }
 
         if (lintResult.INVALID_TEMPLATE && lintResult.INVALID_TEMPLATE.length > 0) {
-            console.log(chalk`{bold ${lintResult.INVALID_TEMPLATE.length} template(s) have an invalid ISML tree.}`);
+            console.log(chalk`{bold ${getPluralTermString('template', lintResult.INVALID_TEMPLATE.length)} have an invalid ISML tree.}`);
         }
 
         if (lintResult.UNKNOWN_ERROR && lintResult.UNKNOWN_ERROR.length > 0) {

package/src/util/GeneralUtils.js

@@ -34,12 +34,52 @@ const getActiveLineBreak = () => {
     return configLineBreak || Constants.EOL;
 };
 
+const getFileLineBreakStyle = templateContent => {
+    const indexOfLF = templateContent.indexOf(Constants.lineBreak.unix, 1);
+
+    if (indexOfLF === -1) {
+        if (templateContent.indexOf('\r') !== -1) {
+            return '\r';
+        }
+
+        return Constants.lineBreak.unix;
+    }
+
+    if (templateContent[indexOfLF - 1] === '\r') {
+        return Constants.lineBreak.windows;
+    }
+
+    return Constants.lineBreak.unix;
+};
+
 module.exports.formatTemplatePath = filePath => {
     return filePath.replace(/\//g, path.sep);
 };
 
 module.exports.toLF = content => {
-    return content.replace(/\r\n/g, '\n');
+    return content.replace(/\r\n/g, Constants.lineBreak.unix);
+};
+
+module.exports.getFileLineBreakStyle = getFileLineBreakStyle;
+
+module.exports.applyLineBreak = (content, lineBreak) => {
+    const config                      = ConfigUtils.load();
+    const configLineBreak             = config.linebreakStyle && Constants.lineBreak[config.linebreakStyle];
+    const templateHasWindowsLineBreak = content.indexOf(Constants.lineBreak.windows) >= 0;
+
+    if (configLineBreak) {
+        lineBreak = configLineBreak;
+    }
+
+    if (lineBreak === Constants.lineBreak.windows && !templateHasWindowsLineBreak) {
+        return content
+            .replace(new RegExp(Constants.lineBreak.unix, 'g'), lineBreak);
+    } else if (lineBreak === Constants.lineBreak.unix && templateHasWindowsLineBreak) {
+        return content
+            .replace(new RegExp(Constants.lineBreak.windows, 'g'), lineBreak);
+    }
+
+    return content;
 };
 
 module.exports.applyActiveLineBreaks = content => {

package/src/util/RuleUtils.js

@@ -6,7 +6,6 @@ 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 GeneralUtils          = require('./GeneralUtils');
 const ConsoleUtils          = require('./ConsoleUtils');
 const ExceptionUtils        = require('./ExceptionUtils');
 
@@ -225,7 +224,7 @@ const checkCustomModules = () => {
 const parseAndPossiblyFixTemplate = (templatePath, data, content = '', templateName = '') => {
     ConsoleUtils.displayVerboseMessage(`\nChecking "${templatePath}" template`);
     const config          = ConfigUtils.load();
-    const templateContent = GeneralUtils.toLF(content || fs.readFileSync(templatePath, 'utf-8'));
+    const templateContent = content || fs.readFileSync(templatePath, 'utf-8');
     const lineResults     = checkAndPossiblyFixLineByLineRules(templatePath, templateContent, config, data);
     const treeResults     = checkAndPossiblyFixTreeRules(templatePath, lineResults.finalContent, config, data) || { errors : [] };
     const filenameResults = checkFileName(templateName, templateContent);