选项

用于在终端中创建格式化文本框、标题和行的简单工具.

安装

npm install @davidwells/box-logger

使用量

方框

以自定义的边框、 粘贴和样式创建文本周围的框 .

const { makeBox, logBox } = require('@davidwells/box-logger')

// Simple usage with a string
console.log(makeBox('Hello World'))

// With options
console.log(makeBox({
  content: 'Hello World',
  textAlign: 'center',
  paddingLeft: 4,
  paddingRight: 4,
  borderColor: 'green',
  borderStyle: 'bold'
}))

// With title and content
console.log(makeBox({
  title: 'My Title',
  content: 'Box content here',
  borderStyle: 'rounded'
}))

// Hex colors are supported
console.log(makeBox({
  content: 'Custom colors',
  borderColor: '#4287f5',
  backgroundColor: '#1a1a2e'
}))

// Dynamic content - function receives { innerWidth } for sizing
console.log(makeBox({
  title: 'Dynamic Width',
  content: ({ innerWidth }) => generateContent({ width: innerWidth }),
  paddingLeft: 1,
  paddingRight: 0
}))

// Async content - use makeBoxAsync for async functions
const box = await makeBoxAsync({
  title: 'Async Content',
  content: async ({ innerWidth }) => await fetchData({ width: innerWidth })
})
console.log(box)

// Call logger directly
logBox('Log the box directly')

框选项

边框样式

• normal - 标准框绘图字符(QQ)
• rounded - 圆角(XQ)
• bold - 重度边界(XQ)
• double - 双线边界(XQ)
• dashed - 扭曲的横向行线( )
• dotted - 点点水平线( )
• thick - 块字符 (Q)
• half-thick - 半块边界( )
• ultra-thick - 全部区块边界(
• ascii - ASCII倒计时(-)
• dots - 点数(-)
• circles - 圆圈(0个)
• stars - 闪光星星(QQ)
• triple - 三行线( )
• transparent - 隐形边界(空间)
• none - 根本没有边界
• filled - 与背景相通

区域对象

标题和内容可以是字符串或节对象,以进行更多的控制:

makeBox({
  title: {
    left: 'Title',
    right: 'v1.0.0',
    fontStyle: 'bold',
    color: 'cyan'
  },
  content: {
    left: 'Description',
    right: 'Status: OK',
    color: 'green'
  }
})

区域属性 : left, (中文(简体) ), right, (中文(简体) ), center, (中文(简体) ), color, (中文(简体) ), fontStyle, (中文(简体) ), paddingLeft, (中文(简体) ), paddingRight, (中文(简体) ), paddingTop, (中文(简体) ), paddingBottom, (中文(简体) ), truncate

堆叠的框

在共享边框上垂直堆放多个框 :

const { makeStackedBoxes } = require('@davidwells/box-logger')

console.log(makeStackedBoxes([
  { title: 'Box 1', content: 'First box content' },
  { title: 'Box 2', content: 'Second box content' },
  { title: 'Box 3', content: 'Third box content' }
], {
  borderStyle: 'rounded',
  borderColor: 'cyan'
}))

水平框

并排渲染盒 :

const { makeHorizontalBoxes } = require('@davidwells/box-logger')

console.log(makeHorizontalBoxes([
  { content: 'Left box' },
  { content: 'Middle box' },
  { content: 'Right box' }
], {
  gap: 2,
  mergeBoxes: true  // Merge adjacent borders
}))

选项 : gap, (中文(简体) ), marginLeft, (中文(简体) ), connectRows, (中文(简体) ), justifyContent ("弹性启动","弹性端","间距"), wrap, (中文(简体) ), mergeBoxes

页眉

创建标题( 无左边框的框) :

const { makeHeader, logHeader } = require('@davidwells/box-logger')

// Simple usage
console.log(makeHeader('Hello World'))

// With options
console.log(makeHeader({
  content: 'Hello World',
  borderColor: 'blue'
}))

// Typed variants
logHeader.success('Operation completed')
logHeader.error('An error occurred')
logHeader.warning('Please be careful')
logHeader.info('Information')

标题使用与 Box 相同的选项( 这只是 header: true 盖下.

线条

以可选文本创建水平行 :

const { makeLine, logLine } = require('@davidwells/box-logger')

// Simple line
console.log(makeLine())

// Line with centered text
console.log(makeLine('Section Title'))

// Line with options
console.log(makeLine({
  text: 'Styled text',
  fontStyle: 'bold',
  borderColor: 'green'
}))

// Left and right text
console.log(makeLine({
  left: 'Section',
  right: 'v1.2.3',
  borderColor: 'cyan'
}))

// All three positions
console.log(makeLine({
  left: 'Left',
  center: 'Center',
  right: 'Right'
}))

行选项

已打入的备选案文

所有日志功能都有有自动图标和颜色的输入变体:

const { logBox, logHeader, logLine } = require('@davidwells/box-logger')

// Box variants
logBox.success('Operation completed successfully')
logBox.error('An error occurred')
logBox.warning('Please be careful')
logBox.info('Here is some information')

// Header variants
logHeader.success('Success!')
logHeader.error('Error!')

// Line variants
logLine.success('Success line')
logLine.error('Error line')

处理错误

向logBox传递一个错误对象用于格式化错误显示 :

try {
  throw new Error('Something went wrong')
} catch (err) {
  logBox.error(err)  // Shows error name, message, and cleaned stack trace
}

实例

基本方框

┌─────────────┐
│  Hello World  │
└─────────────┘

有标题的圆形框

╭──────────────────────╮
│  My Title            │
├──────────────────────┤
│  Content goes here   │
╰──────────────────────╯

粗体框

┏━━━━━━━━━━━━━━━━━━━━━━┓
┃  Hello World         ┃
┗━━━━━━━━━━━━━━━━━━━━━━┛

标题( 无左边框)

──────────────────────────────┐
  Hello World                 │
──────────────────────────────┘

带文字的行

────────── Section Title ──────────

以左右为行

──── Section ──────────── v1.2.3 ────

公用事业

终端大小

获取当前终端尺寸 :

const { terminalSize } = require('@davidwells/box-logger')

const { columns, rows } = terminalSize()
console.log(`Terminal is ${columns}x${rows}`)

获取内网

计算框配置的内在内容宽度 :

const { getInnerWidth } = require('@davidwells/box-logger')

const innerWidth = getInnerWidth({
  paddingLeft: 1,
  paddingRight: 0,
  marginLeft: 5
})
// Use innerWidth to pre-size content before calling makeBox

许可证

麻省理工学院

其他表达式

• https://github.com/tecfu/tty-table 页面存档备份,存于互联网档案馆
• https://www.npmjs.com/package/boxen (英语)