From 275b92fcb84da0f20ba6ffafa802368b6d6dc21f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Vytick=20Vytrhl=C3=ADk?= Date: Wed, 15 Jan 2025 12:02:23 +0100 Subject: [PATCH] chore(suite-common): rename formatter to more appropriate name --- suite-common/formatters/src/FormatterProvider.tsx | 12 ++++++------ .../src/formatters/prepareCryptoAmountFormatter.ts | 6 +++--- ...Formatter.ts => prepareDisplaySymbolFormatter.ts} | 8 ++++---- ...test.ts => prepareDisplaySymbolFormatter.test.ts} | 10 +++++----- .../src/components/SelectableNetworkItem.tsx | 4 ++-- .../module-send/src/components/CryptoAmountInput.tsx | 2 +- 6 files changed, 21 insertions(+), 21 deletions(-) rename suite-common/formatters/src/formatters/{prepareNetworkSymbolFormatter.ts => prepareDisplaySymbolFormatter.ts} (83%) rename suite-common/formatters/src/formatters/tests/{prepareNetworkSymbolFormatter.test.ts => prepareDisplaySymbolFormatter.test.ts} (69%) diff --git a/suite-common/formatters/src/FormatterProvider.tsx b/suite-common/formatters/src/FormatterProvider.tsx index 5712ca72bf6..05f2278d6df 100644 --- a/suite-common/formatters/src/FormatterProvider.tsx +++ b/suite-common/formatters/src/FormatterProvider.tsx @@ -21,9 +21,9 @@ import { } from './formatters/prepareFiatAmountFormatter'; import { MonthNameFormatter } from './formatters/prepareMonthNameFormatter'; import { - NetworkSymbolFormatterDataContext, - prepareNetworkSymbolFormatter, -} from './formatters/prepareNetworkSymbolFormatter'; + DisplaySymbolFormatterDataContext, + prepareDisplaySymbolFormatter, +} from './formatters/prepareDisplaySymbolFormatter'; import { prepareTimeFormatter } from './formatters/prepareTimeFormatter'; import { Formatter } from './makeFormatter'; import { FormatterConfig, FormatterProviderConfig } from './types'; @@ -39,7 +39,7 @@ export type Formatters = { string, CryptoAmountFormatterDataContext >; - NetworkSymbolFormatter: Formatter; + DisplaySymbolFormatter: Formatter; NetworkNameFormatter: Formatter; SignValueFormatter: Formatter; FiatAmountFormatter: Formatter< @@ -57,7 +57,7 @@ export const FormatterProviderContext = createContext({} as Formatte export const getFormatters = (config: FormatterConfig): Formatters => { const CryptoAmountFormatter = prepareCryptoAmountFormatter(config); - const NetworkSymbolFormatter = prepareNetworkSymbolFormatter(config); + const DisplaySymbolFormatter = prepareDisplaySymbolFormatter(config); const FiatAmountFormatter = prepareFiatAmountFormatter(config); const DateFormatter = prepareDateFormatter(config); const TimeFormatter = prepareTimeFormatter(config); @@ -65,7 +65,7 @@ export const getFormatters = (config: FormatterConfig): Formatters => { return { CryptoAmountFormatter, - NetworkSymbolFormatter, + DisplaySymbolFormatter, NetworkNameFormatter, FiatAmountFormatter, DateFormatter, diff --git a/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts b/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts index d09ac9a5dc4..1ff842d7e67 100644 --- a/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts +++ b/suite-common/formatters/src/formatters/prepareCryptoAmountFormatter.ts @@ -15,7 +15,7 @@ import { PROTO } from '@trezor/connect'; import { makeFormatter } from '../makeFormatter'; import { FormatterConfig } from '../types'; -import { prepareNetworkSymbolFormatter } from './prepareNetworkSymbolFormatter'; +import { prepareDisplaySymbolFormatter } from './prepareDisplaySymbolFormatter'; export type CryptoAmountFormatterInputValue = string; @@ -70,9 +70,9 @@ const convertToUnit = ( }; const appendSymbol = (value: string, config: FormatterConfig, symbol: NetworkSymbol) => { - const NetworkSymbolFormatter = prepareNetworkSymbolFormatter(config); + const DisplaySymbolFormatter = prepareDisplaySymbolFormatter(config); - return `${value} ${NetworkSymbolFormatter.format(symbol)}`; + return `${value} ${DisplaySymbolFormatter.format(symbol)}`; }; export const prepareCryptoAmountFormatter = (config: FormatterConfig) => diff --git a/suite-common/formatters/src/formatters/prepareNetworkSymbolFormatter.ts b/suite-common/formatters/src/formatters/prepareDisplaySymbolFormatter.ts similarity index 83% rename from suite-common/formatters/src/formatters/prepareNetworkSymbolFormatter.ts rename to suite-common/formatters/src/formatters/prepareDisplaySymbolFormatter.ts index 5db3ebe3176..87c52bf894e 100644 --- a/suite-common/formatters/src/formatters/prepareNetworkSymbolFormatter.ts +++ b/suite-common/formatters/src/formatters/prepareDisplaySymbolFormatter.ts @@ -4,10 +4,10 @@ import { getNetwork, getNetworkDisplaySymbol, NetworkSymbol } from '@suite-commo import { FormatterConfig } from '../types'; import { makeFormatter } from '../makeFormatter'; -export type NetworkSymbolFormatterDataContext = { areAmountUnitsEnabled?: boolean }; +export type DisplaySymbolFormatterDataContext = { areAmountUnitsEnabled?: boolean }; -export const prepareNetworkSymbolFormatter = (config: FormatterConfig) => - makeFormatter( +export const prepareDisplaySymbolFormatter = (config: FormatterConfig) => + makeFormatter( (symbol, dataContext) => { const { bitcoinAmountUnit } = config; const { areAmountUnitsEnabled = true } = dataContext; @@ -26,5 +26,5 @@ export const prepareNetworkSymbolFormatter = (config: FormatterConfig) => return formattedSymbol; }, - 'NetworkSymbolFormatter', + 'DisplaySymbolFormatter', ); diff --git a/suite-common/formatters/src/formatters/tests/prepareNetworkSymbolFormatter.test.ts b/suite-common/formatters/src/formatters/tests/prepareDisplaySymbolFormatter.test.ts similarity index 69% rename from suite-common/formatters/src/formatters/tests/prepareNetworkSymbolFormatter.test.ts rename to suite-common/formatters/src/formatters/tests/prepareDisplaySymbolFormatter.test.ts index 0d0df3e2e5a..cada120a5ca 100644 --- a/suite-common/formatters/src/formatters/tests/prepareNetworkSymbolFormatter.test.ts +++ b/suite-common/formatters/src/formatters/tests/prepareDisplaySymbolFormatter.test.ts @@ -1,13 +1,13 @@ import { PROTO } from '@trezor/connect'; import { NetworkSymbol } from '@suite-common/wallet-config'; -import { prepareNetworkSymbolFormatter } from '../prepareNetworkSymbolFormatter'; +import { prepareDisplaySymbolFormatter } from '../prepareDisplaySymbolFormatter'; -describe('prepareNetworkSymbolFormatter', () => { - let networkSymbolFormatter: ReturnType; +describe('prepareDisplaySymbolFormatter', () => { + let displaySymbolFormatter: ReturnType; beforeEach(() => { - networkSymbolFormatter = prepareNetworkSymbolFormatter({ + displaySymbolFormatter = prepareDisplaySymbolFormatter({ coins: [], locale: 'en', bitcoinAmountUnit: PROTO.AmountUnit.BITCOIN, @@ -24,7 +24,7 @@ describe('prepareNetworkSymbolFormatter', () => { ] as [NetworkSymbol, string][])( 'should display symbolName (#16190) case %#', (symbol: NetworkSymbol, expectedValue: string) => { - expect(networkSymbolFormatter.format(symbol, {})).toBe(expectedValue); + expect(displaySymbolFormatter.format(symbol, {})).toBe(expectedValue); }, ); }); diff --git a/suite-native/accounts/src/components/SelectableNetworkItem.tsx b/suite-native/accounts/src/components/SelectableNetworkItem.tsx index ccfceb88f81..e5e5b1262c4 100644 --- a/suite-native/accounts/src/components/SelectableNetworkItem.tsx +++ b/suite-native/accounts/src/components/SelectableNetworkItem.tsx @@ -28,7 +28,7 @@ const tokensBadgeStyle = prepareNativeStyle(utils => ({ export const SelectableNetworkItem = ({ symbol, onPress, rightIcon }: SelectableAssetItemProps) => { const { applyStyle } = useNativeStyles(); - const { NetworkSymbolFormatter } = useFormatters(); + const { DisplaySymbolFormatter } = useFormatters(); const handlePress = () => { if (!onPress) return; @@ -52,7 +52,7 @@ export const SelectableNetworkItem = ({ symbol, onPress, rightIcon }: Selectable {networkName} - diff --git a/suite-native/module-send/src/components/CryptoAmountInput.tsx b/suite-native/module-send/src/components/CryptoAmountInput.tsx index f56126328dd..66bf9e2c6c5 100644 --- a/suite-native/module-send/src/components/CryptoAmountInput.tsx +++ b/suite-native/module-send/src/components/CryptoAmountInput.tsx @@ -53,7 +53,7 @@ export const CryptoAmountInput = ({ const { applyStyle } = useNativeStyles(); const { setValue, trigger } = useFormContext(); const { cryptoAmountTransformer } = useSendAmountTransformers(symbol); - const { NetworkSymbolFormatter: formatter } = useFormatters(); + const { DisplaySymbolFormatter: formatter } = useFormatters(); const debounce = useDebounce(); const tokenSymbol = useSelector((state: TokensRootState) =>