Merge pull request #345 from woocommerce/dev/281-nodejs-18-and-bump-d…

…ev-deps Upgrade to Node.js 18 and bump all NPM dev dependencies
woocommerce · Jan 4, 2024 · fdb9a70 · fdb9a70
2 parents 1eca13b + 917f9ca
commit fdb9a70
Show file tree

Hide file tree

Showing 5 changed files with 12,599 additions and 7,224 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-v14
+v18
diff --git a/assets/js/src/tracking.js b/assets/js/src/tracking.js
@@ -15,8 +15,8 @@ let currentStep = -1;
 /**
  * Tracks view_item_list event
  *
- * @param {Object} params The function params
- * @param {Array} params.products The products to track
+ * @param {Object} params            The function params
+ * @param {Array}  params.products   The products to track
  * @param {string} [params.listName] The name of the list in which the item was presented to the user.
  */
 export const trackListProducts = ( {
@@ -39,8 +39,8 @@ export const trackListProducts = ( {
 /**
  * Tracks add_to_cart event
  *
- * @param {Object} params The function params
- * @param {Array} params.product The product to track
+ * @param {Object} params              The function params
+ * @param {Array}  params.product      The product to track
  * @param {number} [params.quantity=1] The quantity of that product in the cart.
  */
 export const trackAddToCart = ( { product, quantity = 1 } ) => {
@@ -57,8 +57,8 @@ export const trackAddToCart = ( { product, quantity = 1 } ) => {
 /**
  * Tracks remove_from_cart event
  *
- * @param {Object} params The function params
- * @param {Array} params.product The product to track
+ * @param {Object} params              The function params
+ * @param {Array}  params.product      The product to track
  * @param {number} [params.quantity=1] The quantity of that product in the cart.
  */
 export const trackRemoveCartItem = ( { product, quantity = 1 } ) => {
@@ -75,8 +75,8 @@ export const trackRemoveCartItem = ( { product, quantity = 1 } ) => {
 /**
  * Tracks change_cart_quantity event
  *
- * @param {Object} params The function params
- * @param {Array} params.product The product to track
+ * @param {Object} params              The function params
+ * @param {Array}  params.product      The product to track
  * @param {number} [params.quantity=1] The quantity of that product in the cart.
  */
 export const trackChangeCartItemQuantity = ( { product, quantity = 1 } ) => {
@@ -133,10 +133,10 @@ export const trackCheckoutStep =
  * Track a set_checkout_option event
  * Notice calling this will set the current checkout step as the step provided in the parameter.
  *
- * @param {Object} params The params from the option.
- * @param {number} params.step The step to track
+ * @param {Object} params        The params from the option.
+ * @param {number} params.step   The step to track
  * @param {string} params.option The option to set in checkout
- * @param {string} params.value The value for the option
+ * @param {string} params.value  The value for the option
  *
  * @return {(function() : void)} A callable to track the checkout event.
  */
@@ -155,8 +155,8 @@ export const trackCheckoutOption =
 /**
  * Tracks select_content event.
  *
- * @param {Object} params The function params
- * @param {Object} params.product The product to track
+ * @param {Object} params          The function params
+ * @param {Object} params.product  The product to track
  * @param {string} params.listName The name of the list in which the item was presented to the user.
  */
 export const trackSelectContent = ( {
@@ -172,7 +172,7 @@ export const trackSelectContent = ( {
 /**
  * Tracks search event.
  *
- * @param {Object} params The function params
+ * @param {Object} params            The function params
  * @param {string} params.searchTerm The search term to track
  */
 export const trackSearch = ( { searchTerm } ) => {
@@ -184,8 +184,8 @@ export const trackSearch = ( { searchTerm } ) => {
 /**
  * Tracks view_item event
  *
- * @param {Object} params The function params
- * @param {Object} params.product The product to track
+ * @param {Object} params            The function params
+ * @param {Object} params.product    The product to track
  * @param {string} [params.listName] The name of the list in which the item was presented to the user.
  */
 export const trackViewItem = ( {
@@ -202,8 +202,8 @@ export const trackViewItem = ( {
 /**
  * Track exception event
  *
- * @param {Object} params The function params
- * @param {string} params.status The status of the exception. It should be "error" for tracking it.
+ * @param {Object} params         The function params
+ * @param {string} params.status  The status of the exception. It should be "error" for tracking it.
  * @param {string} params.content The exception description
  */
 export const trackException = ( { status, content } ) => {
@@ -218,7 +218,7 @@ export const trackException = ( { status, content } ) => {
 /**
  * Track an event using the global gtag function.
  *
- * @param {string} eventName - Name of the event to track
+ * @param {string} eventName     - Name of the event to track
  * @param {Object} [eventParams] - Props to send within the event
  */
 export const trackEvent = ( eventName, eventParams ) => {

diff --git a/assets/js/src/utils.js b/assets/js/src/utils.js
@@ -4,7 +4,7 @@ import { addAction, removeAction } from '@wordpress/hooks';
  * Formats data into the productFieldObject shape.
  *
  * @see https://developers.google.com/analytics/devguides/collection/gtagjs/enhanced-ecommerce#product-data
- * @param {Object} product - The product data
+ * @param {Object} product  - The product data
  * @param {number} quantity - The product quantity
  *
  * @return {Object} The product data
@@ -26,7 +26,7 @@ export const getProductFieldObject = ( product, quantity ) => {
  * Formats data into the impressionFieldObject shape.
  *
  * @see https://developers.google.com/analytics/devguides/collection/gtagjs/enhanced-ecommerce#impression-data
- * @param {Object} product - The product data
+ * @param {Object} product  - The product data
  * @param {string} listName - The list for this product
  *
  * @return {Object} - The product impression data
@@ -47,7 +47,7 @@ export const getProductImpressionObject = ( product, listName ) => {
 /**
  * Returns the price of a product formatted as a string.
  *
- * @param {string} price - The price to parse
+ * @param {string} price                 - The price to parse
  * @param {number} [currencyMinorUnit=2] - The number decimals to show in the currency
  *
  * @return {string} - The price of the product formatted
@@ -59,9 +59,9 @@ export const formatPrice = ( price, currencyMinorUnit = 2 ) => {
 /**
  * Removes previous actions with the same hookName and namespace and then adds the new action.
  *
- * @param {string} hookName The hook name for the action
- * @param {string} namespace The unique namespace for the action
- * @param {Function} callback The function to run when the action happens.
+ * @param {string}   hookName  The hook name for the action
+ * @param {string}   namespace The unique namespace for the action
+ * @param {Function} callback  The function to run when the action happens.
  */
 export const addUniqueAction = ( hookName, namespace, callback ) => {
 	removeAction( hookName, namespace );