fix(@formatjs/intl-numberformat): better handling of useGrouping, fix #…

…4476
formatjs · Dec 9, 2024 · 7743782 · 7743782
1 parent f6e67ad
commit 7743782
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 6 deletions.
diff --git a/packages/ecma402-abstract/NumberFormat/format_to_parts.ts b/packages/ecma402-abstract/NumberFormat/format_to_parts.ts
@@ -203,7 +203,7 @@ export default function formatToParts(
             exponent,
             numberingSystem,
             // If compact number pattern exists, do not insert group separators.
-            !compactNumberPattern && Boolean(options.useGrouping),
+            !compactNumberPattern && (options.useGrouping ?? true),
             decimalNumberPattern,
             style,
             options.roundingIncrement,
@@ -377,7 +377,7 @@ function partitionNumberIntoParts(
   notation: NumberFormatOptionsNotation,
   exponent: number,
   numberingSystem: string,
-  useGrouping: boolean,
+  useGrouping: UseGroupingType,
   /**
    * This is the decimal number pattern without signs or symbols.
    * It is used to infer the group size when `useGrouping` is true.
@@ -423,10 +423,15 @@ function partitionNumberIntoParts(
   // unless the rounded number is greater than 10000:
   //   NumberFormat('de', {notation: 'compact', compactDisplay: 'short'}).format(1234) //=> "1234"
   //   NumberFormat('de').format(1234) //=> "1.234"
-  if (
-    useGrouping &&
-    (notation !== 'compact' || x.greaterThanOrEqualTo(10000))
-  ) {
+  let shouldUseGrouping = false
+  if (useGrouping === 'always') {
+    shouldUseGrouping = true
+  } else if (useGrouping === 'min2') {
+    shouldUseGrouping = x.greaterThanOrEqualTo(10000)
+  } else if (useGrouping === 'auto' || useGrouping) {
+    shouldUseGrouping = notation !== 'compact' || x.greaterThanOrEqualTo(10000)
+  }
+  if (shouldUseGrouping) {
     // a. Let groupSepSymbol be the implementation-, locale-, and numbering system-dependent (ILND) String representing the grouping separator.
     // For currency we should use `currencyGroup` instead of generic `group`
     const groupSepSymbol =

diff --git a/packages/intl-numberformat/tests/misc.test.ts b/packages/intl-numberformat/tests/misc.test.ts
@@ -348,3 +348,11 @@ test('#4678', () => {
   })
   expect(nf.format(1050)).toEqual('1K')
 })
+
+test('#4476', () => {
+  const formatter = new NumberFormat('zh-Hant', {
+    notation: 'compact',
+    useGrouping: 'always',
+  })
+  expect(formatter.format(1000)).toEqual('1,000')
+})