How stephencombs/dotfiles works
Main Components
• Dotfiles Repository: This is the central source containing all the configuration files and templates.
• Configuration Groups: Organize configurations by tools or services. For this project, key groups include:
• shell (zsh) configurations and secrets (in dot_config/zsh)
• Neovim configurations and plugins (in dot_config/nvim)
• Terminal multiplexer (zellij) configs along with its plugins and themes (in dot_config/zellij)
• Aliases and other shell enhancements (located in dot_config/aliases)
• Utility scripts for setting up other tools (located in dot_config/scripts)
• Additional configurations like fzf and posh settings (e.g., dot_config/fzf, dot_config/posh)
• Template Files & Setup Scripts: Files like .chezmoi.toml.tmpl and shell scripts (e.g., run_once_before_install-packages.sh.tmpl) that help in applying and customizing the environment.
Relationships and Interactions
• Dependencies also exist among components: for instance, the zsh configuration may load source files (dot_config/zsh/dot_conf, dot_env) and utilize external tools like oh-my-posh.
• The alias files and scripts might be shared across tools, indicating a cross-component relationship.
Architectural Patterns and Design Principles
• Modularity: Configurations are maintained in separate directories for each tool, making the environment modular and easy to update.
• Reusability: Shell aliases, plugins, and scripts are reused across different tools.
• Declarative Setup: The use of chezmoi allows declarative management of the environment, ensuring that systems can be set up consistently across different OS (macOS and Debian-based Linux).
• Security: Use of encryption (files like encrypted_dot_secrets.age) to manage secure configurations.
Technologies and Tools
• Labels for external dependencies/tools such as Neovim, zsh, fzf, alacritty, zellij, oh-my-posh, and others.
• Chezmoi as the mechanism that installs and applies these configurations.
• Optionally, show age (the encryption tool) as a component for decrypting secure files prior to applying the configurations.
Final Detailed Assembly
• Connections where one configuration may be interdependent (for example, alias or script usage across multiple shells/tools).
• Adding notes that mention OS support (macOS and Linux) which could be annotated near the deployment block.