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

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

@@ -12,7 +12,8 @@ const {
   getNodeModulesPath
 } = require('../../utils/General/getNodeModulesPath');
 const {
-  filterFiles
+  filterFiles,
+  filterWarningInFile
 } = require('../../utils/FileAndFolderOperations/filterFiles');
 const {
   Logger
@@ -23,6 +24,14 @@ const {
 const {
   getBranchName
 } = require('../../utils/GitActions/gitActions');
+const {
+  getConfigurationPrecommit,
+  getSupportedLanguage
+} = require('../../utils/General/getGeneralInfo');
+const {
+  impactBasedPrecommit,
+  shouldWarningsAbortCommit
+} = getConfigurationPrecommit();
 
 /**
  * @function isMergeCommit - This method check whether it is merge or not
@@ -122,6 +131,21 @@ function areAllPluginsInstalled() {
   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(eslintErrorsPresentInFile) {
+  let severityOfEachErrorInFile = [];
+  let startIndex = 1;
+  let endIndex = eslintErrorsPresentInFile.length - 2;
+  eslintErrorsPresentInFile.slice(startIndex, endIndex).map(error => {
+    let partsInString = error.split(" ");
+    severityOfEachErrorInFile.push(partsInString[1]);
+  });
+  return severityOfEachErrorInFile.includes('error');
+}
+
 /**
  * @function {preCommitHook} - method execute pre commit hook
  * @returns {void}
@@ -141,6 +165,7 @@ async function preCommitHook() {
       let exemptionFiles = [];
       let current_branch = '';
       let hasEslintErrorsInChangedLines = false;
+      let hasEslintErrorsInFiles = false;
       let areFilesStaged = false;
       try {
         current_branch = await getBranchName();
@@ -162,46 +187,66 @@ async function preCommitHook() {
             let currentFileName = staged_files[file];
             let changedLinesArray = [];
             let eslintErrorsInChangedLines = [];
-            if (path.extname(staged_files[file]) === '.js') {
+            let isOnlyEslintWarningsPresentInFile = false;
+            if (getSupportedLanguage().includes(path.extname(staged_files[file]))) {
               try {
-                let eslintErrorsInFile = await findEslintErrors(staged_files[file]);
+                var eslintErrorsInFile = await findEslintErrors(staged_files[file]);
+                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(eslintErrorsInFile) : eslintErrorsInFile
+                isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(eslintErrorsInFile);
                 if (staged_files[file] && typeof staged_files[file] == 'string') {
                   if (!eslintErrorsInFile.length == 0) {
-                    //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 = [];
-
                     //Calculating changed lines in a file and storing them in respective arrays
-                    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);
+                    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
+                      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]);
+                        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) {
-                      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 (eslintErrorsInChangedLines.length > 0) {
+                        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;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInChangedLines = false;
+                        }
+                      }
+                    } else {
+                      if (eslintErrorsInFile.length > 0) {
+                        Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
+                        for (let eslintError of eslintErrorsInFile) {
+                          Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                        }
+                        if (shouldWarningsAbortCommit) {
+                          hasEslintErrorsInFiles = true;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInFiles = false;
+                        }
                       }
-                      hasEslintErrorsInChangedLines = true;
                     }
                   }
                 }
@@ -217,10 +262,13 @@ async function preCommitHook() {
       } catch {
         Logger.log(Logger.INFO_TYPE, 'Error executing pre commit hook');
       }
-      if (hasEslintErrorsInChangedLines) {
+      if (hasEslintErrorsInChangedLines && areFilesStaged) {
+        Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
+        process.exit(1);
+      } else if (hasEslintErrorsInFiles && areFilesStaged) {
         Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
         process.exit(1);
-      } else if (!hasEslintErrorsInChangedLines && areFilesStaged) {
+      } else if (!hasEslintErrorsInFiles && !hasEslintErrorsInChangedLines && areFilesStaged) {
         Logger.log(Logger.SUCCESS_TYPE, `Commit Successful`);
         process.exit(0);
       }

package/build/setup/sample.config.js

@@ -0,0 +1,36 @@
+"use strict";
+
+const path = require("path");
+
+/**
+ * Configuration object for linting and reporting.
+ * @property {string} ruleConfigurationPath - The path to the ESLint configuration file.
+ * @property {boolean} impactBased - Indicates if the linting is impact-based.
+ * @property {string} lintReportPath - The path to the lint report JSON file.
+ * @property {string} metricServerHost - The URL of the SonarQube server.
+ * @property {string} exemptionInstanceHost -  This is Exemption running host URL
+ * @property {string} metric_token - The token for authentication with the SonarQube server.
+ * @property {string} gitEndPoint - API EndPoint for Git Actions
+ * @property {string} tsConfigurationPath - The path of the ts configuration Path
+ * @property {number} projectId - project id of repository
+ * @property {boolean} impactBasedPrecommit - Indicates if the linting is impact-based in pre commit
+ * @property {string} token - Encrypted Authentication Token
+ * @property {string} compareBranch - Branch to compare diff
+ */
+
+module.exports = {
+  ruleConfigurationPath: path.resolve(process.cwd(), ".eslintrc.js"),
+  impactBased: true,
+  lintReportPath: path.resolve(process.cwd(), "lint-report", "lintReport.json"),
+  metricServerHost: "https://client-linters.zohodesk.csez.zohocorpin.com",
+  exemptionInstanceHost: "",
+  metric_token: "zxh_9737850jh2l53ml17223929ihii73072j54j2260",
+  branchDiffPath: path.resolve(process.cwd(), "diffBranch.json"),
+  gitEndPoint: "https://zgit.csez.zohocorpin.com",
+  tsConfigurationPath: path.resolve(process.cwd(), 'tsconfig.json'),
+  projectId: `project-id`,
+  impactBasedPrecommit: true,
+  shouldWarningsAbortCommit: false,
+  token: "w-OkG3f5OOM1Rkly8phZ",
+  compareBranch: 'release'
+};

package/build/utils/FileAndFolderOperations/filterFiles.js

@@ -36,6 +36,15 @@ function filterFiles(arrayOfFilesToBeFiltered, filesToBeRemoved, isConfigFileNee
     return arrayOfFilesToBeFiltered;
   }
 }
+
+/**
+ * @function filterWarningInFile - filter warning in files
+ * @returns {Array<string>}
+ */
+function filterWarningInFile(array) {
+  // handle error in file 
+}
 module.exports = {
-  filterFiles
+  filterFiles,
+  filterWarningInFile
 };

package/build/utils/General/getGeneralInfo.js

@@ -1,6 +1,8 @@
 "use strict";
 
 const os = require('os');
+const path = require('path');
+const fs = require("fs");
 
 /**
  * @function getTimeStampInfo - to fetch various timestamp details
@@ -25,7 +27,40 @@ function getTimeStampInfo() {
 function getEnv() {
   return os.type();
 }
+
+/**
+ * @function getConfigPath - get a path of lint configuration path
+ * @returns {string}
+ */
+function getConfigPath() {
+  const configPath = path.resolve(process.cwd(), 'lint.config.js');
+  const defaultConfigPath = path.resolve(__dirname, '..', '..', 'setup', 'sample.config.js');
+  return fs.exitSync(configPath) ? configPath : defaultConfigPath;
+}
+
+/**
+ * @function getConfiguration - get configuration object of lint configuration
+ * @returns
+ */
+function getConfigurationPrecommit() {
+  return require(getConfigPath());
+}
+
+/**
+ * @function getSupportedLanguage - get support language
+ * @returns {Array<string>}
+ */
+function getSupportedLanguage() {
+  const _language = [];
+  _language.push('.js');
+  _language.push('.jsx');
+  _language.push('.ts');
+  _language.push('.tsx');
+  return _language;
+}
 module.exports = {
+  getSupportedLanguage,
   getTimeStampInfo,
-  getEnv
+  getEnv,
+  getConfigurationPrecommit
 };

package/build/utils/HuskySetup/setupHusky.js

@@ -4,17 +4,21 @@
 const {
   execSync
 } = require('child_process');
+const {
+  readdirSync
+} = require('fs');
+const path = require('path');
 const initializeHusky = require('./initializeHusky');
 const configurePrecommitHook = require('./configurePrecommitHook');
+const {
+  getNodeModulesPath
+} = require('../General/getNodeModulesPath');
 const {
   executeSynchronizedCommands
 } = require('../General/executeSyncCommands');
 const {
   Logger
 } = require('../Logger/Logger');
-const {
-  getRootDirectory
-} = require('../General/RootDirectoryUtils/getRootDirectory');
 let isCustomPrecommitConfigurationSuccessful = false;
 
 /**
@@ -49,25 +53,16 @@ function setupHusky() {
  * @returns {boolean} - indicating if husky package installed successfully or not
  */
 function installHuskyPackage() {
-  // checking globally so removed
-  // const nodeModulesPathOfProject = path.join(getNodeModulesPath(),'node_modules')
-  // let pluginsInNodeModules = executeSynchronizedCommands(readdirSync,[nodeModulesPathOfProject],'','Unable to get directories in node_modules when checking if husky is installed',true,false)
+  const nodeModulesPathOfProject = path.join(getNodeModulesPath(), 'node_modules');
+  let pluginsInNodeModules = executeSynchronizedCommands(readdirSync, [nodeModulesPathOfProject], '', 'Unable to get directories in node_modules when checking if husky is installed', true, false);
   let husky = {
     packageName: 'husky',
-    version: '7.0.4'
+    version: '^7.0.4'
   };
-
-  // let isHuskyInstalled = pluginsInNodeModules.includes(husky.packageName) ? true : false
-  try {
-    const huskyVersion = execSync("husky -v", {
-      cwd: getRootDirectory()
-    }).toString();
-    if (!(huskyVersion.trim() == husky.version)) {
-      throw new Error("error");
-    }
-  } catch {
+  let isHuskyInstalled = pluginsInNodeModules.includes(husky.packageName) ? true : false;
+  if (!isHuskyInstalled) {
     Logger.log(Logger.INFO_TYPE, 'Installing husky package ....');
-    let installCommand = `npm install ${husky.packageName}@${husky.version} --save-dev --save-exact -g`;
+    let installCommand = `npm install ${husky.packageName}@${husky.version} --save-dev`;
     let isHuskyPackageInstalled = executeSynchronizedCommands(execSync, [installCommand, {
       stdio: 'inherit'
     }], 'Husky package Installed Successfully', 'Unable to install husky package', false, true);

package/package.json

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