dotfiles_bookkeeper.zsh

#!/usr/bin/env zsh
#
# This script attempts to reflect changes to the system in the .dotfiles 
# project, and (if possible automatically) commit & push them to GitHub:
# 
#  - upgrade all outdated brew, npm & python packages
#  - backup (a list of) all installed brew, npm & python packages
#  - backup (a list of) all installed Visual Studio Code extensions
#  - commit simple changes automatically to GitHub
#  - for more complex changes: open .dotfiles project in Visual Studio Code for review
#

echo " "
echo "<*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*>"
echo "┌┐ ┌─┐┌─┐┬┌─┬┌─┌─┐┌─┐┌─┐┌─┐┬─┐"
echo "├┴┐│ ││ │├┴┐├┴┐├┤ ├┤ ├─┘├┤ ├┬┘"
echo "└─┘└─┘└─┘┴ ┴┴ ┴└─┘└─┘┴  └─┘┴└─"
echo "$(date "+%Y-%m-%d %H:%M:%S")"
echo " "


DOTFILES_HOME="/Users/roelfie/.dotfiles"

BREW_BACKUP_FILE="Brewfile"
PIP_BACKUP_FILE="pip.requirements.txt"
NPM_BACKUP_FILE="npm.global.txt"

PIP_BACKUP="$HOME/.dotfiles/backup/$PIP_BACKUP_FILE"
NPM_BACKUP="$HOME/.dotfiles/backup/$NPM_BACKUP_FILE"
VSCODE_EXTENSIONS="$HOME/.dotfiles/backup/vscode_extensions"

PATH="/opt/homebrew/bin:$PATH"
PATH="$HOME/.n/bin:$PATH"
PATH="$HOME/.pyenv/shims:$PATH"
PATH="/Applications/Visual Studio Code.app/Contents/Resources/app/bin:$PATH"

LOG_HOME="$HOME/log"

BREW_LOG="$LOG_HOME/brew.log"
NPM_LOG="$LOG_HOME/npm.log"
PIP_LOG="$LOG_HOME/pip.log"
BREW_ERR_LOG="$LOG_HOME/brew.err.log"
NPM_ERR_LOG="$LOG_HOME/npm.err.log"
PIP_ERR_LOG="$LOG_HOME/pip.err.log"

###############################################################################
###   Helper functions                                                      ###
###############################################################################

section() {
    echo "________________________________________________________________"
    echo $1
}

display_notification() {
    osascript -e 'display notification "'$1'" with title "Dotfiles"'
    # Use pync (python wrapper around terminal-notifier). Unlike the osascript variant it allows you to use icons, open files etc.
    # Disabled because it stopped working on 2022-05-25.
    # $HOME/.pyenv/shims/python $HOME/.dotfiles/bookkeeper/notify.py \
    #     "Dotfiles" \
    #     "$1" \
    #     "file:///Users/roelfie/log/bookkeeper.log" \
    #     "file:///Users/roelfie/.dotfiles/bookkeeper/images/icons8-checked-checkbox-50.png"
}

display_alert() {
    osascript -e "display alert \"Dotfiles\" message \"$1\""
}

review_dotfiles_project() {
    display_alert ".dotfiles contains uncommitted work\r\rPLEASE REVIEW"
    # Open .dotfiles in Visual Studio Code
    /Applications/Visual\ Studio\ Code.app/Contents/Resources/app/bin/code --new-window ~/.dotfiles
}

git_commit_file() {
    echo "Commit & push $1."
    git add $1
    git commit --author="bookkeeper <>" -m "$2 (auto-commit)."
    git push
    display_notification "GitHub auto-commit: $2"
}



###############################################################################
###   Upgrade homebrew packages                                             ###
###############################################################################

section "Upgrading Homebrew packages"

# Update Homebrew
brew update -q

# Upgrade outdated brew packages
#   Do not pass '--greedy-auto-updates' since that will lead to error:
#   "sudo: a terminal is required to read the password;"
#   "either use the -S option to read from standard input or configure an askpass helper".
OUTDATED_BREW_PKGS=($(brew outdated -q))
OUTDATED_BREW_PKGS_SIZE=${#OUTDATED_BREW_PKGS}
if [ $OUTDATED_BREW_PKGS_SIZE -gt 0 ]; then
    echo "Found $OUTDATED_BREW_PKGS_SIZE outdated brew package(s):"
    echo $OUTDATED_BREW_PKGS
    # Append outdated packages to logfile (prefixing each line with current date; skip header line(s)).
    brew outdated | ts '%Y%m%d  ' >> $BREW_LOG 2>> $BREW_ERR_LOG
    # Perform update of global packages 
    brew upgrade
    # display_notification "Upgraded $OUTDATED_BREW_PKGS_SIZE outdated brew package(s)."
else
    echo "No outdated brew packages found."
fi



###############################################################################
###   Upgrade global python packages                                        ###
###############################################################################

section "Upgrading Python packages"

# Upgrade outdated python packages
OUTDATED_PIP_PKGS=($(pip list --outdated --format freeze))
OUTDATED_PIP_PKGS_SIZE=${#OUTDATED_PIP_PKGS}
if [ $OUTDATED_PIP_PKGS_SIZE -gt 0 ]; then
    echo "Found $OUTDATED_PIP_PKGS_SIZE outdated python package(s):"
    echo $OUTDATED_PIP_PKGS
    # Append outdated packages to logfile (prefixing each line with current date; skip header line(s)).
    pip list --outdated --format columns | ts '%Y%m%d  ' | tail --lines +3 >> $PIP_LOG 2>> $PIP_ERR_LOG
    # Perform update of global packages 
    pip-review --auto
    # display_notification "Upgraded $OUTDATED_PIP_PKGS_SIZE outdated python package(s)."
    # Alternative (with 'pip' commands only): 
    # https://fedingo.com/how-to-upgrade-all-python-packages-with-pip/
else
    echo "No outdated python packages found."
fi



###############################################################################
###   Upgrade global NPM packages                                           ###
###############################################################################

section "Upgrading NPM & all outdated global NPM packages"

# Update npm
npm install npm@latest -g

# Upgrade outdated npm packages
OUTDATED_NPM_PKGS=($(npm outdated --global --parseable))
OUTDATED_NPM_PKGS_SIZE=${#OUTDATED_NPM_PKGS}
if [ $OUTDATED_NPM_PKGS_SIZE -gt 0 ]; then
    echo "Found $OUTDATED_NPM_PKGS_SIZE outdated npm package(s):"
    echo $OUTDATED_NPM_PKGS
    # Append outdated packages to logfile (prefixing each line with current date; skip header line(s)).
    npm outdated -g | ts '%Y%m%d  ' | tail --lines +2 >> $NPM_LOG 2>> $NPM_ERR_LOG
    # Perform update of global packages
    npm update -g
    # display_notification "Upgraded $OUTDATED_NPM_PKGS_SIZE outdated npm package(s)."
else
    echo "No outdated NPM packages found."
fi



###############################################################################
###   Backup installed homebrew, python & npm packages                      ###
###############################################################################

# NB: Files generated below are used in the homebrew, python and node setup scripts to restore installed packages.

section "Backing up homebrew, node & python packages\n"
cd $DOTFILES_HOME

echo "Backing up Homebrew packages"
brew bundle dump --force
# BUG: above command sometimes does not include the mas applications (causing needless commits).
# See https://github.com/Homebrew/homebrew-bundle/issues/1112
# To avoid needless commits, for now simply exclude the mas lines from the Brewfile:
sed '/^mas/d' Brewfile > Brewfile_without_mas
mv Brewfile_without_mas Brewfile

echo "Backing up Python packages"
# NB: 'pip list' also lists all dependencies of installed packages. 
# Using the '--not-required' flag will only include everything that is *not* a dependency.
# But if you installed a pkg yourself, that happens to be a dependency of another installed pkg,
# 'pip list --not-required' will not include that package in the output!
# Therefore we do not use the '--not-required' option. As a result, our backup will not only 
# contain 'level 0' packages but also all of its dependencies.
# TODO find a way to export only those python packages that we've installed ourselves.
# (does pip-chill have the same problem???)
pip-chill --all --no-version > $PIP_BACKUP
# Without --verbose because the verbose stuff isn't produced consistently (leading to unnecessary commits).

echo "Backing up NPM packages"
backup-global backup --no-version --no-yarn --output $NPM_BACKUP

echo "Backing up vscode extensions"
code --list-extensions > $VSCODE_EXTENSIONS



###############################################################################
###   Commit changes                                                        ###
###############################################################################

section "Commit changes"

# Check if there are changes in the .dotfiles project.
DIRTY_RAW=$(git status -s)
if [[ ${#DIRTY_RAW} = 0 ]]; then 
    echo "No changes found in .dotfiles project."; exit
else 
    echo "Changes found in .dotfiles project: \n$DIRTY_RAW"
fi

# If there are staged changes, always review manually
STAGED=($(git diff --name-only --cached))
if [[ ${#STAGED} > 0 ]]; then
    echo "Staged changes in .dotfiles project: \n$STAGED"
    review_dotfiles_project; exit
else
    echo "No staged changes found in .dotfiles project."
fi

# Some simple changes (homebrew, npm, pip and vscode backup files) can be committed automatically
DIRTY=("${(f)DIRTY_RAW}") # one line per file
if [[ ${#DIRTY} = 1 ]]; then 
    # regex 'ends with'
    if [[ $DIRTY[1] =~ Brewfile$ ]]; then 
        git_commit_file $BREW_BACKUP_FILE "Backup Homebrew packages"; exit
    fi
    if [[ $DIRTY[1] =~ $NPM_BACKUP_FILE$ ]]; then 
        git_commit_file $NPM_BACKUP "Backup NPM packages"; exit
    fi
    if [[ $DIRTY[1] =~ $PIP_BACKUP_FILE$ ]]; then 
        git_commit_file $PIP_BACKUP "Backup Python packages"; exit
    fi
    if [[ $DIRTY[1] =~ vscode_extensions$ ]]; then 
        git_commit_file $VSCODE_EXTENSIONS "Backup vscode extensions"; exit
    fi
fi

# All other changes must be reviewed manually
echo "Changes should be reviewed manually."
review_dotfiles_project; exit