feat: [yuanFormat] 增加 options.prefix 和 options.space

Author: GreatAuk

packages/core/src/yuanFormat.test.ts

@@ -46,4 +46,72 @@ describe('yuanFormat', () => {
     expect(yuanFormat(-1000000, { unit: 'yuan' })).toMatchInlineSnapshot(`"-1,000,000.00"`)
     expect(yuanFormat(-9432432.34, { unit: 'yuan'})).toMatchInlineSnapshot(`"-9,432,432.34"`)
   })
+
+  describe('prefix option', () => {
+    it('should work with prefix: true (¥)', () => {
+      expect(yuanFormat(100, { prefix: true })).toBe('¥1.00')
+      expect(yuanFormat(100000, { prefix: true })).toBe('¥1,000.00')
+      expect(yuanFormat(100, { prefix: true, unit: 'yuan' })).toBe('¥100.00')
+      expect(yuanFormat(-100, { prefix: true })).toBe('¥-1.00')
+    })
+
+    it('should work with custom prefix string', () => {
+      expect(yuanFormat(100, { prefix: '$' })).toBe('$1.00')
+      expect(yuanFormat(100000, { prefix: 'USD' })).toBe('USD1,000.00')
+      expect(yuanFormat(100, { prefix: '€', unit: 'yuan' })).toBe('€100.00')
+      expect(yuanFormat(-100, { prefix: 'RMB' })).toBe('RMB-1.00')
+    })
+
+    it('should work without prefix (undefined)', () => {
+      expect(yuanFormat(100)).toBe('1.00')
+      expect(yuanFormat(100, { prefix: undefined })).toBe('1.00')
+      expect(yuanFormat(100000)).toBe('1,000.00')
+    })
+  })
+
+  describe('space option', () => {
+    it('should add space between prefix and amount when space: true', () => {
+      expect(yuanFormat(100, { prefix: true, space: true })).toBe('¥ 1.00')
+      expect(yuanFormat(100000, { prefix: true, space: true })).toBe('¥ 1,000.00')
+      expect(yuanFormat(100, { prefix: '$', space: true })).toBe('$ 1.00')
+      expect(yuanFormat(100, { prefix: 'USD', space: true })).toBe('USD 1.00')
+      expect(yuanFormat(-100, { prefix: true, space: true })).toBe('¥ -1.00')
+    })
+
+    it('should not add space when space: false or undefined', () => {
+      expect(yuanFormat(100, { prefix: true, space: false })).toBe('¥1.00')
+      expect(yuanFormat(100, { prefix: true })).toBe('¥1.00')
+      expect(yuanFormat(100, { prefix: '$', space: false })).toBe('$1.00')
+      expect(yuanFormat(100, { prefix: '$' })).toBe('$1.00')
+    })
+
+    it('should ignore space option when prefix is undefined', () => {
+      expect(yuanFormat(100, { space: true })).toBe('1.00')
+      expect(yuanFormat(100, { prefix: undefined, space: true })).toBe('1.00')
+    })
+  })
+
+  describe('combined prefix and space options', () => {
+    it('should work with all combinations', () => {
+      // prefix: true, space: true
+      expect(yuanFormat(12345, { prefix: true, space: true })).toBe('¥ 123.45')
+      // prefix: string, space: true
+      expect(yuanFormat(12345, { prefix: 'CNY', space: true })).toBe('CNY 123.45')
+      // prefix: true, space: false
+      expect(yuanFormat(12345, { prefix: true, space: false })).toBe('¥123.45')
+      // prefix: string, space: false
+      expect(yuanFormat(12345, { prefix: 'CNY', space: false })).toBe('CNY123.45')
+      // with unit: yuan
+      expect(yuanFormat(123.45, { prefix: true, space: true, unit: 'yuan' })).toBe('¥ 123.45')
+      expect(yuanFormat(123456.78, { prefix: 'USD', space: true, unit: 'yuan' })).toBe('USD 123,456.78')
+    })
+  })
+
+  describe('error cases with prefix and space', () => {
+    it('should return "-" when input is invalid even with prefix/space options', () => {
+      expect(yuanFormat(null as any, { prefix: true, space: true })).toBe('-')
+      expect(yuanFormat('abc' as any, { prefix: '$', space: true })).toBe('-')
+      expect(yuanFormat(Number.NaN, { prefix: true })).toBe('-')
+    })
+  })
 })

packages/core/src/yuanFormat.ts

@@ -8,29 +8,55 @@ interface Options {
    * @default 'fen'
    */
   unit?: 'fen' | 'yuan'
+  /**
+   * 前缀，如果是 true 则使用 ¥，或者使用传入的字符
+   * @default undefined
+   */
+  prefix?: string | true
+  /**
+   * 是否在前缀 prefix 和数值之间添加空格
+   * @default undefined
+   */
+  space?: boolean
 }
 
 /**
  * 金额格式化￥ 分转元(如果单位是分)，并保留两位小数，最后添加千位分隔符
  * @param num 金额
- * @param options (单位默认是 分),
+ * @param options 格式化选项
+ * @param options.unit 单位，分或元，如果单位是分，则会将金额转换为元，默认为 'fen'
+ * @param options.prefix 前缀，如果是 true 则使用 ¥，或者使用传入的字符串，默认为 undefined
+ * @param options.space 是否在前缀和数值之间添加空格，默认为 false
  * @returns 格式化后的金额, 如果输入不是数字，则返回 '-'
  * @example
  * ```ts
  * yuanFormat(100) // '1.00'
  * yuanFormat(100, { unit: 'yuan' }) // '100.00'
+ * yuanFormat(100, { prefix: true }) // '¥1.00'
+ * yuanFormat(100, { prefix: '$' }) // '$1.00'
+ * yuanFormat(100, { prefix: true, space: true }) // '¥ 1.00'
+ * yuanFormat(100000, { prefix: 'USD', space: true }) // 'USD 1,000.00'
  * yuanFormat('not number') // '-'
  * ```
  */
 export function yuanFormat(num?: number, options?: Options): string | '-' {
   try {
     if (!isNumber(num) || Number.isNaN(num))
       return '-'
-    const { unit = 'fen' } = options ?? {}
+    const { unit = 'fen', prefix, space } = options ?? {}
     const yuan = unit === 'fen' ? fenToYuan(num) : num
     if (yuan === null || yuan === undefined)
       return '-'
-    return yuan.toFixed(2).toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')
+
+    const formattedAmount = yuan.toFixed(2).toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')
+
+    if (!prefix)
+      return formattedAmount
+
+    const prefixStr = prefix === true ? '¥' : prefix
+    const spacing = space ? ' ' : ''
+
+    return `${prefixStr}${spacing}${formattedAmount}`
   }
   catch (err) {
     console.error(err)