✨ dotfiles function

Author: juftin

Makefile

@@ -1,35 +1,33 @@
 SHELL := /bin/bash
+MAKE_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 OS := $(shell uname -s)
 
 ##@ dotfiles
 
 .PHONY: bootstrap
 bootstrap: ## Initialize the project by running the bootstrap script.
-	$(SHELL) ./bootstrap/bootstrap.sh
+	$(SHELL) $(MAKE_DIR)/bootstrap/bootstrap.sh
 
 .PHONY: deps
 deps: ## Install dependencies for the project based on the OS.
 ifeq ($(OS),Linux)
-	$(SHELL) ./bin/aptfile ./linux/Aptfile
+	@echo "Installing packages from Aptfile 📦"
+	$(SHELL) $(MAKE_DIR)/bin/aptfile $(MAKE_DIR)/linux/Aptfile
 else ifeq ($(OS),Darwin)
-	brew bundle --file=./macos/Brewfile
+	. ~/.shell_functions
+	@echo "Installing packages from Brewfile 📦"
+	brew bundle --file=$(MAKE_DIR)/macos/Brewfile
 else
-	$(error Unsupported operating system - $(OS))
+	@echo "Unsupported OS: $(OS)"
+	exit 1
 endif
+	@echo "Dependencies installed successfully 🎉"
 
 .PHONY: sync
 sync: ## Update the project and its submodules.
+	@echo "Updating dotfiles and its submodules 🔄"
 	git pull --recurse-submodules --jobs=4
-
-##@ development
-
-.PHONY: fmt
-fmt: ## Run pre-commit hooks on all files.
-	pre-commit run --all-files
-
-.PHONY: docs
-docs: ## Serve the documentation locally.
-	hatch run docs:serve --livereload
+	@echo "Dotfiles synced successfully 🎉"
 
 ##@ general
 
@@ -39,6 +37,20 @@ version: ## Show the version of the project.
 	@git fetch --tags 2>/dev/null || true
 	@echo "dotfiles $$(git describe --tags --abbrev=0)"
 
+##################################################
+# dotfiles development - do not autodocument these
+##################################################
+
+# Lint with pre-commit
+.PHONY: fmt
+fmt:
+	pre-commit run --all-files
+
+# Build the documentation
+.PHONY: docs
+docs:
+	hatch run docs:serve --livereload
+
 .DEFAULT_GOAL := help
 .PHONY: help
 help: ## Show this help message and exit.
@@ -47,4 +59,4 @@ help: ## Show this help message and exit.
 # - "##@" denotes a target category
 # - "##" denotes a specific target description
 ###############################################
-	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+	@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n  dotfiles \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

bootstrap/bootstrap.sh

@@ -111,6 +111,7 @@ DEPENDENCIES=(
 	zsh
 	tar
 	gh
+	make
 )
 
 function install_dependencies() {
@@ -131,6 +132,8 @@ function install_dependencies() {
 			curl
 			zsh
 			tar
+			make
+			gh
 		)
 	else
 		log_event "error" "No package manager detected"

docs/dotfiles/dependencies.md

@@ -10,12 +10,12 @@ respectively.
 
 ## Installation
 
-The `dotfiles-deps` alias will install the right dependencies for
+The `dotfiles deps` command will install the right dependencies for
 the current operating system. See the [macOS](#macos) and [Linux](#linux)
 sections for the manual installation steps.
 
 ```shell
-dotfiles-deps
+dotfiles deps
 ```
 
 ### Linux

docs/dotfiles/features.md

@@ -35,6 +35,15 @@ productive and enjoyable:
 
 ### Functions
 
+#### Dotfiles Management
+
+The `dotfiles` command is a wrapper around the `dotfiles` directory and provides
+a number of useful operations:
+
+-   `dotfiles sync`: Sync the dotfiles.
+-   `dotfiles bootstrap`: Bootstrap the dotfiles.
+-   `dotfiles deps`: Install dependencies from Brewfile or Aptfile.
+
 #### Directory Operations
 
 -   `mkcd`: Create a directory and change to it.
@@ -44,17 +53,10 @@ productive and enjoyable:
 
 #### Git Operations
 
--   `dotfiles-git`: Run a git command in the dotfiles directory.
 -   `check`: Checkout a branch.
 -   `git-remove-deleted`: Remove branches that have been deleted.
 -   `git-tree`: Display a tree considering `.gitignore`.
 
-#### Dotfiles Management
-
--   `dotfiles-sync`: Sync the dotfiles.
--   `dotfiles-bootstrap`: Bootstrap the dotfiles.
--   `dotfiles-deps`: Install dependencies from Brewfile or Aptfile.
-
 #### Search Operations
 
 -   `f`: Find a file by name.

docs/dotfiles/installation.md

@@ -34,7 +34,7 @@ the steps below:
 1. Install any missing dependencies
 
     ```shell
-    apt install -y git curl zsh tar gh
+    apt install -y git curl zsh make tar gh
     ```
 
 2. Clone the repo to `~/.dotfiles`

docs/dotfiles/quickstart.md

@@ -34,7 +34,7 @@ Install `curl` / `wget` to download the installation script:
 ## Install any missing [dependencies](dependencies.md)
 
 ```shell
-dotfiles-deps
+dotfiles deps
 ```
 
 ## Set `zsh` as the default shell

shell/.shell_functions

@@ -3,65 +3,17 @@
 ##########################################################
 
 #############################################
-# dotfiles-git
+# dotfiles
 # -------------------------------------------
-# Run a git command in the dotfiles directory
+# Run a make command in the dotfiles directory
 #############################################
-dotfiles-git() {
+dotfiles() {
     local DOTFILES_DIR="${DOTFILES_DIR:-${HOME}/.dotfiles}"
-    local GIT_COMMAND="git ${*}"
-	log_event "info" "${PURPLE}[${DOTFILES_DIR}]${NO_COLOR} ${CYAN}${GIT_COMMAND}${NO_COLOR} 📂"
-    runin "${DOTFILES_DIR}" "${GIT_COMMAND}"
-}
-
-#############################################
-# dotfiles-sync
-# -------------------------------------------
-# Sync the dotfiles
-#############################################
-dotfiles-sync() {
-    log_event "info" "Syncing dotfiles 🔄"
-	dotfiles-git pull --recurse-submodules --jobs=4
-	log_event "info" "Dotfiles synced successfully 🎉"
-}
-
-#############################################
-# dotfiles-bootstrap
-# -------------------------------------------
-# Bootstrap the dotfiles
-#############################################
-dotfiles-bootstrap() {
-    local DOTFILES_DIR="${DOTFILES_DIR:-${HOME}/.dotfiles}"
-    bash "${DOTFILES_DIR}/bootstrap/bootstrap.sh"
-}
-
-#############################################
-# dotfiles-deps
-# -------------------------------------------
-# Install dependencies from Brewfile or Aptfile
-#############################################
-dotfiles-deps() {
-    local DOTFILES_DIR="${DOTFILES_DIR:-${HOME}/.dotfiles}"
-    OS_NAME=$(uname -s)
-    if [[ ${OS_NAME} == "Darwin" ]]; then
-        if ! command -v brew &>/dev/null; then
-            echo "Error: Homebrew is not installed."
-            return 1
-        fi
-        log_event "info" "Installing packages from Brewfile 📦"
-        brew bundle --file="${DOTFILES_DIR}/macos/Brewfile"
-    elif [[ ${OS_NAME} == "Linux" ]]; then
-        if ! command -v apt &>/dev/null; then
-            echo "Error: apt is not installed."
-            return 1
-        fi
-        log_event "info" "Installing packages from Aptfile 📦"
-        bash "${DOTFILES_DIR}/bin/aptfile" "${DOTFILES_DIR}/linux/Aptfile"
-    else
-        log_event "error" "Unsupported OS: ${OS_NAME}"
-        return 1
+    if [[ "${*}" == *"--help"* ]]; then
+        make -s -C "${DOTFILES_DIR:-${HOME}/.dotfiles}" help
+        return 0
     fi
-    log_event "info" "Dependencies installed successfully 🎉"
+    make -s -C "${DOTFILES_DIR:-${HOME}/.dotfiles}" ${*}
 }
 
 ##########################################################