How jpmelos/dotfiles works
Main components
• Dotfiles Repository (Core)
• GNU stow (the deployment/symlink mechanism)
• Shell Configurations (e.g. .bashrc, .bash_profile)
• Git Configurations (.gitconfig, .gitignore, etc.)
• Neovim Configurations
• The .config/nvim directory
• Core directory, plugins, and ftplugin configurations inside “jpmelos” subdirectories that set up the behavior of Neovim as per the user's personal preferences.
• WezTerm Configurations (under .config/wezterm)
• Other Miscellaneous configuration files (e.g., .psqlrc, .ripgreprc, stylua.toml)
Establish relationships and interactions
• Each configuration group (shell, git, Neovim, WezTerm, etc.) should be represented as a distinct node that is “deployed” via stow to a particular directory in the system.
• Interactions between different sub-components if applicable (e.g., Neovim’s configuration references plugins and filetype-specific settings might interact with language-specific configurations).
Architectural patterns and design principles
• Separation of Concerns: Each group of configurations is kept in its own directory (e.g., .config/nvim for Neovim, .config/wezterm for WezTerm, etc.).
• Modularity: The use of stow allows for modular management and isolated updates by letting you “stow” selected directories separately.
• Extensibility: The repository is structured to easily add or update configurations (notice the detailed structure within the Neovim settings, including a central “jpmelos” theme).
a. Central Node: Dotfiles Repository
c. Configuration Categories:
• Shell (Bash configuration files like .bashrc, .bash_profile)
• Git (gitconfig, gitignore and related reference files)
• Neovim (comprising multiple subcomponents: core config, plugins such as cmp-nvim-lsp, treesitter integrations, etc.)
• WezTerm (keys.lua, appearance.lua, nvim-integration.lua, etc.)
• Others (additional references for iptables, SQL formatting, etc.)
Elements
• Clear labels for each major component (e.g., “Shell Configurations”, “Git Configurations”, “Neovim Configurations”, etc.).
• Another for static configuration files and directories.
• Annotations summarizing the function of each component (for example, “Neovim Plugins - Manage editor enhancements” or “WezTerm Config - Terminal appearance and behavior”).
• The central dotfiles repository,
• Its structure into logical configuration domains,
• The role of GNU stow in deploying these settings,
• And the manner these individual components prepare an integrated development environment.
By detailing these connections and modules, you provide a strong visual map that accurately represents the architectural setup of the dotfiles project. This approach ensures clarity, modularity, and precision for understanding how the entire configuration system interacts and is deployed onto a system.
Happy diagramming!