How neko-neko/dotfiles works
Main components
• Setup and Installation Scripts:
• The “setup” directory contains multiple installation scripts (install.zsh, sub-scripts in setup/install/ and the uninstall.zsh). This forms the entry point for setting up a new machine.
• Configuration Files:
• “config” directory holds subdirectories for specific applications:
• helix (editor configuration with config.toml and languages.toml)
• karabiner (keyboard/mouse customization including assets and complex modifications)
• mise, sheldon, and starship are for other specific tools
• Command-Line Utilities and Custom Scripts:
• “bin” directory includes executables (e.g., epoch, various “fzf-” scripts, sha256). These scripts likely extend or automate command-line workflows.
• Shell and Environment Configuration:
• Files such as .gitignore, .zshenv, .zshrc, gitconfig, editorconfig, and others define environment behaviors and developer preferences.
• Additional Resources:
• VSCode settings (in the vscode directory)
• WezTerm configuration (wezterm.lua)
• “functions” directory containing further shell functions (e.g., fzf-history)
• “aliases” file for command shortcuts
Relationships and interactions
• The installation scripts (in “setup”) are responsible for deploying the configurations and custom scripts.
• The configuration files control the behavior of separate applications, like the shell (zsh), text editors (Helix), terminal emulators (WezTerm), and other utilities (Karabiner and VSCode).
• The executable scripts (in “bin”) and functions help integrate these configurations with enhanced productivity tools (for example, integration with fzf for fuzzy search in different contexts).
Architectural patterns and design principles
• Modular configuration: Each subdirectory in “config” deals with one application or purpose, following a separation of concerns.
• Script-driven automation: The setup/installation scripts are orchestrated in sequentially numbered files (install/01_brew.zsh, install/02_gnu.zsh, etc.), which show a step-by-step bootstrapping process.
• Extensibility: The repository is structured in a way that allows for straightforward extensions (adding more config directories, additional command line scripts, or further environment variables).
Relevant technologies and tools
• Shell scripting (zsh)
• JSON and TOML configuration files for applications like Helix, Karabiner, and Sheldon's plugin manager.
• CI integration via GitHub actions (in .github/workflows/ci.yml) for testing the dotfiles setup.
• Editor and terminal customization (VSCode settings, wezterm.lua, etc.)