From 3b1a3404d6c5fa5c67b839b51769a695dcd34142 Mon Sep 17 00:00:00 2001
From: Josh Sherman <joshsherman@gmail.com>
Date: Mon, 24 Jun 2024 13:06:09 -0500
Subject: [PATCH] Expand comments, make arguments verbose, consolidate

On this kick of making sure my dotfiles are an easy to follow living
document, so I'm removing any shorthand, writing better comments, and
added bonus, I consolidated some of the redundant OS checks.
---
 zsh/.aliases | 54 +++++++++++++++++++++++++++-------------------------
 zsh/.zshrc   | 34 ++++++++++++++++-----------------
 2 files changed, 44 insertions(+), 44 deletions(-)

diff --git a/zsh/.aliases b/zsh/.aliases
index fb70297..7c11184 100644
--- a/zsh/.aliases
+++ b/zsh/.aliases
@@ -1,25 +1,31 @@
+# Starts with a clean slate
 unalias -a
 
-# Safety first
-alias cp='cp -i'
-alias mv='mv -i'
-alias rm='rm -i'
+# Prompt when doing something destructive
+alias cp='cp --interactive'
+alias mv='mv --interactive'
+alias rm='rm --interactive'
 
-# Colorize output, make ls human readable and classify...
+# Colorize output, make ls human-readable and add classification indicators
 if [[ `uname` == Darwin ]]; then
+  # macOS
   alias dircolors='gdircolors'
-  alias ls='gls --color=auto -hF'
-else
-  alias ls='ls --color=auto -hF'
+  alias ls='gls --color=auto --human-readable --classify'
 
-  # ...and standardize to macOS naming on Linux
+  # Force uuidgen to use lowercase letters like Linux
+  alias uuidgen='uuidgen | tr A-F a-f'
+else
+  # Linux
+  alias ls='ls --color=auto --human-readable --classify'
+
+  # Use the same open command as macOS
   alias open='xdg-open'
 fi
 
-# Run ls after cd
+# Run ls immediately after cd
 function cd { builtin cd "$@" && ls }
 
-# Colorize cat with bat
+# Use bat instead of cat for syntax highlighting
 if command -v apt-get &> /dev/null; then
   # Debian
   alias cat='batcat'
@@ -28,18 +34,24 @@ else
   alias cat='bat'
 fi
 
-# Disk utility aliases
-alias df='df -h'
-alias du='du -h'
+# Make disk utility human-readable
+alias df='df --human-readable'
+alias du='du --human-readable'
 
-# Colorize output and some exclusions
+# Colorize grep output and add some exclusions
 alias grep="grep --color=auto --exclude-dir={.git,artwork,node_modules,vendor}"
 
-# Git functions
+# Use HTTPie in place of the old libwww-perl commands
+alias GET='http'
+alias POST='http POST'
+alias HEAD='http HEAD'
+
+# Get the git branch name for the current directory (used in the prompt)
 git_current_branch() {
   (command git symbolic-ref -q HEAD || command git name-rev --name-only --no-undefined --always HEAD) 2> /dev/null
 }
 
+# Get the default branch name for the current directory (usually master or main)
 git_default_branch() {
   (git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@') 2> /dev/null
 }
@@ -72,13 +84,3 @@ alias grb='git rebase'
 alias grbm='git rebase $(git_default_branch)'
 alias grm='git rm'
 alias gst='git status'
-
-# HTTPie aliases
-alias GET='http'
-alias POST='http POST'
-alias HEAD='http HEAD'
-
-# Universally unique identifier (UUID) generator
-if [[ `uname` == Darwin ]]; then
-  alias uuidgen='uuidgen | tr A-F a-f'
-fi
diff --git a/zsh/.zshrc b/zsh/.zshrc
index a7fb6db..56e7702 100644
--- a/zsh/.zshrc
+++ b/zsh/.zshrc
@@ -9,21 +9,37 @@ source $HOME/.aliases
 
 eval `dircolors $HOME/.dircolors`
 
+# Load up and configure fzf, nvm, and zsh plugins
 if [[ `uname` == Darwin ]]; then
   # macOS
   [ -f ~/.fzf.zsh ] && source ~/.fzf.zsh
+
+  export NVM_DIR="$HOME/.nvm"
+  [ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"
+
   source /opt/homebrew/share/zsh-history-substring-search/zsh-history-substring-search.zsh
   source /opt/homebrew/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
 elif command -v apt &> /dev/null; then
   # Debian
   source /usr/share/doc/fzf/examples/completion.zsh
   source /usr/share/doc/fzf/examples/key-bindings.zsh
+
+  export NVM_DIR="$HOME/.nvm"
+  [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+  [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
+
   source /usr/share/zsh-history-substring-search/zsh-history-substring-search.zsh
   source /usr/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
 elif command -v pacman &> /dev/null; then
   # Arch
   source /usr/share/fzf/completion.zsh
   source /usr/share/fzf/key-bindings.zsh
+
+  [ -z "$NVM_DIR" ] && export NVM_DIR="$HOME/.nvm"
+  source /usr/share/nvm/nvm.sh
+  source /usr/share/nvm/bash_completion
+  source /usr/share/nvm/install-nvm-exec
+
   source /usr/share/zsh/plugins/zsh-history-substring-search/zsh-history-substring-search.zsh
   source /usr/share/zsh/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
 fi
@@ -79,23 +95,6 @@ PS1='
 %F{blue}%~$(git_prompt)
 %F{244}%# %F{reset}'
 
-if [[ `uname` == Darwin ]]; then
-  # macOS
-  export NVM_DIR="$HOME/.nvm"
-  [ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"
-elif command -v apt &> /dev/null; then
-  # Debian
-  export NVM_DIR="$HOME/.nvm"
-  [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-  [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
-elif command -v pacman &> /dev/null; then
-  # Arch
-  [ -z "$NVM_DIR" ] && export NVM_DIR="$HOME/.nvm"
-  source /usr/share/nvm/nvm.sh
-  source /usr/share/nvm/bash_completion
-  source /usr/share/nvm/install-nvm-exec
-fi
-
 # Automatically use Node.js version specified in .nvmrc
 autoload -U add-zsh-hook
 
@@ -117,5 +116,4 @@ load-nvmrc() {
 }
 
 add-zsh-hook chpwd load-nvmrc
-
 load-nvmrc