@zohodesk/codestandard-validator 0.0.4 → 0.0.6

package/build/lib/cli.js

@@ -15,6 +15,9 @@ const {
 const {
   installPlugins
 } = require("../utils/PluginsInstallation/installPlugins");
+const {
+  checkIfPluginsAreInstalled
+} = require("../utils/PluginsInstallation/checkIfPluginsAreInstalled");
 const [,, action, ...options] = process.argv;
 async function run() {
   switch (action) {
@@ -30,7 +33,10 @@ async function run() {
       }
     case "setupPlugins":
       {
-        await executeMethodsThatReturnBooleanValue("Some issue occurred in installing plugins", installPlugins, null);
+        const {
+          uninstalledPlugins
+        } = checkIfPluginsAreInstalled();
+        await executeMethodsThatReturnBooleanValue("Some issue occurred in installing plugins", installPlugins, uninstalledPlugins);
         break;
       }
     case "setupExtension":

package/build/lib/postinstall.js

@@ -35,7 +35,7 @@ async function postInstall() {
     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);
-    Logger.log(Logger.SUCCESS_TYPE, "Pre commit setup successful");
+    Logger.log(Logger.SUCCESS_TYPE, "Pre commit setup successfull");
     arePluginsInstalled();
   } catch (error) {
     Logger.log(Logger.FAILURE_TYPE, `Kindly retry npm install. & ${error.message}`);

package/build/setup/sample.config.js

@@ -8,7 +8,7 @@ const path = require("path");
  * @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} meticHandler_api_token -  The token for authentication with the SonarQube server.
  * @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
@@ -24,7 +24,7 @@ module.exports = {
   impactBased: true,
   lintReportPath: path.resolve(process.cwd(), "lint-report", "lintReport.json"),
   metricServerHost: "https://client-linters.zohodesk.csez.zohocorpin.com",
-  exemptionInstanceHost: "",
+  meticHandler_api_token: "oyRcKJZxm2RkXytfAzVtmyRlLIftou5anC==",
   metric_token: "zxh_9737850jh2l53ml17223929ihii73072j54j2260",
   branchDiffPath: path.resolve(process.cwd(), "diffBranch.json"),
   gitEndPoint: "https://zgit.csez.zohocorpin.com",
@@ -33,5 +33,6 @@ module.exports = {
   impactBasedPrecommit: true,
   shouldWarningsAbortCommit: false,
   token: "w-OkG3f5OOM1Rkly8phZ",
-  compareBranch: 'release'
+  compareBranch: 'release',
+  supportedExtensions: ['.js', '.jsx', '.ts', '.tsx', '.properties']
 };

package/build/utils/CloneCommonLinterRepo/cloneViaCdt.js

@@ -46,8 +46,9 @@ function cloneViaCdt() {
   removeFolder(getDeleteDirPath());
   const userName = user;
   var absoluteEndPoint = `https://${endPoint}`;
-  if (getRunningEnv() === "CI") {
-    Logger.log(Logger.INFO_TYPE, `Running in CI`);
+  const runningEnv = getRunningEnv();
+  if (runningEnv === "CI" || runningEnv === "DEVAUTOMATION") {
+    Logger.log(Logger.INFO_TYPE, `Running in ${runningEnv}`);
     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}`;

package/build/utils/FileAndFolderOperations/versionControl.js

@@ -0,0 +1,30 @@
+"use strict";
+
+const path = require('path');
+const {
+  getNodeModulesPath
+} = require('../General/getNodeModulesPath');
+const {
+  writeFileSync
+} = require('fs');
+const {
+  Logger
+} = require('../Logger/Logger');
+const {
+  existsSync
+} = require("fs");
+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(',')}]`);
+  }
+}
+module.exports = {
+  createVersionControlFile
+};

package/build/utils/General/getGeneralInfo.js

@@ -54,11 +54,10 @@ function getConfigurationPrecommit() {
  * @returns {Array<string>}
  */
 function getSupportedLanguage() {
-  const _language = [];
-  _language.push('.js');
-  _language.push('.jsx');
-  _language.push('.ts');
-  _language.push('.tsx');
+  const {
+    supportedExtensions
+  } = getConfigurationPrecommit();
+  const _language = supportedExtensions;
   return _language;
 }
 function getRunningEnv() {

package/build/utils/HuskySetup/initializeHusky.js

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

package/build/utils/HuskySetup/setupHusky.js

@@ -1,21 +1,8 @@
 "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');
@@ -26,51 +13,21 @@ let isCustomPrecommitConfigurationSuccessful = false;
  * @returns {boolean} - indicating whether entire custom precommit hook setup using husky process is success or failure
  */
 function setupHusky() {
-  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;
-      }
+  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, '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/build/utils/PluginsInstallation/arePluginsInstalled.js

@@ -6,9 +6,19 @@ const {
 const {
   printUninstalledPlugins
 } = require('./printUninstalledPlugins');
+const {
+  installPlugins
+} = require('./installPlugins');
 function arePluginsInstalled() {
-  let uninstalledPlugins = checkIfPluginsAreInstalled();
-  printUninstalledPlugins(uninstalledPlugins);
+  let {
+    uninstalledPlugins,
+    noPluginMessage
+  } = checkIfPluginsAreInstalled();
+  let areAllPluginsInstalled = uninstalledPlugins.length === 0 ? true : false;
+  if (!areAllPluginsInstalled) {
+    installPlugins(uninstalledPlugins);
+  }
+  // printUninstalledPlugins(uninstalledPlugins,noPluginMessage)
 }
 module.exports = {
   arePluginsInstalled

package/build/utils/PluginsInstallation/checkIfPluginsAreInstalled.js

@@ -74,30 +74,50 @@ function getAllPlugins() {
  */
 function checkIfPluginsAreInstalled() {
   const pluginsForCurrentRepo = getAllPlugins();
-  let uninstalledPlugins = [];
-  let plugin = {
+  var uninstalledPlugins = [];
+  var plugin = {
     noPluginMessage: '',
     uninstalledPlugins: []
   };
-  let pluginsIndevDependencies = {};
-  let pluginNamesOfDevDependencyPlugins = [];
-  let arePluginsPresentIndevDependencies = false;
-  let 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!');
+  // 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,
+      version
+    } = plugin;
+    const {
+      isPluginPresent,
+      pluginPath
+    } = checkPluginsPresentInNodemodules(packageName);
+    if (isPluginPresent && checkPluginHasProperVersion(packageName, pluginPath, version)) {
+      return false;
     }
-  } else {
-    arePluginsPresentIndevDependencies = false;
-  }
-  arePluginsPresentForCurrentRepo = pluginsForCurrentRepo.length !== 0 ? true : false;
-  if (arePluginsPresentForCurrentRepo || arePluginsPresentIndevDependencies) {
-    uninstalledPlugins = getUnInstalledPlugins(pluginsForCurrentRepo, pluginNamesOfDevDependencyPlugins, pluginsIndevDependencies);
+    return `${packageName}@${version}`;
+  }).filter(Boolean);
+  if (uninstalledPlugins.length > 0) {
+    // uninstalledPlugins = getUnInstalledPlugins(pluginsForCurrentRepo, pluginNamesOfDevDependencyPlugins, pluginsIndevDependencies);
     plugin.noPluginMessage = '';
     plugin.uninstalledPlugins = uninstalledPlugins;
     return plugin;
@@ -107,6 +127,51 @@ function checkIfPluginsAreInstalled() {
     return plugin;
   }
 }
+
+/**
+ * @function returnExactPluginVersion - to return the exact plugin version after removing caret or tilde symbol if present
+ * @param {string} pluginVersion
+ * @returns {string} - which represents exactPluginVersion
+ */
+function returnExactPluginVersion(pluginVersion) {
+  return pluginVersion.replace(/[\^~]/, '');
+}
+
+/**
+ * @function checkPluginsPresentInNodemodules - to check if the plugin is present in the node_modules of the project
+ * @param {string} rulePluginName 
+ * @returns 
+ */
+function checkPluginsPresentInNodemodules(rulePluginName) {
+  try {
+    const pluginPath = require.resolve(rulePluginName.toString());
+    return {
+      pluginPath: pluginPath,
+      isPluginPresent: existsSync(pluginPath)
+    };
+  } catch (error) {
+    return {
+      pluginPath: "",
+      isPluginPresent: false
+    };
+  }
+}
+
+/**
+ * @function checkPluginHasProperVersion - to check if the plugin has the proper version`
+ * @param {string} rulePluginName 
+ * @param {string} installationPath 
+ * @param {string} remotePluginVersion 
+ * @returns 
+ */
+
+function checkPluginHasProperVersion(rulePluginName, installationPath, remotePluginVersion) {
+  const pluginPathArray = installationPath.toString().split(rulePluginName);
+  const rulePluginPackageJSONPath = path.join(pluginPathArray[0], rulePluginName, 'package.json');
+  const remotePluginExactVersion = returnExactPluginVersion(remotePluginVersion);
+  const packageJsonPluginExactVersion = returnExactPluginVersion(require(rulePluginPackageJSONPath).version);
+  return remotePluginExactVersion == packageJsonPluginExactVersion ? true : false;
+}
 module.exports = {
   checkIfPluginsAreInstalled
 };

package/build/utils/PluginsInstallation/installPlugins.js

@@ -3,6 +3,9 @@
 const {
   execSync
 } = require('child_process');
+const {
+  writeFileSync
+} = require('fs');
 const {
   checkIfPluginsAreInstalled
 } = require('./checkIfPluginsAreInstalled');
@@ -12,34 +15,68 @@ const {
 const {
   Logger
 } = require('../Logger/Logger');
+const {
+  createVersionControlFile
+} = require('../FileAndFolderOperations/versionControl');
+const {
+  getNodeModulesPath
+} = require('../General/getNodeModulesPath');
 
 /**
  * @function installPlugins - installs uninstalled plugins for the project
  * @returns {boolean} - indicating if plugins to be installed are installed successfully or not
  */
-function installPlugins() {
-  let uninstalledPlugins = checkIfPluginsAreInstalled();
-  let pluginsToBeInstalled = uninstalledPlugins.uninstalledPlugins;
+function installPlugins(pluginsToBeInstalled) {
+  // let {uninstalledPlugins : pluginsToBeInstalled} = checkIfPluginsAreInstalled()
   if (pluginsToBeInstalled.length > 0) {
+    let packageJsonBeforePluginsInstallation = getPackageJsonContentBeforeInstallingPlugins();
     let installCommand = `npm install --save-dev ${pluginsToBeInstalled.join(' ')}`;
     Logger.log(Logger.INFO_TYPE, 'Installing plugins ....');
     Logger.log(Logger.INFO_TYPE, `Install command being executed: ${installCommand}`);
     let arePluginsInstalledSuccessfully = executeSynchronizedCommands(execSync, [installCommand, {
-      stdio: 'inherit'
+      stdio: 'inherit',
+      cwd: getNodeModulesPath()
     }], '', 'Some issue occured while installing plugins', false, true);
     if (arePluginsInstalledSuccessfully) {
       Logger.log(Logger.SUCCESS_TYPE, 'Plugins installation successful');
-      return true;
+      let isPackageJsonRestored = restorePackageJsonContent(packageJsonBeforePluginsInstallation);
+      if (isPackageJsonRestored) {
+        createVersionControlFile(pluginsToBeInstalled);
+        // return true 
+      } else {
+        Logger.log(Logger.FAILURE_TYPE, 'Unable to restore package.json content');
+        // return false
+      }
     } else {
       Logger.log(Logger.FAILURE_TYPE, "Unable to install plugins.Kindly retry the command");
-      return false;
+      // return false
     }
   } else {
     Logger.log(Logger.INFO_TYPE, 'Plugins are already installed');
-    return true;
+    // return true
   }
 }
 
+/**
+ * @function getPackageJsonContentBeforeInstallingPlugins - to get the content of package.json before installing plugins
+ * @returns {Object} - package.json content before installing plugins
+ */
+function getPackageJsonContentBeforeInstallingPlugins() {
+  let packageJsonFilePath = `${getNodeModulesPath()}/package.json`;
+  let packageJsonContentBeforePluginsInstallation = require(packageJsonFilePath);
+  return packageJsonContentBeforePluginsInstallation;
+}
+
+/**
+ * @function restorePackageJsonContent - restore the same content as it was before installing plugins
+ * @returns {Boolean} - indicating the success or failure of restoring package.json content
+ */
+function restorePackageJsonContent(packageJsonContentBeforePluginsInstallation) {
+  let packageJsonFilePath = `${getNodeModulesPath()}/package.json`;
+  let isPackageJsonRestored = executeSynchronizedCommands(writeFileSync, [packageJsonFilePath, JSON.stringify(packageJsonContentBeforePluginsInstallation, null, 2)], 'Package.json content restored successfully', 'Unable to restore package.json content', false, true);
+  return isPackageJsonRestored;
+}
+
 // function appendInstalledPluginsToPackageJson(pluginsToBeAppendedInPackageJson){
 //     let packageJsonFilePath = `${nodeModulesPathOfProject}/package.json`
 //     let packageJsonContent = require(packageJsonFilePath)

package/build/utils/PluginsInstallation/printUninstalledPlugins.js

@@ -8,17 +8,17 @@ const {
  * @function printUninstalledPlugins - to notify the user regarding plugins for the repository has been installed or not 
  * @param {Array} uninstalledPlugins - contains list of uninstalled plugins for the project
  */
-function printUninstalledPlugins(uninstalledPlugins) {
+function printUninstalledPlugins(uninstalledPlugins, noPluginMessage) {
   let commandToInstallPlugins = 'npx ZDPrecommit setupPlugins';
-  if (uninstalledPlugins.uninstalledPlugins.length !== 0) {
+  if (uninstalledPlugins.length !== 0) {
     Logger.log(Logger.INFO_TYPE, 'The following plugins are not installed:');
-    uninstalledPlugins.uninstalledPlugins.map(plugin => {
+    uninstalledPlugins.map(plugin => {
       Logger.log(Logger.INFO_TYPE, `"${plugin}"`);
     });
     Logger.log(Logger.FAILURE_TYPE, `Kindly execute the command \x1b[37m"${commandToInstallPlugins}\x1b[0m" \x1b[31mfrom the location where package.json of the repo is present to install the plugins`);
-  } else if (uninstalledPlugins.uninstalledPlugins.length === 0 && uninstalledPlugins.noPluginMessage.trim() === '') {
+  } else if (uninstalledPlugins.length === 0 && noPluginMessage.trim() === '') {
     Logger.log(Logger.INFO_TYPE, 'Plugins are installed already');
-  } else if (uninstalledPlugins.uninstalledPlugins.length === 0 && uninstalledPlugins.noPluginMessage.trim() !== '') {
+  } else if (uninstalledPlugins.length === 0 && noPluginMessage.trim() !== '') {
     Logger.log(Logger.INFO_TYPE, 'No plugins present for the repository');
   }
 }

package/changeLog.md

@@ -4,7 +4,7 @@
  1. Testing version of the library
 
 # 0.0.1
- - This version was mistakenly published without the build folder which will be corrected in the next release
+ 1. This version was mistakenly published without the build folder which will be corrected in the next release
 
 # 0.0.2 - first stable release of the library
  1. Sets up a custom precommit hook using husky
@@ -12,11 +12,21 @@
  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 - minor issue fix
+ # 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.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.
+ 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.
+
+# 0.0.5 - Automatic eslint plugins installation
+ 1. The required eslint plugins configured for a repository will be automatically installed during the installation of the library
+
+# 0.0.6 - Support extended for .properties file
+ 
+ 1. The file types that are supported by this library can now be configured using the configuration file "lint.config.js" 
+ 2. Support for .properties file is also extended in this version along with existing support for file types .js, .jsx, .ts, .tsx

package/package.json

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