Viddy 开源项目教程

Viddy 开源项目教程

viddy👀 A modern watch command. Time machine and pager etc.项目地址:https://gitcode.com/gh_mirrors/vi/viddy

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

Viddy 项目的目录结构如下：

viddy/
├── cmd/
│   └── viddy/
│       └── main.go
├── internal/
│   ├── config/
│   ├── output/
│   ├── pager/
│   ├── time_machine/
│   └── watcher/
├── pkg/
│   ├── keymap/
│   ├── shell/
│   └── util/
├── .gitignore
├── .goreleaser.yml
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
└── go.mod

• cmd/: 包含项目的主命令文件。
• internal/: 包含项目的内部包，如配置、输出、分页器、时间机器和观察器。
• pkg/: 包含项目的公共包，如键映射、shell 和工具。
• .gitignore: Git 忽略文件。
• .goreleaser.yml: Goreleaser 配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 变更日志。
• LICENSE: 许可证文件。
• README.md: 项目说明文档。
• go.mod: Go 模块文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/viddy/main.go。这个文件是 Viddy 的入口点，负责初始化配置、解析命令行参数并启动应用程序。

package main

import (
    "github.com/sachaos/viddy/internal/config"
    "github.com/sachaos/viddy/internal/output"
    "github.com/sachaos/viddy/internal/pager"
    "github.com/sachaos/viddy/internal/time_machine"
    "github.com/sachaos/viddy/internal/watcher"
)

func main() {
    // 初始化配置
    cfg := config.LoadConfig()

    // 创建观察器
    w := watcher.NewWatcher(cfg)

    // 创建输出器
    out := output.NewOutput(cfg)

    // 创建分页器
    pg := pager.NewPager(cfg)

    // 创建时间机器
    tm := time_machine.NewTimeMachine(cfg)

    // 启动应用程序
    w.Start()
    out.Start()
    pg.Start()
    tm.Start()
}

3. 项目的配置文件介绍

Viddy 的配置文件默认位于 $XDG_CONFIG_HOME/viddy.toml，在 macOS 上路径为 ~/Library/Application Support/viddy.toml。配置文件的示例如下：

[general]
no_shell = false
shell = "zsh"
shell_options = ""
skip_empty_diffs = false

[keymap]
timemachine_go_to_past = "Down"
timemachine_go_to_more_past = "Shift-Down"
timemachine_go_to_future = "Up"
timemachine_go_to_more_future = "Shift-Up"
timemachine_go_to_now = "Ctrl-Shift-Up"
timemachine_go_to_oldest = "Ctrl-Shift-Down"

[color]
background = "white"  # 默认值继承自终端颜色

• [general]: 包含一般配置，如是否禁用 shell、使用的 shell 类型和选项、是否跳过空差异。
• [keymap]: 包含键映射配置，如时间机器的键绑定。
• [color]: 包含颜色配置，如背景颜色。

以上是 Viddy 开源项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

viddy👀 A modern watch command. Time machine and pager etc.项目地址:https://gitcode.com/gh_mirrors/vi/viddy