drawBox.ts•1.99 kB
import cliTruncate from 'cli-truncate'
import { bold, grey, reset } from 'kleur/colors'
import stringWidth from 'string-width'
export type BoxOptions = {
title?: string
width: number
height: number
str: string
horizontalPadding?: number
verticalPadding?: number
}
const chars = {
topLeft: '┌',
topRight: '┐',
bottomRight: '┘',
bottomLeft: '└',
vertical: '│',
horizontal: '─',
}
function maxLineLength(str: string): number {
return str.split('\n').reduce((max, curr) => Math.max(max, stringWidth(curr)), 0) + 2
}
export function drawBox({ title, width, height, str, horizontalPadding }: BoxOptions): string {
// This avoids having NaN later
// if these required param were not passed (in JS, for example)
horizontalPadding = horizontalPadding || 0
width = width || 0
height = height || 0
// Make sure the width is at least as long as the string
width = Math.max(width, maxLineLength(str) + horizontalPadding * 2)
const topLine = title
? grey(chars.topLeft + chars.horizontal) +
' ' +
reset(bold(title)) +
' ' +
grey(chars.horizontal.repeat(width - title.length - 2 - 3) + chars.topRight) +
reset()
: grey(chars.topLeft + chars.horizontal) + grey(chars.horizontal.repeat(width - 3) + chars.topRight)
const bottomLine = chars.bottomLeft + chars.horizontal.repeat(width - 2) + chars.bottomRight
const lines = str.split('\n')
if (lines.length < height) {
lines.push(...new Array(height - lines.length).fill(''))
}
const mappedLines = lines
.slice(-height)
.map((l) => {
const lineWidth = Math.min(stringWidth(l), width)
const paddingRight = Math.max(width - lineWidth - 2, 0)
return `${grey(chars.vertical)}${' '.repeat(horizontalPadding!)}${reset(cliTruncate(l, width - 2))}${' '.repeat(
paddingRight - horizontalPadding!,
)}${grey(chars.vertical)}`
})
.join('\n')
return grey(topLine + '\n' + mappedLines + '\n' + bottomLine)
}