@zohodesk/codestandard-validator 0.0.3 → 0.0.4

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,17 @@ const {
 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
@@ -53,7 +65,7 @@ async function getStagedFiles() {
       if (error) {
         if (error != null) reject("Couldn't fetch staged files");
       } else if (stderr) {
-        resolve(stderr.trim().split('\n'));
+        resolve(filterDeltedFileFromStagedFiles(stderr.trim().split('\n')));
       } else if (stdout.trim() === '') {
         resolve(stdout.trim());
       }
@@ -61,6 +73,21 @@ async function getStagedFiles() {
   });
 }
 
+/**
+ * @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
@@ -122,6 +149,20 @@ 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(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}
@@ -141,7 +182,9 @@ async function preCommitHook() {
       let exemptionFiles = [];
       let current_branch = '';
       let hasEslintErrorsInChangedLines = false;
+      let hasEslintErrorsInFiles = false;
       let areFilesStaged = false;
+      let shouldAbortCommit = false;
       try {
         current_branch = await getBranchName();
       } catch {
@@ -162,46 +205,78 @@ 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
                 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) {
+                        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;
+                        }
                       }
-                      hasEslintErrorsInChangedLines = true;
                     }
                   }
                 }
@@ -217,10 +292,10 @@ async function preCommitHook() {
       } catch {
         Logger.log(Logger.INFO_TYPE, 'Error executing pre commit hook');
       }
-      if (hasEslintErrorsInChangedLines) {
-        Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
+      if (shouldAbortCommit) {
+        Logger.log(Logger.FAILURE_TYPE, `There are eslint errors/warnings present. So commit is aborted.`);
         process.exit(1);
-      } else if (!hasEslintErrorsInChangedLines && areFilesStaged) {
+      } else if (shouldAbortCommit === false && staged_files.length !== 0) {
         Logger.log(Logger.SUCCESS_TYPE, `Commit Successful`);
         process.exit(0);
       }

package/build/setup/sample.config.js

@@ -0,0 +1,37 @@
+"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 {boolean} shouldWarningsAbortCommit - Indicates if eslint warnings should abort the 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/CloneCommonLinterRepo/cloneViaCdt.js

@@ -16,21 +16,41 @@ const {
 const {
   executeSynchronizedCommands
 } = require('../General/executeSyncCommands');
-const {
+var {
   type,
   endPoint,
   branch,
   cacheDirectory,
-  commonLinterRepoName
+  commonLinterRepoName,
+  user
 } = require('../../../jsonUtils/commonLinterRepoDetails');
+const {
+  getConfigurationPrecommit,
+  getRunningEnv
+} = require("../General/getGeneralInfo");
+const {
+  decrypt
+} = require("../General/Hash");
+const {
+  Logger
+} = require("../Logger/Logger");
 /**
  * @function cloneViaCdt - Using the "clint development tool" clones the common linter_configuration repo into precommit library
  * @returns {boolean} - indicating the success or failure of the cloning process
  */
 
 function cloneViaCdt() {
+  const {
+    token
+  } = getConfigurationPrecommit();
   removeFolder(getDeleteDirPath());
-  const commandToCloneCommonConfigRepo = `npx cdt clone --clone:type=${type} --clone:url=${endPoint} --clone:branch=${branch} --clone:cacheDir=${cacheDirectory} --clone:proj:name=${commonLinterRepoName}`;
+  const userName = user;
+  var absoluteEndPoint = `https://${endPoint}`;
+  if (getRunningEnv() === "CI") {
+    Logger.log(Logger.INFO_TYPE, `Running in CI`);
+    absoluteEndPoint = `https://${userName}:${decrypt(token, 12)}@${endPoint}`;
+  }
+  var commandToCloneCommonConfigRepo = `npx cdt clone --clone:type=${type} --clone:url=${absoluteEndPoint} --clone:branch=${branch} --clone:cacheDir=${cacheDirectory} --clone:proj:name=${commonLinterRepoName}`;
   let isCommonConfigurationClonedSuccessfully = executeSynchronizedCommands(execSync, [commandToCloneCommonConfigRepo, {
     cwd: getClonedDirPath()
   }], `Lint Configuration Cloned Successfully - ${getRepoName() || 'common'}`, 'Could not clone the linters common repo', false, true);

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/Hash.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.encrypt = exports.decrypt = void 0;
+const caesarCipher = (str, shift) => {
+  return str.split("").map(char => {
+    let code = char.charCodeAt();
+    if (code >= 65 && code <= 90) {
+      return String.fromCharCode((code - 65 + shift) % 26 + 65);
+    } else if (code >= 97 && code <= 122) {
+      return String.fromCharCode((code - 97 + shift) % 26 + 97);
+    }
+    return char;
+  }).join("");
+};
+const encrypt = (plaintext, shift) => caesarCipher(plaintext, shift);
+exports.encrypt = encrypt;
+const decrypt = (ciphertext, shift) => caesarCipher(ciphertext, 26 - shift);
+exports.decrypt = decrypt;

package/build/utils/General/getGeneralInfo.js

@@ -1,6 +1,11 @@
 "use strict";
 
 const os = require('os');
+const path = require('path');
+const fs = require("fs");
+const {
+  execSync
+} = require('child_process');
 
 /**
  * @function getTimeStampInfo - to fetch various timestamp details
@@ -25,7 +30,47 @@ 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.existsSync(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;
+}
+function getRunningEnv() {
+  const command = "npm config get lint_env";
+  return execSync(command, {
+    shell: true
+  }).toString().trim();
+}
 module.exports = {
+  getSupportedLanguage,
   getTimeStampInfo,
-  getEnv
+  getEnv,
+  getConfigurationPrecommit,
+  getRunningEnv
 };

package/build/utils/HuskySetup/initializeHusky.js

@@ -23,7 +23,7 @@ function initializeHusky() {
   let isNavigationToRootDirectorySuccessful = navigateToRootDirectory(getRootDirectory());
   if (isNavigationToRootDirectorySuccessful) {
     try {
-      execSync('npx husky@7 install');
+      execSync('npx husky install');
       return true;
     } catch (error) {
       Logger.log(Logger.FAILURE_TYPE, error.toString());

package/build/utils/HuskySetup/setupHusky.js

@@ -1,8 +1,21 @@
 "use strict";
 
 /* eslint-disable no-console */
+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');
@@ -13,21 +26,51 @@ let isCustomPrecommitConfigurationSuccessful = false;
  * @returns {boolean} - indicating whether entire custom precommit hook setup using husky process is success or failure
  */
 function setupHusky() {
-  let isHuskyInitializedSuccessfully = initializeHusky();
-  if (isHuskyInitializedSuccessfully) {
-    Logger.log(Logger.SUCCESS_TYPE, 'Husky installation successful');
-    isCustomPrecommitConfigurationSuccessful = configurePrecommitHook();
-    if (isCustomPrecommitConfigurationSuccessful) {
-      Logger.log(Logger.SUCCESS_TYPE, 'Custom pre commit hook setup was successful');
-      return true;
+  let isHuskyPackageInstalled = installHuskyPackage();
+  if (isHuskyPackageInstalled) {
+    let isHuskyInitializedSuccessfully = initializeHusky();
+    if (isHuskyInitializedSuccessfully) {
+      Logger.log(Logger.SUCCESS_TYPE, 'Husky installation successful');
+      isCustomPrecommitConfigurationSuccessful = configurePrecommitHook();
+      if (isCustomPrecommitConfigurationSuccessful) {
+        Logger.log(Logger.SUCCESS_TYPE, 'Custom pre commit hook setup was successful');
+        return true;
+      } else {
+        Logger.log(Logger.FAILURE_TYPE, 'Couldn\'t configure custom pre commit hook');
+        return false;
+      }
     } else {
-      Logger.log(Logger.FAILURE_TYPE, 'Couldn\'t configure custom pre commit hook');
       return false;
     }
   } else {
+    Logger.log(Logger.FAILURE_TYPE, 'Some issue in installing husky package.');
     return false;
   }
 }
+
+/**
+ * @function installHuskyPackage - installs husky package if not installed for the project
+ * @returns {boolean} - indicating if husky package installed successfully or not
+ */
+function installHuskyPackage() {
+  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'
+  };
+  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`;
+    let isHuskyPackageInstalled = executeSynchronizedCommands(execSync, [installCommand, {
+      stdio: 'inherit'
+    }], 'Husky package Installed Successfully', 'Unable to install husky package', false, true);
+    return isHuskyPackageInstalled;
+  }
+  Logger.log(Logger.SUCCESS_TYPE, 'Husky package already installed!');
+  return true;
+}
 module.exports = {
   setupHusky
 };

package/changeLog.md

@@ -12,5 +12,11 @@
  3. Based on the cloned configuration folder creates a eslint config file
  4. Checks for eslint rule violations in the staged files(Impact based) and aborts/allows commit accordingly
 
- # 0.0.3 - modifications in usage of Husky package
- 1. The husky package is not installed and the required huksy package version is temporarily downloaded from npm registry and used 
+# 0.0.3 - minor issue fix
+
+# 0.0.4 - configuration based Execution 
+
+1. Avoid linting deleted files that have been staged.
+2. Added configuration for linting based on impacted lines or the entire file.
+3. Added configuration to abort commits if there are warnings or issues.
+4. Environment-specific clone configuration added.

package/jsonUtils/commonLinterRepoDetails.js

@@ -9,9 +9,10 @@
  */
 
 module.exports =  {
-  endPoint: "https://zgit.csez.zohocorpin.com/code_standard/client_linter/linter_configuration.git",
+  endPoint: "zgit.csez.zohocorpin.com/code_standard/client_linter/linter_configuration.git",
   branch: "master",
   cacheDirectory: "./",
   commonLinterRepoName: "configuration",
-  type: "git"
+  type: "git",
+  user:"rajasekar.hm"
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/codestandard-validator",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "library to enforce code standard using eslint",
   "main": "index.js",
   "scripts": {
@@ -16,12 +16,12 @@
   "type": "commonjs",
   "dependencies": {
     "@zohodesk-private/client_deployment_tool": "0.0.5",
-    "eslint": "^8.26.0"
+    "eslint": "8.26.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/plugin-transform-runtime": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
-    "husky": "^7.0.4"
+    "@babel/core": "7.24.7",
+    "@babel/plugin-transform-runtime": "7.24.7",
+    "@babel/preset-env": "7.24.7",
+    "husky": "7.0.4"
   }
 }