README
¶
internal/pretty 维护说明
1. 背景
github.com/coder/pretty 已停止维护。为降低外部依赖风险并保证输出样式能力可持续维护，本项目将其迁移为内部实现：internal/pretty。
2. 维护目标
- 保持与当前项目使用场景的 API 兼容。
- 保持帮助输出（
help.go）行为稳定。 - 避免引入不必要的功能扩展。
3. 当前提供的能力
3.1 文本结构与格式化接口
TextFormatterStyleString(...)
3.2 常用格式化函数
FgColor(...)BgColor(...)CSI(...)Wrap(...)Bold()Italic()Underline()LineWrap(...)XPad(...)
4. 使用约定
- 仅用于本项目命令行输出样式层。
- 首选在
help.go中集中使用，避免在业务逻辑中散布样式代码。 - 如需扩展接口，优先保证向后兼容，不破坏现有调用。
5. 变更流程
- 明确变更动机（兼容性、性能、可维护性）。
- 评估是否影响
help.go现有输出。 - 完成代码改动后执行格式化与测试。
- 更新
docs/CHANGELOG.md记录变更。
6. 验证建议
- 运行全量测试：
go test ./... - 检查帮助输出关键路径：
- 命令列表输出
- 标志列表输出
- 帮助模板渲染
7. 迁移说明
- 旧导入：
github.com/coder/pretty - 新导入：
github.com/pubgo/redant/internal/pretty
迁移策略为“接口兼容优先”，即在不改变上层业务逻辑的前提下完成替换。
Documentation
¶
Index ¶
- func Fprint(w io.Writer, f Formatter, args ...any)
- func Fprintf(w io.Writer, f Formatter, format string, args ...any)
- func Printf(f Formatter, format string, args ...any)
- func Sprint(f Formatter, args ...any) string
- func Sprintf(f Formatter, format string, args ...any) string
- type Formatter
- type Style
- type Text
- func (t *Text) Append(ss ...string) *Text
- func (t *Text) Bytes(b []byte) []byte
- func (t *Text) Head() *Text
- func (t *Text) Insert(s string) *Text
- func (t *Text) Len() int
- func (t *Text) Prepend(ss ...string) *Text
- func (t *Text) Split(n int) *Text
- func (t *Text) String() string
- func (t *Text) Tail() *Text
- func (t *Text) WriteTo(w io.Writer) (int64, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Formatter ¶
type Formatter interface {
Format(*Text)
}
Formatter manipulates Text.
func LineWrap ¶
LineWrap wraps the text at the given width. It breaks lines at word boundaries when possible.
type Style ¶
type Style []Formatter
Style applies multiple formatters to a text in order.
type Text ¶
Text is a linked-list structure that represents an in-progress text string. Most formatters work by prepending and appending to text, so this structure is far more efficient than manipulating strings directly.
The pointer is intrinsically a cursor that points to the current text segment. So, subsequent appends and prepends are O(1) since the cursor is already at the tail or head respectively.
func (*Text) Bytes ¶
Bytes allocates a new byte slice containing the entire text. It uses the given buffer if it is large enough.
func (*Text) Head ¶
Head returns the absolute head of the text. It adjusts the pointer to the head of the text.
func (*Text) Insert ¶
Insert inserts the given text before the current text. It returns the new node.
func (*Text) Split ¶
Split splits the current text into two parts at the given index. The current node contains the first part, and the new node contains the second part. It returns the new node, and does not adjust the pointer.
Source Files