@zohodesk/codestandard-validator 0.0.7 → 1.0.0-exp-1

package/build/hooks/Precommit/utils.js

@@ -0,0 +1,56 @@
+"use strict";
+
+const {
+  exec
+} = require("child_process");
+const {
+  promisify
+} = require("util");
+const fs = require("fs");
+const path = require("path");
+const {
+  getRootDirectory
+} = require("../../utils/General/RootDirectoryUtils/getRootDirectory");
+const {
+  checkIfPluginsAreInstalled
+} = require("../../utils/PluginsInstallation/checkIfPluginsAreInstalled");
+const execAsync = promisify(exec);
+async function isMergeCommit() {
+  try {
+    const {
+      stdout
+    } = await execAsync("git rev-parse -q --verify MERGE_HEAD");
+    return Boolean(stdout.trim());
+  } catch {
+    return false;
+  }
+}
+async function getStagedFiles() {
+  try {
+    const {
+      stdout
+    } = await execAsync("git diff --staged --name-only");
+    const files = stdout.trim().split("\n").filter(Boolean);
+    return files.filter(file => fs.existsSync(path.resolve(getRootDirectory(), file)));
+  } catch {
+    throw new Error("Couldn't fetch staged files");
+  }
+}
+function areAllPluginsInstalled() {
+  return checkIfPluginsAreInstalled().uninstalledPlugins.length === 0;
+}
+function isOnlyWarnings(errors) {
+  return !errors.some(line => /\b(error|✖)\b/.test(line));
+}
+function extractDiffHunks(diffText) {
+  return diffText.split("\n").filter(line => line.startsWith("@@") || line.startsWith("+") || line.startsWith("-"))
+  // skip file headers like "+++ b/" or "--- a/"
+  .filter(line => !line.startsWith("+++ ") && !line.startsWith("--- ")).join("\n");
+}
+module.exports = {
+  isMergeCommit,
+  isOnlyWarnings,
+  areAllPluginsInstalled,
+  getStagedFiles,
+  extractDiffHunks
+};

package/build/hooks/hook.js

@@ -0,0 +1,40 @@
+"use strict";
+
+const {
+  getLastCommitHash,
+  getStoredCommitHash,
+  updateJsonFile
+} = require("../utils/General/getGeneralInfo");
+const {
+  executeMethodsThatReturnBooleanValue
+} = require("../utils/General/wrapperFunctionToExecuteAFunction");
+const {
+  cloneViaCdt
+} = require("../utils/CloneCommonLinterRepo/cloneViaCdt");
+const {
+  getPluginsToInstall
+} = require("../utils/PluginsInstallation/checkIfPluginsAreInstalled");
+const {
+  installPlugins
+} = require("../utils/PluginsInstallation/installPlugins");
+const path = require("path");
+const {
+  Logger
+} = require("../utils/Logger/Logger");
+async function hooks() {
+  var jsonFilePath = path.join(__dirname, '..', '..', 'jsonUtils', 'fsUtils.json');
+  if (!(getLastCommitHash() == getStoredCommitHash())) {
+    updateJsonFile(jsonFilePath, data => {
+      data.commitHash = getLastCommitHash();
+      return data;
+    });
+    Logger.log(Logger.INFO_TYPE, `Some rules and plugins are being fetched from a remote source and installed...`);
+    await executeMethodsThatReturnBooleanValue("Make sure zgit.csez.zohocorpin.com is accessible", cloneViaCdt, null);
+    const {
+      uninstalledPlugins
+    } = getPluginsToInstall();
+    await executeMethodsThatReturnBooleanValue("Some issue occurred in installing plugins", installPlugins, uninstalledPlugins);
+  }
+  require('./Precommit/commit');
+}
+hooks();

package/build/lib/cli.js

@@ -16,7 +16,7 @@ const {
   installPlugins
 } = require("../utils/PluginsInstallation/installPlugins");
 const {
-  checkIfPluginsAreInstalled
+  getPluginsToInstall
 } = require("../utils/PluginsInstallation/checkIfPluginsAreInstalled");
 const [,, action, ...options] = process.argv;
 async function run() {
@@ -35,7 +35,7 @@ async function run() {
       {
         const {
           uninstalledPlugins
-        } = checkIfPluginsAreInstalled();
+        } = getPluginsToInstall();
         await executeMethodsThatReturnBooleanValue("Some issue occurred in installing plugins", installPlugins, uninstalledPlugins);
         break;
       }

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)}@${endPoint}`;
+  try {
+    const {
+      token
+    } = getConfigurationPrecommit();
+    const currentEnv = getRunningEnv();
+    Logger.log(Logger.INFO_TYPE, `Application is running in the following 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/getLintConfiguration.js

@@ -29,12 +29,12 @@ function getServicePathElseCommon() {
   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 _stylelintPath = 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');
+  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,
-    cssLintConfig: _stylelintPath
+    pathOfServiceSpecificCssConfigFile: _cssLintConfig
   };
 }
 function getLintConfigurationUtil() {

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') || currentFile.includes('.properties') && 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

@@ -6,6 +6,13 @@ const fs = require("fs");
 const {
   execSync
 } = require('child_process');
+const {
+  readOnlyToken,
+  commitHashEndPoint
+} = require('../../../jsonUtils/commonLinterRepoDetails');
+const {
+  Logger
+} = require('../Logger/Logger');
 
 /**
  * @function getTimeStampInfo - to fetch various timestamp details
@@ -57,8 +64,14 @@ function getSupportedLanguage() {
   const {
     supportedExtensions
   } = getConfigurationPrecommit();
-  const _language = supportedExtensions;
-  return _language;
+  const _language = supportedExtensions || [];
+  _language.push('.js');
+  _language.push('.jsx');
+  _language.push('.ts');
+  _language.push('.tsx');
+  _language.push('.css');
+  _language.push('.scss');
+  return [...new Set(_language)];
 }
 function getRunningEnv() {
   const command = "npm config get lint_env";
@@ -66,10 +79,58 @@ 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 = getJsonUtilsPath();
+  return fs.existsSync(commitInfoPath) && require(commitInfoPath).commitHash;
+}
+function getJsonUtilsPath() {
+  return path.join(__dirname, '..', '..', '..', 'jsonUtils', 'fsUtils.json');
+}
+function updateJsonFile(filePath, modifier) {
+  try {
+    const absolutePath = path.resolve(filePath);
+    const rawData = fs.readFileSync(absolutePath, "utf-8");
+    const jsonData = JSON.parse(rawData);
+    const updatedData = modifier(jsonData);
+    fs.writeFileSync(absolutePath, JSON.stringify(updatedData, null, 2), "utf-8");
+  } catch (error) {
+    Logger.log(Logger.FAILURE_TYPE, "Error updating JSON file");
+  }
+}
 module.exports = {
   getSupportedLanguage,
   getTimeStampInfo,
   getEnv,
   getConfigurationPrecommit,
-  getRunningEnv
+  getRunningEnv,
+  getLastCommitHash,
+  getStoredCommitHash,
+  getJsonUtilsPath,
+  updateJsonFile
 };

package/build/utils/General/getNodeModulesPath.js

@@ -1,13 +1,16 @@
 "use strict";
 
 const path = require('path');
+const {
+  getJsonUtilsPath
+} = require('./getGeneralInfo');
 
 /**
  * @function getNodeModulesPath - fetches the absolute path where node_modules of project is present
  * @returns {string} - path where node_modules of the project is present
  */
 function getNodeModulesPath() {
-  return require(path.join(__dirname, '..', '..', '..', 'jsonUtils', 'fsUtils.json')).nodeModulesPath;
+  return require(getJsonUtilsPath()).nodeModulesPath;
 }
 module.exports = {
   getNodeModulesPath

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

@@ -1,11 +1,8 @@
 "use strict";
 
 const {
-  checkIfPluginsAreInstalled
+  getPluginsToInstall
 } = require('./checkIfPluginsAreInstalled');
-const {
-  printUninstalledPlugins
-} = require('./printUninstalledPlugins');
 const {
   installPlugins
 } = require('./installPlugins');
@@ -13,12 +10,11 @@ function arePluginsInstalled() {
   let {
     uninstalledPlugins,
     noPluginMessage
-  } = checkIfPluginsAreInstalled();
+  } = getPluginsToInstall();
   let areAllPluginsInstalled = uninstalledPlugins.length === 0 ? true : false;
   if (!areAllPluginsInstalled) {
     installPlugins(uninstalledPlugins);
   }
-  // printUninstalledPlugins(uninstalledPlugins,noPluginMessage)
 }
 module.exports = {
   arePluginsInstalled

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
@@ -26,33 +19,7 @@ const {
 } = require('../General/wrapperFunctionToExecuteAFunction');
 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;
-}
+} = require('../ConfigFileUtils/getLintConfiguration');
 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,
@@ -110,14 +54,42 @@ function checkIfPluginsAreInstalled() {
     const {
       isPluginPresent,
       pluginPath
-    } = checkPluginsPresentInNodemodules(packageName);
+    } = checkPluginsPresentInNodemodules(packageName); // circular installation loop so comment out
     if (isPluginPresent && checkPluginHasProperVersion(packageName, pluginPath, version)) {
       return false;
     }
     return `${packageName}@${version}`;
   }).filter(Boolean);
   if (uninstalledPlugins.length > 0) {
-    // uninstalledPlugins = getUnInstalledPlugins(pluginsForCurrentRepo, pluginNamesOfDevDependencyPlugins, pluginsIndevDependencies);
+    plugin.noPluginMessage = '';
+    plugin.uninstalledPlugins = uninstalledPlugins;
+    return plugin;
+  } else {
+    plugin.noPluginMessage = 'No plugins present for the repository';
+    plugin.uninstalledPlugins = [];
+    return plugin;
+  }
+}
+
+/**
+ * @function getPluginsToInstall - plugins need for this repository
+ * @returns {Array<String>}
+ */
+function getPluginsToInstall() {
+  const pluginsForCurrentRepo = getAllPlugins();
+  var uninstalledPlugins = [];
+  var plugin = {
+    noPluginMessage: '',
+    uninstalledPlugins: []
+  };
+  uninstalledPlugins = pluginsForCurrentRepo.map(plugin => {
+    const {
+      packageName,
+      version
+    } = plugin;
+    return `${packageName}@${version}`;
+  }).filter(Boolean);
+  if (uninstalledPlugins.length > 0) {
     plugin.noPluginMessage = '';
     plugin.uninstalledPlugins = uninstalledPlugins;
     return plugin;
@@ -173,5 +145,6 @@ function checkPluginHasProperVersion(rulePluginName, installationPath, remotePlu
   return remotePluginExactVersion == packageJsonPluginExactVersion ? true : false;
 }
 module.exports = {
+  getPluginsToInstall,
   checkIfPluginsAreInstalled
 };