@zohodesk/codestandard-validator 0.0.6-exp-6 → 0.0.6-exp-8

package/build/hooks/Precommit/lint.js

@@ -0,0 +1,310 @@
+"use strict";
+
+const {
+  exec
+} = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const {
+  getEslintExecutablePath
+} = require('../../utils/EslintConfigFileUtils/getEslintExecutablePath');
+const {
+  getNodeModulesPath
+} = require('../../utils/General/getNodeModulesPath');
+const {
+  filterFiles,
+  filterWarningInFile
+} = require('../../utils/FileAndFolderOperations/filterFiles');
+const {
+  Logger
+} = require('../../utils/Logger/Logger');
+const {
+  checkIfPluginsAreInstalled
+} = require('../../utils/PluginsInstallation/checkIfPluginsAreInstalled');
+const {
+  getBranchName
+} = require('../../utils/GitActions/gitActions');
+const {
+  getConfigurationPrecommit,
+  getSupportedLanguage
+} = require('../../utils/General/getGeneralInfo');
+const {
+  getRootDirectory
+} = require('../../utils/General/RootDirectoryUtils/getRootDirectory');
+const {
+  impactBasedPrecommit,
+  shouldWarningsAbortCommit
+} = getConfigurationPrecommit();
+
+/**
+ * @function isMergeCommit - This method check whether it is merge or not
+ * @returns {Boolean} -  return boolean based on latest merge changes
+ */
+async function isMergeCommit() {
+  return new Promise((resolve, reject) => {
+    exec('git rev-parse -q --verify MERGE_HEAD', (error, stderr, stdout) => {
+      if (error) {
+        reject(error.toString().trim());
+      } else if (stderr) {
+        resolve(stderr.trim());
+      } else if (stdout) {
+        resolve(stdout.trim());
+      }
+    });
+  });
+}
+
+/**
+ * @function {getStagedFiles} - methods return staged files
+ * @returns {Array<string>} -  array of  files
+ */
+
+async function getStagedFiles() {
+  return new Promise((resolve, reject) => {
+    exec("git diff --staged --name-only", (error, stderr, stdout) => {
+      if (error) {
+        if (error != null) reject("Couldn't fetch staged files");
+      } else if (stderr) {
+        resolve(filterDeltedFileFromStagedFiles(stderr.trim().split('\n')));
+      } else if (stdout.trim() === '') {
+        resolve(stdout.trim());
+      }
+    });
+  });
+}
+
+/**
+ * @function {filterDeltedFileFromStagedFiles} - filter deleted staged files
+ * @param {Array<string>} files - staged files
+ * @returns 
+ */
+function filterDeltedFileFromStagedFiles(files) {
+  return files.filter(file => {
+    const absolutePath = path.resolve(getRootDirectory(), file);
+    if (fs.existsSync(absolutePath)) {
+      return true;
+    }
+    return false;
+  });
+}
+
+/**
+ * @function findEslintErrors - method  Lint given file based on given configuration
+ * @param {*} file - path of file to lint
+ * @returns {Array<string>} -  array of command line report as a string 
+ */
+
+async function findEslintErrors(file) {
+  let nodeModulesPathOfProject = `${getNodeModulesPath()}`;
+  let eslintExecutablePath = getEslintExecutablePath();
+  let eslintConfigurationFilePath = `${nodeModulesPathOfProject}/.eslintrc.js`;
+  let isEslintExecutablePresent = fs.existsSync(eslintExecutablePath) ? true : false;
+  let isNodeModulesPresent = fs.existsSync(nodeModulesPathOfProject);
+  if (isNodeModulesPresent) {
+    if (isEslintExecutablePresent) {
+      return new Promise((resolve, reject) => {
+        exec(`npx --ignore-existing "${eslintExecutablePath}" --config "${eslintConfigurationFilePath}" --no-inline-config --resolve-plugins-relative-to="${nodeModulesPathOfProject}/node_modules" ${file}`, (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([]);
+          }
+        });
+      });
+    } else {
+      Logger.log(Logger.INFO_TYPE, 'Eslint executable not found. make sure eslint plugin is installed');
+    }
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'node_modules not found');
+  }
+}
+/**
+ * @function {calculateGitDiffForFile} -  method calculate diff of file
+ * @param {*} branch_name - branch name
+ * @param {*} file - path of file
+ * @returns {Promise<Array<string>>} - array of command line report as a string 
+ */
+async function calculateGitDiffForFile(branch_name, file) {
+  let gitDiffCommand = `git diff -U0 ${branch_name.trim()} ${file}`;
+  return new Promise((resolve, reject) => {
+    exec(gitDiffCommand, (error, stderr) => {
+      if (stderr) {
+        resolve(stderr.trim().split('\n'));
+      } else if (error) {
+        reject(error);
+      }
+    });
+  });
+}
+/**
+ * @function {areAllPluginsInstalled} -  method whether plugin is installed or not
+ * @returns {Boolean} - return boolean based on plugin installed or not
+ */
+
+function areAllPluginsInstalled() {
+  let unInstalledPlugins = checkIfPluginsAreInstalled().uninstalledPlugins;
+  return unInstalledPlugins.length === 0 ? true : false;
+}
+
+/**
+ * @function {isOnlyWarningsPresentInFile} - method that checks if only eslint warnings are present in a file
+ * @returns {Boolean} - returns boolean based on only warnings present or not in file
+ */
+function isOnlyWarningsPresentInFile(eslintErrorsPresent) {
+  let severityOfEachErrorInFile = [];
+  eslintErrorsPresent.map(error => {
+    let partsInString = error.split(" ");
+    let severityOfError = partsInString.find(word => word === 'error' || word === 'warning');
+    severityOfEachErrorInFile.push(severityOfError);
+  });
+  return !severityOfEachErrorInFile.includes('error');
+}
+
+/**
+ * @function {preCommitHook} - method execute pre commit hook
+ * @returns {void}
+ */
+
+async function preCommitHook() {
+  Logger.log(Logger.INFO_TYPE, 'Executing pre commit hook...');
+  Logger.log(Logger.INFO_TYPE, `working dir  : ${process.cwd()}`);
+  try {
+    let isMerge = await isMergeCommit();
+    Logger.log(Logger.INFO_TYPE, 'Looks like you have merged. So skipping pre commit check');
+    process.exit(0);
+  } catch (error) {
+    if (areAllPluginsInstalled()) {
+      let staged_files = [];
+      let eslintConfigFiles = ['.eslintrc.js'];
+      let exemptionFiles = [];
+      let current_branch = '';
+      let hasEslintErrorsInChangedLines = false;
+      let hasEslintErrorsInFiles = false;
+      let areFilesStaged = false;
+      let shouldAbortCommit = false;
+      try {
+        current_branch = await getBranchName();
+      } catch {
+        Logger.log(Logger.INFO_TYPE, "Error fetching current branch");
+      }
+      try {
+        staged_files = await getStagedFiles();
+        if (!staged_files.length == 0) {
+          staged_files = 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){
+          //     Logger.log(Logger.SUCCESS_TYPE,`Commit Successful`)
+          //     process.exit(0)
+          // }
+          areFilesStaged = true;
+          for (let file in staged_files) {
+            let currentFileName = staged_files[file];
+            let changedLinesArray = [];
+            let eslintErrorsInChangedLines = [];
+            let isOnlyEslintWarningsPresentInFile = false;
+            if (getSupportedLanguage().includes(path.extname(staged_files[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) {
+                    //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]);
+                      changedLinesArray = git_diff.filter(line => line.startsWith('@@'));
+                      let changedLinesStartArray = [];
+                      let changedLinesEndArray = [];
+                      for (let number of changedLinesArray) {
+                        let changesStartLine = parseInt(number.split(' ')[2].split(',')[0]);
+                        changedLinesStartArray.push(changesStartLine);
+                        let changesEndLine = number.split(' ')[2].split(',')[1];
+                        if (changesEndLine === undefined) {
+                          changedLinesEndArray.push(changesStartLine);
+                        } else {
+                          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
+
+                        let eslintErrorLineNumber = eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0];
+                        for (let lineNumber in changedLinesStartArray) {
+                          if (eslintErrorLineNumber >= changedLinesStartArray[lineNumber] && eslintErrorLineNumber <= changedLinesEndArray[lineNumber]) {
+                            eslintErrorsInChangedLines.push(eslintErrorsInFile[error]);
+                          }
+                        }
+                      }
+                      if (eslintErrorsInChangedLines.length > 0) {
+                        isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(eslintErrorsInChangedLines);
+                        Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
+                        for (let eslintError of eslintErrorsInChangedLines) {
+                          Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                        }
+                        if (shouldWarningsAbortCommit) {
+                          hasEslintErrorsInChangedLines = true;
+                          shouldAbortCommit = true;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInChangedLines = false;
+                        } else if (!shouldWarningsAbortCommit && !isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInChangedLines = true;
+                          shouldAbortCommit = true;
+                        }
+                      }
+                    } else {
+                      if (eslintErrorsInFile.length > 0) {
+                        let startIndex = 1;
+                        let endIndex = eslintErrorsInFile.length - 2;
+                        let listOsEslintErrors = eslintErrorsInFile.slice(startIndex, endIndex);
+                        isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(listOsEslintErrors);
+                        Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
+                        for (let eslintError of listOsEslintErrors) {
+                          Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                        }
+                        if (shouldWarningsAbortCommit) {
+                          hasEslintErrorsInFiles = true;
+                          shouldAbortCommit = true;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInFiles = false;
+                        } else if (!shouldWarningsAbortCommit && !isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInFiles = true;
+                          shouldAbortCommit = true;
+                        }
+                      }
+                    }
+                  }
+                }
+              } catch (err) {
+                Logger.log(Logger.FAILURE_TYPE, err);
+                Logger.log(Logger.FAILURE_TYPE, "Error in executing eslint command");
+              }
+            }
+          }
+        } else if (staged_files.length === 0) {
+          Logger.log(Logger.INFO_TYPE, 'No files have been staged. Stage your files before committing');
+        }
+      } catch {
+        Logger.log(Logger.INFO_TYPE, 'Error executing pre commit hook');
+      }
+      if (shouldAbortCommit) {
+        Logger.log(Logger.FAILURE_TYPE, `There are eslint errors/warnings present. So commit is aborted.`);
+        process.exit(1);
+      } else if (shouldAbortCommit === false && staged_files.length !== 0) {
+        Logger.log(Logger.SUCCESS_TYPE, `Commit Successful`);
+        process.exit(0);
+      }
+    } else {
+      Logger.log(Logger.FAILURE_TYPE, 'Commit failed since some eslint plugins are not installed');
+      Logger.log(Logger.INFO_TYPE, `Kindly execute the command \x1b[37mnpx ZDPrecommit setupPlugins \x1b[33mfrom the location where package.json is present to install the plugins`);
+      Logger.log(Logger.INFO_TYPE, 'Execute the command and kindly try committing again.');
+      process.exit(1);
+    }
+  }
+}
+preCommitHook();

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

@@ -19,9 +19,6 @@ const {
 const {
   arePluginsInstalled
 } = require("../../utils/PluginsInstallation/arePluginsInstalled");
-const {
-  default: prePushCheck
-} = require("../PrePush/pre-push");
 async function validateRemotePackages() {
   try {
     if (!(getStoredCommitHash() == getLastCommitHash())) {
@@ -36,5 +33,5 @@ async function validateRemotePackages() {
 }
 (async function () {
   await validateRemotePackages();
-  await prePushCheck();
+  require('./lint');
 })();

package/build/utils/FileAndFolderOperations/versionControl.js

@@ -16,14 +16,13 @@ const {
 function createVersionControlFile(uninstalledPlugins) {
   Logger.log(Logger.INFO_TYPE, `Rule Plugin Versions are Noted in pluginVersionControl.js`);
   const versionfilePath = path.join(getNodeModulesPath(), 'node_modules', '@zohodesk', 'codestandard-validator', 'pluginVersionControl.js');
-  if (existsSync(versionfilePath)) {
-    writeFileSync(versionfilePath, `module.exports.plugins = [${uninstalledPlugins.map(plugin => {
-      return JSON.stringify({
-        plugin: `${plugin}`,
-        time: `${new Date()}`
-      });
-    }).join(',')}]`);
-  }
+  existsSync(versionfilePath) && writeFileSync(versionfilePath, '');
+  writeFileSync(versionfilePath, `module.exports.plugins = [${uninstalledPlugins.map(plugin => {
+    return JSON.stringify({
+      plugin: `${plugin}`,
+      time: `${new Date()}`
+    });
+  }).join(',')}]`);
 }
 module.exports = {
   createVersionControlFile

package/build/utils/HuskySetup/configurePrecommitHook.js

@@ -21,33 +21,17 @@ const {
  */
 function configurePrecommitHook() {
   let rootDirectory = getRootDirectory();
-  let customPrecomitHookPath = path.join(getLibraryInstalledLocation(), "bin", "precommit.js");
-
-  // let customPrePushHookPath = path.join(
-  //   getLibraryInstalledLocation(),
-  //   "bin",
-  //   "push.js"
-  // );
-
+  let customPrecomitHookPath = path.join(getLibraryInstalledLocation(), "bin", "execute.js");
   let huskyPrecommitPath = path.join(rootDirectory, ".husky", "pre-commit");
-  // let huskyPrePushPath  = path.join(rootDirectory,".husky","pre-push")  
   let huskyPrecommitHookContent = `#!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
 "${customPrecomitHookPath}"
 `;
-
-  //   let huskyPrePushHookContent = `#!/bin/sh
-  // . "$(dirname "$0")/_/husky.sh"
-
-  // "${customPrePushHookPath}"
-  // ` 
   let isCustomPrecommitConfigurationSuccessful = executeSynchronizedCommands(writeFileSync, [huskyPrecommitPath, huskyPrecommitHookContent, 'utf-8'], '', 'Could not create and write pre-commit.sh inisde husky directory', false, true);
-  // let isCustomPrePushConfigurationSuccessful = executeSynchronizedCommands(writeFileSync, [huskyPrePushPath, huskyPrePushHookContent, 'utf-8'], '', 'Could not create and write pre-push.sh inisde husky directory', false, true);
   if (isCustomPrecommitConfigurationSuccessful) {
-    let isExecutionPermissionGivenSuccessfully_precommit = grantExecutionPermission([huskyPrecommitPath, customPrecomitHookPath]);
-    // let isExecutionPermissionGivenSuccessfully_prepush = grantExecutionPermission([huskyPrePushPath, customPrePushHookPath]);
-    return isExecutionPermissionGivenSuccessfully_precommit;
+    let isExecutionPermissionGivenSuccessfully = grantExecutionPermission([huskyPrecommitPath, customPrecomitHookPath]);
+    return isExecutionPermissionGivenSuccessfully;
   } else {
     return false;
   }

package/build/utils/PluginsInstallation/checkIfPluginsAreInstalled.js

@@ -1,22 +1,15 @@
 "use strict";
 
 const {
-  readdirSync,
   existsSync
 } = require('fs');
 const path = require('path');
-const {
-  getNodeModulesPath
-} = require('../General/getNodeModulesPath');
 const {
   Logger
 } = require('../Logger/Logger');
 const {
   getLibraryInstalledLocation
 } = require('../General/getLibraryInstalledLocation');
-const {
-  executeSynchronizedCommands
-} = require('../General/executeSyncCommands');
 const {
   endPoint,
   commonLinterRepoName
@@ -27,32 +20,6 @@ const {
 const {
   getServicePathElseCommon
 } = require('../EslintConfigFileUtils/getLintConfiguration');
-function getUnInstalledPlugins(pluginsForCurrentRepo, pluginNamesOfDevDependencyPlugins, devDependencies) {
-  let pluginsInNodeModules = executeSynchronizedCommands(readdirSync, [path.join(getNodeModulesPath(), 'node_modules')], '', 'Unable to get the plugins inside node_modules', true, false);
-  let pluginsToBeInstalled = [];
-  pluginsForCurrentRepo.filter(plugin => {
-    if (plugin.packageName.startsWith('@')) {
-      let scope = plugin.packageName.split('/')[0];
-      let pluginName = plugin.packageName.split('/')[1];
-      let scopedPlugins = executeSynchronizedCommands(readdirSync, [path.join(getNodeModulesPath(), 'node_modules', scope)], '', 'Unable to get the plugins inside the scope inside node_modules', true, false);
-      let isPluginInstalled = scopedPlugins.includes(pluginName) ? true : false;
-      if (!isPluginInstalled) {
-        pluginsToBeInstalled.push(`${plugin.packageName}@${plugin.version}`);
-      }
-    } else {
-      let isPluginInstalled = pluginsInNodeModules.includes(plugin.packageName) ? true : false;
-      if (!isPluginInstalled) {
-        pluginsToBeInstalled.push(`${plugin.packageName}@${plugin.version}`);
-      }
-    }
-    if (pluginNamesOfDevDependencyPlugins.includes(plugin.packageName)) {
-      if (plugin.version !== devDependencies[plugin.packageName]) {
-        pluginsToBeInstalled.push(`${plugin.packageName}@${plugin.version}`);
-      }
-    }
-  });
-  return pluginsToBeInstalled;
-}
 function getAllPlugins() {
   let serviceSpecificPlugins = [];
   const pathToCommonPluginsFile = path.join(getLibraryInstalledLocation(), commonLinterRepoName, 'common', 'pluginVersion.js');
@@ -79,29 +46,6 @@ function checkIfPluginsAreInstalled() {
     noPluginMessage: '',
     uninstalledPlugins: []
   };
-  // let pluginsIndevDependencies = {}
-  // let pluginNamesOfDevDependencyPlugins = []
-  // let arePluginsPresentIndevDependencies = false
-  // var arePluginsPresentForCurrentRepo = false
-
-  // if(existsSync(path.join(getNodeModulesPath(),'package.json'))){
-  //     let packageJsonContent = require(path.join(getNodeModulesPath(),'package.json'))
-  //     pluginsIndevDependencies = packageJsonContent.devDependencies
-
-  //     if(pluginsIndevDependencies !== undefined){
-  //         arePluginsPresentIndevDependencies = true
-  //         pluginNamesOfDevDependencyPlugins = Object.keys(pluginsIndevDependencies)
-  //     }
-  //     else if(pluginsIndevDependencies === undefined){
-  //         Logger.log(Logger.INFO_TYPE,'No devDependencies present!')
-  //     }
-  // }
-  // else{
-  //     arePluginsPresentIndevDependencies = false
-  // }
-
-  // arePluginsPresentForCurrentRepo = pluginsForCurrentRepo.length !== 0 ? true : false
-
   uninstalledPlugins = pluginsForCurrentRepo.map(plugin => {
     const {
       packageName,
@@ -117,7 +61,6 @@ function checkIfPluginsAreInstalled() {
     return `${packageName}@${version}`;
   }).filter(Boolean);
   if (uninstalledPlugins.length > 0) {
-    // uninstalledPlugins = getUnInstalledPlugins(pluginsForCurrentRepo, pluginNamesOfDevDependencyPlugins, pluginsIndevDependencies);
     plugin.noPluginMessage = '';
     plugin.uninstalledPlugins = uninstalledPlugins;
     return plugin;

package/package.json

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

package/bin/push.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-
-// require('../build/hooks/PrePush/pre-push')