开源项目 TML 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00827/article/details/141525651

开源项目 TML 使用教程

tml:rainbow::computer::art: A tiny markup language for terminal output. Makes formatting output in CLI apps easier!项目地址:https://gitcode.com/gh_mirrors/tm/tml

1. 项目的目录结构及介绍

tml/
├── cmd/
│   └── tml/
│       └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── app/
│   └── pkg/
├── pkg/
│   ├── logger/
│   └── utils/
├── .gitignore
├── go.mod
├── go.sum
└── README.md

cmd/: 存放项目的入口文件。
- tml/: 主程序目录。
  - main.go: 项目的启动文件。
config/: 存放项目的配置文件。
- config.yaml: 配置文件，包含项目的各种配置选项。
internal/: 存放内部包，不对外暴露。
- app/: 应用逻辑相关代码。
- pkg/: 内部使用的工具包。
pkg/: 存放公共包，可以对外暴露。
- logger/: 日志工具包。
- utils/: 通用工具包。
.gitignore: Git 忽略文件列表。
go.mod: Go 模块文件。
go.sum: Go 模块依赖校验文件。
README.md: 项目说明文档。

2. 项目的启动文件介绍

cmd/tml/main.go 是项目的启动文件，负责初始化配置、启动服务等操作。以下是简要代码示例：

package main

import (
    "tml/config"
    "tml/internal/app"
)

func main() {
    // 加载配置
    cfg, err := config.LoadConfig()
    if err != nil {
        panic(err)
    }

    // 启动应用
    app.Run(cfg)
}

3. 项目的配置文件介绍

config/config.yaml 是项目的配置文件，包含项目的各种配置选项。以下是简要配置示例：

server:
  host: "0.0.0.0"
  port: 8080

database:
  driver: "mysql"
  source: "user:password@tcp(127.0.0.1:3306)/dbname"

log:
  level: "info"
  output: "stdout"

server: 服务器配置。
- host: 服务器监听地址。
- port: 服务器监听端口。
database: 数据库配置。
- driver: 数据库驱动。
- source: 数据库连接字符串。
log: 日志配置。
- level: 日志级别。
- output: 日志输出位置。