@zohodesk/codestandard-validator 0.0.2-exp-7 → 0.0.2-exp-8

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

@@ -12,7 +12,8 @@ const {
   getNodeModulesPath
 } = require('../../utils/General/getNodeModulesPath');
 const {
-  filterFiles
+  filterFiles,
+  filterWarningInFile
 } = require('../../utils/FileAndFolderOperations/filterFiles');
 const {
   Logger
@@ -28,7 +29,8 @@ const {
   getSupportedLanguage
 } = require('../../utils/General/getGeneralInfo');
 const {
-  impactBasedPrecommit
+  impactBasedPrecommit,
+  shouldWarningsAbortCommit
 } = getConfigurationPrecommit();
 
 /**
@@ -129,6 +131,21 @@ function areAllPluginsInstalled() {
   return unInstalledPlugins.length === 0 ? true : false;
 }
 
+/**
+ * @function {isOnlyWarningsPresentInFile} - method that checks if only eslint warnings are present in a file
+ * @returns {Boolean} - returns boolean based on only warnings present or not in file
+ */
+function isOnlyWarningsPresentInFile(eslintErrorsPresentInFile) {
+  let severityOfEachErrorInFile = [];
+  let startIndex = 1;
+  let endIndex = eslintErrorsPresentInFile.length - 2;
+  eslintErrorsPresentInFile.slice(startIndex, endIndex).map(error => {
+    let partsInString = error.split(" ");
+    severityOfEachErrorInFile.push(partsInString[1]);
+  });
+  return severityOfEachErrorInFile.includes('error');
+}
+
 /**
  * @function {preCommitHook} - method execute pre commit hook
  * @returns {void}
@@ -170,19 +187,21 @@ async function preCommitHook() {
             let currentFileName = staged_files[file];
             let changedLinesArray = [];
             let eslintErrorsInChangedLines = [];
+            let isOnlyEslintWarningsPresentInFile = false;
             if (getSupportedLanguage().includes(path.extname(staged_files[file]))) {
               try {
-                let eslintErrorsInFile = await findEslintErrors(staged_files[file]);
+                var eslintErrorsInFile = await findEslintErrors(staged_files[file]);
+                // eslintErrorsInFile = impactBasedPrecommit == false ? filterWarningInFile(eslintErrorsInFile) : eslintErrorsInFile
+                isOnlyEslintWarningsPresentInFile = isOnlyWarningsPresentInFile(eslintErrorsInFile);
                 if (staged_files[file] && typeof staged_files[file] == 'string') {
                   if (!eslintErrorsInFile.length == 0) {
-                    //git diff is computed and stored in an array
-                    let git_diff = await calculateGitDiffForFile(current_branch, staged_files[file]);
-                    changedLinesArray = git_diff.filter(line => line.startsWith('@@'));
-                    let changedLinesStartArray = [];
-                    let changedLinesEndArray = [];
-
                     //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, staged_files[file]);
+                      changedLinesArray = git_diff.filter(line => line.startsWith('@@'));
+                      let changedLinesStartArray = [];
+                      let changedLinesEndArray = [];
                       for (let number of changedLinesArray) {
                         let changesStartLine = parseInt(number.split(' ')[2].split(',')[0]);
                         changedLinesStartArray.push(changesStartLine);
@@ -210,15 +229,23 @@ async function preCommitHook() {
                         for (let eslintError of eslintErrorsInChangedLines) {
                           Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
                         }
-                        hasEslintErrorsInChangedLines = true;
+                        if (shouldWarningsAbortCommit) {
+                          hasEslintErrorsInChangedLines = true;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInChangedLines = false;
+                        }
                       }
                     } else {
                       if (eslintErrorsInFile.length > 0) {
                         Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
-                        for (let eslintError of eslintErrorsInChangedLines) {
+                        for (let eslintError of eslintErrorsInFile) {
                           Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
                         }
-                        hasEslintErrorsInFiles = true;
+                        if (shouldWarningsAbortCommit) {
+                          hasEslintErrorsInFiles = true;
+                        } else if (!shouldWarningsAbortCommit && isOnlyEslintWarningsPresentInFile) {
+                          hasEslintErrorsInFiles = false;
+                        }
                       }
                     }
                   }
@@ -235,10 +262,10 @@ async function preCommitHook() {
       } catch {
         Logger.log(Logger.INFO_TYPE, 'Error executing pre commit hook');
       }
-      if (hasEslintErrorsInChangedLines) {
+      if (hasEslintErrorsInChangedLines && areFilesStaged) {
         Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
         process.exit(1);
-      } else if (hasEslintErrorsInFiles) {
+      } else if (hasEslintErrorsInFiles && areFilesStaged) {
         Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
         process.exit(1);
       } else if (!hasEslintErrorsInFiles && !hasEslintErrorsInChangedLines && areFilesStaged) {

package/build/setup/sample.config.js

@@ -30,6 +30,7 @@ module.exports = {
   tsConfigurationPath: path.resolve(process.cwd(), 'tsconfig.json'),
   projectId: `project-id`,
   impactBasedPrecommit: true,
+  shouldWarningsAbortCommit: false,
   token: "w-OkG3f5OOM1Rkly8phZ",
   compareBranch: 'release'
 };

package/build/utils/FileAndFolderOperations/filterFiles.js

@@ -36,6 +36,15 @@ function filterFiles(arrayOfFilesToBeFiltered, filesToBeRemoved, isConfigFileNee
     return arrayOfFilesToBeFiltered;
   }
 }
+
+/**
+ * @function filterWarningInFile - filter warning in files
+ * @returns {Array<string>}
+ */
+function filterWarningInFile(array) {
+  // handle error in file 
+}
 module.exports = {
-  filterFiles
+  filterFiles,
+  filterWarningInFile
 };

package/build/utils/General/getGeneralInfo.js

@@ -52,10 +52,10 @@ function getConfigurationPrecommit() {
  */
 function getSupportedLanguage() {
   const _language = [];
-  _language.push('js');
-  _language.push('jsx');
-  _language.push('ts');
-  _language.push('tsx');
+  _language.push('.js');
+  _language.push('.jsx');
+  _language.push('.ts');
+  _language.push('.tsx');
   return _language;
 }
 module.exports = {

package/package.json

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