From c621bade172eea1ec4e05b4423033b811c4b9e65 Mon Sep 17 00:00:00 2001 From: Paul Sealock Date: Fri, 31 Jul 2020 07:32:09 +1200 Subject: [PATCH] Currency: re-add deprecated formatCurrency (https://github.com/woocommerce/woocommerce-admin/pull/4891) * Currency: re-add deprecated formatCurrency * better warning * bump removal version to 5.0.0 --- plugins/woocommerce-admin/package-lock.json | 3 ++- .../packages/currency/package.json | 3 ++- .../packages/currency/src/index.js | 20 +++++++++++++++++++ 3 files changed, 24 insertions(+), 2 deletions(-) diff --git a/plugins/woocommerce-admin/package-lock.json b/plugins/woocommerce-admin/package-lock.json index 58e31265cbe..da134fad106 100644 --- a/plugins/woocommerce-admin/package-lock.json +++ b/plugins/woocommerce-admin/package-lock.json @@ -7758,7 +7758,8 @@ "dev": true, "requires": { "@babel/runtime-corejs2": "7.10.5", - "@woocommerce/number": "2.0.0" + "@woocommerce/number": "2.0.0", + "@wordpress/deprecated": "^2.9.0" } }, "@woocommerce/data": { diff --git a/plugins/woocommerce-admin/packages/currency/package.json b/plugins/woocommerce-admin/packages/currency/package.json index b3daebf34fd..2fd9beab493 100644 --- a/plugins/woocommerce-admin/packages/currency/package.json +++ b/plugins/woocommerce-admin/packages/currency/package.json @@ -22,7 +22,8 @@ "react-native": "src/index", "dependencies": { "@babel/runtime-corejs2": "7.10.5", - "@woocommerce/number": "2.0.0" + "@woocommerce/number": "2.0.0", + "@wordpress/deprecated": "^2.9.0" }, "publishConfig": { "access": "public" diff --git a/plugins/woocommerce-admin/packages/currency/src/index.js b/plugins/woocommerce-admin/packages/currency/src/index.js index 48cd7a5bc97..b98eb093dcb 100644 --- a/plugins/woocommerce-admin/packages/currency/src/index.js +++ b/plugins/woocommerce-admin/packages/currency/src/index.js @@ -3,6 +3,7 @@ */ import { sprintf } from '@wordpress/i18n'; import { numberFormat } from '@woocommerce/number'; +import deprecated from '@wordpress/deprecated'; const CurrencyFactory = ( currencySetting ) => { let currency; @@ -48,6 +49,24 @@ const CurrencyFactory = ( currencySetting ) => { return sprintf( priceFormat, symbol, formattedNumber ); } + /** + * Formats money value. + * + * @deprecated + * + * @param {number|string} number number to format + * @return {?string} A formatted string. + */ + function formatCurrency( number ) { + deprecated( 'Currency().formatCurrency', { + version: '5.0.0', + alternative: 'Currency().formatAmount', + plugin: 'WooCommerce', + hint: '`formatAmount` accepts the same arguments as formatCurrency', + } ); + return formatAmount( number ); + } + /** * Get the default price format from a currency. * @@ -79,6 +98,7 @@ const CurrencyFactory = ( currencySetting ) => { }, setCurrency, formatAmount, + formatCurrency, getPriceFormat, /**