Dotdrop 项目使用与配置指南

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

dotdrop 是一个用于管理 dotfiles 的开源项目。它的目录结构如下：

dotdrop/
├── assets/                # 存储项目相关的资源文件
├── completion/            # 包含命令行补全脚本
├── docs/                  # 项目文档
├── dotdrop/               # 主程序脚本
├── highlighters/          # 代码高亮相关文件
├── manpage/               # 手册页面
├── packages/              # 包管理相关文件
├── scripts/               # 脚本文件
├── tests-ng/              # 单元测试文件
├── tests/                 # 测试相关文件
├── bootstrap.sh           # 项目初始化脚本
├── config.toml            # 默认配置文件
├── gitattributes          # Git 属性文件
├── gitignore              # Git 忽略文件
├── LICENSE                # 项目许可证文件
├── MANIFEST.in            # 打包配置文件
├── README.md              # 项目说明文件
├── requirements.txt       # Python 依赖文件
└── setup.py               # Python 包设置文件

2. 项目的启动文件介绍

项目的启动文件是 dotdrop/dotdrop.py。这个文件是 dotdrop 的主程序，它负责解析命令行参数，并根据用户输入执行相应的操作，如导入、安装、比较、更新、移除 dotfiles 等。

要运行 dotdrop，你可以在命令行中直接调用它：

python3 dotdrop.py <command> [options]

其中 <command> 可以是 import、install、compare、update 等，而 [options] 是可选的参数，用于自定义命令的执行。

3. 项目的配置文件介绍

dotdrop 的配置文件是 config.toml。这个文件定义了 dotdrop 的行为和设置，包括以下部分：

• backup: 是否在安装之前备份现有文件。
• banner: 是否显示启动时的横幅。
• create: 是否在导入 dotfiles 时创建缺失的目录。
• dotpath: dotfiles 存储的目录。
• ignoreempty: 是否忽略空目录。
• keepdot: 是否保留 dotfiles 目录中的点文件。
• longkey: 是否在配置文件中使用完整的文件路径作为键。
• showdiff: 是否在安装时显示差异。

此外，配置文件还包含了 dotfiles、profiles、actions、transformations、variables、uservariables 等部分，用于定义 dotfiles 的源和目标路径、配置文件模板、用户变量等。

以下是 config.toml 的一个简单示例：

config = {
    backup = true,
    banner = true,
    create = true,
    dotpath = "dotfiles",
    ignoreempty = false,
    keepdot = false,
    longkey = false,
    showdiff = false,
    workdir = "~/config/dotdrop"
}

[dotfiles]
"d_polybar" = { dst = "~/config/polybar", src = "config/polybar" }
"f_vimrc" = { dst = "~/vimrc", src = "vimrc" }
"f_xinitrc" = { dst = "~/xinitrc", src = "xinitrc" }

[profiles]
home = {
    dotfiles = ["d_polybar", "f_vimrc", "f_xinitrc"]
}

在这个配置文件中，我们定义了三个 dotfiles 和一个名为 home 的配置文件，它包含了这三个 dotfiles。这样，dotdrop 就知道要管理哪些文件，并将它们安装到哪些位置。