@zohodesk/codestandard-validator 0.0.7-exp-5 → 0.0.7-exp-7

package/bin/execute.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../build/hooks/Precommit/pre-commit')
+require('../build/hooks/hook')

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

@@ -144,19 +144,24 @@ function findEslintErrors(file) {
  * @param {*} params 
  */
 function findStyleLintErrors(filePath) {
-  const configFilePath = path.resolve(getNodeModulesPath(), '.stylelintrc.json');
+  const configFilePath = path.resolve(getNodeModulesPath(), '.stylelintrc.js');
   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) {
+        if (stdout) {
           resolve(stderr.trim().split('\n'));
-        } else if (error) {
-          Logger.log(Logger.FAILURE_TYPE, error);
-          reject("Error executing eslint command");
-        } else {
+        }
+        // if(stderr){
+        //     resolve(stderr.trim().split('\n'))
+        // }
+        // else if(error){
+        //     Logger.log(Logger.FAILURE_TYPE,error)
+        //     reject("Error executing eslint command")
+        // }
+        else {
           resolve([]);
         }
       });

package/build/lib/postinstall.js

@@ -7,8 +7,8 @@ const {
   setupHusky
 } = require("../utils/HuskySetup/setupHusky");
 const {
-  createEslintConfigFile
-} = require("../utils/EslintConfigFileUtils/createEslintConfigFile");
+  createConfigFile
+} = require("../utils/ConfigFileUtils/createConfigFile");
 const {
   Logger
 } = require("../utils/Logger/Logger");
@@ -34,7 +34,7 @@ async function postInstall() {
     await executeMethodsThatReturnBooleanValue("Some issue in writing node_modules path to json", writeFsPaths, null);
     isGitInitialized() ? await executeMethodsThatReturnBooleanValue("Some issue occurred in setting up husky.", setupHusky, null) : null;
     await executeMethodsThatReturnBooleanValue("Make sure zgit.csez.zohocorpin.com is accessible", cloneViaCdt, null);
-    await executeMethodsThatReturnBooleanValue("Some issue occurred in creating eslint config file.", createEslintConfigFile, null);
+    await executeMethodsThatReturnBooleanValue("Some issue occurred in creating eslint config file.", createConfigFile, null);
     Logger.log(Logger.SUCCESS_TYPE, "Pre commit setup successfull");
     arePluginsInstalled();
   } catch (error) {

package/build/utils/CloneCommonLinterRepo/cloneViaCdt.js

@@ -16,14 +16,6 @@ const {
 const {
   executeSynchronizedCommands
 } = require('../General/executeSyncCommands');
-var {
-  type,
-  endPoint,
-  branch,
-  cacheDirectory,
-  commonLinterRepoName,
-  user
-} = require('../../../jsonUtils/commonLinterRepoDetails');
 const {
   getConfigurationPrecommit,
   getRunningEnv
@@ -34,28 +26,49 @@ const {
 const {
   Logger
 } = require("../Logger/Logger");
+const {
+  type,
+  endPoint,
+  branch,
+  cacheDirectory,
+  commonLinterRepoName,
+  user
+} = require('../../../jsonUtils/commonLinterRepoDetails');
+
 /**
- * @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
+ * @description Clones the common linter configuration repo using Clint Development Tool (CDT)
+ * @returns {boolean} Indicates the success or failure of the cloning process
  */
-
 function cloneViaCdt() {
-  const {
-    token
-  } = getConfigurationPrecommit();
-  removeFolder(getDeleteDirPath());
-  const userName = user;
-  var absoluteEndPoint = `https://${endPoint}`;
-  const runningEnv = getRunningEnv();
-  if (runningEnv === "CI" || runningEnv === "DEVAUTOMATION") {
-    Logger.log(Logger.INFO_TYPE, `Running in ${runningEnv}`);
-    absoluteEndPoint = `https://${userName}:${decrypt(token, process.env.DECRYPT_TOKEN || 12)}@${endPoint}`;
+  try {
+    const {
+      token
+    } = getConfigurationPrecommit();
+    const currentEnv = getRunningEnv();
+    Logger.log(Logger.INFO_TYPE, `Running in environment: ${currentEnv}`);
+
+    // Clean up existing folder
+    const deleteDir = getDeleteDirPath();
+    removeFolder(deleteDir);
+
+    // Construct endpoint with credentials if in CI or automation
+    const isAutomatedEnv = currentEnv === "CI" || currentEnv === "DEVAUTOMATION";
+    const authenticatedEndpoint = isAutomatedEnv ? `https://${user}:${decrypt(token, 12)}@${endPoint}` : `https://${endPoint}`;
+    const cloneCommand = ['npx cdt clone', `--clone:type=${type}`, `--clone:url=${authenticatedEndpoint}`, `--clone:branch=${branch}`, `--clone:cacheDir=${cacheDirectory}`, `--clone:proj:name=${commonLinterRepoName}`].join(' ');
+
+    // Execute the CDT command
+    const clonedDir = getClonedDirPath();
+    const successMessage = `Lint Configuration Cloned Successfully - ${getRepoName() || 'common'}`;
+    const errorMessage = 'Could not clone the linters common repo';
+    const result = executeSynchronizedCommands(execSync, [cloneCommand, {
+      cwd: clonedDir
+    }], successMessage, errorMessage, false, true);
+    return result;
+  } catch (error) {
+    Logger.log(Logger.ERROR_TYPE, `cloneViaCdt failed: ${error.message}`);
+    return false;
   }
-  var commandToCloneCommonConfigRepo = `npx cdt clone --clone:type=${type} --clone:url=${absoluteEndPoint} --clone:branch=${process.env.CONFIGURATION_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);
-  return isCommonConfigurationClonedSuccessfully;
 }
 module.exports = {
   cloneViaCdt

package/build/utils/ConfigFileUtils/createConfigFile.js

@@ -0,0 +1,63 @@
+"use strict";
+
+const path = require('path');
+const {
+  writeFileSync,
+  existsSync,
+  unlinkSync,
+  readFileSync
+} = require('fs');
+const {
+  getNodeModulesPath
+} = require('../General/getNodeModulesPath.js');
+const {
+  Logger
+} = require('../Logger/Logger.js');
+const {
+  executeSynchronizedCommands
+} = require('../General/executeSyncCommands.js');
+const {
+  getServicePathElseCommon
+} = require('./getLintConfiguration.js');
+
+/**
+ * @function createConfigFile - creates ESLint and/or Stylelint configuration files based on repo config.
+ * @returns {boolean} - true if any config file is created successfully, false otherwise.
+ */
+function createConfigFile() {
+  const nodeModulesPath = getNodeModulesPath();
+  const eslintConfigFilePath = path.join(nodeModulesPath, '.eslintrc.js');
+  const stylelintConfigFilePath = path.join(nodeModulesPath, '.stylelintrc.js');
+  const {
+    pathOfServiceSpecificEslintConfigFile,
+    pathOfServiceSpecificCssConfigFile
+  } = getServicePathElseCommon();
+  try {
+    const eslintConfig = executeSynchronizedCommands(readFileSync, [pathOfServiceSpecificEslintConfigFile, 'utf-8'], '', 'Unable to read content of eslint config file.', true, false);
+    const cssConfig = executeSynchronizedCommands(readFileSync, [pathOfServiceSpecificCssConfigFile, 'utf-8'], '', 'Unable to read content of stylelint config file.', true, false);
+    const cssCreated = handleConfigFile(stylelintConfigFilePath, cssConfig, 'Stylelint');
+    const eslintCreated = handleConfigFile(eslintConfigFilePath, eslintConfig, 'Eslint');
+    return cssCreated || eslintCreated;
+  } catch (error) {
+    Logger.log(Logger.FAILURE_TYPE, error);
+    Logger.log(Logger.FAILURE_TYPE, 'Issue occurred while generating config files.');
+    return false;
+  }
+}
+
+/**
+ * @function handleConfigFile - handles deletion (if exists) and creation of config files.
+ * @param {string} filePath - Path to the config file.
+ * @param {string} configContent - Configuration content.
+ * @param {string} type - Type of configuration (e.g., Eslint, Stylelint).
+ * @returns {boolean}
+ */
+function handleConfigFile(filePath, configContent, type) {
+  if (existsSync(filePath)) {
+    executeSynchronizedCommands(unlinkSync, [filePath], `${type} configuration file removed successfully!`, `Unable to remove the ${type.toLowerCase()} config file.`, false, false);
+  }
+  return executeSynchronizedCommands(writeFileSync, [filePath, configContent, 'utf-8'], `${type} configuration file created successfully!`, `Unable to create and write a ${type.toLowerCase()} configuration file.`, false, true);
+}
+module.exports = {
+  createConfigFile
+};

package/build/utils/ConfigFileUtils/getEslintExecutablePath.js

@@ -0,0 +1,24 @@
+"use strict";
+
+const path = require('path');
+const {
+  readdirSync
+} = require('fs');
+const {
+  getNodeModulesPath
+} = require('../General/getNodeModulesPath');
+const {
+  executeSynchronizedCommands
+} = require('../General/executeSyncCommands');
+const {
+  getLibraryInstalledLocation
+} = require('../General/getLibraryInstalledLocation');
+function getEslintExecutablePath() {
+  let eslintLibraryName = 'eslint';
+  let librariesInNodeModulesOfProject = executeSynchronizedCommands(readdirSync, [path.join(getNodeModulesPath(), 'node_modules')], '', 'Unable to get the plugins inside node_modules', true, false);
+  let isEslintInstalledinProject = librariesInNodeModulesOfProject.some(library => library === eslintLibraryName);
+  return isEslintInstalledinProject ? path.join(getNodeModulesPath(), 'node_modules', eslintLibraryName, 'bin', 'eslint.js') : path.join(getLibraryInstalledLocation(), 'node_modules', eslintLibraryName, 'bin', 'eslint.js');
+}
+module.exports = {
+  getEslintExecutablePath
+};

package/build/utils/ConfigFileUtils/getLintConfiguration.js

@@ -0,0 +1,54 @@
+"use strict";
+
+const path = require('path');
+const {
+  existsSync
+} = require('fs');
+const {
+  endPoint,
+  commonLinterRepoName
+} = require("../../../jsonUtils/commonLinterRepoDetails.js");
+const {
+  getRepoName
+} = require('../GitActions/gitActions.js');
+const {
+  getLibraryInstalledLocation
+} = require('../General/getLibraryInstalledLocation.js');
+const {
+  executeMethodsThatMayThrowException
+} = require("../General/wrapperFunctionToExecuteAFunction.js");
+
+/**
+ * @function getLintConfiguration - returns eslint configuration file from common linters repo
+ * @returns {object} - containing properties of the eslint configuration file
+ */
+function getServicePathElseCommon() {
+  const repoName = getRepoName();
+  const libraryInstalledLocation = getLibraryInstalledLocation();
+  let commonConfigPath = path.join(libraryInstalledLocation, commonLinterRepoName, 'common', 'index.js');
+  const _configurationPath = repoName && existsSync(path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, 'index.js')) ? path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, 'index.js') : commonConfigPath;
+  let _pathOfServiceSpecificEslintConfigFile = repoName && existsSync(path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, '.eslintrc.js')) ? path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, '.eslintrc.js') : path.join(libraryInstalledLocation, commonLinterRepoName, 'common', '.eslintrc.js');
+  let _pluginVersionPath = repoName && existsSync(path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, 'pluginVersion.js')) ? path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, 'pluginVersion.js') : undefined;
+  let _cssLintConfig = repoName && existsSync(path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, '.stylelintrc.js')) ? path.join(libraryInstalledLocation, commonLinterRepoName, 'services', repoName, '.stylelintrc.js') : path.join(libraryInstalledLocation, commonLinterRepoName, 'common', '.stylelintrc.js');
+  return {
+    configurationPath: _configurationPath,
+    pathOfServiceSpecificEslintConfigFile: _pathOfServiceSpecificEslintConfigFile,
+    pluginVersionPath: _pluginVersionPath,
+    pathOfServiceSpecificCssConfigFile: _cssLintConfig
+  };
+}
+function getLintConfigurationUtil() {
+  const {
+    configurationPath
+  } = getServicePathElseCommon();
+  const exceptionHandleObject = {
+    rulesConfig: [{}, {}],
+    plugins: [],
+    extendPlugins: []
+  };
+  return executeMethodsThatMayThrowException(exceptionHandleObject, `Kindly Ensure that Configuration is setup in Configuration repo \n ${endPoint}`, require, configurationPath);
+}
+module.exports = {
+  getLintConfigurationUtil,
+  getServicePathElseCommon
+};

package/build/utils/General/getGeneralInfo.js

@@ -6,6 +6,10 @@ const fs = require("fs");
 const {
   execSync
 } = require('child_process');
+const {
+  readOnlyToken,
+  commitHashEndPoint
+} = require('../../../jsonUtils/commonLinterRepoDetails');
 
 /**
  * @function getTimeStampInfo - to fetch various timestamp details
@@ -72,10 +76,42 @@ function getRunningEnv() {
     shell: true
   }).toString().trim();
 }
+
+/**
+ * @function getLastCommitHash - Fetches the last commit hash from a GitLab project using its API.
+ * 
+ * @note This function assumes access to a specific GitLab instance and a hardcoded token and project ID.
+ * @returns {string} The latest commit hash (SHA) from the specified GitLab repository.
+ * @throws {Error} Will throw an error if the API request fails or returns unexpected data.
+ */
+
+function getLastCommitHash() {
+  try {
+    var _JSON$parse$;
+    const cmd = `curl --header "PRIVATE-TOKEN: ${readOnlyToken}" --url ${commitHashEndPoint}`;
+    return (_JSON$parse$ = JSON.parse(execSync(cmd))[0]) === null || _JSON$parse$ === void 0 ? void 0 : _JSON$parse$.id;
+  } catch (err) {
+    Logger.log(Logger.FAILURE_TYPE, err);
+    return null;
+  }
+}
+
+/**
+ * @function getStoredCommitHash - Loads and returns the stored commit hash from `fsUtils.json`.
+ * @returns {string} The commit hash stored in the `fsUtils.json` file.
+ * @throws {Error} Will throw if the file does not exist or does not contain a `commitHash` key.
+ */
+
+function getStoredCommitHash() {
+  const commitInfoPath = path.join(__dirname, '..', '..', '..', 'jsonUtils', 'fsUtils.json');
+  return fs.existsSync(commitInfoPath) && require(commitInfoPath).commitHash;
+}
 module.exports = {
   getSupportedLanguage,
   getTimeStampInfo,
   getEnv,
   getConfigurationPrecommit,
-  getRunningEnv
+  getRunningEnv,
+  getLastCommitHash,
+  getStoredCommitHash
 };

package/build/utils/General/writeProjectDetailsToJson.js

@@ -7,9 +7,13 @@ const {
 const {
   executeSynchronizedCommands
 } = require('./executeSyncCommands');
+const {
+  getLastCommitHash
+} = require('./getGeneralInfo');
 function writeFsPaths() {
   var fileContent = {
-    nodeModulesPath: path.resolve(process.cwd(), '..', '..', '..')
+    nodeModulesPath: path.resolve(process.cwd(), '..', '..', '..'),
+    commitHash: getLastCommitHash()
   };
   return executeSynchronizedCommands(writeFileSync, [path.join(process.cwd(), 'jsonUtils', 'fsUtils.json'), JSON.stringify(fileContent), 'utf-8'], 'node_modules path updated in json file', 'Unable to write node_modules path to json file', false, true);
 }

package/build/utils/PluginsInstallation/arePluginsInstalled.js

@@ -14,11 +14,11 @@ function arePluginsInstalled() {
     uninstalledPlugins,
     noPluginMessage
   } = checkIfPluginsAreInstalled();
-  // let areAllPluginsInstalled = uninstalledPlugins.length === 0 ? true : false
-  // if(!areAllPluginsInstalled){
-  //     installPlugins(uninstalledPlugins)
-  // }
-  printUninstalledPlugins(uninstalledPlugins, noPluginMessage);
+  let areAllPluginsInstalled = uninstalledPlugins.length === 0 ? true : false;
+  if (!areAllPluginsInstalled) {
+    installPlugins(uninstalledPlugins);
+  }
+  // printUninstalledPlugins(uninstalledPlugins,noPluginMessage)
 }
 module.exports = {
   arePluginsInstalled

package/build/utils/PluginsInstallation/checkIfPluginsAreInstalled.js

@@ -21,7 +21,7 @@ const {
 } = require('../General/wrapperFunctionToExecuteAFunction');
 const {
   getServicePathElseCommon
-} = require('../EslintConfigFileUtils/getLintConfiguration');
+} = require('../ConfigFileUtils/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)

package/build/utils/PrecommitUsingGitSetup/update-git-precommithook.js

@@ -1,37 +1,44 @@
-"use strict";
-
-const {
-  existsSync
-} = require("fs");
-const {
-  getRootDirectory
-} = require('../General/RootDirectoryUtils/getRootDirectory');
-const {
-  getNodeModulesPath
-} = require('../General/getNodeModulesPath');
-const path = require('path');
-const fs = require('fs');
-function getCustomPrecommitHookPath() {
-  return path.resolve(getNodeModulesPath(), "node_modules", "@zohodesk", "codestandard-validator", "bin", "execute.js");
-}
-
 /**
- * @function updateGitFile - updates default precommit hook provided by git with the custom precommit hook file
- * @returns {null}
+ * @note currently dead code but helps in future
  */
-function updateGitFile() {
-  const preCommit_File_Path_Default = path.resolve(getRootDirectory(), '.git', 'hooks', 'pre-commit.sample');
-  let preCommit_File_Path = path.join(path.dirname(preCommit_File_Path_Default), 'pre-commit');
-  if (existsSync(preCommit_File_Path_Default)) {
-    fs.writeFileSync(preCommit_File_Path_Default, `#!/bin/sh${getCustomPrecommitHookPath()}`);
-    fs.renameSync(preCommit_File_Path_Default, preCommit_File_Path);
-    return;
-  }
-  if (existsSync(preCommit_File_Path)) {
-    fs.appendFileSync(preCommit_File_Path, `\n${getCustomPrecommitHookPath()}`);
-    return;
-  }
-}
-module.exports = {
-  updateGitFile
-};
+
+// const { existsSync } = require("fs")
+// const { getRootDirectory }  = require('../General/RootDirectoryUtils/getRootDirectory')
+// const { getNodeModulesPath } = require('../General/getNodeModulesPath')
+// const path = require('path')
+// const fs = require('fs')
+
+// function getCustomPrecommitHookPath(){
+//     return path.resolve(
+//         getNodeModulesPath(),
+//         "node_modules",
+//         "@zohodesk",
+//         "codestandard-validator",
+//         "bin",
+//         "execute.js",
+//     );
+// }
+
+// /**
+//  * @function updateGitFile - updates default precommit hook provided by git with the custom precommit hook file
+//  * @returns {null}
+//  */
+// function updateGitFile(){
+//     const preCommit_File_Path_Default = path.resolve(getRootDirectory(),'.git','hooks','pre-commit.sample')
+//     let   preCommit_File_Path = path.join(path.dirname(preCommit_File_Path_Default),'pre-commit')
+//     if(existsSync(preCommit_File_Path_Default)){
+//         fs.writeFileSync(preCommit_File_Path_Default,`#!/bin/sh${getCustomPrecommitHookPath()}`)
+//         fs.renameSync(preCommit_File_Path_Default,preCommit_File_Path)
+//         return;
+//     }
+
+//     if(existsSync(preCommit_File_Path)){
+//         fs.appendFileSync(preCommit_File_Path,`\n${getCustomPrecommitHookPath()}`)
+//         return;
+//     }
+// }
+
+// module.exports = {
+//     updateGitFile
+// }
+"use strict";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/codestandard-validator",
-  "version": "0.0.7-exp-5",
+  "version": "0.0.7-exp-7",
   "description": "library to enforce code standard using eslint",
   "main": "index.js",
   "scripts": {
@@ -16,7 +16,8 @@
   "type": "commonjs",
   "dependencies": {
     "@zohodesk-private/client_deployment_tool": "0.0.5",
-    "eslint": "8.26.0"
+    "eslint": "8.26.0",
+    "stylelint":"16.23.0"
   },
   "devDependencies": {
     "@babel/core": "7.24.7",