Mr EdHeltzel's Dotfiles

My setup for 🐠 Fish shell on  macOS - v3

Here, you'll find my dotfiles configuration for fish shell on macOS managed using GNU Stow. You'll also find files for provisioning a new machine and setting up my environment. Again, this is my personal setup and changes often, so don't blindly fork and run the install.sh script without reading it first. But get inspired, take what you want, and leave the rest to make it your own.

Prerequisites

bash -c "`curl -fsSL https://raw.githubusercontent.com/edheltzel/dotfiles/master/bootstrap.sh`"

csrutil status

System Integrity Protection status: enabled.

👋 For future Mr EdHeltzel:

Since we have a bad habit of forgetting things:

1. Installing Xcode Command Line Tools

   • sudo softwardupdate -i -a && xcode-select --install This will install git and make if not already installed.

2. Generate a new SSH key and add to GitHub

   • Generate a new ssh keys
   • eval "$(ssh-agent -s)" && ssh-add --apple-use-keychain ~/.ssh/id_ed25519

3. Clone repo

   • git clone https://github.com/edheltzel/dotfiles.git ~/.dotfiles

4. Use the Makefile for the rest of the setup

   • cd ~/.dotfiles && make install
   • Alternatively, run install script cd ~/.dotfiles && ./install.sh

5. After the setup is complete, run upp to execute topgrade and update everything.

   • upp is an alias for topgrade which is Update Packages (this is what I say to myself).
   • The topgrade.toml includes [post_commands] for additional Brew and Node updates.

6. Optional steps for DX and nice to haves:

   • Disable Gatekeeper when installing apps: sudo spctl --master-disable (in macos/security.sh)
   • Make sure to run fnm env --use-on-cd | source to enable auto-switching of Node versions. (in fish)

The Nitty Gritty

Originally, I used a series of custom scripts to create symlinks, and it worked, but I've since switched to using GNU Stow. This is way easier to manage.

So, with the addition of GNU Stow, I added a makefile – I treat this like NPM scripts. You need to be in the root of ~/.dotfiles to execute any of the make tasks.

The following are available:

help          Show this help message (default)
install       Bootstraps a new machine
run           Symlink all dotfiles w/Stow
stow          Add individual packages w/Stow
unstow        Remove individual packages w/Stow
delete        Delete all dotfiles w/Stow
update        Sync & clean dead symlinks w/Stow

Bootstrapping

• make install task, it will execute the bootstrap.sh script. This script, is for setting up a brand new machine, it will install the necessary package managers, packages with dependencies, applications, clone the necessary repositories, configure the ~/.gitconfig.local and symlink dotfiles using GNU Stow.

Stowing/Unstowing (add/remove)

There are two options for managing packages with GNU Stow:

1. Just use Stow: stow nvim / stow --restow nvim or stow -D nvim (unstow)
2. Use the Makefile: make stow pkg=nvim or make unstow pkg=nvim
   • The pkg= variable must be specified.

Stow Packages

• dots (dots/)
  • misc dotfiles that are stored in the $HOME directory
• git (git/)
  • git configuration
• zsh (zsh/)
  • Zsh configuration files (this kind of sort of mimics fish - WIP)
• fish (fish/)
  • XDG Base Directory – Reference: XDG Base Directory for more information. To edit/set the XDG Base Directory variables, you can edit the ~/fish/.config/fish/conf.d/paths.fish file. Hopefully, this will keep the $HOME directory clean and organized.
• nvim (nvim/)
  • When I need Vim, I use LazyVim - lightly customized.
• config (config/)
  • Configuration files for various applications
• local (local/)
  • User-specific data not configuration-related. ie: dictionaries, wallpapers, misc items that mean nothing, etc.
• warp (warp/)
  • Includes my Lunar Eclipse theme and Warp preferences.
  • iTerm2 is my daily driver, I really want to like Warp, but I just can't get into it.
  • iTerm's preferences are synced with iCloud Drive.

Scripts

Any of the scripts can be run individually at any time to update/reset as needed. ie: cd ~/.dotfiles && ./duti/duti.sh

• macOS (macos/)
  • macos.sh - Executes a long list of commands pertaining to macOS Preferences – DO NOT blindly run this script - it is a WIP with each macOS update things change.
• packages (packages/)
  • packages.sh - Installs the Brewfile and each package manager's packages based on the .txt files.
• repositories (repos/)
  • repos.sh - Clones the repositories in the .txt files at the corresponding locations
• private (private/)
  • private.sh - Left empty on purpose
• duti (duti/)
  • duti.sh - Sets the default applications for file types
    • run ./duti/duti.sh to reset the default applications for file types
• Helper Scripts (scripts/)
  • functions.sh - Contains helper functions for for the scripts

Troubleshooting

curl -sL https://raw.githubusercontent.com/jorgebucaran/fisher/main/functions/fisher.fish | source && fisher install jorgebucaran/fisher

brew install fnm
fnm env --use-on-cd | source

fnm completions --shell fish

make update #updates all stow packages
OR
make stow pkg=fish

# auto runs: fnm use
fnm env --use-on-cd | source

npm install --global $(cat node_packages.txt)

  [meta]
    isLocalConfig = true
  [user]
    signingkey = PATH_TO_YOUR_KEY
  [gpg "ssh"]
    allowedSignersFile = PATH_TO_YOUR_ALLOWED_SIGNERS_FILE

launchctl load -w /System/Library/LaunchAgents/com.apple.rcd.plist

TODOs

• [ ] Look into other/better options that Stow:
  • [ ]Tuckr
  • [ ]Rotz
• [ ] Convert fish functions to zsh functions - WIP
• [ ] zsh completions doesn't seem to be working as expected issue #40
  • [ ] Look into zsh-completions vs autocomplete
• [x] Consider using NixOS for package management over Homebrew. ie: good example
• [x] include zsh abbreviations
• [x] Create a single-line install script to execute bootstrap.sh
• [x] use makefile to execute bootstrap.sh and install.sh
• [x] update make unstow to include only the available stow package or all
• [x] add customizations to lazyvim
• [x] Add vscode settings and symlink to dotfiles
• [x] Add XDG Base Directory support
• [x] update README
  • [x] include XDG info
  • [x] include Stow info
  • [x] include Make info
  • [x] include New bootstrap process
  • [x] include New install process (makefile)