Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 129 additions & 7 deletions common/src/util/__tests__/string.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { describe, expect, it } from 'bun:test'

import { pluralize } from '../string'
import {
capitalize,
pluralize,
truncateString,
truncateStringWithMessage,
} from '../string'

describe('pluralize', () => {
it('should handle singular and plural cases correctly', () => {
Expand Down Expand Up @@ -53,13 +58,13 @@ describe('pluralize', () => {
expect(pluralize(2, 'person')).toBe('2 people')
expect(pluralize(2, 'child')).toBe('2 children')
expect(pluralize(2, 'mouse')).toBe('2 mice')

// -ex/-ix → -ices (no reliable rule, must be hardcoded)
expect(pluralize(2, 'index')).toBe('2 indices')
expect(pluralize(2, 'vertex')).toBe('2 vertices')
expect(pluralize(2, 'matrix')).toBe('2 matrices')
expect(pluralize(2, 'appendix')).toBe('2 appendices')

// Latin -um → -a
expect(pluralize(2, 'datum')).toBe('2 data')
expect(pluralize(2, 'medium')).toBe('2 media')
Expand Down Expand Up @@ -123,7 +128,7 @@ describe('pluralize', () => {
expect(pluralize(2, 'data')).toBe('2 data')
expect(pluralize(2, 'metadata')).toBe('2 metadata')
expect(pluralize(2, 'feedback')).toBe('2 feedback')

// Other words ending in -s that don't change
expect(pluralize(2, 'series')).toBe('2 series')
expect(pluralize(2, 'chassis')).toBe('2 chassis')
Expand All @@ -135,7 +140,7 @@ describe('pluralize', () => {
expect(pluralize(2, 'hero')).toBe('2 heroes')
expect(pluralize(2, 'echo')).toBe('2 echoes')
expect(pluralize(2, 'veto')).toBe('2 vetoes')

// Tech terms that just add -s
expect(pluralize(2, 'photo')).toBe('2 photos')
expect(pluralize(2, 'video')).toBe('2 videos')
Expand All @@ -160,11 +165,11 @@ describe('pluralize', () => {
expect(pluralize(2, 'shelf')).toBe('2 shelves')
expect(pluralize(2, 'self')).toBe('2 selves')
expect(pluralize(2, 'leaf')).toBe('2 leaves')

// -fe to -ves
expect(pluralize(2, 'knife')).toBe('2 knives')
expect(pluralize(2, 'life')).toBe('2 lives')

// Tech/design terms that just add -s
expect(pluralize(2, 'proof')).toBe('2 proofs') // mathematical proofs
expect(pluralize(2, 'brief')).toBe('2 briefs') // design briefs
Expand Down Expand Up @@ -237,3 +242,120 @@ describe('pluralize', () => {
})
})

describe('truncateString', () => {
it('returns string unchanged when length <= maxLength', () => {
expect(truncateString('hello', 5)).toBe('hello')
expect(truncateString('hi', 5)).toBe('hi')
expect(truncateString('', 5)).toBe('')
})

it('truncates and appends ellipsis when length > maxLength', () => {
expect(truncateString('hello world', 5)).toBe('hello...')
})

it('does not split surrogate pairs when cut lands on a high surrogate', () => {
const rocket = '🚀' // \uD83D\uDE80 (high surrogate: \uD83D, low surrogate: \uDE80)
const str = 'abc' + rocket // length is 3 + 2 = 5
// Cutting at length 4 lands on \uD83D (the high surrogate of 🚀)
const truncated = truncateString(str, 4)
expect(truncated).toBe('abc...')
expect(truncated).not.toContain('\uD83D')
})
})

describe('truncateStringWithMessage', () => {
it('returns string unchanged when length <= maxLength', () => {
expect(truncateStringWithMessage({ str: 'hello', maxLength: 10 })).toBe(
'hello',
)
expect(truncateStringWithMessage({ str: 'hello', maxLength: 5 })).toBe(
'hello',
)
})

it('truncates from END and appends message', () => {
const str = 'a'.repeat(100)
const result = truncateStringWithMessage({
str,
maxLength: 50,
remove: 'END',
})
expect(result.length).toBe(50)
expect(result.endsWith('\n[TRUNCATED DUE TO LENGTH...]')).toBe(true)
})

it('truncates from START and prepends message', () => {
const str = 'a'.repeat(100)
const result = truncateStringWithMessage({
str,
maxLength: 50,
remove: 'START',
})
expect(result.length).toBe(50)
expect(result.startsWith('[...TRUNCATED DUE TO LENGTH]\n')).toBe(true)
})

it('truncates from MIDDLE and places message in center', () => {
const str = 'a'.repeat(100)
const result = truncateStringWithMessage({
str,
maxLength: 50,
remove: 'MIDDLE',
})
expect(result.length).toBeLessThanOrEqual(50)
expect(result).toContain('\n[...TRUNCATED DUE TO LENGTH...]\n')
})

it('never expands beyond maxLength when maxLength is smaller than message', () => {
const str = 'a'.repeat(100)
const endResult = truncateStringWithMessage({
str,
maxLength: 20,
remove: 'END',
})
expect(endResult.length).toBe(20)

const startResult = truncateStringWithMessage({
str,
maxLength: 20,
remove: 'START',
})
expect(startResult.length).toBe(20)

const midResult = truncateStringWithMessage({
str,
maxLength: 20,
remove: 'MIDDLE',
})
expect(midResult.length).toBe(20)
})

it('does not split surrogate pairs', () => {
const rocket = '🚀'
// 'a'.repeat(20) places the high surrogate at index 20.
// Default suffix '\n[TRUNCATED DUE TO LENGTH...]' is 29 chars long.
// maxLength = 50 -> cut index end = 50 - 29 = 21, landing right after the high surrogate.
const str = 'a'.repeat(20) + rocket + 'b'.repeat(50)
const result = truncateStringWithMessage({
str,
maxLength: 50,
remove: 'END',
})
expect(result).toBe('a'.repeat(20) + '\n[TRUNCATED DUE TO LENGTH...]')
expect(result).not.toContain('\uD83D')
expect(result.length).toBeLessThanOrEqual(50)
})
})

describe('capitalize', () => {
it('capitalizes ASCII strings', () => {
expect(capitalize('hello')).toBe('Hello')
expect(capitalize('WORLD')).toBe('World')
expect(capitalize('a')).toBe('A')
expect(capitalize('')).toBe('')
})

it('handles astral code points gracefully without corrupting surrogates', () => {
expect(capitalize('🚀rocket')).toBe('🚀rocket')
})
})
62 changes: 56 additions & 6 deletions common/src/util/string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@ export const truncateString = (str: string, maxLength: number) => {
if (str.length <= maxLength) {
return str
}
return str.slice(0, maxLength) + '...'
let end = maxLength
// If the cut lands on a high surrogate, back off by 1 so the astral character is not halved
if (
end > 0 &&
str.charCodeAt(end - 1) >= 0xd800 &&
str.charCodeAt(end - 1) <= 0xdbff
) {
end--
}
return str.slice(0, end) + '...'
}

export const truncateStringWithMessage = ({
Expand All @@ -22,16 +31,56 @@ export const truncateStringWithMessage = ({

if (remove === 'END') {
const suffix = `\n[${message}...]`
return str.slice(0, maxLength - suffix.length) + suffix
if (maxLength <= suffix.length) {
return suffix.slice(0, maxLength)
}
let end = maxLength - suffix.length
if (
end > 0 &&
str.charCodeAt(end - 1) >= 0xd800 &&
str.charCodeAt(end - 1) <= 0xdbff
) {
end--
}
return str.slice(0, end) + suffix
}
if (remove === 'START') {
const prefix = `[...${message}]\n`
return prefix + str.slice(str.length - maxLength + prefix.length)
if (maxLength <= prefix.length) {
return prefix.slice(0, maxLength)
}
let start = str.length - (maxLength - prefix.length)
if (
start < str.length &&
str.charCodeAt(start) >= 0xdc00 &&
str.charCodeAt(start) <= 0xdfff
) {
start++
}
return prefix + str.slice(start)
}

const middle = `\n[...${message}...]\n`
const length = Math.floor((maxLength - middle.length) / 2)
return str.slice(0, length) + middle + str.slice(-length)
if (maxLength <= middle.length) {
return middle.slice(0, maxLength)
}
let length = Math.floor((maxLength - middle.length) / 2)
if (
length > 0 &&
str.charCodeAt(length - 1) >= 0xd800 &&
str.charCodeAt(length - 1) <= 0xdbff
) {
length--
}
let endStart = str.length - length
if (
endStart < str.length &&
str.charCodeAt(endStart) >= 0xdc00 &&
str.charCodeAt(endStart) <= 0xdfff
) {
endStart++
}
return str.slice(0, length) + middle + str.slice(endStart)
}

/**
Expand Down Expand Up @@ -242,7 +291,8 @@ export const pluralize = (
*/
export const capitalize = (str: string): string => {
if (!str) return str
return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase()
const [first = '', ...rest] = Array.from(str)
return first.toUpperCase() + rest.join('').toLowerCase()
}

/**
Expand Down
Loading