@zohodesk/codestandard-validator 0.0.4-exp-16 → 0.0.4-exp-18

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');
@@ -88,22 +87,6 @@ function filterDeltedFileFromStagedFiles(files) {
     return false;
   });
 }
-async function lintFiles(filePath) {
-  switch (path.extname(filePath)) {
-    case '.js' || '.ts' || '.tsx' || '.jsx':
-      {
-        return await findEslintErrors(filePath);
-      }
-    case '.css' || '.scss':
-      {
-        return await findStyleLintErrors(filePath);
-      }
-    default:
-      {
-        return [];
-      }
-  }
-}
 
 /**
  * @function findEslintErrors - method  Lint given file based on given configuration
@@ -111,7 +94,7 @@ async function lintFiles(filePath) {
  * @returns {Array<string>} -  array of command line report as a string 
  */
 
-function findEslintErrors(file) {
+async function findEslintErrors(file) {
   let nodeModulesPathOfProject = `${getNodeModulesPath()}`;
   let eslintExecutablePath = getEslintExecutablePath();
   let eslintConfigurationFilePath = `${nodeModulesPathOfProject}/.eslintrc.js`;
@@ -138,35 +121,6 @@ function findEslintErrors(file) {
     Logger.log(Logger.INFO_TYPE, 'node_modules not found');
   }
 }
-
-/**
- * 
- * @param {*} params 
- */
-function findStyleLintErrors(filePath) {
-  const configFilePath = path.resolve(getNodeModulesPath(), '.stylelintrc.json');
-  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) {
-          resolve(stderr.trim().split('\n'));
-        } else if (error) {
-          Logger.log(Logger.FAILURE_TYPE, error);
-          reject("Error executing eslint command");
-        } else {
-          resolve([]);
-        }
-      });
-    });
-  } catch (error) {
-    Logger.log(Logger.FAILURE_TYPE, `Issue is lint css files`);
-    return [];
-  }
-}
-
 /**
  * @function {calculateGitDiffForFile} -  method calculate diff of file
  * @param {*} branch_name - branch name
@@ -203,10 +157,10 @@ function isOnlyWarningsPresentInFile(eslintErrorsPresent) {
   let severityOfEachErrorInFile = [];
   eslintErrorsPresent.map(error => {
     let partsInString = error.split(" ");
-    let severityOfError = partsInString.find(word => word === 'error' || word === 'warning' || word === '✖');
+    let severityOfError = partsInString.find(word => word === 'error' || word === 'warning');
     severityOfEachErrorInFile.push(severityOfError);
   });
-  return !(severityOfEachErrorInFile.includes('✖') || severityOfEachErrorInFile.includes('error'));
+  return !severityOfEachErrorInFile.includes('error');
 }
 
 /**
@@ -239,33 +193,29 @@ async function preCommitHook() {
       try {
         staged_files = await getStagedFiles();
         if (!staged_files.length == 0) {
-          const {
-            JsFiles: staged_filesJS,
-            CssFiles
-          } = filterFiles(staged_files, eslintConfigFiles, true);
+          staged_files = filterFiles(staged_files, eslintConfigFiles, true);
 
-          // staged_filesJS = filterFiles(staged_filesJS,exemptionFiles) //this is the code for giving exemption to a file during pre commit
-          // if(staged_filesJS.length === 0){
+          // staged_files = filterFiles(staged_files,exemptionFiles) //this is the code for giving exemption to a file during pre commit
+          // if(staged_files.length === 0){
           //     Logger.log(Logger.SUCCESS_TYPE,`Commit Successful`)
           //     process.exit(0)
           // }
           areFilesStaged = true;
-          var stagedFiles = [...staged_filesJS, ...CssFiles];
-          for (let file in stagedFiles) {
-            let currentFileName = stagedFiles[file];
+          for (let file in staged_files) {
+            let currentFileName = staged_files[file];
             let changedLinesArray = [];
             let eslintErrorsInChangedLines = [];
             let isOnlyEslintWarningsPresentInFile = false;
-            if (getSupportedLanguage().includes(path.extname(stagedFiles[file]))) {
+            if (getSupportedLanguage().includes(path.extname(staged_files[file]))) {
               try {
-                var errorsInFile = await lintFiles(stagedFiles[file]);
-                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(errorsInFile) : errorsInFile
-                if (stagedFiles[file] && typeof stagedFiles[file] == 'string') {
-                  if (!errorsInFile.length == 0) {
+                var eslintErrorsInFile = await findEslintErrors(staged_files[file]);
+                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(eslintErrorsInFile) : eslintErrorsInFile
+                if (staged_files[file] && typeof staged_files[file] == 'string') {
+                  if (!eslintErrorsInFile.length == 0) {
                     //Calculating changed lines in a file and storing them in respective arrays
                     if (impactBasedPrecommit) {
                       //git diff is computed and stored in an array
-                      let git_diff = await calculateGitDiffForFile(current_branch, stagedFiles[file]);
+                      let git_diff = await calculateGitDiffForFile(current_branch, staged_files[file]);
                       changedLinesArray = git_diff.filter(line => line.startsWith('@@'));
                       let changedLinesStartArray = [];
                       let changedLinesEndArray = [];
@@ -279,15 +229,15 @@ async function preCommitHook() {
                           changedLinesEndArray.push(changesStartLine + parseInt(changesEndLine) - 1);
                         }
                       }
-                      for (let error = 1; error < errorsInFile.length - 2; error++) {
-                        //errorsInFile[error].trim() - 69:26  error => Do not hardcode content. Use I18N key instead  no-hardcoding/no-hardcoding, 
-                        //errorsInFile[error].trim().split(' ')[0] => 69:26
-                        //errorsInFile[error].trim().split(' ')[0].split(':')[0] => 69
+                      for (let error = 1; error < eslintErrorsInFile.length - 2; error++) {
+                        //eslintErrorsInFile[error].trim() - 69:26  error => Do not hardcode content. Use I18N key instead  no-hardcoding/no-hardcoding, 
+                        //eslintErrorsInFile[error].trim().split(' ')[0] => 69:26
+                        //eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0] => 69
 
-                        let eslintErrorLineNumber = errorsInFile[error].trim().split(' ')[0].split(':')[0];
+                        let eslintErrorLineNumber = eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0];
                         for (let lineNumber in changedLinesStartArray) {
                           if (eslintErrorLineNumber >= changedLinesStartArray[lineNumber] && eslintErrorLineNumber <= changedLinesEndArray[lineNumber]) {
-                            eslintErrorsInChangedLines.push(errorsInFile[error]);
+                            eslintErrorsInChangedLines.push(eslintErrorsInFile[error]);
                           }
                         }
                       }
@@ -308,10 +258,10 @@ async function preCommitHook() {
                         }
                       }
                     } else {
-                      if (errorsInFile.length > 0) {
+                      if (eslintErrorsInFile.length > 0) {
                         let startIndex = 1;
-                        let endIndex = errorsInFile.length - 2;
-                        let listOsEslintErrors = errorsInFile.slice(startIndex, endIndex);
+                        let endIndex = eslintErrorsInFile.length - 2;
+                        let listOsEslintErrors = eslintErrorsInFile.slice(startIndex, endIndex);
                         isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(listOsEslintErrors);
                         Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
                         for (let eslintError of listOsEslintErrors) {

package/build/utils/FileAndFolderOperations/filterFiles.js

@@ -3,9 +3,7 @@
 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 
@@ -14,29 +12,6 @@ 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') && 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 => {
@@ -56,7 +31,7 @@ function filterFiles(arrayOfFilesToBeFiltered, filesToBeRemoved, isConfigFileNee
         return false;
       }
     });
-    return filterFilesByExtension(filteredArrayofFilesWithoutConfigFile);
+    return filteredArrayofFilesWithoutConfigFile;
   } else if (filesToBeRemoved.length === 0) {
     return arrayOfFilesToBeFiltered;
   }

package/build/utils/General/getGeneralInfo.js

@@ -59,8 +59,6 @@ function getSupportedLanguage() {
   _language.push('.jsx');
   _language.push('.ts');
   _language.push('.tsx');
-  _language.push('.css');
-  _language.push('.scss');
   return _language;
 }
 function getRunningEnv() {

package/build/utils/PluginsInstallation/arePluginsInstalled.js

@@ -6,12 +6,19 @@ const {
 const {
   printUninstalledPlugins
 } = require('./printUninstalledPlugins');
+const {
+  installPlugins
+} = require('./installPlugins');
 function arePluginsInstalled() {
   let {
     uninstalledPlugins,
     noPluginMessage
   } = checkIfPluginsAreInstalled();
-  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

@@ -128,6 +128,15 @@ function checkIfPluginsAreInstalled() {
   }
 }
 
+/**
+ * @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 
@@ -159,7 +168,9 @@ function checkPluginsPresentInNodemodules(rulePluginName) {
 function checkPluginHasProperVersion(rulePluginName, installationPath, remotePluginVersion) {
   const pluginPathArray = installationPath.toString().split(rulePluginName);
   const rulePluginPackageJSONPath = path.join(pluginPathArray[0], rulePluginName, 'package.json');
-  return remotePluginVersion == require(rulePluginPackageJSONPath).version ? true : false;
+  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');
@@ -26,7 +29,8 @@ const {
 function installPlugins(pluginsToBeInstalled) {
   // let {uninstalledPlugins : pluginsToBeInstalled} = checkIfPluginsAreInstalled()
   if (pluginsToBeInstalled.length > 0) {
-    let installCommand = `npm install --save ${pluginsToBeInstalled.join(' ')}`;
+    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, {
@@ -35,18 +39,44 @@ function installPlugins(pluginsToBeInstalled) {
     }], '', 'Some issue occured while installing plugins', false, true);
     if (arePluginsInstalledSuccessfully) {
       Logger.log(Logger.SUCCESS_TYPE, 'Plugins installation successful');
-      createVersionControlFile(pluginsToBeInstalled);
-      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/package.json

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

package/build/utils/PluginsInstallation/Worker/installPluginsByWoker.js

@@ -1,35 +0,0 @@
-"use strict";
-
-const {
-  Worker
-} = require('worker_threads');
-async function installPluginsByWorker(plugins) {
-  try {
-    const results = await Promise.all(plugins.map(pkg => runWorker({
-      packageName: pkg.packageName,
-      version: pkg.version
-    })));
-    console.log('Package are installed By from workers:', results.join('\n'));
-  } catch (error) {
-    console.error('Error:', error);
-  }
-}
-function runWorker(data) {
-  return new Promise((resolve, reject) => {
-    const worker = new Worker(`${__dirname}/worker.js`, {
-      workerData: data
-    });
-    worker.on('message', result => {
-      resolve(result);
-    });
-    worker.on('error', error => {
-      reject(error);
-    });
-    worker.on('exit', code => {
-      if (code !== 0) {
-        reject(new Error(`Worker stopped with exit code ${code}`));
-      }
-    });
-  });
-}
-module.exports = installPluginsByWorker;

package/build/utils/PluginsInstallation/Worker/worker.js

@@ -1,33 +0,0 @@
-"use strict";
-
-const {
-  workerData,
-  parentPort
-} = require('worker_threads');
-const {
-  spawnSync
-} = require('child_process');
-const {
-  getNodeModulesPath
-} = require('../../General/getNodeModulesPath');
-function performanceInstalllation({
-  packageName,
-  version
-}) {
-  const start = performance.now();
-  try {
-    require.resolve(packageName);
-  } catch (err) {
-    spawnSync('npm', ['install', `${packageName}@${version}`, '--no-save'], {
-      stdio: 'inherit',
-      cwd: getNodeModulesPath()
-    });
-  }
-  const end = performance.now();
-  return `Package ${packageName}@${version} installed successfully and installed in ${end - start} ms`;
-}
-const result = performanceInstalllation({
-  packageName: workerData.packageName,
-  version: workerData.version
-});
-parentPort.postMessage(result);