How moisesmorillo/dotfiles works
Project Type and Purpose
• This is a personal “dotfiles” repository: a modular configuration manager for macOS and GitHub Codespaces.
• It leverages GNU Stow to symlink curated config files (ZSH, Neovim, Tmux, etc.) into your home directory.
• It also provides installation scripts, CI workflows, and cross-platform environment detection.
File-Structure Analysis
• Top-level “modules” directories each contain a tool’s config:
• zsh/ (aliases, options, functions)
• nvim/ (Lua-based init, plugin configs, ftplugins)
• tmux/ (themes, keybindings)
• ghostty/, starship/, brew/, docker/lazygit/lazydocker/mise/ (each tool’s config)
• scripts/ holds the various shell installers and helpers: install.sh, macOS setup, Codespaces detection, utility functions.
• .github/workflows contains CI pipelines for linting shell, YAML, Lua, and running cross-platform install tests.
README Insights
• Highlights modular design with GNU Stow, environment detection (macOS vs. Codespaces), and automated tests via GitHub Actions.
• Describes each module’s role: shell, editor, terminal, Tmux, prompt, container and version managers.
a. Main Components
• Environment (macOS / Codespaces)
• Installer & Scripts (install.sh + helpers)
• GNU Stow orchestrator
• Config Modules (zsh, nvim, tmux, ghostty, starship, brew, docker, lazygit, lazydocker, mise, yamlfmt, yamllint)
• CI Pipeline (GitHub Actions jobs: lint, test, validation)
• External Tools & Services (Homebrew, Docker/Colima, GitHub Codespaces)
b. Relationships & Data Flow
• Environment → invokes Installer
• Installer → uses Stow to symlink each Module into ~/
• Modules reference tool executables (ZSH, nvim, tmux, etc.)
• CI Pipeline → runs against repo on push/PR, yields pass/fail back to GitHub
• External Tools ← Modules supply configuration to these tools at runtime
c. Architectural Patterns & Principles
• Modularity: each tool’s config isolated in its own directory
• Declarative setup: “stow” defines where symlinks go without copying files
• Idempotence: install scripts and CI ensure repeatable, safe installs
• Environment detection: branching logic for Codespaces vs local macOS
d. Key Technologies & Frameworks
• GNU Stow for symlinks
• Bash shell scripts
• Lua (Neovim config)
• GitHub Actions (YAML workflows)
• Linters: ShellCheck, luacheck, yamllint