isml-linter 5.40.4 → 5.41.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [5.41.0] - 2023-01-21
+
+### Added
+ - Exposed "fix" method in [ISML Linter API][api-docs];
+
+### Fixed
+ - Line-by-line and tree rules issues now are fixed in a single ISML Linter execution, not in two steps anymore;
+ 
+## [5.40.5] - 2023-01-15
+
+### Fixed
+ - Disallow void elements closing tags;
+ - Minor output messages improvement;
+
 ## [5.40.4] - 2023-01-15
 
 ### Fixed
@@ -1034,6 +1048,8 @@
 ### Added
 - Linter is published;
 
+[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
 [5.40.4]: https://github.com/FabiowQuixada/isml-linter/compare/v5.40.3...v5.40.4
 [5.40.3]: https://github.com/FabiowQuixada/isml-linter/compare/v5.40.2...v5.40.3
 [5.40.2]: https://github.com/FabiowQuixada/isml-linter/compare/v5.40.1...v5.40.2

package/package.json

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

package/src/isml_tree/ParseUtils.js

@@ -103,6 +103,9 @@ const checkBalance = (node, templatePath) => {
 };
 
 const parseNextElement = state => {
+    const ConfigUtils = require('../util/ConfigUtils');
+
+    const config     = ConfigUtils.load();
     const newElement = getNewElement(state);
 
     const trimmedElement     = newElement.value.trim();
@@ -125,7 +128,8 @@ const parseNextElement = state => {
             parseTextElement(state, newElement);
     }
 
-    newElement.columnNumber = getElementColumnNumber(newElement, state);
+    newElement.columnNumber  = getElementColumnNumber(newElement, state);
+    newElement.isVoidElement = !config.disableHtml5 && Constants.voidElementsArray.indexOf(newElement.tagType) >= 0;
 
     if (state.isCrlfLineBreak) {
         newElement.globalPos += newElement.lineNumber - 1;

package/src/isml_tree/TreeBuilder.js

@@ -110,7 +110,17 @@ const parseContainerElements = (element, currentParent, newNode, templatePath) =
 
 const parseNonContainerElements = (element, currentParent, newNode, templatePath) => {
     if (element.isSelfClosing) {
-        currentParent.addChild(newNode);
+        if (element.isClosingTag && element.isVoidElement) {
+            throw ExceptionUtils.voidElementClosingTag(
+                element.tagType,
+                element.lineNumber,
+                element.globalPos,
+                element.value.trim().length,
+                templatePath
+            );
+        } else {
+            currentParent.addChild(newNode);
+        }
     } else if (!element.isClosingTag && element.tagType !== 'isif') {
         currentParent.addChild(newNode);
 

package/src/publicApi.js

@@ -14,8 +14,23 @@ module.exports = {
         }
 
         linterResult = IsmlLinter.run(path, content);
+
         return linterResult;
     },
+    fix          : (path, content, config) => {
+        let autofixConfig = config;
+
+        if (config) {
+            autofixConfig.autoFix = true;
+            IsmlLinter.setConfig(autofixConfig);
+        } else {
+            autofixConfig = IsmlLinter.getConfig();
+            autofixConfig.autoFix = true;
+            IsmlLinter.setConfig(autofixConfig);
+        }
+
+        return IsmlLinter.run(path, content, autofixConfig);
+    },
     printResults : ()    => ConsoleUtils.displayOccurrenceList(linterResult),
     build        : path  => Builder.run(path),
 

package/src/rules/prototypes/SingleLineRulePrototype.js

@@ -41,7 +41,10 @@ SingleLineRulePrototype.check = function(templateContent, data = { isCrlfLineBre
         };
     }
 
-    return { occurrenceList };
+    return { 
+        occurrenceList,
+        fixedContent : templateContent
+     };
 };
 
 module.exports = SingleLineRulePrototype;

package/src/util/ConfigUtils.js

@@ -158,7 +158,7 @@ const existEslintConfigFile = () => {
         FileUtils.fileExists(Constants.eslintConfigFilePathList[2]);
 };
 
-const isTestEnv = () => process.env.NODE_ENV === Constants.ENV_TEST;
+const isTestEnv = () => process.env.NODE_ENV === Constants.ENV_TEST && !global.isSimulatingProductionEnvironment;
 
 const setLocalConfig = configParam => {
     if (isTestEnv()) {

package/src/util/ExceptionUtils.js

@@ -7,6 +7,7 @@ const types = {
     INVALID_TEMPLATE                 : 'INVALID_TEMPLATE',
     INVALID_NESTED_ISIF              : 'INVALID_NESTED_ISIF',
     INVALID_CHARACTER                : 'INVALID_CHARACTER',
+    VOID_ELEMENT_CLOSING_TAG         : 'VOID_ELEMENT_CLOSING_TAG',
     RULE_ERROR                       : 'RULE_ERROR',
     NO_CONFIG                        : 'NO_CONFIG',
 };
@@ -100,6 +101,18 @@ const invalidCharacterError = (character, lineNumber, globalPos, length, templat
     };
 };
 
+const voidElementClosingTag = (element, lineNumber, globalPos, length, templatePath) => {
+    return {
+        message      : `"<${element}>" is a void element, and as such, should not have a corresponding closing tag`,
+        templatePath : templatePath,
+        globalPos,
+        length,
+        lineNumber   : lineNumber,
+        isCustom     : true,
+        type         : types.VOID_ELEMENT_CLOSING_TAG
+    };
+};
+
 const invalidNestedIsifError = (tagType, lineNumber, globalPos, templatePath) => {
     return {
         message      : `An error occurred while parsing element "<${tagType}>" in line ${lineNumber}. Try moving the closing character ">" of the "<${tagType}>" element to outside of the "<isif>" condition.`,
@@ -135,14 +148,14 @@ const unkownError = (templatePath) => {
 
 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}`,
+        message  : `No ISML Linter configuration file 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.',
+        message  : 'No ESLint configuration file found. Please add an ESLint configuration file and try again.',
         isCustom : true
     };
 };
@@ -160,6 +173,7 @@ module.exports = {
     unbalancedQuotesError,
     ruleApplianceError,
     unkownError,
+    voidElementClosingTag,
     invalidNestedIsifError,
     unclosedDeprecatedIsmlComment,
     unbalancedElementError,

package/src/util/RuleUtils.js

@@ -93,6 +93,7 @@ const applyRuleOnTemplate = (ruleArray, templatePath, root, config, data) => {
             try {
                 ConsoleUtils.displayVerboseMessage(`Applying "${rule.id}" rule`, 1);
                 const ruleResults = rule.check(root, templateResults.data);
+                templateResults.finalContent = ruleResults.fixedContent;
                 applyRuleResult(config, ruleResults, templatePath, templateResults, rule);
 
             } catch (error) {
@@ -226,7 +227,7 @@ const checkTemplate = (templatePath, data, content = '', templateName = '') => {
     const config          = ConfigUtils.load();
     const templateContent = GeneralUtils.toLF(content || fs.readFileSync(templatePath, 'utf-8'));
     const lineResults     = checkLineByLineRules(templatePath, templateContent, config, data);
-    const treeResults     = checkTreeRules(templatePath, templateContent, config, data) || { errors : [] };
+    const treeResults     = checkTreeRules(templatePath, lineResults.finalContent, config, data) || { errors : [] };
     const filenameResults = checkFileName(templateName, templateContent);
 
     return {