@zohodesk/codestandard-validator 0.0.4-exp-14 → 0.0.4-exp-16

package/build/hooks/Precommit/pre-commit.js

@@ -1,7 +1,8 @@
 "use strict";
 
 const {
-  exec
+  exec,
+  execSync
 } = require('child_process');
 const fs = require('fs');
 const path = require('path');
@@ -87,6 +88,22 @@ function filterDeltedFileFromStagedFiles(files) {
     return false;
   });
 }
+async function lintFiles(filePath) {
+  switch (path.extname(filePath)) {
+    case '.js' || '.ts' || '.tsx' || '.jsx':
+      {
+        return await findEslintErrors(filePath);
+      }
+    case '.css' || '.scss':
+      {
+        return await findStyleLintErrors(filePath);
+      }
+    default:
+      {
+        return [];
+      }
+  }
+}
 
 /**
  * @function findEslintErrors - method  Lint given file based on given configuration
@@ -94,7 +111,7 @@ function filterDeltedFileFromStagedFiles(files) {
  * @returns {Array<string>} -  array of command line report as a string 
  */
 
-async function findEslintErrors(file) {
+function findEslintErrors(file) {
   let nodeModulesPathOfProject = `${getNodeModulesPath()}`;
   let eslintExecutablePath = getEslintExecutablePath();
   let eslintConfigurationFilePath = `${nodeModulesPathOfProject}/.eslintrc.js`;
@@ -121,6 +138,35 @@ async function findEslintErrors(file) {
     Logger.log(Logger.INFO_TYPE, 'node_modules not found');
   }
 }
+
+/**
+ * 
+ * @param {*} params 
+ */
+function findStyleLintErrors(filePath) {
+  const configFilePath = path.resolve(getNodeModulesPath(), '.stylelintrc.json');
+  const absolutePath = path.join(getRootDirectory(), filePath);
+  try {
+    return new Promise((resolve, reject) => {
+      exec(`npx stylelint ${absolutePath} --config ${configFilePath}`, {
+        cwd: getNodeModulesPath()
+      }, (error, stderr, stdout) => {
+        if (stderr) {
+          resolve(stderr.trim().split('\n'));
+        } else if (error) {
+          Logger.log(Logger.FAILURE_TYPE, error);
+          reject("Error executing eslint command");
+        } else {
+          resolve([]);
+        }
+      });
+    });
+  } catch (error) {
+    Logger.log(Logger.FAILURE_TYPE, `Issue is lint css files`);
+    return [];
+  }
+}
+
 /**
  * @function {calculateGitDiffForFile} -  method calculate diff of file
  * @param {*} branch_name - branch name
@@ -157,10 +203,10 @@ function isOnlyWarningsPresentInFile(eslintErrorsPresent) {
   let severityOfEachErrorInFile = [];
   eslintErrorsPresent.map(error => {
     let partsInString = error.split(" ");
-    let severityOfError = partsInString.find(word => word === 'error' || word === 'warning');
+    let severityOfError = partsInString.find(word => word === 'error' || word === 'warning' || word === '✖');
     severityOfEachErrorInFile.push(severityOfError);
   });
-  return !severityOfEachErrorInFile.includes('error');
+  return !(severityOfEachErrorInFile.includes('✖') || severityOfEachErrorInFile.includes('error'));
 }
 
 /**
@@ -193,29 +239,33 @@ async function preCommitHook() {
       try {
         staged_files = await getStagedFiles();
         if (!staged_files.length == 0) {
-          staged_files = filterFiles(staged_files, eslintConfigFiles, true);
+          const {
+            JsFiles: staged_filesJS,
+            CssFiles
+          } = filterFiles(staged_files, eslintConfigFiles, true);
 
-          // staged_files = filterFiles(staged_files,exemptionFiles) //this is the code for giving exemption to a file during pre commit
-          // if(staged_files.length === 0){
+          // staged_filesJS = filterFiles(staged_filesJS,exemptionFiles) //this is the code for giving exemption to a file during pre commit
+          // if(staged_filesJS.length === 0){
           //     Logger.log(Logger.SUCCESS_TYPE,`Commit Successful`)
           //     process.exit(0)
           // }
           areFilesStaged = true;
-          for (let file in staged_files) {
-            let currentFileName = staged_files[file];
+          var stagedFiles = [...staged_filesJS, ...CssFiles];
+          for (let file in stagedFiles) {
+            let currentFileName = stagedFiles[file];
             let changedLinesArray = [];
             let eslintErrorsInChangedLines = [];
             let isOnlyEslintWarningsPresentInFile = false;
-            if (getSupportedLanguage().includes(path.extname(staged_files[file]))) {
+            if (getSupportedLanguage().includes(path.extname(stagedFiles[file]))) {
               try {
-                var eslintErrorsInFile = await findEslintErrors(staged_files[file]);
-                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(eslintErrorsInFile) : eslintErrorsInFile
-                if (staged_files[file] && typeof staged_files[file] == 'string') {
-                  if (!eslintErrorsInFile.length == 0) {
+                var errorsInFile = await lintFiles(stagedFiles[file]);
+                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(errorsInFile) : errorsInFile
+                if (stagedFiles[file] && typeof stagedFiles[file] == 'string') {
+                  if (!errorsInFile.length == 0) {
                     //Calculating changed lines in a file and storing them in respective arrays
                     if (impactBasedPrecommit) {
                       //git diff is computed and stored in an array
-                      let git_diff = await calculateGitDiffForFile(current_branch, staged_files[file]);
+                      let git_diff = await calculateGitDiffForFile(current_branch, stagedFiles[file]);
                       changedLinesArray = git_diff.filter(line => line.startsWith('@@'));
                       let changedLinesStartArray = [];
                       let changedLinesEndArray = [];
@@ -229,15 +279,15 @@ async function preCommitHook() {
                           changedLinesEndArray.push(changesStartLine + parseInt(changesEndLine) - 1);
                         }
                       }
-                      for (let error = 1; error < eslintErrorsInFile.length - 2; error++) {
-                        //eslintErrorsInFile[error].trim() - 69:26  error => Do not hardcode content. Use I18N key instead  no-hardcoding/no-hardcoding, 
-                        //eslintErrorsInFile[error].trim().split(' ')[0] => 69:26
-                        //eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0] => 69
+                      for (let error = 1; error < errorsInFile.length - 2; error++) {
+                        //errorsInFile[error].trim() - 69:26  error => Do not hardcode content. Use I18N key instead  no-hardcoding/no-hardcoding, 
+                        //errorsInFile[error].trim().split(' ')[0] => 69:26
+                        //errorsInFile[error].trim().split(' ')[0].split(':')[0] => 69
 
-                        let eslintErrorLineNumber = eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0];
+                        let eslintErrorLineNumber = errorsInFile[error].trim().split(' ')[0].split(':')[0];
                         for (let lineNumber in changedLinesStartArray) {
                           if (eslintErrorLineNumber >= changedLinesStartArray[lineNumber] && eslintErrorLineNumber <= changedLinesEndArray[lineNumber]) {
-                            eslintErrorsInChangedLines.push(eslintErrorsInFile[error]);
+                            eslintErrorsInChangedLines.push(errorsInFile[error]);
                           }
                         }
                       }
@@ -258,10 +308,10 @@ async function preCommitHook() {
                         }
                       }
                     } else {
-                      if (eslintErrorsInFile.length > 0) {
+                      if (errorsInFile.length > 0) {
                         let startIndex = 1;
-                        let endIndex = eslintErrorsInFile.length - 2;
-                        let listOsEslintErrors = eslintErrorsInFile.slice(startIndex, endIndex);
+                        let endIndex = errorsInFile.length - 2;
+                        let listOsEslintErrors = errorsInFile.slice(startIndex, endIndex);
                         isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(listOsEslintErrors);
                         Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
                         for (let eslintError of listOsEslintErrors) {

package/build/utils/FileAndFolderOperations/filterFiles.js

@@ -3,7 +3,9 @@
 const {
   Logger
 } = require('../Logger/Logger');
-
+const {
+  existsSync
+} = require("fs");
 /**
  * @function filterFiles - removes certain files from set of source files
  * @param {Array} arrayOfFilesToBeFiltered - array of files which must be filtered 
@@ -12,6 +14,29 @@ const {
  * @returns {Array} - containing the resultant set of files after filtering
  */
 function filterFiles(arrayOfFilesToBeFiltered, filesToBeRemoved, isConfigFileNeedToBeRemoved = false) {
+  /**
+   * @function filterFilesByExtension - filter javascript files. omit feature files
+   * @param {Array<String>} lintFiles - linter files as Array
+   * @returns {Array<String>} 
+   * */
+  function filterFilesByExtension(lintFiles) {
+    return lintFiles.reduce((files, currentFile) => {
+      if (currentFile.includes('.feature') && existsSync(currentFile)) {
+        files.featureFiles.push(currentFile);
+      }
+      if (currentFile.includes('.js') || currentFile.includes('.ts') || currentFile.includes('.tsx') || currentFile.includes('.jsx') && existsSync(currentFile)) {
+        files.JsFiles.push(currentFile);
+      }
+      if (currentFile.includes('.css') && existsSync(currentFile)) {
+        files.CssFiles.push(currentFile);
+      }
+      return files;
+    }, {
+      featureFiles: [],
+      JsFiles: [],
+      CssFiles: []
+    });
+  }
   if (filesToBeRemoved.length !== 0) {
     if (isConfigFileNeedToBeRemoved) {
       arrayOfFilesToBeFiltered.filter(file => {
@@ -31,7 +56,7 @@ function filterFiles(arrayOfFilesToBeFiltered, filesToBeRemoved, isConfigFileNee
         return false;
       }
     });
-    return filteredArrayofFilesWithoutConfigFile;
+    return filterFilesByExtension(filteredArrayofFilesWithoutConfigFile);
   } else if (filesToBeRemoved.length === 0) {
     return arrayOfFilesToBeFiltered;
   }

package/build/utils/General/getGeneralInfo.js

@@ -59,6 +59,8 @@ function getSupportedLanguage() {
   _language.push('.jsx');
   _language.push('.ts');
   _language.push('.tsx');
+  _language.push('.css');
+  _language.push('.scss');
   return _language;
 }
 function getRunningEnv() {

package/build/utils/PluginsInstallation/installPlugins.js

@@ -26,7 +26,7 @@ const {
 function installPlugins(pluginsToBeInstalled) {
   // let {uninstalledPlugins : pluginsToBeInstalled} = checkIfPluginsAreInstalled()
   if (pluginsToBeInstalled.length > 0) {
-    let installCommand = `npm install --no-save ${pluginsToBeInstalled.join(' ')}`;
+    let installCommand = `npm install --save ${pluginsToBeInstalled.join(' ')}`;
     Logger.log(Logger.INFO_TYPE, 'Installing plugins ....');
     Logger.log(Logger.INFO_TYPE, `Install command being executed: ${installCommand}`);
     let arePluginsInstalledSuccessfully = executeSynchronizedCommands(execSync, [installCommand, {

package/build/utils/PluginsInstallation/printUninstalledPlugins.js

@@ -15,7 +15,7 @@ function printUninstalledPlugins(uninstalledPlugins, noPluginMessage) {
     uninstalledPlugins.map(plugin => {
       Logger.log(Logger.INFO_TYPE, `"${plugin}"`);
     });
-    // Logger.log(Logger.FAILURE_TYPE, `Kindly execute the command \x1b[37m"${commandToInstallPlugins}\x1b[0m" \x1b[31mfrom the location where package.json of the repo is present to install the plugins`)
+    Logger.log(Logger.FAILURE_TYPE, `Kindly execute the command \x1b[37m"${commandToInstallPlugins}\x1b[0m" \x1b[31mfrom the location where package.json of the repo is present to install the plugins`);
   } else if (uninstalledPlugins.length === 0 && noPluginMessage.trim() === '') {
     Logger.log(Logger.INFO_TYPE, 'Plugins are installed already');
   } else if (uninstalledPlugins.length === 0 && noPluginMessage.trim() !== '') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/codestandard-validator",
-  "version": "0.0.4-exp-14",
+  "version": "0.0.4-exp-16",
   "description": "library to enforce code standard using eslint",
   "main": "index.js",
   "scripts": {