Terminal 使用与技术文档

2024-12-24 21:32:06作者：晏闻田Solitary

Terminal 是一个简单的 Go 语言包，用于提供基础的终端处理功能。Terminal 通过封装 ANSI 转义码提供的颜色/格式化功能，使得用户能够更加方便地在终端中进行操作。

1. 安装指南

在开始使用 Terminal 包之前，你需要确保已经安装了 Go 语言环境。

使用 Go Modules 安装

go get github.com/wsxiaoys/terminal

这将会在你的 go.mod 文件中添加相应的依赖，并下载必要的包。

2. 项目的使用说明

Terminal 提供了基本的终端操作，包括颜色设置、光标移动等。以下是一个简单的示例代码：

package main

import (
  "github.com/wsxiaoys/terminal"
  "github.com/wsxiaoys/terminal/color"
)

func main() {
  terminal.Stdout.Color("y").
    Print("Hello world").Nl().
    Reset().
    Colorf("@{kW}Hello world\n")

  color.Print("@rHello world")
}

基本操作

terminal.Stdout.Color("y")：设置输出文字的颜色为黄色。
terminal.Stdout.Print("Hello world")：打印文本。
terminal.Stdout.Nl()：换行。
terminal.Stdout.Reset()：重置颜色和格式设置。
terminal.Stdout.Colorf("@{kW}Hello world\n")：使用格式化字符串设置颜色并打印文本。
color.Print("@rHello world")：使用颜色标签打印文本。

3. 项目API使用文档

以下是 Terminal 包提供的 API 文档。

`TerminalWriter`

TerminalWriter 结构体封装了基本的终端操作。

func (w *TerminalWriter) Clear() *TerminalWriter：清空终端。
func (w *TerminalWriter) ClearLine() *TerminalWriter：清空当前行。
func (w *TerminalWriter) Color(syntax string) *TerminalWriter：设置颜色。
func (w *TerminalWriter) Colorf(format string, a ...interface{}) *TerminalWriter：格式化输出。
func (w *TerminalWriter) Down(x int) *TerminalWriter：向下移动光标。
func (w *TerminalWriter) Left(x int) *TerminalWriter：向左移动光标。
func (w *TerminalWriter) Move(x, y int) *TerminalWriter：移动光标到指定位置。
func (w *TerminalWriter) Nl(a ...interface{}) *TerminalWriter：换行。
func (w *TerminalWriter) Print(a ...interface{}) *TerminalWriter：打印文本。
func (w *TerminalWriter) Reset() *TerminalWriter：重置颜色和格式。
func (w *TerminalWriter) Right(x int) *TerminalWriter：向右移动光标。
func (w *TerminalWriter) Up(x int) *TerminalWriter：向上移动光标。