Merge pull request #79 from alma/feature/pre-commit-hook

Implement pre-commit hook
alma · Sep 20, 2023 · a5b923a · a5b923a
2 parents e73c545 + a43918d
commit a5b923a
Show file tree

Hide file tree

Showing 10 changed files with 102 additions and 40 deletions.
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,8 @@
+{
+  "node": true,
+  "esversion": 8,
+  "predef": [
+    "describe",
+    "it"
+  ]
+}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,61 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=1024"]
+      - id: detect-private-key
+      - id: check-merge-conflict
+
+  - repo: https://github.com/pre-commit/mirrors-jshint
+    rev: v2.13.6
+    hooks:
+      - id: jshint
+        files: "(^.*\\.js$)"
+
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v8.29.0
+    hooks:
+      - id: eslint
+        files: "(^cartridges/int_alma/cartridge/.*\\.js$)"# *.js, *.jsx, *.ts and *.tsx
+        types: [file]
+        args:
+          - --fix
+
+  - repo: https://github.com/thibaudcolas/pre-commit-stylelint
+    rev: v14.16.0
+    hooks:
+      - id: stylelint
+        files: "(^cartridges/int_alma/cartridge/static/default/css/.*\\.css$)"
+        args:
+          - --config
+          - .stylelintrc.json
+        additional_dependencies:
+          - [email protected]
+          - [email protected]
+          - [email protected]
+          - [email protected]
+
+#  - repo: https://github.com/returntocorp/semgrep
+#    rev: v1.27.0
+#    hooks:
+#      - id: semgrep
+#        args:
+#          - --error
+#          - --config
+#          - semgrep/rules/
+#          - --metrics
+#          - "off"
+#          - --quiet
+#          - --disable-version-check
+#          - --skip-unknown-extensions
+#        pass_filenames: false # Passing files explicitely override semgremignore
+
+  - repo: https://github.com/alma/pre-commit-hooks
+    rev: 1.1.2
+    hooks:
+      - id: check-branch-name
+        args:
+          - "-r^((chore|ci|dependabot|devx|docs|feature|fix|hotfix|hotfix-backport|infra|other|perf|refactor|security|test)\/.+|(snyk)-.+|main|HEAD)$$"
diff --git a/cartridges/int_alma/cartridge/scripts/helpers/almaCheckoutHelper.js b/cartridges/int_alma/cartridge/scripts/helpers/almaCheckoutHelper.js
@@ -19,12 +19,8 @@ var paymentMethodId = '';
  * @returns {string} the custom site preference name
  */
 function getSelectorNameFromPlan(plan) {
-    return 'ALMA_general_'
-        // number of installments (p1x, p3x, p4x, ....)
-        + plan.installments_count + '_'
-        // by how many days is the payment defered
-        + plan.deferred_days
-        ;
+    // ALMA_general + number of installments (p1x, p3x, p4x, ....) + by how many days is the payment defered
+    return 'ALMA_general_' + plan.installments_count + '_' + plan.deferred_days;
 }
 
 /**
@@ -210,9 +206,7 @@ function getPlanPaymentMethodID(plan) {
     if (plan.deferred_days > 0 && planIsActivated(PaymentMgr.getPaymentMethod(ALMA_DEFERRED_ID), plan)) {
         paymentMethodId = ALMA_DEFERRED_ID;
     }
-    if (plan.installments_count === 1
-        && plan.deferred_days === 0
-        && planIsActivated(PaymentMgr.getPaymentMethod(ALMA_PAY_NOW_ID), plan)) {
+    if (plan.installments_count === 1 && plan.deferred_days === 0 && planIsActivated(PaymentMgr.getPaymentMethod(ALMA_PAY_NOW_ID), plan)) {
         paymentMethodId = ALMA_PAY_NOW_ID;
     }
 

diff --git a/cartridges/int_alma/cartridge/scripts/helpers/almaOnShipmentHelper.js b/cartridges/int_alma/cartridge/scripts/helpers/almaOnShipmentHelper.js
@@ -18,9 +18,8 @@ function isOnShipmentPaymentEnabled(installmentsCount, deferredDays) {
         return plan.installments_count === parseInt(installmentsCount, 10) && plan.deferred_days === parseInt(deferredDays, 10);
     });
 
-    return Site.getCurrent().getCustomPreferenceValue('ALMA_On_Shipment_Payment')
-        && requestedPlan !== null
-        && requestedPlan.deferred_trigger_limit_days !== null;
+    return Site.getCurrent()
+        .getCustomPreferenceValue('ALMA_On_Shipment_Payment') && requestedPlan !== null && requestedPlan.deferred_trigger_limit_days !== null;
 }
 
 module.exports = {

diff --git a/cartridges/int_alma/cartridge/scripts/helpers/almaPaymentHelper.js b/cartridges/int_alma/cartridge/scripts/helpers/almaPaymentHelper.js
@@ -1,4 +1,5 @@
 'use strict';
+
 var pkg = require('../../../package.json');
 
 /**

diff --git a/cartridges/int_alma/cartridge/scripts/helpers/almaPlanHelper.js b/cartridges/int_alma/cartridge/scripts/helpers/almaPlanHelper.js
@@ -27,11 +27,8 @@ function getFeePlans() {
  * @returns {string} site preference name
  */
 function getSitePrefNameFromPlan(plan) {
-    return 'ALMA_general_'
-        // number of installments (p1x, p3x, p4x, ....)
-        + plan.installments_count + '_'
-        // by how many days is the payment deferred
-        + plan.deferred_days
+    // ALMA_general + number of installments (p1x, p3x, p4x, ....) + by how many days is the payment deferred
+    return 'ALMA_general_' + plan.installments_count + '_' + plan.deferred_days
     ;
 }
 
@@ -77,8 +74,7 @@ function applyMerchantConfig(currentPlan) {
  * @returns {Object} plan any alma plan
  */
 function filterWithMerchantConfig(plan, purchaseAmount) {
-    return (purchaseAmount > (plan.min_display_amount / 100))
-        && (purchaseAmount < (plan.max_display_amount / 100));
+    return (purchaseAmount > (plan.min_display_amount / 100)) && (purchaseAmount < (plan.max_display_amount / 100));
 }
 
 /**

diff --git a/cartridges/int_alma/cartridge/scripts/steps/CheckRefund.js b/cartridges/int_alma/cartridge/scripts/steps/CheckRefund.js
@@ -7,10 +7,9 @@
  */
 function isOrderToBeRefund(order) {
     return (
-        order.custom.almaRefundType.toString() === 'Total'
-        || (order.custom.almaRefundType.toString() === 'Partial'
-            && order.custom.almaWantedRefundAmount > 0
-            && order.custom.almaWantedRefundAmount < order.totalGrossPrice.value)
+        order.custom.almaRefundType.toString() === 'Total' || (
+            order.custom.almaRefundType.toString() === 'Partial' && order.custom.almaWantedRefundAmount > 0 && order.custom.almaWantedRefundAmount < order.totalGrossPrice.value
+        )
     );
 }
 
@@ -66,6 +65,7 @@ exports.execute = function () {
                             Logger.info('Partial refund is not yet implemented with deferred payment - order id {0}', [orderItem.orderNo]);
                         }
 
+                        /* jshint loopfunc: true */
                         // eslint-disable-next-line no-loop-func
                         Transaction.wrap(function () {
                             orderItem.custom.ALMA_Deferred_Capture = deferredStatus;

diff --git a/cartridges/int_alma/cartridge/static/default/css/almaContent.css b/cartridges/int_alma/cartridge/static/default/css/almaContent.css
@@ -1,5 +1,4 @@
 .alma-content .pay-type {
-    /* background: #cccccc7a;*/
     border-radius: 5px;
     margin-top: 10px;
     cursor: pointer;
@@ -42,11 +41,11 @@
 }
 
 .alma-content .pay-type p {
-    color:  var(--color-grey6);
+    color: var(--color-grey6);
 }
 
 .alma-content .pay-type .no-margin {
-    margin-bottom: 0px;
+    margin-bottom: 0;
 }
 
 .alma-content .loading {
@@ -86,7 +85,8 @@
 .alma-lds-ring div:nth-child(3) {
     animation-delay: -0.15s;
 }
-.alma-error-message{
+
+.alma-error-message {
     color: red;
     font-size: small;
     text-align: center;

diff --git a/test/mocks/helpers/almaOrderHelpers.js b/test/mocks/helpers/almaOrderHelpers.js
@@ -1,4 +1,5 @@
 'use strict';
+
 var sinon = require('sinon');
 var proxyquire = require('proxyquire')
     .noCallThru()

diff --git a/test/util.js b/test/util.js
@@ -1,4 +1,5 @@
 'use strict';
+
 var ArrayList = require('./mocks/dw.util.Collection');
 
 module.exports = function toProductMock(mock) {
@@ -8,20 +9,21 @@ module.exports = function toProductMock(mock) {
 
     var result = {};
     if (typeof mock === 'object') {
-        Object.keys(mock).forEach(function (item) {
-            if (typeof mock[item] === 'object') {
-                if (mock[item] && mock[item].type === 'function') {
-                    var innerMock = typeof mock[item].return !== 'undefined'
-                        ? toProductMock(mock[item].return)
-                        : toProductMock(mock[item]);
-                    result[item] = function () { return innerMock; };
-                } else {
-                    result[item] = toProductMock(mock[item]);
+        Object.keys(mock)
+            .forEach(function (item) {
+                if (typeof mock[item] === 'object') {
+                    if (mock[item] && mock[item].type === 'function') {
+                        var innerMock = typeof mock[item].return !== 'undefined' ? toProductMock(mock[item].return) : toProductMock(mock[item]);
+                        result[item] = function () {
+                            return innerMock;
+                        };
+                    } else {
+                        result[item] = toProductMock(mock[item]);
+                    }
+                } else if (item !== 'function' || item !== 'return') {
+                    result[item] = mock[item];
                 }
-            } else if (item !== 'function' || item !== 'return') {
-                result[item] = mock[item];
-            }
-        });
+            });
     } else {
         result = mock;
     }