@zohodesk/codestandard-validator 1.0.0 → 1.1.0

package/build/hooks/Precommit/utils.js

@@ -0,0 +1,48 @@
+"use strict";
+
+const {
+  execSync
+} = require("child_process");
+const {
+  getRootDirectory
+} = require("../../utils/General/RootDirectoryUtils/getRootDirectory");
+const {
+  checkIfPluginsAreInstalled
+} = require("../../utils/PluginsInstallation/checkIfPluginsAreInstalled");
+const fs = require("fs");
+const path = require("path");
+async function isMergeCommit() {
+  try {
+    const stdout = await execSync("git rev-parse -q --verify MERGE_HEAD").toString();
+    return Boolean(stdout.trim());
+  } catch {
+    return false;
+  }
+}
+async function getStagedFiles() {
+  try {
+    const stdout = await execSync("git diff --staged --name-only").toString();
+    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

@@ -4,23 +4,27 @@ const {
   getLastCommitHash,
   getStoredCommitHash,
   updateJsonFile
-} = require("../utils/General/getGeneralInfo");
+} = require('../utils/General/getGeneralInfo');
 const {
   executeMethodsThatReturnBooleanValue
-} = require("../utils/General/wrapperFunctionToExecuteAFunction");
+} = require('../utils/General/wrapperFunctionToExecuteAFunction');
 const {
   cloneViaCdt
-} = require("../utils/CloneCommonLinterRepo/cloneViaCdt");
+} = require('../utils/CloneCommonLinterRepo/cloneViaCdt');
 const {
   getPluginsToInstall
-} = require("../utils/PluginsInstallation/checkIfPluginsAreInstalled");
+} = require('../utils/PluginsInstallation/checkIfPluginsAreInstalled');
 const {
   installPlugins
-} = require("../utils/PluginsInstallation/installPlugins");
-const path = require("path");
+} = require('../utils/PluginsInstallation/installPlugins');
+const path = require('path');
 const {
   Logger
-} = require("../utils/Logger/Logger");
+} = require('../utils/Logger/Logger');
+const config = require(path.join(process.cwd(), 'lint.config.js'));
+process.env.SONARQUBE_EXTERNAL = config.metric_token;
+process.env.SONARQUBE = config.meticHandler_api_token;
+process.env.ZGIT_TOKEN = config.token;
 async function hooks() {
   var jsonFilePath = path.join(__dirname, '..', '..', 'jsonUtils', 'fsUtils.json');
   if (!(getLastCommitHash() == getStoredCommitHash())) {
@@ -29,12 +33,16 @@ async function hooks() {
       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);
+    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);
+    await executeMethodsThatReturnBooleanValue('Some issue occurred in installing plugins', installPlugins, uninstalledPlugins);
+  }
+  if (process.env.CLIPRECOMMIT && Boolean(process.env.CLIPRECOMMIT) == true) {
+    require('./Precommit/pre-commit-default');
+  } else {
+    require('./Precommit/commit');
   }
-  require('./Precommit/pre-commit');
 }
 hooks();

package/build/lib/postinstall.js

@@ -2,41 +2,49 @@
 
 const {
   cloneViaCdt
-} = require("../utils/CloneCommonLinterRepo/cloneViaCdt");
+} = require('../utils/CloneCommonLinterRepo/cloneViaCdt');
 const {
   setupHusky
-} = require("../utils/HuskySetup/setupHusky");
+} = require('../utils/HuskySetup/setupHusky');
 const {
   createConfigFile
-} = require("../utils/ConfigFileUtils/createConfigFile");
+} = require('../utils/ConfigFileUtils/createConfigFile');
 const {
   Logger
-} = require("../utils/Logger/Logger");
+} = require('../utils/Logger/Logger');
 const {
   executeMethodsThatReturnBooleanValue
-} = require("../utils/General/wrapperFunctionToExecuteAFunction");
+} = require('../utils/General/wrapperFunctionToExecuteAFunction');
 const {
   arePluginsInstalled
-} = require("../utils/PluginsInstallation/arePluginsInstalled");
+} = require('../utils/PluginsInstallation/arePluginsInstalled');
 const {
   isGitInitialized
-} = require("../utils/GitActions/gitActions");
+} = require('../utils/GitActions/gitActions');
 const {
   writeFsPaths
-} = require("../utils/General/writeProjectDetailsToJson");
-
+} = require('../utils/General/writeProjectDetailsToJson');
+const path = require('path');
 /**
  *  @function {postInstall} -  This methods setup husky and configuration for executing project
  *  @returns {void}
  */
 async function postInstall() {
   try {
-    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.", createConfigFile, null);
-    Logger.log(Logger.SUCCESS_TYPE, "Pre commit setup successfull");
-    arePluginsInstalled();
+    await executeMethodsThatReturnBooleanValue('Some issue in writing node_modules path to json', writeFsPaths, null).then(() => {
+      const {
+        getNodeModulesPath
+      } = require('../utils/General/getNodeModulesPath');
+      const config = require(path.join(getNodeModulesPath(), 'lint.config.js'));
+      process.env.SONARQUBE_EXTERNAL = config.metric_token;
+      process.env.SONARQUBE = config.meticHandler_api_token;
+      process.env.ZGIT_TOKEN = config.token;
+    });
+    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.', createConfigFile, null);
+    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

@@ -25,8 +25,8 @@ module.exports = {
   impactBased: true,
   lintReportPath: path.resolve(process.cwd(), "lint-report", "lintReport.json"),
   metricServerHost: "https://client-linters.zdesk.csez.zohocorpin.com",
-  meticHandler_api_token: "KIDfmI46KIDfmI4kYPU1",
-  metric_token: "zxh_371336m636584i54m662j6495h46228mkj6hihh8",
+  meticHandler_api_token: "YWRtaW46YWRtaW4yMDI1",
+  metric_token: "sqa_371336f636584b54f662c6495a46228fdc6abaa8",
   branchDiffPath: path.resolve(process.cwd(), "diffBranch.json"),
   gitEndPoint: "https://zgit.csez.zohocorpin.com",
   tsConfigurationPath: path.resolve(process.cwd(), 'tsconfig.json'),
@@ -34,7 +34,7 @@ module.exports = {
   impactBasedPrecommit: true,
   shouldWarningsAbortCommit: false,
   pushMetricsOnPreCommit: true,
-  token: "w-OkG3f5OOM1Rkly8phZ",
+  token: "k-CyU3t5CCA1Fyzm8dvN",
   compareBranch: 'release',
   supportedExtensions: ['.js', '.jsx', '.ts', '.tsx', '.properties']
 };

package/build/utils/CloneCommonLinterRepo/cloneViaCdt.js

@@ -46,7 +46,7 @@ function cloneViaCdt() {
       token
     } = getConfigurationPrecommit();
     const currentEnv = getRunningEnv();
-    Logger.log(Logger.INFO_TYPE, `Application is running in the following environment:${currentEnv}`);
+    Logger.log(Logger.INFO_TYPE, `Application is running in the following environment:${currentEnv || "Development"}`);
 
     // Clean up existing folder
     const deleteDir = getDeleteDirPath();
@@ -54,7 +54,7 @@ function cloneViaCdt() {
 
     // 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 authenticatedEndpoint = isAutomatedEnv ? `https://${user}:${process.env.ZGIT_TOKEN}@${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

package/build/utils/General/SonarQubeUtil.js

@@ -0,0 +1,108 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _Logger = require("../Logger/Logger");
+var _getGeneralInfo = require("./getGeneralInfo");
+const {
+  execSync
+} = require('child_process');
+/**
+ * Constructs a URL for searching issues in SonarQube.
+ *
+ * @param {string} componentKey - The key of the component to search issues for.
+ * @returns {string} The fully constructed URL for the SonarQube issues search API.
+ */
+
+function buildIssuesSearchUrl(componentKey) {
+  const {
+    metricServerHost = "https://client-linters.zdesk.csez.zohocorpin.com"
+  } = (0, _getGeneralInfo.getConfigurationPrecommit)();
+  const base = `${metricServerHost}/api/issues/search`;
+  const params = new URLSearchParams({
+    componentKeys: componentKey,
+    s: 'FILE_LINE',
+    resolved: 'false',
+    ps: '100',
+    facets: 'severities,types',
+    additionalFields: '_all',
+    timeZone: 'Asia/Calcutta'
+  });
+  return `${base}?${params.toString()}`;
+}
+
+/**
+ * Extract minimal issue info from SonarQube issues JSON.
+ */
+function extractIssues(json) {
+  var hasIssue = false;
+  var totalIssues = json.issues.length;
+  if (!json || !Array.isArray(json.issues)) return [];
+  return {
+    issues: json.issues.map(i => {
+      if (i.severity == 'MAJOR') {
+        hasIssue = true;
+      }
+      return {
+        key: i.key,
+        component: i.component,
+        severity: i.severity,
+        type: i.type,
+        message: i.message,
+        line: i.line,
+        rule: i.rule,
+        status: i.status
+      };
+    }),
+    hasIssue,
+    totalIssues
+  };
+}
+
+/**
+ * Fetches project issues for a given component key using a cURL command.
+ *
+ * This function constructs a URL to search for issues, decrypts an API token,
+ * and executes a cURL command to retrieve the issues in JSON format. It then
+ * extracts and returns the issues along with the raw JSON response.
+ *
+ * @param {string} componentKey - The key of the component for which issues are to be fetched.
+ * @returns {Object} An object containing:
+ *   - {Object|null} raw: The raw JSON response from the API, or null if an error occurred.
+ *   - {Array} issues: An array of extracted issues, or an empty array if an error occurred.
+ */
+
+async function fetchProjectIssuesViaCurl(componentKey) {
+  _Logger.Logger.log(_Logger.Logger.INFO_TYPE, `\n Fetching issues (curl) for component: ${componentKey}`);
+  const url = buildIssuesSearchUrl(componentKey);
+  try {
+    const token = process.env.SONARQUBE; //'sqa_1f6675c05f63c4784dc741ce751efa0066d2693c' || decrypt(getAPIToken(), ); // sonarqube
+    const command = `curl --tlsv1.2 -s -u "${token}:" "${url}"`;
+    const output = execSync(command).toString();
+    const json = JSON.parse(output.toString());
+    const {
+      issues,
+      hasIssue,
+      totalIssues
+    } = extractIssues(json);
+    _Logger.Logger.log(_Logger.Logger.INFO_TYPE, `Retrieved ${issues.length} issues.`);
+    return {
+      raw: json,
+      issues,
+      hasIssue,
+      totalIssues
+    };
+  } catch (err) {
+    _Logger.Logger.log(_Logger.Logger.FAILURE_TYPE, 'Issue fetching project issues (curl)');
+    _Logger.Logger.log(_Logger.Logger.FAILURE_TYPE, err);
+    return {
+      raw: null,
+      issues: [],
+      hasIssue: true,
+      totalIssues: 0
+    };
+  }
+}
+var _default = exports.default = fetchProjectIssuesViaCurl;

package/build/utils/General/getGeneralInfo.js

@@ -7,7 +7,6 @@ const {
   execSync
 } = require('child_process');
 const {
-  readOnlyToken,
   commitHashEndPoint
 } = require('../../../jsonUtils/commonLinterRepoDetails');
 const {
@@ -91,7 +90,7 @@ function getRunningEnv() {
 function getLastCommitHash() {
   try {
     var _JSON$parse$;
-    const cmd = `curl --header "PRIVATE-TOKEN: ${readOnlyToken}" --url ${commitHashEndPoint}`;
+    const cmd = `curl --header "PRIVATE-TOKEN: ${process.env.ZGIT_TOKEN}" --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);

package/build/utils/HuskySetup/configurePrecommitHook.js

@@ -14,6 +14,9 @@ const {
 const {
   executeSynchronizedCommands
 } = require("../General/executeSyncCommands");
+const {
+  getNodeModulesPath
+} = require("../General/getNodeModulesPath");
 
 /**
  * @function configurePrecommitHook - creates the link to custom pre commit hook file and husky precommit file 
@@ -26,7 +29,7 @@ function configurePrecommitHook() {
   let huskyPrecommitHookContent = `#!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-"${customPrecomitHookPath}"
+cd "${getNodeModulesPath()}" && "${customPrecomitHookPath}"
 `;
   let isCustomPrecommitConfigurationSuccessful = executeSynchronizedCommands(writeFileSync, [huskyPrecommitPath, huskyPrecommitHookContent, 'utf-8'], '', 'Could not create and write pre-commit.sh inisde husky directory', false, true);
   if (isCustomPrecommitConfigurationSuccessful) {

package/build/utils/HuskySetup/initializeHusky.js

@@ -2,9 +2,6 @@
 
 /* eslint-disable no-console */
 
-const {
-  execSync
-} = require('child_process');
 const {
   navigateToRootDirectory
 } = require('../General/RootDirectoryUtils/navigateToRootDirectory');
@@ -14,12 +11,15 @@ const {
 const {
   Logger
 } = require('../Logger/Logger');
+const {
+  execSync
+} = require('child_process');
 
 /**
  * @function initializeHusky - creates a .husky folder at the root of the project with the husky execution script file
  * @returns {boolean} - indicating the success or failure of initializing husky process
  */
-function initializeHusky() {
+async function initializeHusky() {
   let isNavigationToRootDirectorySuccessful = navigateToRootDirectory(getRootDirectory());
   if (isNavigationToRootDirectorySuccessful) {
     try {

package/build/utils/Logger/Logger.js

@@ -22,5 +22,8 @@ class LoggerImpl {
     const color = this.colors[type];
     this.consoleLogger.log(`${color[0]}${message}${color[1]}`);
   }
+  logger(message) {
+    this.consoleLogger.log(message);
+  }
 }
 module.exports.Logger = new LoggerImpl();

package/build/utils/PluginsInstallation/installPlugins.js

@@ -1,8 +1,5 @@
 "use strict";
 
-const {
-  execSync
-} = require('child_process');
 const {
   writeFileSync
 } = require('fs');
@@ -15,36 +12,44 @@ const {
 const {
   getNodeModulesPath
 } = require('../General/getNodeModulesPath');
+const path = require('path');
+const {
+  spawnSync,
+  spawn
+} = require('child_process');
 
 /**
  * @function installPlugins - installs uninstalled plugins for the project
  * @returns {boolean} - indicating if plugins to be installed are installed successfully or not
  */
-function installPlugins(pluginsToBeInstalled) {
+async function installPlugins(pluginsToBeInstalled) {
   if (pluginsToBeInstalled.length > 0) {
     let packageJsonBeforePluginsInstallation = getPackageJsonContentBeforeInstallingPlugins();
-    Logger.log(Logger.INFO_TYPE, 'Installing plugins ....');
-    const installCommand = `npm install --save-dev ${pluginsToBeInstalled.join(' ')} --legacy-peer-deps`;
-    Logger.log(Logger.INFO_TYPE, `Install command being executed: ${installCommand}`);
-    let arePluginsInstalledSuccessfully = executeSynchronizedCommands(execSync, [installCommand, {
-      stdio: 'inherit',
-      cwd: getNodeModulesPath()
-    }], '', 'Some issue occured while installing plugins', false, true);
-    if (arePluginsInstalledSuccessfully) {
-      Logger.log(Logger.SUCCESS_TYPE, 'Plugins installation successful');
-      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");
+    Logger.log(Logger.SUCCESS_TYPE, 'Installing rule plugins; this may take some time.');
+    const args = ['install', '--save-dev', ...pluginsToBeInstalled, '--legacy-peer-deps'];
+    Logger.log(Logger.INFO_TYPE, `Install command being executed: npm ${args.join(' ')}`);
+    const result = spawnSync('npm', args, {
+      cwd: getNodeModulesPath(),
+      shell: false,
+      encoding: 'utf8'
+    });
+    if (result.stdout) {
+      Logger.logger(result.stdout);
+    }
+    if (result.stderr) {
+      Logger.log(Logger.INFO_TYPE, result.stderr);
+    }
+    if (result.error) {
+      Logger.log(Logger.FAILURE_TYPE, 'Unable to install plugins. Spawn error.');
+      Logger.log(Logger.FAILURE_TYPE, result.error);
+      return false;
+    }
+    if (result.status !== 0) {
+      Logger.log(Logger.FAILURE_TYPE, `npm exited with code ${result.status}`);
       return false;
     }
+    Logger.log(Logger.SUCCESS_TYPE, 'Plugins installation successful');
+    return restorePackageJsonContent(packageJsonBeforePluginsInstallation);
   } else {
     Logger.log(Logger.INFO_TYPE, 'Plugins are already installed');
     return true;
@@ -66,7 +71,7 @@ function getPackageJsonContentBeforeInstallingPlugins() {
  * @returns {Boolean} - indicating the success or failure of restoring package.json content
  */
 function restorePackageJsonContent(packageJsonContentBeforePluginsInstallation) {
-  let packageJsonFilePath = `${getNodeModulesPath()}/package.json`;
+  let packageJsonFilePath = path.join(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;
 }

package/changeLog.md

@@ -35,4 +35,9 @@
  # 1.0.0 - Support For Stylelint 
  
  1. Enhancement Parser support CSS files and linter
- 2. Clone Configuration Flow Enhancement Validation
+ 2. Clone Configuration Flow Enhancement Validation
+
+
+# 1.1.0 - SonarQube Enable
+
+1. Enable sonarqube with flag with backward compactibility

package/index.js

@@ -5,4 +5,4 @@ module.exports = {
   rulesConfig,
   plugins,
   extendPlugins
-};
+};

package/jsonUtils/MandatoryListRules.js

@@ -0,0 +1,3 @@
+const MandatoryListRules = ["@zohodesk/fitnessfunction/chunk-size"]
+
+module.exports = MandatoryListRules

package/jsonUtils/commonLinterRepoDetails.js

@@ -16,7 +16,6 @@ module.exports =  {
   type: "git",
   user:"rajasekar.hm",
   commitHashEndPoint:"https://zgit.csez.zohocorpin.com/api/v4/projects/19251/repository/commits",
-  readOnlyToken:"k-CyU3t5CCA1Fyzm8dvN"
 };
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/codestandard-validator",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "library to enforce code standard using eslint",
   "main": "index.js",
   "scripts": {
@@ -15,9 +15,10 @@
   },
   "type": "commonjs",
   "dependencies": {
+    "@zohodesk/codestandard-analytics": "1.1.2",
     "@zohodesk-private/client_deployment_tool": "0.0.5",
     "eslint": "8.26.0",
-    "stylelint":"16.23.0"
+    "stylelint": "16.23.0"
   },
   "devDependencies": {
     "@babel/core": "7.24.7",