isml-linter 5.38.2 → 5.39.0

package/CHANGELOG.md

@@ -1,26 +1,49 @@
 # Changelog
 
+## [5.39.0] - 2021-09-17
+
+### Added
+ - [Issue #31][issue#31] - "verbose" global configuration option;
+
+## [5.38.5] - 2021-09-12
+
+### Fixed
+ - "[eslint-to-isscript][eslint-to-isscript-readme]" rule;
+
+## [5.38.4] - 2021-09-11
+
+### Fixed
+ - Tree build edge case;
+ - DOM element attributes parse;
+ - "no-require-in-loop" rule - occurrence line number;
+ - Displayed message when rule-specific unexpected error occurs;
+
+## [5.38.3] - 2021-09-01
+
+### Fixed
+ - [Issue #30][issue#30]: allow custom tags to be non-self-closing;
+
 ## [5.38.2] - 2021-08-31
 
 ### Changed
-  - Default value of "[indent][indent-readme]" rule's "quote" option to "never";
-  - Improved "[indent][indent-readme]" rule's "standAloneClosingChars" configuration occurrence messages;
+ - Default value of "[indent][indent-readme]" rule's "quote" option to "never";
+ - Improved "[indent][indent-readme]" rule's "standAloneClosingChars" configuration occurrence messages;
 
 ### Fixed
-  - "[indent][indent-readme]" rule - tags closing character global position;
-  
+ - "[indent][indent-readme]" rule - tags closing character global position;
+
 ## [5.38.1] - 2021-08-29
 
 ### Fixed
-  - "[indent][indent-readme]" rule autofix - removed buggy optimization;
-  
+ - "[indent][indent-readme]" rule autofix - removed buggy optimization;
+
 ## [5.38.0] - 2021-08-29
 
 ### Added
  - "standAloneClosingChars" configuration attribute to the "[indent][indent-readme]" rule;
 
 ### Fixed
-  - "indent" rule - duplicated attribute parse;
+ - "indent" rule - duplicated attribute parse;
 
 ## [5.37.0] - 2021-08-22
 
@@ -30,33 +53,33 @@
 ## [5.36.5] - 2021-08-18
 
 ### Changed
-  - Removed redundant information from "invalid character found" error message;
+ - Removed redundant information from "invalid character found" error message;
 
 ### Fixed
-  - Unbalanced element position detection;
-  - Tree build parse on edge cases;
-  - "[no-inline-style][no-inline-style-readme]" rule - allow `<isprint>` tag to have "style" attribute;
-  
+ - Unbalanced element position detection;
+ - Tree build parse on edge cases;
+ - "[no-inline-style][no-inline-style-readme]" rule - allow `<isprint>` tag to have "style" attribute;
+
 ## [5.36.4] - 2021-08-15
 
 ### Fixed
-  - "indent" rule - "isif"-nested value indentation;
-  - "indent" rule - attribute multi-line value indentation;
+ - "indent" rule - "isif"-nested value indentation;
+ - "indent" rule - attribute multi-line value indentation;
 
 ## [5.36.3] - 2021-08-13
 
 ### Fixed
-  - "indent" rule - autofix to keep space between tag attributes;
-  - "indent" rule - expression attribute indentation fix;
-  - "indent" rule - indentation of attribute value with embedded "isif" in it;
+ - "indent" rule - autofix to keep space between tag attributes;
+ - "indent" rule - expression attribute indentation fix;
+ - "indent" rule - indentation of attribute value with embedded "isif" in it;
 
 ## [5.36.2] - 2021-08-11
 
 ### Fixed
-  - "indent" rule - autofix to keep duplicate spaces between tag attributes;
-  - "indent" rule - attribute value indentation;
-  - Tree build - unbalanced element detection;
-  - Tree build - "script" tag with attribute parse;
+ - "indent" rule - autofix to keep duplicate spaces between tag attributes;
+ - "indent" rule - attribute value indentation;
+ - Tree build - unbalanced element detection;
+ - Tree build - "script" tag with attribute parse;
 
 ## [5.36.1] - 2021-08-09
 
@@ -331,7 +354,7 @@
  - License file;
 
 ### Changed
- - Set some dependencies as "dev" dependencies;  
+ - Set some dependencies as "dev" dependencies;
 
 ### Security
  - Upgraded dependencies;
@@ -412,7 +435,7 @@
 ## [5.22.0] - 2019-11-24
 
 ### Added
- -  [Issue #4][issue#4] ".eslintrc" filename as an acceptable config filename;
+ - [Issue #4][issue#4] ".eslintrc" filename as an acceptable config filename;
 
 ### Fixed
  - Command Line - If no directory or template parameter is passed, configured root directory or default directory is used;
@@ -865,7 +888,7 @@
  - Issue related to &lt;style> tag;
 
 ### Removed
-  - 'empty-eof-line' rule from docs, as it is not implemented yet;
+ - 'empty-eof-line' rule from docs, as it is not implemented yet;
 
 ## [4.0.0] - 2019-03-03
 
@@ -878,10 +901,10 @@
    - No hardcode;
    - One Element per Line;
    - No Embedded ISML Tag;
-    
+
 ### Removed
 - Global installation support;
-    
+
 ### Deprecated
  - Output directory and json file;
 
@@ -949,6 +972,10 @@
 ### Added
 - Linter is published;
 
+[5.39.0]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.5...v5.39.0
+[5.38.5]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.4...v5.38.5
+[5.38.4]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.3...v5.38.4
+[5.38.3]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.2...v5.38.3
 [5.38.2]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.1...v5.38.2
 [5.38.1]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.0...v5.38.1
 [5.38.1]: https://github.com/FabiowQuixada/isml-linter/compare/v5.38.0...v5.38.1
@@ -1089,15 +1116,18 @@
 [issue#23]: https://github.com/FabiowQuixada/isml-linter/issues/23
 [issue#26]: https://github.com/FabiowQuixada/isml-linter/issues/26
 [issue#29]: https://github.com/FabiowQuixada/isml-linter/issues/29
+[issue#30]: https://github.com/FabiowQuixada/isml-linter/issues/30
+[issue#31]: https://github.com/FabiowQuixada/isml-linter/issues/31
 
 [cli-docs]: <docs/cli.md>
 [api-docs]: <docs/api.md>
 [license]:  <LICENSE>
 
-[disallow-tags-readme]:    <docs/rules/disallow-tags.md>
-[no-br-readme]:            <docs/rules/no-br.md>
-[no-inline-style-readme]:  <docs/rules/no-br.md>
-[no-isscript-readme]:      <docs/rules/no-isscript.md>
-[enforce-security-readme]: <docs/rules/enforce-security.md>
-[no-hardcode-readme]:      <docs/rules/no-hardcode.md>
-[indent-readme]:           <docs/rules/indent.md>
+[disallow-tags-readme]:      <docs/rules/disallow-tags.md>
+[no-br-readme]:              <docs/rules/no-br.md>
+[no-inline-style-readme]:    <docs/rules/no-br.md>
+[no-isscript-readme]:        <docs/rules/no-isscript.md>
+[enforce-security-readme]:   <docs/rules/enforce-security.md>
+[no-hardcode-readme]:        <docs/rules/no-hardcode.md>
+[indent-readme]:             <docs/rules/indent.md>
+[eslint-to-isscript-readme]: <docs/rules/eslint-to-isscript.md>

package/README.md

@@ -61,7 +61,8 @@ You can disable any rule by removing it from the config file. You may also find
 | eslintConfig        | Path to a eslint configuration file, to be applied within `<isscript>` tags. Default: _.eslintrc.json_ |
 | enableCache         | <span style="color:orange">[Deprecated]</span> Please check [cache docs][cache-docs]. Default: **false** |
 | autoFix             | Applies fixes for enabled rules. Default: **false** |
-| printPartialResults | Prints partial results. Useful to get overall picture in case of many errors. Default: **false** |
+| printPartialResults | Limits issues or rule occurrences listed in the console to up to 30 items. Useful to get overall picture in case of many errors. Default: **false** |
+| verbose             | Provides additional details of the linting process in the console. Default: **false** |
 | disableTreeParse    | Enables only rules that do not depend on  building an ISML tree. Check below when this might be useful. Default: **false** |
 | rules               | Defines which rules to check. See available rules below |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isml-linter",
-  "version": "5.38.2",
+  "version": "5.39.0",
   "author": "Fabiow Quixadá <ftquixada@gmail.com>",
   "license": "MIT",
   "main": "src/publicApi.js",
@@ -37,10 +37,10 @@
   "dependencies": {
     "app-root-path": "^3.0.0",
     "chalk": "^4.1.0",
+    "eslint": "^6.8.0",
     "readdir": "^1.0.2"
   },
   "devDependencies": {
-    "eslint": "^6.8.0",
     "eslint-plugin-jasmine": "^4.1.2",
     "eslint-plugin-varspacing": "^1.2.2",
     "ghooks": "^2.0.4",

package/src/Constants.js

@@ -38,7 +38,7 @@ const specInvalidTemplateDir           = path.join(specIsmlTreeTemplateDir, 'inv
 const specGlobalPosTemplateDir         = path.join(specIsmlTreeTemplateDir, 'global_position');
 const specComplexTemplatesDir          = path.join(specIsmlTreeTemplateDir, 'complex_templates');
 const specElementBalanceTemplatesDir   = path.join(specIsmlTreeTemplateDir, 'element_balance');
-const specSuffixLineNumberTemplatesDir = path.join(specIsmlTreeTemplateDir, 'suffix_line_number');
+const specTailLineNumberTemplatesDir   = path.join(specIsmlTreeTemplateDir, 'tail_line_number');
 const specAutofixTemplatesDir          = path.join(specTemplateDir, 'autofix');
 const rulesDir                         = path.join(linterModuleDir, 'src', 'rules');
 const lineByLineRulesDir               = path.join(rulesDir, 'line_by_line');
@@ -104,7 +104,7 @@ module.exports = {
     specComplexTemplatesDir,
     specAutofixTemplatesDir,
     specElementBalanceTemplatesDir,
-    specSuffixLineNumberTemplatesDir,
+    specTailLineNumberTemplatesDir,
     specDir,
     linterModuleDir,
 

package/src/IsmlLinter.js

@@ -10,6 +10,7 @@ let RuleUtils        = null;
 
 const UNKNOWN_ERROR = ExceptionUtils.types.UNKNOWN_ERROR;
 const UNPARSEABLE   = ExceptionUtils.types.INVALID_TEMPLATE;
+const RULE_ERROR    = ExceptionUtils.types.RULE_ERROR;
 const Linter        = {};
 
 // Configuration set through the public API;
@@ -92,6 +93,7 @@ const getEmptyResult = () => {
         info               : {},
         UNKNOWN_ERROR      : [],
         INVALID_TEMPLATE   : [],
+        RULE_ERROR         : [],
         issueQty           : 0,
         occurrenceQty      : 0,
         templatesFixed     : 0,
@@ -138,6 +140,17 @@ const checkTemplate = (templatePath, data, content, templateName) => {
             templateResults.issueQty++;
             templateResults.occurrenceQty++;
 
+        } else if (e.type === RULE_ERROR) {
+            templateResults[RULE_ERROR].push({
+                templatePath  : formattedTemplatePath,
+                ruleID        : e.ruleID,
+                message       : e.message,
+                originalError : e.originalError
+            });
+
+            templateResults.issueQty++;
+            templateResults.occurrenceQty++;
+
         } else if (!config.ignoreUnparseable) {
             templateResults[UNPARSEABLE].push({
                 templatePath : formattedTemplatePath,
@@ -164,6 +177,7 @@ const merge = (finalResult, templateResults) => {
         templatesFixed     : finalResult.templatesFixed                 + templateResults.templatesFixed,
         UNKNOWN_ERROR      : [...finalResult[UNKNOWN_ERROR],           ...templateResults[UNKNOWN_ERROR]],
         INVALID_TEMPLATE   : [...finalResult[UNPARSEABLE],             ...templateResults[UNPARSEABLE]],
+        RULE_ERROR         : [...finalResult[RULE_ERROR],              ...templateResults[RULE_ERROR]],
         totalTemplatesQty  : finalResult.totalTemplatesQty
     };
 };

package/src/isml_tree/ContainerNode.js

@@ -13,7 +13,7 @@ class ContainerNode extends IsmlNode {
 
     constructor(lineNumber, globalPos) {
         super();
-        this.value      = '(Container node)';
+        this.head       = '(Container node)';
         this.lineNumber = lineNumber;
         this.globalPos  = globalPos;
     }