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

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

@@ -23,6 +23,13 @@ const {
 const {
   getBranchName
 } = require('../../utils/GitActions/gitActions');
+const {
+  getConfigurationPrecommit,
+  getSupportedLanguage
+} = require('../../utils/General/getGeneralInfo');
+const {
+  impactBasedPrecommit
+} = getConfigurationPrecommit();
 
 /**
  * @function isMergeCommit - This method check whether it is merge or not
@@ -141,6 +148,7 @@ async function preCommitHook() {
       let exemptionFiles = [];
       let current_branch = '';
       let hasEslintErrorsInChangedLines = false;
+      let hasEslintErrorsInFiles = false;
       let areFilesStaged = false;
       try {
         current_branch = await getBranchName();
@@ -162,7 +170,7 @@ async function preCommitHook() {
             let currentFileName = staged_files[file];
             let changedLinesArray = [];
             let eslintErrorsInChangedLines = [];
-            if (path.extname(staged_files[file]) === '.js') {
+            if (getSupportedLanguage().includes(path.extname(staged_files[file]))) {
               try {
                 let eslintErrorsInFile = await findEslintErrors(staged_files[file]);
                 if (staged_files[file] && typeof staged_files[file] == 'string') {
@@ -174,34 +182,44 @@ async function preCommitHook() {
                     let changedLinesEndArray = [];
 
                     //Calculating changed lines in a file and storing them in respective arrays
-                    for (let number of changedLinesArray) {
-                      let changesStartLine = parseInt(number.split(' ')[2].split(',')[0]);
-                      changedLinesStartArray.push(changesStartLine);
-                      let changesEndLine = number.split(' ')[2].split(',')[1];
-                      if (changesEndLine === undefined) {
-                        changedLinesEndArray.push(changesStartLine);
-                      } else {
-                        changedLinesEndArray.push(changesStartLine + parseInt(changesEndLine) - 1);
+                    if (impactBasedPrecommit) {
+                      for (let number of changedLinesArray) {
+                        let changesStartLine = parseInt(number.split(' ')[2].split(',')[0]);
+                        changedLinesStartArray.push(changesStartLine);
+                        let changesEndLine = number.split(' ')[2].split(',')[1];
+                        if (changesEndLine === undefined) {
+                          changedLinesEndArray.push(changesStartLine);
+                        } else {
+                          changedLinesEndArray.push(changesStartLine + parseInt(changesEndLine) - 1);
+                        }
                       }
-                    }
-                    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
+                      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 = eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0];
-                      for (let lineNumber in changedLinesStartArray) {
-                        if (eslintErrorLineNumber >= changedLinesStartArray[lineNumber] && eslintErrorLineNumber <= changedLinesEndArray[lineNumber]) {
-                          eslintErrorsInChangedLines.push(eslintErrorsInFile[error]);
+                        let eslintErrorLineNumber = eslintErrorsInFile[error].trim().split(' ')[0].split(':')[0];
+                        for (let lineNumber in changedLinesStartArray) {
+                          if (eslintErrorLineNumber >= changedLinesStartArray[lineNumber] && eslintErrorLineNumber <= changedLinesEndArray[lineNumber]) {
+                            eslintErrorsInChangedLines.push(eslintErrorsInFile[error]);
+                          }
                         }
                       }
-                    }
-                    if (eslintErrorsInChangedLines.length > 0) {
-                      Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
-                      for (let eslintError of eslintErrorsInChangedLines) {
-                        Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                      if (eslintErrorsInChangedLines.length > 0) {
+                        Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
+                        for (let eslintError of eslintErrorsInChangedLines) {
+                          Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                        }
+                        hasEslintErrorsInChangedLines = true;
+                      }
+                    } else {
+                      if (eslintErrorsInFile.length > 0) {
+                        Logger.log(Logger.FAILURE_TYPE, `\x1b[1m${currentFileName}\x1b[0m`);
+                        for (let eslintError of eslintErrorsInChangedLines) {
+                          Logger.log(Logger.FAILURE_TYPE, `\x1b[37m${eslintError.trimEnd()}\x1b[0m`);
+                        }
+                        hasEslintErrorsInFiles = true;
                       }
-                      hasEslintErrorsInChangedLines = true;
                     }
                   }
                 }
@@ -220,7 +238,10 @@ async function preCommitHook() {
       if (hasEslintErrorsInChangedLines) {
         Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
         process.exit(1);
-      } else if (!hasEslintErrorsInChangedLines && areFilesStaged) {
+      } else if (hasEslintErrorsInFiles) {
+        Logger.log(Logger.FAILURE_TYPE, `There are eslint errors present. So commit is aborted`);
+        process.exit(1);
+      } else if (!hasEslintErrorsInFiles && !hasEslintErrorsInChangedLines && areFilesStaged) {
         Logger.log(Logger.SUCCESS_TYPE, `Commit Successful`);
         process.exit(0);
       }

package/build/setup/sample.config.js

@@ -0,0 +1,35 @@
+"use strict";
+
+const path = require("path");
+
+/**
+ * Configuration object for linting and reporting.
+ * @property {string} ruleConfigurationPath - The path to the ESLint configuration file.
+ * @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} 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
+ * @property {number} projectId - project id of repository
+ * @property {boolean} impactBasedPrecommit - Indicates if the linting is impact-based in pre commit
+ * @property {string} token - Encrypted Authentication Token
+ * @property {string} compareBranch - Branch to compare diff
+ */
+
+module.exports = {
+  ruleConfigurationPath: path.resolve(process.cwd(), ".eslintrc.js"),
+  impactBased: true,
+  lintReportPath: path.resolve(process.cwd(), "lint-report", "lintReport.json"),
+  metricServerHost: "https://client-linters.zohodesk.csez.zohocorpin.com",
+  exemptionInstanceHost: "",
+  metric_token: "zxh_9737850jh2l53ml17223929ihii73072j54j2260",
+  branchDiffPath: path.resolve(process.cwd(), "diffBranch.json"),
+  gitEndPoint: "https://zgit.csez.zohocorpin.com",
+  tsConfigurationPath: path.resolve(process.cwd(), 'tsconfig.json'),
+  projectId: `project-id`,
+  impactBasedPrecommit: true,
+  token: "w-OkG3f5OOM1Rkly8phZ",
+  compareBranch: 'release'
+};

package/build/utils/General/getGeneralInfo.js

@@ -1,6 +1,8 @@
 "use strict";
 
 const os = require('os');
+const path = require('path');
+const fs = require("fs");
 
 /**
  * @function getTimeStampInfo - to fetch various timestamp details
@@ -25,7 +27,40 @@ function getTimeStampInfo() {
 function getEnv() {
   return os.type();
 }
+
+/**
+ * @function getConfigPath - get a path of lint configuration path
+ * @returns {string}
+ */
+function getConfigPath() {
+  const configPath = path.resolve(process.cwd(), 'lint.config.js');
+  const defaultConfigPath = path.resolve(__dirname, '..', '..', 'setup', 'sample.config.js');
+  return fs.exitSync(configPath) ? configPath : defaultConfigPath;
+}
+
+/**
+ * @function getConfiguration - get configuration object of lint configuration
+ * @returns
+ */
+function getConfigurationPrecommit() {
+  return require(getConfigPath());
+}
+
+/**
+ * @function getSupportedLanguage - get support language
+ * @returns {Array<string>}
+ */
+function getSupportedLanguage() {
+  const _language = [];
+  _language.push('js');
+  _language.push('jsx');
+  _language.push('ts');
+  _language.push('tsx');
+  return _language;
+}
 module.exports = {
+  getSupportedLanguage,
   getTimeStampInfo,
-  getEnv
+  getEnv,
+  getConfigurationPrecommit
 };

package/build/utils/HuskySetup/initializeHusky.js

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

package/build/utils/HuskySetup/setupHusky.js

@@ -26,7 +26,7 @@ let isCustomPrecommitConfigurationSuccessful = false;
  * @returns {boolean} - indicating whether entire custom precommit hook setup using husky process is success or failure
  */
 function setupHusky() {
-  let isHuskyPackageInstalled = true; //installHuskyPackage()
+  let isHuskyPackageInstalled = installHuskyPackage();
   if (isHuskyPackageInstalled) {
     let isHuskyInitializedSuccessfully = initializeHusky();
     if (isHuskyInitializedSuccessfully) {

package/changeLog.md

@@ -1,6 +1,12 @@
 # Code standard library
 
 # 0.0.0
+ 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
+
+# 0.0.2 - first stable release of the library
  1. Sets up a custom precommit hook using husky
  2. clones the common linter configuration repository in developer branch 
  3. Based on the cloned configuration folder creates a eslint config file

package/package.json

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

package/configuration/common/.eslintrc.js

@@ -1,18 +0,0 @@
-const { rulesConfig, plugins, extendPlugins } = require("@zohodesk/codestandard-validator"); //no i18n
-const [off, , error] = ["off", "warn", "error"];
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-  },
-  extends: extendPlugins,
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 12,
-    sourceType: "module",
-  },
-  plugins: plugins,
-  overrides: rulesConfig
-};

package/configuration/common/index.js

@@ -1,9 +0,0 @@
-const { zsecurityRules } = require('./rule_configuration/configurations')
-const $plugins =  require('./pluginVersion')
-
-
-module.exports = { 
-    rulesConfig : Object.assign([],[...zsecurityRules]),
-    plugins:$plugins.map((plugin) =>  plugin?.plugin).filter(item => item !== undefined) ,
-    extendPlugins:$plugins.map((plugin) =>  plugin?.extend).filter(item => item !== undefined) 
-}

package/configuration/common/pluginVersion.js

@@ -1,7 +0,0 @@
-module.exports = [
-  {
-    packageName: "@zohodesk/eslint-plugin-zsecurity",
-    version: "0.0.1-beta.4",
-    plugin: "@zohodesk/zsecurity"
-  }
-];

package/configuration/common/rule_configuration/configurations.js

@@ -1,9 +0,0 @@
-module.exports.zsecurityRules = [
-  {
-    files: ["src/**/*.js"],
-    rules: {
-      "@zohodesk/zsecurity/no-unsecure-html": 'error',
-      "@zohodesk/zsecurity/no-protocol-check": 'error',
-    },
-  },
-];

package/configuration/services/desk_client_app/.eslintrc.js

@@ -1,18 +0,0 @@
-const { rulesConfig, plugins, extendPlugins } = require("@zohodesk/codestandard-validator"); //no i18n
-const [off, , error] = ["off", "warn", "error"];
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-  },
-  extends: extendPlugins,
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
-    },
-    ecmaVersion: 12,
-    sourceType: "module",
-  },
-  plugins: plugins,
-  overrides: rulesConfig
-};

package/configuration/services/desk_client_app/index.js

@@ -1,16 +0,0 @@
-const { plugins ,  rulesConfig} = require('../../common/index')
-const { architectureRules } = require("./rule_configuration/architectureRules/bestPracticeRules")
-const { i18Configuration } = require("./rule_configuration/i18nRules/noHardcodingRuleExcludes") 
-const $plugins =  [...require('./pluginVersion'), ...plugins ]
-
-
-module.exports = { 
-    rulesConfig : Object.assign([],[...architectureRules,...i18Configuration,...rulesConfig])   ,
-    plugins:$plugins.map((plugin) =>  plugin?.plugin).filter(item => item !== undefined) ,
-    extendPlugins:$plugins.map((plugin) =>  plugin?.extend).filter(item => item !== undefined) 
-}
-
-
-
-
-

package/configuration/services/desk_client_app/pluginVersion.js

@@ -1,17 +0,0 @@
-module.exports = [
-  {
-    packageName: "@zohodesk/eslint-plugin-architecturerules",
-    version: "0.0.2-exp-4",
-    plugin: "@zohodesk/architecturerules",
-  },
-  {
-    packageName: "@zohodesk/eslint-plugin-no-hardcoding",
-    version: "1.0.2",
-    plugin: "@zohodesk/no-hardcoding",
-  },
-  {
-    packageName: "@zohodesk/eslint-config-acceptancetest",
-    version: "0.0.3",
-    extend: "@zohodesk/eslint-config-acceptancetest",
-  }
-];

package/configuration/services/desk_client_app/rule_configuration/architectureRules/bestPracticeRules.js

@@ -1,9 +0,0 @@
-module.exports.architectureRules  = [
-    {
-        files: ['src/**/*.js'],
-        rules: {
-            '@zohodesk/architecturerules/no-unused-vars' : 'warn',
-            '@zohodesk/architecturerules/no-comments-rule':'warn'
-        }
-    }
-]

package/configuration/services/desk_client_app/rule_configuration/i18nRules/noHardcodingRuleExcludes.js

@@ -1,32 +0,0 @@
-let noHardcodingRuleExcludes = {
-    objectKeys:["dataId","data-id","data-test-id","size","iconSize","iconName","align","alignBox","palette","scroll","boxSize","boxPosition","type","moduleName","apiname","apiName","id","target","tagName","module","folderName","componentGroup","hoverType","tabIndex","aria-Label","aria-label","ariaLabel","d","className","rel","heading","column","row","transform","color","condition","fieldName","animationStyle","textBoxVariant","searchBoxSize","src","display","href","width","height","enctype","target","left","top","position","location","backgroundColor","visibility","cursor","lineHeight","border","readOnly","textAlign","scrolling","class","padding","overflow","textBoxSize","right","top","bottom","left","fieldType","regex","searchModuleFieldName","searchConditionValue","logoName","_id"],
-    props:["dataId","data-id","data-test-id","size","iconSize","iconName","align","alignBox","palette","scroll","boxSize","boxPosition","type","moduleName","apiname","apiName","id","target","tagName","module","folderName","componentGroup","hoverType","tabIndex","aria-Label","aria-label","ariaLabel","d","className","rel","heading","column","row","transform","color","condition","fieldName","animationStyle","textBoxVariant","searchBoxSize","src","display","href","width","height","enctype","target","left","top","position","location","backgroundColor","visibility","cursor","lineHeight","border","readOnly","textAlign","scrolling","class","padding","overflow","textBoxSize","right","top","bottom","left","fieldType","logoName","_id"],
-    methods:["findIdex","findIndex","includes","getFieldIndex","oneOf","oneOfType","bind","getFieldLabel","addEventListener","removeEventListener","replace","split","indexOf","set","selectn","getAdditionalProperty","reject","sendResponse","resolve","mapStateToProps","setAttribute","updateError","concat","createElement","getproperty","addElement","getElementsByName","match","lastIndexOf","setRequestHeader","getParameter","getAttribute","RegExp","substring","equals","log","debug","addClass","open","find","setTimeout","attachEvent","addEventListener","removeAttribute","parseInt","replace","setInterval","getObj","detachEvent","removeEventListener","css","animate","bind","ajaxNew","set_cookie","getElementById","ajax","find","createTextNode","parents","removeClass","toggleClass","write","get_cookie","parseFromString","Error","error","querySelector","getDeptBasedData","timeEnd","time","deskCustomError"],
-    allowedTags:["svg"],
-    keys:["Product Category","Product Owner","Product Information","Summarize information","and then","and finally","Support Manager","Newbie Agent","Light Agent","All Accounts","All Contacts","All Cases","Open Cases","Closed Cases","My Cases","All Products","Published Solutions","Open Tasks","All Published Solutions","My Draft Solutions","My Review Solutions","Today+Overdue Tasks","Overdue Cases","My Overdue Cases","Spam Cases","Requests for review","Customer Responded Requests","Customer Responded Time","Unassigned Open Requests","Unassigned Open Cases","SLAViolated Requests","My Open Requests","My Accounts","My Contacts","My Products","All Solutions","My Solutions","All Tasks","My Open Tasks","Todays Tasks","Unpublished Solutions","Overdue Tasks","Tomorrows Tasks","All Contracts","Expired Contracts","My Contracts","My Tasks","Completed Tasks","Missed Chats","All Missed Calls","My Missed Calls","Accounts Unmapped with CRM","Accounts Mapped with CRM","Contacts Unmapped with CRM","Contacts Mapped with CRM","Agent Notification","Contact Notification","Contact Created Time","Public Email Templates","Request has been assigned to you","Request for review","Request moved to the Department","Team Notification","Secondary Contacts Notification","Created By","Created Time","Modified Time","Last Activity Time","Unsubscribed Mode","Unsubscribed Time","Reports To","Date of Birth","New Request Created","Your request has been closed","Requestor has replied to the request","Comment Added for the Request","Comment is deleted from a ticket","Comment is edited in a ticket","Resolution Updated for the Request","Notify support reps on new request","Notify Agent when a comment is deleted for their ticket","Notify Agent when a comment is edited from their ticket","Acknowledge contact on receiving a new ticket","Notify agent on assigning a task","Notify agents when a ticket is moved to their department","Notify all agents when a new ticket is created","Notify contact when a comment is added","Notify contact when a comment is deleted","Notify contact when a comment is edited","Notify contact when a resolution is added","Task has been assigned to you","Remind Task Owner on Set Time","Popular Articles","Remind At","User Information","To Address","Account Name","Contact Information",
-        "All Requests","Product Code","Product Name","Unit Price","Due Date","Case Number","Not Started","In Progress","Waiting on someone else","On Hold","Contact Name","Last Week","Current Week","Last Month","Current Month","Previous FY","Current FY","Next FY","Previous FQ","Current FQ","Next FQ","Next Week","Next Month","Last 60 Days","Last 90 Days","Last 120 Days","Next 7 Days","Next 30 Days","Next 60 Days","Next 90 Days","Next 120 Days","Full Name","Due on","All User","View Requests","Add Request","View Thread","Paid User","Open in New Window","Recent articles","Contract Name","Contract End","Contract Start","Request Id","Contract Number","Sub Category","support.label.Additional Information","Closed Activities","Recent Views","Modified By","Other Phone","Home Phone","Account Number","Request Subject","Request Charge","Other Address","Mailing Address","Billing Address","Shipping Address","Response Due Date","Unassigned Cases","Case On Hold Time","Summarize information by","and then by","and finally by","Time to Respond","Closing Date","crm.label.Product Category","crm.label.Product Owner","crm.label.Product Information","crm.label.Contact Name","Sub Category","mousemove click","Manufacturer","Hour","Deactivated","Review","Notes","CREATEDTIME","Requests","Social","Reports","Report","Solution","Articles","Article","Customized","Title","Fax","Lookup","Chat","Community","Left","Cases","Solutions","Contract","Accounts","Account","Contacts","Contact","Products","Product","Home","Tasks","Calls","Events","IM","Phone","Mobile","Email","Type","Website","Name","Country","Comments","Priority","Description","Department","click","email","is","are","None","this","these","Total","Category","Pending","Status","Subject","Answer","Overdue","between","Top","Customer","Completed","Deferred","Highest","Lowest","High","Low","Normal","Inactive","Open","New","Web","Draft","Duplicate","Closed","Archived","Today","January","February","March","April","May","June","July","August","September","October","November","December","Jan","Feb","Mar","Apr","Jun","Jul","Aug","Sep","Oct","Nov","Dec","days","day","on","User","Records","Private","AllUsers","Month","Avg","General","and","or","currentDateTime","confirmmsg","maxlenmsg","AM","PM","for","Update","to","Direction","hour","hours","minute",
-        "minutes","second","seconds","ago","Move","Unassigned","Expired","Prospect","potential","Lead","Request","Mode","Forums","More","Call","Task","Event","sendingportalinvitation","loading","Custom","loggedinuser_view","everyone_view","onlyagents_view","Agent","Ticket","Attachment","SMS","Subscriptions","ActiveUsersList","DeactivatedUsersList","NotConfirmedUsersList","Content","Created"],
-    commentsToIgnoreHardcodingCheck:["no i18n"],
-    stringsAllowedAsBlockCommentStart: ["ignore i18n start","no i18n start"],
-    stringsAllowedAsBlockCommentEnd: ["ignore i18n end","no i18n end"],
-    dateFormatPatterns:["DD MMM YYYY hh:mm A","DD\/MM\/YYYY h:mm A","DDD, DD MMM YYYY HH:mm:ss","DD MMM YYYY","hh:mm A"]
-}
-const [error,,off] = ['error','','off'] 
-
-let usegetI18NValueAppropriatelyExcludes = {
-    i18nKeys:noHardcodingRuleExcludes.keys,
-    commentsToIgnoreCheck:noHardcodingRuleExcludes.commentsToIgnoreHardcodingCheck
-}
-
-module.exports.i18Configuration  = [
-    {
-        files: ['src/**/*.js'],
-        rules: {
-            '@zohodesk/no-hardcoding/no-hardcoding' : [error,{...noHardcodingRuleExcludes}],
-            '@zohodesk/no-hardcoding/use-getI18NValue-method-appropriately': [error,{...usegetI18NValueAppropriatelyExcludes}]
-        }
-    }
-]
-
-
-