Replace human-number with Intl.NumberFormat and add tests

Co-authored-by: electerious <[email protected]>

Author: Copilot

package-lock.json

@@ -64,7 +64,6 @@
     "classnames": "^2.3.1",
     "formbase": "^12.0.2",
     "history": "^5.3.0",
-    "human-number": "^2.0.1",
     "mocked-env": "^1.3.5",
     "mongodb-memory-server": "^10.3.0",
     "nodemon": "^3.1.10",

package.json

@@ -0,0 +1,15 @@
+/**
+ * Format a number using compact notation with SI prefixes (K, M, B, T)
+ * @param {number} num - The number to format
+ * @param {number} maximumFractionDigits - Maximum number of fraction digits (default: 1)
+ * @returns {string} The formatted number
+ */
+export default (num, maximumFractionDigits = 1) => {
+	const formatter = new Intl.NumberFormat('en', {
+		notation: 'compact',
+		compactDisplay: 'short',
+		maximumFractionDigits,
+	})
+
+	return formatter.format(num)
+}

src/ui/scripts/utils/formatCompactNumber.js

@@ -1,8 +1,5 @@
-import humanNumber from 'human-number'
+import formatCompactNumber from './formatCompactNumber'
 
 export default (num) => {
-	const formattedNum = humanNumber(num, (num) => Number.parseFloat(num).toFixed(2))
-	const cleanNum = formattedNum.replace('.00', '')
-
-	return cleanNum
+	return formatCompactNumber(num, 2)
 }

src/ui/scripts/utils/formatFloat.js

@@ -1,9 +1,6 @@
-import humanNumber from 'human-number'
+import formatCompactNumber from './formatCompactNumber'
 
 export default (num) => {
 	const roundedNum = Math.round(num)
-	const formattedNum = humanNumber(roundedNum, (num) => Number.parseFloat(num).toFixed(1))
-	const cleanNum = formattedNum.replace('.0', '')
-
-	return cleanNum
+	return formatCompactNumber(roundedNum, 1)
 }

src/ui/scripts/utils/formatNumber.js

@@ -0,0 +1,17 @@
+'use strict'
+
+/**
+ * Format a number using compact notation with SI prefixes (K, M, B, T)
+ * @param {number} num - The number to format
+ * @param {number} maximumFractionDigits - Maximum number of fraction digits (default: 1)
+ * @returns {string} The formatted number
+ */
+module.exports = (num, maximumFractionDigits = 1) => {
+	const formatter = new Intl.NumberFormat('en', {
+		notation: 'compact',
+		compactDisplay: 'short',
+		maximumFractionDigits,
+	})
+
+	return formatter.format(num)
+}

src/utils/formatCompactNumber.js

@@ -0,0 +1,67 @@
+'use strict'
+
+const test = require('ava')
+
+const formatCompactNumber = require('../../src/utils/formatCompactNumber')
+
+test('format numbers less than 1000 without suffix', (t) => {
+	t.is(formatCompactNumber(0), '0')
+	t.is(formatCompactNumber(100), '100')
+	t.is(formatCompactNumber(999), '999')
+})
+
+test('format thousands with K suffix', (t) => {
+	t.is(formatCompactNumber(1000), '1K')
+	t.is(formatCompactNumber(1500), '1.5K')
+	t.is(formatCompactNumber(10000), '10K')
+	t.is(formatCompactNumber(10500), '10.5K')
+	t.is(formatCompactNumber(99999), '100K')
+})
+
+test('format millions with M suffix', (t) => {
+	t.is(formatCompactNumber(1000000), '1M')
+	t.is(formatCompactNumber(1500000), '1.5M')
+	t.is(formatCompactNumber(10000000), '10M')
+	t.is(formatCompactNumber(10500000), '10.5M')
+})
+
+test('format billions with B suffix', (t) => {
+	t.is(formatCompactNumber(1000000000), '1B')
+	t.is(formatCompactNumber(1500000000), '1.5B')
+})
+
+test('format trillions with T suffix', (t) => {
+	t.is(formatCompactNumber(1000000000000), '1T')
+	t.is(formatCompactNumber(1500000000000), '1.5T')
+})
+
+test('respect maximumFractionDigits parameter', (t) => {
+	// Default is 1
+	t.is(formatCompactNumber(1234), '1.2K')
+
+	// With 0 fraction digits
+	t.is(formatCompactNumber(1234, 0), '1K')
+
+	// With 2 fraction digits
+	t.is(formatCompactNumber(1234, 2), '1.23K')
+	t.is(formatCompactNumber(123.456, 2), '123.46')
+})
+
+test('handle decimal numbers', (t) => {
+	t.is(formatCompactNumber(1234.56, 2), '1.23K')
+	t.is(formatCompactNumber(123.456, 2), '123.46')
+	t.is(formatCompactNumber(12.34, 2), '12.34')
+})
+
+test('handle negative numbers', (t) => {
+	t.is(formatCompactNumber(-1000), '-1K')
+	t.is(formatCompactNumber(-1500), '-1.5K')
+	t.is(formatCompactNumber(-1000000), '-1M')
+})
+
+test('handle edge cases', (t) => {
+	t.is(formatCompactNumber(999.9), '999.9')
+	t.is(formatCompactNumber(999.4), '999.4')
+	t.is(formatCompactNumber(1000), '1K')
+	t.is(formatCompactNumber(0.1, 2), '0.1')
+})