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

package/build/hooks/Precommit/commit.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+"use strict";
+
+const {
+  filterFiles
+} = require("../../utils/FileAndFolderOperations/filterFiles");
+const {
+  Logger
+} = require("../../utils/Logger/Logger");
+const {
+  handleMergeCommit,
+  ensurePluginsInstalled,
+  safeGetStagedFiles,
+  safeGetBranch
+} = require("./guard");
+const {
+  runLintWorkflow
+} = require("./lint");
+async function preCommitHook() {
+  Logger.log(Logger.INFO_TYPE, "Executing pre commit hook...");
+  Logger.log(Logger.INFO_TYPE, `working dir: ${process.cwd()}`);
+  if (await handleMergeCommit()) return;
+  if (!(await ensurePluginsInstalled())) return;
+  const stagedFiles = await safeGetStagedFiles();
+  if (stagedFiles.length === 0) {
+    Logger.log(Logger.INFO_TYPE, "No staged files. Commit skipped.");
+    return;
+  }
+  const {
+    JsFiles
+  } = filterFiles(stagedFiles, [".eslintrc.js"], true);
+  const branch = await safeGetBranch();
+  const shouldAbort = await runLintWorkflow(JsFiles, branch);
+  if (shouldAbort) {
+    Logger.log(Logger.FAILURE_TYPE, "There are linter errors/warnings. Commit aborted.");
+    process.exit(1);
+  }
+  Logger.log(Logger.SUCCESS_TYPE, "Commit Successful");
+  process.exit(0);
+}
+preCommitHook();

package/build/hooks/Precommit/errorhelpers.js

@@ -0,0 +1,39 @@
+"use strict";
+
+const {
+  Logger
+} = require("../../utils/Logger/Logger");
+const {
+  calculateGitDiffForFile
+} = require("./lint");
+function parseDiffHunks(diff) {
+  return diff.filter(line => line.startsWith("@@")).map(hunk => {
+    const [start, count = 1] = hunk.split(" ")[2].slice(1).split(",").map(Number);
+    return [start, start + (count - 1)];
+  });
+}
+async function filterErrorsByChangedLines(errors, branch, file) {
+  const diff = await calculateGitDiffForFile(branch, file);
+  const changedRanges = parseDiffHunks(diff);
+  return errors.filter(err => {
+    const line = parseInt(err.split(" ")[0].split(":")[0], 10);
+    return changedRanges.some(([s, e]) => line >= s && line <= e);
+  });
+}
+async function createBranchDiff(diff) {
+  // const diff = await calculateGitDiffForFile(branch, file);
+  // const changeset = extractDiffHunks(diff)
+}
+function filterFileLevelErrors(errors) {
+  return errors.slice(1, -2); // strip ESLint summary lines
+}
+function logErrors(file, errors) {
+  Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${file}\x1b[0m`);
+  errors.forEach(err => Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${err.trimEnd()}\x1b[0m`));
+}
+module.exports = {
+  filterErrorsByChangedLines,
+  filterFileLevelErrors,
+  logErrors,
+  parseDiffHunks
+};

package/build/hooks/Precommit/guard.js

@@ -0,0 +1,50 @@
+"use strict";
+
+const {
+  getBranchName
+} = require("../../utils/GitActions/gitActions");
+const {
+  Logger
+} = require("../../utils/Logger/Logger");
+const {
+  isMergeCommit,
+  areAllPluginsInstalled,
+  getStagedFiles
+} = require("./utils");
+async function handleMergeCommit() {
+  if (await isMergeCommit()) {
+    Logger.log(Logger.INFO_TYPE, "Merge detected. Skipping pre-commit check.");
+    process.exit(0);
+    return true;
+  }
+  return false;
+}
+async function ensurePluginsInstalled() {
+  if (areAllPluginsInstalled()) return true;
+  Logger.log(Logger.FAILURE_TYPE, "Commit failed since some lint plugins are not installed");
+  Logger.log(Logger.INFO_TYPE, `Run \x1b[37mnpx ZDPrecommit setupPlugins \x1b[33m in the project root to install them.`);
+  process.exit(1);
+  return false;
+}
+async function safeGetStagedFiles() {
+  try {
+    return await getStagedFiles();
+  } catch {
+    Logger.log(Logger.INFO_TYPE, "Error fetching staged files");
+    process.exit(1);
+  }
+}
+async function safeGetBranch() {
+  try {
+    return await getBranchName();
+  } catch {
+    Logger.log(Logger.INFO_TYPE, "Error fetching current branch");
+    return "";
+  }
+}
+module.exports = {
+  safeGetBranch,
+  safeGetStagedFiles,
+  handleMergeCommit,
+  ensurePluginsInstalled
+};

package/build/hooks/Precommit/lint.js

@@ -0,0 +1,128 @@
+"use strict";
+
+const {
+  exec
+} = require("child_process");
+const {
+  promisify
+} = require("util");
+const fs = require("fs");
+const path = require("path");
+const {
+  getNodeModulesPath
+} = require("../../utils/General/getNodeModulesPath");
+const {
+  getEslintExecutablePath
+} = require("../../utils/ConfigFileUtils/getEslintExecutablePath");
+const {
+  getRootDirectory
+} = require("../../utils/General/RootDirectoryUtils/getRootDirectory");
+const {
+  getSupportedLanguage
+} = require("../../utils/General/getGeneralInfo");
+const {
+  filterFileLevelErrors,
+  filterErrorsByChangedLines,
+  logErrors
+} = require("./errorhelpers");
+const {
+  Execution
+} = require("@zohodesk/codestandard-analytics");
+const {
+  getBranchName
+} = require("../../utils/GitActions/gitActions");
+const {
+  extractDiffHunks
+} = require("./utils");
+const execAsync = promisify(exec);
+async function lintFiles(filePath) {
+  const ext = path.extname(filePath);
+  if ([".js", ".ts", ".tsx", ".jsx", ".properties"].includes(ext)) {
+    return findEslintErrors(filePath);
+  }
+  if ([".css", ".scss"].includes(ext)) {
+    return findStyleLintErrors(filePath);
+  }
+  return [];
+}
+async function findEslintErrors(file) {
+  const nodeModulesPath = getNodeModulesPath();
+  const eslintPath = getEslintExecutablePath();
+  const eslintConfig = `${nodeModulesPath}/.eslintrc.js`;
+  var rulesArrayReport = [];
+  if (!fs.existsSync(nodeModulesPath)) {
+    Logger.log(Logger.INFO_TYPE, "node_modules not found");
+    return [];
+  }
+  if (!fs.existsSync(eslintPath)) {
+    Logger.log(Logger.INFO_TYPE, "Eslint executable not found. Make sure eslint plugin is installed");
+    return [];
+  }
+  return execAsync(`npx --ignore-existing "${eslintPath}" --config "${eslintConfig}" --no-inline-config --resolve-plugins-relative-to="${nodeModulesPath}/node_modules" ${file}`).then(({
+    stderr
+  }) => stderr ? stderr.trim().split("\n") : []).catch(err => {
+    Logger.log(Logger.FAILURE_TYPE, err);
+    throw new Error("Error executing eslint command");
+  });
+}
+function findStyleLintErrors(filePath) {
+  const configFile = path.resolve(getNodeModulesPath(), ".stylelintrc.js");
+  const absolutePath = path.join(getRootDirectory(), filePath);
+  return execAsync(`npx stylelint ${absolutePath} --config ${configFile}`, {
+    cwd: getNodeModulesPath()
+  }).then(({
+    stdout
+  }) => stdout ? stdout.trim().split("\n") : []).catch(err => {
+    Logger.log(Logger.FAILURE_TYPE, err);
+    return [];
+  });
+}
+async function calculateGitDiffForFile(branch, file) {
+  try {
+    const {
+      stdout
+    } = await execAsync(`git diff -U0 ${branch.trim()} ${file}`);
+    return stdout;
+  } catch (err) {
+    throw err;
+  }
+}
+async function runLintWorkflow(files, branch) {
+  const branchDiff = {
+    diffs: []
+  };
+  let shouldAbort = false;
+  var branchName = getBranchName();
+  for (const file of files) {
+    if (!getSupportedLanguage().includes(path.extname(file))) continue;
+    const changeset = extractDiffHunks(await calculateGitDiffForFile(branchName, file));
+    const diff = {
+      old_path: file,
+      new_path: file,
+      diff: changeset
+    };
+    branchDiff.diffs.push(diff);
+    // const filteredErrors = impactBasedPrecommit
+    //   ? await filterErrorsByChangedLines(errors, branch, file)
+    //   : filterFileLevelErrors(errors);
+
+    // if (filteredErrors.length > 0) {
+    //   logErrors(file, filteredErrors);
+    //   shouldAbort ||= shouldWarningsAbortCommit || !isOnlyWarnings(filteredErrors);
+    // }
+  }
+  const diffPath = path.resolve(getNodeModulesPath(), "diffBranch.json");
+  fs.writeFileSync(diffPath, branchDiff);
+  const execute = new Execution(EsLint, SonarQube, $cliObjects);
+  await execute.executeLintHandler().finally(() => {
+    execute.executeMetricHandler();
+  });
+  return global.analytics.status == 'FAILURE' ? true : false;
+}
+module.exports = {
+  runLintWorkflow,
+  lintFiles,
+  findEslintErrors,
+  findStyleLintErrors,
+  calculateGitDiffForFile
+};

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

@@ -1,8 +1,7 @@
 "use strict";
 
 const {
-  exec,
-  execSync
+  exec
 } = require('child_process');
 const fs = require('fs');
 const path = require('path');
@@ -13,8 +12,7 @@ const {
   getNodeModulesPath
 } = require('../../utils/General/getNodeModulesPath');
 const {
-  filterFiles,
-  filterWarningInFile
+  filterFiles
 } = require('../../utils/FileAndFolderOperations/filterFiles');
 const {
   Logger

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

@@ -18,6 +18,9 @@ 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())) {
@@ -25,12 +28,13 @@ async function hooks() {
       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/pre-commit');
+  require('./Precommit/commit');
 }
 hooks();

package/build/utils/CloneCommonLinterRepo/cloneViaCdt.js

@@ -46,7 +46,7 @@ function cloneViaCdt() {
       token
     } = getConfigurationPrecommit();
     const currentEnv = getRunningEnv();
-    Logger.log(Logger.INFO_TYPE, `Running in environment: ${currentEnv}`);
+    Logger.log(Logger.INFO_TYPE, `Application is running in the following environment:${currentEnv}`);
 
     // Clean up existing folder
     const deleteDir = getDeleteDirPath();

package/build/utils/General/getGeneralInfo.js

@@ -64,7 +64,7 @@ function getSupportedLanguage() {
   const {
     supportedExtensions
   } = getConfigurationPrecommit();
-  const _language = supportedExtensions;
+  const _language = supportedExtensions || [];
   _language.push('.js');
   _language.push('.jsx');
   _language.push('.ts');

package/build/utils/PluginsInstallation/installPlugins.js

@@ -12,15 +12,9 @@ const {
 const {
   Logger
 } = require('../Logger/Logger');
-const {
-  createVersionControlFile
-} = require('../FileAndFolderOperations/versionControl');
 const {
   getNodeModulesPath
 } = require('../General/getNodeModulesPath');
-const {
-  spawn
-} = require('child_process');
 
 /**
  * @function installPlugins - installs uninstalled plugins for the project
@@ -39,13 +33,14 @@ function installPlugins(pluginsToBeInstalled) {
     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;
-      }
+      // 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;

package/changeLog.md

@@ -32,7 +32,7 @@
  2. Support for .properties file is also extended in this version along with existing support for file types .js, .jsx, .ts, .tsx
 
 
- #   - Support For Stylelint 
+ # 1.0.0 - Support For Stylelint 
  
  1. Enhancement Parser support CSS files and linter
- 2. Clonet Configuration Flow Enhancement Validation
+ 2. Clone Configuration Flow Enhancement Validation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/codestandard-validator",
-  "version": "0.0.7-exp-13",
+  "version": "1.0.0-exp-1",
   "description": "library to enforce code standard using eslint",
   "main": "index.js",
   "scripts": {
@@ -15,6 +15,7 @@
   },
   "type": "commonjs",
   "dependencies": {
+    "@zohodesk/codestandard-analytics":"1.0.2-exp-1",
     "@zohodesk-private/client_deployment_tool": "0.0.5",
     "eslint": "8.26.0",
     "stylelint":"16.23.0"