Dotfiles

个人跨平台（macOS / Linux）配置文件仓库，遵循 实用、简单、清晰、零框架冗余 原则。

• 所见即所得：通过软链（Symlink）直接映射 $HOME，修改 ~/.zshrc 即直接修改仓库文件。
• 零外部管理依赖：不依赖 stow、chezmoi 或 Git Submodule，内置 install.sh 一键完成依赖拉取、冲突自动备份、旧软链清理与新软链维护。
• 极速 Zsh（~50ms 启动）：基于原生 Zsh 配置 + 直连 powerlevel10k 与 4 个核心插件，告别 oh-my-zsh / zplug 启动卡顿。

---

一、 快速开始（全新安装 vs 旧版升级）

1. 全新机器：一行命令安装所有

在一台从未装过 dotfiles 的新机器上，只需有 git 和 curl，直接执行：

curl -fsSL https://raw.githubusercontent.com/everbird/dotfiles/master/install.sh | bash

或者手动克隆到任意目录后执行 make：

git clone https://github.com/everbird/dotfiles.git ~/.dotfiles && make -C ~/.dotfiles

这行命令会自动完成：

1. 克隆仓库到 ~/.dotfiles（若通过 curl 执行）；
2. 将所有配置文件软链到 $HOME（若存在同名非软链文件，自动备份为 *.bak.<时间戳>）；
3. 将 5 个核心 Zsh 插件安装至 ~/.local/share/zsh/plugins/；
4. 将 everbird/dotvim 克隆至 ~/.everbird-dotvim 并调用其 bootstrap.sh 初始化 Vim 与 Neovim（检测到 git 与 vim/nvim 时默认安装 --full 完备插件集，若失败或处于极简环境自动回退 --basic，也可通过 DOTVIM_PROFILE=basic make 手动指定）；
5. 将 Tmux TPM 安装至 ~/.tmux/plugins/tpm；
6. 将 Doom Emacs 克隆至 ~/.emacs.d，并在系统已安装 emacs 时自动执行 doom sync（且 ~/.emacs.d/bin 已自动加入 $PATH）。

2. 已安装旧版 dotfiles 的机器：平滑升级为新版

如果机器上之前已经装过老版本（带 stowsh 和 bundle/* 子模块）的 ~/.dotfiles，只需执行：

cd ~/.dotfiles && git pull && make

升级过程会自动处理兼容与清理：

1. 无缝迁移外部框架：
   • 自动将旧 ~/.zplug/repos/ 下的 Zsh 插件迁移到 ~/.local/share/zsh/plugins/；
   • 自动将旧 bundle/tmux-tpm 迁移到 ~/.tmux/plugins/tpm；
   • 自动将旧 ~/.emacs.d -> .dotfiles/bundle/doom-emacs 软链解耦迁移为独立的 ~/.emacs.d Git 仓库（完整保留已编译的 .local 包缓存；若旧目录已被清理则自动重新克隆 Doom Emacs 并恢复 .local）；
2. 重定向软链：将 ~/.zshrc、~/.gitconfig、~/.tmux.conf、~/.doom.d/* 等全部切换到最新结构；
3. 清理历史遗留软链：自动移除 $HOME 下已废弃的旧软链（~/.oh-my-zsh、~/.zplug、~/.spacemacs、~/.ohmyvocabularyrc、~/bin/{pex,mdict.pex,omv,tosink}）。
4. 清理旧子模块残留目录（可选）：升级完成后，可清理旧仓库下未追踪的 bundle/ 残留：

   git -C ~/.dotfiles clean -ffd

---

二、 目录结构

dotfiles/
├── install.sh                 # 零依赖安装与管理脚本（顶部声明 DOTFILE_LINKS 与 ZSH_PLUGINS）
├── Makefile                   # 常用命令入口（make, make link, make bootstrap, make status）
├── zsh/
│   ├── .zshenv                # 环境变量与禁用 Ubuntu 全局重复 compinit
│   ├── .zshrc                 # 跨平台 Zsh 主配置（原生手感 + 插件自动按需加载）
│   └── .p10k.zsh              # Powerlevel10k 提示符样式配置
├── git/
│   ├── .gitconfig             # 统一 Git 配置（支持本地与工作目录条件覆盖）
│   └── .config/git/ignore     # 全局 gitignore
├── tmux/
│   └── .tmux.conf             # Tmux 配置（C-q 前缀、OSC 52 剪贴板同步、TPM 插件）
├── doom/
│   └── .doom.d/               # Doom Emacs 配置（init.el, config.el, packages.el, custom.el）
├── editorconfig/
│   └── .editorconfig          # 通用编辑器缩进与编码规范
├── gpg/
│   ├── gpg-agent.conf.linux   # Linux GPG Agent 配置
│   └── gpg-agent.conf.macos   # macOS GPG Agent 配置
└── iterm2/                    # macOS iTerm2 配色与 Profile 备份

---

三、 日常维护命令

在仓库根目录下直接通过 make 操作：

make            # 完整执行 bootstrap + link（并清理废弃旧软链）
make link       # 仅更新软链（新增或调整配置文件路径后执行）
make bootstrap  # 仅安装/检查外部插件框架（Zsh 插件、everbird-dotvim、Tmux TPM）
make status     # 检查所有软链与外部插件状态（OK / DRIFTED / MISSING）
make unlink     # 卸载所有指向本仓库的软链

---

四、 如何添加新的配置

所有软链映射都集中在 install.sh 顶部的 DOTFILE_LINKS 数组中，添加新配置只需 2 步：

1. 纳管普通配置文件（以 htop 为例）

1. 将配置文件放入仓库对应模块目录：

   mkdir -p htop/.config/htop
   mv ~/.config/htop/htoprc htop/.config/htop/htoprc

2. 在 install.sh 顶部的 DOTFILE_LINKS 数组中添加一行（格式为 "仓库相对路径:HOME相对路径"）：

   DOTFILE_LINKS=(
     "zsh/.zshenv:.zshenv"
     "zsh/.zshrc:.zshrc"
     ...
     "htop/.config/htop/htoprc:.config/htop/htoprc"
   )

3. 执行 make link 即可生效（make status 和 make unlink 也会自动纳管该文件）。

2. 纳管区分 macOS / Linux 的配置文件

如果某个配置文件在 macOS 和 Linux 下内容不同，放到 install.sh 顶部的系统判断分支即可：

case "$(uname -s)" in
  Darwin*) DOTFILE_LINKS+=("gpg/gpg-agent.conf.macos:.gnupg/gpg-agent.conf") ;;
  Linux*)  DOTFILE_LINKS+=("gpg/gpg-agent.conf.linux:.gnupg/gpg-agent.conf") ;;
esac

3. 添加新的 Zsh 插件

1. 在 install.sh 顶部的 ZSH_PLUGINS 数组中加入 GitHub "作者/仓库名"；
2. 在 zsh/.zshrc 的第 4 节中加入对应的 _zsh_ensure_plugin "作者/仓库名" 和 source 语句。

---

五、 本机私有配置与多环境隔离（不入库）

为了避免把机器私有路径、Token 或公司内网配置提交到公开仓库，支持以下本地覆盖文件（均已被 .gitignore 忽略）：

• Zsh 本机私有配置 (~/.zshrc.local)： zsh/.zshrc 末尾会自动加载 ~/.zshrc.local。本机特有的环境变量、内网 SSH 别名等可直接写在该文件中。
• Git 本机与工作目录配置：
  • ~/.gitconfig.local：存放当前机器私有的 Git 配置。
  • ~/.gitconfig.work：当 Git 仓库位于 ~/workspace/work/ 目录下时，git/.gitconfig 会通过 includeIf 自动加载 ~/.gitconfig.work（可用于配置工作邮箱和独立签名设置）。