feat: new function - desensitizeName

README.md

@@ -130,6 +130,7 @@ pnpm add @utopia-utils/dom
 * formatterBankCard: 银行卡号格式化。[source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts)
 * formatterPhoneNumber: 手机号格式化。[source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts)
 * formatterIdCard: 身份证呈格式化。[source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts)
+* desensitizeName: 姓名脱敏。[source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringDesensitize.ts)
 
 ### 类型判断
 

packages/core/src/index.ts

@@ -37,6 +37,7 @@ export * from './randomString'
 export * from './retry'
 export * from './sleep'
 export * from './sort'
+export * from './stringDesensitize'
 export * from './stringFormatter'
 export * from './union'
 export * from './unique'

packages/core/src/stringDesensitize.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, vi } from 'vitest'
+
+import { desensitizeName } from './stringDesensitize'
+
+describe('stringDesensitize', () => {
+  it('desensitizeName', () => {
+    expect(desensitizeName()).toBeUndefined()
+    expect(desensitizeName('')).toBe('')
+    expect(desensitizeName('张')).toBe('张')
+    expect(desensitizeName('张三')).toMatchInlineSnapshot(`"张*"`)
+    expect(desensitizeName('张三丰')).toMatchInlineSnapshot(`"张*丰"`)
+    expect(desensitizeName('张二三丰')).toMatchInlineSnapshot(`"张**丰"`)
+    expect(desensitizeName('张二三四丰')).toMatchInlineSnapshot(`"张***丰"`)
+  })
+})

packages/core/src/stringDesensitize.ts

@@ -0,0 +1,31 @@
+import { isString } from '@utopia-utils/share'
+
+/**
+ * Desensitizes a name，
+ * If the name is not a string, it will be returned as is.
+ * @param name - The name to be desensitized.
+ * @returns The desensitized name.
+ * @example
+ * ```ts
+ * desensitizeName('张三') // '张*'
+ * desensitizeName('张三丰') // '张*丰'
+ * desensitizeName('张二三丰') // '张**丰'
+ * desensitizeName('张') // '张'
+ * desensitizeName(undefined) // undefined
+ * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringDesensitize.ts
+ */
+export function desensitizeName(name?: string) {
+  if (!isString(name))
+    return name
+
+  const length = name.length
+
+  if (length < 2)
+    return name
+
+  if (length === 2)
+    return `${name[0]}*`
+
+  return name[0] + '*'.repeat(length - 2) + name[length - 1]
+}

packages/core/src/stringFormatter.ts

@@ -8,8 +8,9 @@
  * formatterBankCard('_  3232 32432 32432  ') // '3232 3243 2324 32'
  * formatterBankCard(undefined) // ''
  * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts
  */
-export function formatterBankCard(str: string) {
+export function formatterBankCard(str?: string) {
   return `${str}`.replace(/\D/g, '').replace(/(\d{4})(?=\d)/g, '$1 ')
 }
 
@@ -25,8 +26,9 @@ const PHONE_LENGTH = 11
  * formatterPhoneNumber(' asd  123456789012345678901') // '123 4567 8901'
  * formatterPhoneNumber(undefined) // ''
  * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts
  */
-export function formatterPhoneNumber(str: string) {
+export function formatterPhoneNumber(str?: string) {
   return `${str}`
     .replace(/\D/g, '')
     .substring(0, PHONE_LENGTH)
@@ -50,8 +52,9 @@ const ID_CARD_LENGTH = 18
  * formatterIdCard(' fsd  36072119941229004X') // '360721 19941229 004X'
  * formatterIdCard(undefined) // ''
  * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/core/src/stringFormatter.ts
  */
-export function formatterIdCard(str: string) {
+export function formatterIdCard(str?: string) {
   return `${str}`
     .replace(/[^0-9xX]/g, '')
     .substring(0, ID_CARD_LENGTH)