isml-linter 5.38.5 → 5.39.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [5.39.0] - 2021-09-17
+
+### Added
+ - [Issue #31][issue#31] - "verbose" global configuration option;
+
 ## [5.38.5] - 2021-09-12
 
 ### Fixed
@@ -967,6 +972,7 @@
 ### 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
@@ -1111,6 +1117,7 @@
 [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>

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.5",
+  "version": "5.39.0",
   "author": "Fabiow Quixadá <ftquixada@gmail.com>",
   "license": "MIT",
   "main": "src/publicApi.js",

package/src/util/ConsoleUtils.js

@@ -303,11 +303,25 @@ const getInfoData = lintResult => {
     };
 };
 
+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);
+    }
+};
+
 module.exports = {
     displayOccurrenceList,
     displayConfigError,
     displayEslintConfigError,
     displayInvalidTemplatesPaths,
     displayInvalidCommandError,
-    printExceptionMsg
+    printExceptionMsg,
+    displayVerboseMessage
 };

package/src/util/RuleUtils.js

@@ -7,6 +7,7 @@ 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');
 
 const lineByLineRules = [];
@@ -90,6 +91,7 @@ const applyRuleOnTemplate = (ruleArray, templatePath, root, config, data) => {
         const rule = ruleArray[i];
         if (!rule.shouldIgnore(templatePath)) {
             try {
+                ConsoleUtils.displayVerboseMessage(`Applying "${rule.id}" rule`, 1);
                 const ruleResults = rule.check(root, templateResults.data);
                 applyRuleResult(config, ruleResults, templatePath, templateResults, rule);
 
@@ -169,6 +171,7 @@ const checkFileName = (filename, templateContent) => {
 
 const checkTreeRules = (templatePath, templateContent, config, data) => {
     if (!config.disableTreeParse) {
+        ConsoleUtils.displayVerboseMessage(`Building tree for "${templatePath}"`, 1);
         const tree = TreeBuilder.build(templatePath, templateContent);
 
         if (!tree.rootNode) {
@@ -219,6 +222,7 @@ const checkCustomModules = () => {
 };
 
 const checkTemplate = (templatePath, data, content = '', templateName = '') => {
+    ConsoleUtils.displayVerboseMessage(`\nChecking "${templatePath}" template`);
     const config          = ConfigUtils.load();
     const templateContent = GeneralUtils.toLF(content || fs.readFileSync(templatePath, 'utf-8'));
     const lineResults     = checkLineByLineRules(templatePath, templateContent, config, data);