isml-linter 5.39.1 → 5.40.0

package/ismllinter.config.js

@@ -1,33 +1,33 @@
-// Please check all available configurations and rules
-// at https://www.npmjs.com/package/isml-linter.
-
-const config = {
-    'rules': {
-
-        // Line by line rules;
-        'no-br'               : {},
-        'no-git-conflict'     : {},
-        'no-import-package'   : {},
-        'no-inline-style'     : {
-            level : 'warning'
-        },
-        'no-isscript'         : {},
-        'no-space-only-lines' : {},
-        'no-tabs'             : {},
-        'no-trailing-spaces'  : {},
-
-        // Tree rules;
-        'indent'               : {},
-        'no-redundant-context' : {},
-        'max-depth'            : {
-            level : 'warning'
-        },
-        'no-hardcode'          : {},
-        'no-require-in-loop'   : {},
-        'one-element-per-line' : {
-            except: ['iscomment']
-        }
-    }
-};
-
-module.exports = config;
+// Please check all available configurations and rules
+// at https://www.npmjs.com/package/isml-linter.
+
+const config = {
+    'rules': {
+
+        // Line by line rules;
+        'no-br'               : {},
+        'no-git-conflict'     : {},
+        'no-import-package'   : {},
+        'no-inline-style'     : {
+            level : 'warning'
+        },
+        'no-isscript'         : {},
+        'no-space-only-lines' : {},
+        'no-tabs'             : {},
+        'no-trailing-spaces'  : {},
+
+        // Tree rules;
+        'indent'               : {},
+        'no-redundant-context' : {},
+        'max-depth'            : {
+            level : 'warning'
+        },
+        'no-hardcode'          : {},
+        'no-require-in-loop'   : {},
+        'one-element-per-line' : {
+            except: ['iscomment']
+        }
+    }
+};
+
+module.exports = config;

package/package.json

@@ -1,53 +1,53 @@
-{
-  "name": "isml-linter",
-  "version": "5.39.1",
-  "author": "Fabiow Quixadá <ftquixada@gmail.com>",
-  "license": "MIT",
-  "main": "src/publicApi.js",
-  "engines": {
-    "node": ">=10.0.0"
-  },
-  "scripts": {
-    "lint": "./node_modules/.bin/eslint . --fix",
-    "test": "jasmine-node spec/",
-    "lint:isml": "node scripts/lint.js",
-    "build:isml": "node scripts/lint.js --build",
-    "fix:isml": "node scripts/lint.js --autofix",
-    "prepush": "npm run lint && npm test --silent",
-    "release": "node scripts/release"
-  },
-  "bin": {
-    "isml-linter": "./bin/isml-linter.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/FabiowQuixada/isml-linter"
-  },
-  "keywords": [
-    "isml",
-    "template",
-    "lint",
-    "linter",
-    "demandware",
-    "salesforce",
-    "digital-script",
-    "sfra",
-    "site-genesis"
-  ],
-  "dependencies": {
-    "app-root-path": "^3.0.0",
-    "chalk": "^4.1.0",
-    "eslint": "^7.32.0",
-    "readdir": "^1.0.2"
-  },
-  "devDependencies": {
-    "eslint-plugin-jasmine": "^4.1.2",
-    "eslint-plugin-varspacing": "^1.2.2",
-    "ghooks": "^2.0.4",
-    "jasmine": "^3.6.4",
-    "jasmine-node": "^3.0.0",
-    "rmdir": "^1.2.0",
-    "sinon": "^9.2.4",
-    "to-snake-case": "^1.0.0"
-  }
-}
+{
+  "name": "isml-linter",
+  "version": "5.40.0",
+  "author": "Fabiow Quixadá <ftquixada@gmail.com>",
+  "license": "MIT",
+  "main": "src/publicApi.js",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "scripts": {
+    "lint": "./node_modules/.bin/eslint . --fix",
+    "test": "jasmine-node spec/",
+    "lint:isml": "node scripts/lint.js",
+    "build:isml": "node scripts/lint.js --build",
+    "fix:isml": "node scripts/lint.js --autofix",
+    "prepush": "npm run lint && npm test --silent",
+    "release": "node scripts/release"
+  },
+  "bin": {
+    "isml-linter": "./bin/isml-linter.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FabiowQuixada/isml-linter"
+  },
+  "keywords": [
+    "isml",
+    "template",
+    "lint",
+    "linter",
+    "demandware",
+    "salesforce",
+    "digital-script",
+    "sfra",
+    "site-genesis"
+  ],
+  "dependencies": {
+    "app-root-path": "^3.0.0",
+    "chalk": "^4.1.0",
+    "eslint": "^7.32.0",
+    "readdir": "^1.0.2"
+  },
+  "devDependencies": {
+    "eslint-plugin-jasmine": "^4.1.2",
+    "eslint-plugin-varspacing": "^1.2.2",
+    "ghooks": "^2.0.4",
+    "jasmine": "^3.6.4",
+    "jasmine-node": "^3.0.0",
+    "rmdir": "^1.2.0",
+    "sinon": "^9.2.4",
+    "to-snake-case": "^1.0.0"
+  }
+}

package/scaffold_files/ismllinter.config.js

@@ -1,47 +1,47 @@
-// Please check all available configurations and rules
-// at https://www.npmjs.com/package/isml-linter.
-
-const config = {
-    'rules': {
-
-        // Line by line rules;
-        // 'enforce-isprint'  : {}, // Known issue, will be fixed on v6.0.0;
-        'enforce-require'     : {},
-        'no-br'               : {},
-        'no-git-conflict'     : {},
-        'no-import-package'   : {},
-        'no-inline-style'     : {},
-        'no-isscript'         : {},
-        'no-space-only-lines' : {},
-        'no-tabs'             : {},
-        'no-trailing-spaces'  : {},
-        'max-lines'           : {},
-
-        // Tree rules;
-        'indent'               : {},
-        'no-redundant-context' : {},
-        'leading-iscontent'    : {},
-        'max-depth'            : {},
-        'no-embedded-isml'     : {},
-        'no-hardcode'          : {},
-        'no-require-in-loop'   : {},
-        'one-element-per-line' : {},
-        'leading-iscache'      : {},
-        'no-deprecated-attrs'  : {},
-        'contextual-attrs'     : {},
-        'custom-tags'          : {},
-        'eslint-to-isscript'   : {},
-        'no-iselse-slash'      : {},
-        'empty-eof'            : {},
-        'align-isset'          : {},
-        'disallow-tags'        : {
-            values : ['isscript', 'br', 'style', 'iframe']
-        },
-        'enforce-security'     : {},
-
-        // Other
-        'lowercase-filename' : {}
-    }
-};
-
-module.exports = config;
+// Please check all available configurations and rules
+// at https://www.npmjs.com/package/isml-linter.
+
+const config = {
+    'rules': {
+
+        // Line by line rules;
+        // 'enforce-isprint'  : {}, // Known issue, will be fixed on v6.0.0;
+        'enforce-require'     : {},
+        'no-br'               : {},
+        'no-git-conflict'     : {},
+        'no-import-package'   : {},
+        'no-inline-style'     : {},
+        'no-isscript'         : {},
+        'no-space-only-lines' : {},
+        'no-tabs'             : {},
+        'no-trailing-spaces'  : {},
+        'max-lines'           : {},
+
+        // Tree rules;
+        'indent'               : {},
+        'no-redundant-context' : {},
+        'leading-iscontent'    : {},
+        'max-depth'            : {},
+        'no-embedded-isml'     : {},
+        'no-hardcode'          : {},
+        'no-require-in-loop'   : {},
+        'one-element-per-line' : {},
+        'leading-iscache'      : {},
+        'no-deprecated-attrs'  : {},
+        'contextual-attrs'     : {},
+        'custom-tags'          : {},
+        'eslint-to-isscript'   : {},
+        'no-iselse-slash'      : {},
+        'empty-eof'            : {},
+        'align-isset'          : {},
+        'disallow-tags'        : {
+            values : ['isscript', 'br', 'style', 'iframe']
+        },
+        'enforce-security'     : {},
+
+        // Other
+        'lowercase-filename' : {}
+    }
+};
+
+module.exports = config;

package/src/Builder.js

@@ -1,15 +1,15 @@
-
-const run = path => {
-    const IsmlLinter   = require('./IsmlLinter');
-    const ConsoleUtils = require('./util/ConsoleUtils');
-
-    const lintResults = IsmlLinter.run(path);
-
-    ConsoleUtils.displayOccurrenceList(lintResults);
-
-    return lintResults.issueQty > 0 ? 1 : 0;
-};
-
-module.exports = {
-    run
-};
+
+const run = path => {
+    const IsmlLinter   = require('./IsmlLinter');
+    const ConsoleUtils = require('./util/ConsoleUtils');
+
+    const lintResults = IsmlLinter.run(path);
+
+    ConsoleUtils.displayOccurrenceList(lintResults);
+
+    return lintResults.issueQty > 0 ? 1 : 0;
+};
+
+module.exports = {
+    run
+};

package/src/Constants.js

@@ -1,139 +1,139 @@
-const path    = require('path');
-const appRoot = require('app-root-path');
-const fs      = require('fs');
-const OS_EOL  = require('os').EOL;
-const EOL     = '\n'; // Internal processing line break;
-
-// Environments;
-const ENV_DEV  = 'dev';
-const ENV_TEST = 'test';
-const ENV_PROD = 'prod';
-
-// File names;
-const configFileNameList       = ['ismllinter.config.js', '.ismllinter.json', '.ismllintrc.js'];
-const eslintConfigFileNameList = ['.eslintrc.json', '.eslintrc.js', '.eslintrc'];
-
-const clientAppDir    = appRoot.toString();
-const productionDir   = path.join(clientAppDir, 'node_modules', 'isml-linter');
-const linterModuleDir = fs.existsSync(productionDir) ? productionDir : clientAppDir;
-
-// Directories;
-const specDir                          = path.join(appRoot.toString(), 'spec');
-const specTempDir                      = path.join(specDir, 'temp');
-const specTemplateDir                  = path.join(specDir, 'templates', 'default');
-const specFileParserTemplate           = path.join(specTemplateDir, 'file_parser');
-const specLinterTemplate               = path.join(specTemplateDir, 'isml_linter');
-const specSpecificDirLinterTemplate    = path.join('spec', 'templates', 'default', 'isml_linter', 'specific_directory_to_be_linted');
-const specUnparseableDirLinterTemplate = path.join('spec', 'templates', 'default', 'isml_linter', 'unparseable');
-const specFilenameTemplate             = path.join('spec', 'templates', 'default', 'isml_linter', 'filenames');
-const specConfigTemplate               = path.join('spec', 'templates', 'default', 'config');
-const specIgnoreDirLinterTemplateDir   = path.join(specLinterTemplate, 'ignore_config');
-const specRuleTemplateDir              = path.join(specTemplateDir, 'rules');
-const specIsmlTreeTemplateDir          = path.join(specTemplateDir, 'isml_tree');
-const specIsmlNodeTemplateDir          = path.join(specTemplateDir, 'isml_node');
-const specPublicApiTemplatesDir        = path.join(specTemplateDir, 'public_api');
-const specLineNumberTemplateDir        = path.join(specIsmlTreeTemplateDir, 'line_numbers');
-const specColumnNumberTemplateDir      = path.join(specIsmlTreeTemplateDir, 'column_number');
-const specInvalidTemplateDir           = path.join(specIsmlTreeTemplateDir, 'invalid_templates');
-const specGlobalPosTemplateDir         = path.join(specIsmlTreeTemplateDir, 'global_position');
-const specComplexTemplatesDir          = path.join(specIsmlTreeTemplateDir, 'complex_templates');
-const specElementBalanceTemplatesDir   = path.join(specIsmlTreeTemplateDir, 'element_balance');
-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');
-const treeRulesDir                     = path.join(rulesDir, 'tree');
-
-// Regex;
-const srcJsRegex  = path.join('src', '**', '*.js');
-const appJsRegex  = path.join('src', '**', '*.js');
-const specJsRegex = path.join('spec', '**', '*.js');
-
-// File paths;
-const configFilePathList       = configFileNameList.map( fileName => path.join(clientAppDir, fileName));
-const eslintConfigFilePathList = eslintConfigFileNameList.map( fileName => path.join(clientAppDir, fileName));
-
-// Links;
-const repositoryUrl = 'https://github.com/FabiowQuixada/isml-linter';
-
-// Other;
-const voidElementsArray = [
-    'area', 'base', 'br', 'col',
-    'command', 'embed', 'hr', 'img',
-    'input', 'keygen', 'link', 'meta',
-    'param', 'source', 'track', 'wbr'
-];
-const lineBreak         = {
-    windows : '\r\n',
-    unix    : '\n'
-};
-const occurrenceLevels  = {
-    ERROR    : 'error',
-    WARNINGS : 'warning',
-    INFO     : 'info',
-    toArray  : () => ['info', 'warning', 'error']
-};
-
-const leadingElementsChecking = 4;
-
-module.exports = {
-    // Client directories;
-    clientAppDir,
-
-    // Directories;
-    ismlLinterSpecDir: specLinterTemplate,
-    specSpecificDirLinterTemplate,
-    specUnparseableDirLinterTemplate,
-    specFilenameTemplate,
-    specConfigTemplate,
-    specIgnoreDirLinterTemplateDir,
-    templateParserSpecDir: specFileParserTemplate,
-    specTempDir,
-    rulesDir,
-    specTemplateDir,
-    lineByLineRulesDir,
-    treeRulesDir,
-    specRuleTemplateDir,
-    specPublicApiTemplatesDir,
-    specIsmlTreeTemplateDir,
-    specIsmlNodeTemplateDir,
-    specGlobalPosTemplateDir,
-    specLineNumberTemplateDir,
-    specColumnNumberTemplateDir,
-    specInvalidTemplateDir,
-    specComplexTemplatesDir,
-    specAutofixTemplatesDir,
-    specElementBalanceTemplatesDir,
-    specTailLineNumberTemplatesDir,
-    specDir,
-    linterModuleDir,
-
-    // File names;
-    configFileNameList,
-    eslintConfigFileNameList,
-
-    // File paths;
-    configFilePathList,
-    eslintConfigFilePathList,
-
-    // Regex;
-    srcJsRegex,
-    appJsRegex,
-    specJsRegex,
-
-    // Environments;
-    ENV_DEV,
-    ENV_TEST,
-    ENV_PROD,
-
-    // Links
-    repositoryUrl,
-
-    // Other;
-    voidElementsArray,
-    leadingElementsChecking,
-    occurrenceLevels,
-    EOL,
-    OS_EOL,
-    lineBreak
-};
+const path    = require('path');
+const appRoot = require('app-root-path');
+const fs      = require('fs');
+const OS_EOL  = require('os').EOL;
+const EOL     = '\n'; // Internal processing line break;
+
+// Environments;
+const ENV_DEV  = 'dev';
+const ENV_TEST = 'test';
+const ENV_PROD = 'prod';
+
+// File names;
+const configFileNameList       = ['ismllinter.config.js', '.ismllinter.json', '.ismllintrc.js'];
+const eslintConfigFileNameList = ['.eslintrc.json', '.eslintrc.js', '.eslintrc'];
+
+const clientAppDir    = appRoot.toString();
+const productionDir   = path.join(clientAppDir, 'node_modules', 'isml-linter');
+const linterModuleDir = fs.existsSync(productionDir) ? productionDir : clientAppDir;
+
+// Directories;
+const specDir                          = path.join(appRoot.toString(), 'spec');
+const specTempDir                      = path.join(specDir, 'temp');
+const specTemplateDir                  = path.join(specDir, 'templates', 'default');
+const specFileParserTemplate           = path.join(specTemplateDir, 'file_parser');
+const specLinterTemplate               = path.join(specTemplateDir, 'isml_linter');
+const specSpecificDirLinterTemplate    = path.join('spec', 'templates', 'default', 'isml_linter', 'specific_directory_to_be_linted');
+const specUnparseableDirLinterTemplate = path.join('spec', 'templates', 'default', 'isml_linter', 'unparseable');
+const specFilenameTemplate             = path.join('spec', 'templates', 'default', 'isml_linter', 'filenames');
+const specConfigTemplate               = path.join('spec', 'templates', 'default', 'config');
+const specIgnoreDirLinterTemplateDir   = path.join(specLinterTemplate, 'ignore_config');
+const specRuleTemplateDir              = path.join(specTemplateDir, 'rules');
+const specIsmlTreeTemplateDir          = path.join(specTemplateDir, 'isml_tree');
+const specIsmlNodeTemplateDir          = path.join(specTemplateDir, 'isml_node');
+const specPublicApiTemplatesDir        = path.join(specTemplateDir, 'public_api');
+const specLineNumberTemplateDir        = path.join(specIsmlTreeTemplateDir, 'line_numbers');
+const specColumnNumberTemplateDir      = path.join(specIsmlTreeTemplateDir, 'column_number');
+const specInvalidTemplateDir           = path.join(specIsmlTreeTemplateDir, 'invalid_templates');
+const specGlobalPosTemplateDir         = path.join(specIsmlTreeTemplateDir, 'global_position');
+const specComplexTemplatesDir          = path.join(specIsmlTreeTemplateDir, 'complex_templates');
+const specElementBalanceTemplatesDir   = path.join(specIsmlTreeTemplateDir, 'element_balance');
+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');
+const treeRulesDir                     = path.join(rulesDir, 'tree');
+
+// Regex;
+const srcJsRegex  = path.join('src', '**', '*.js');
+const appJsRegex  = path.join('src', '**', '*.js');
+const specJsRegex = path.join('spec', '**', '*.js');
+
+// File paths;
+const configFilePathList       = configFileNameList.map( fileName => path.join(clientAppDir, fileName));
+const eslintConfigFilePathList = eslintConfigFileNameList.map( fileName => path.join(clientAppDir, fileName));
+
+// Links;
+const repositoryUrl = 'https://github.com/FabiowQuixada/isml-linter';
+
+// Other;
+const voidElementsArray = [
+    'area', 'base', 'br', 'col',
+    'command', 'embed', 'hr', 'img',
+    'input', 'keygen', 'link', 'meta',
+    'param', 'source', 'track', 'wbr'
+];
+const lineBreak         = {
+    windows : '\r\n',
+    unix    : '\n'
+};
+const occurrenceLevels  = {
+    ERROR    : 'error',
+    WARNINGS : 'warning',
+    INFO     : 'info',
+    toArray  : () => ['info', 'warning', 'error']
+};
+
+const leadingElementsChecking = 4;
+
+module.exports = {
+    // Client directories;
+    clientAppDir,
+
+    // Directories;
+    ismlLinterSpecDir: specLinterTemplate,
+    specSpecificDirLinterTemplate,
+    specUnparseableDirLinterTemplate,
+    specFilenameTemplate,
+    specConfigTemplate,
+    specIgnoreDirLinterTemplateDir,
+    templateParserSpecDir: specFileParserTemplate,
+    specTempDir,
+    rulesDir,
+    specTemplateDir,
+    lineByLineRulesDir,
+    treeRulesDir,
+    specRuleTemplateDir,
+    specPublicApiTemplatesDir,
+    specIsmlTreeTemplateDir,
+    specIsmlNodeTemplateDir,
+    specGlobalPosTemplateDir,
+    specLineNumberTemplateDir,
+    specColumnNumberTemplateDir,
+    specInvalidTemplateDir,
+    specComplexTemplatesDir,
+    specAutofixTemplatesDir,
+    specElementBalanceTemplatesDir,
+    specTailLineNumberTemplatesDir,
+    specDir,
+    linterModuleDir,
+
+    // File names;
+    configFileNameList,
+    eslintConfigFileNameList,
+
+    // File paths;
+    configFilePathList,
+    eslintConfigFilePathList,
+
+    // Regex;
+    srcJsRegex,
+    appJsRegex,
+    specJsRegex,
+
+    // Environments;
+    ENV_DEV,
+    ENV_TEST,
+    ENV_PROD,
+
+    // Links
+    repositoryUrl,
+
+    // Other;
+    voidElementsArray,
+    leadingElementsChecking,
+    occurrenceLevels,
+    EOL,
+    OS_EOL,
+    lineBreak
+};