update Makefile

Author: jedib0t

Makefile

@@ -1,41 +1,84 @@
-.PHONY: all profile test
+# Declare all phony targets (targets that don't create files)
+.PHONY: all bench cyclo default demo-colors demo-list demo-progress demo-table fmt help profile test test-race tools vet
 
+# ============================================================================
+# Main targets
+# ============================================================================
+
+## default: Run tests (default target)
 default: test
 
+## all: Run all checks: tests and benchmarks
 all: test bench
 
-tools:
-	go install github.com/fzipp/gocyclo/cmd/[email protected]
-	go install github.com/rinchsan/gosimports/cmd/[email protected]
+# ============================================================================
+# Testing targets
+# ============================================================================
 
+## bench: Run benchmark tests with memory profiling
 bench:
 	go test -bench=. -benchmem
 
+## test: Run tests with coverage (runs fmt, vet, and cyclo first)
+test: fmt vet cyclo
+	go test -cover -coverprofile=.coverprofile ./...
+
+## test-race: Run progress demo with race detector
+test-race:
+	go run -race ./cmd/demo-progress/demo.go
+
+# ============================================================================
+# Code quality targets
+# ============================================================================
+
+## cyclo: Check cyclomatic complexity (warns if complexity > 13)
 cyclo:
 	gocyclo -over 13 ./*/*.go
 
+## fmt: Format code and organize imports
+fmt:
+	go fmt ./...
+	gosimports -w .
+
+## vet: Run go vet static analysis
+vet:
+	go vet ./...
+
+# ============================================================================
+# Demo targets
+# ============================================================================
+
+## demo-colors: Run the colors demo
+demo-colors:
+	go run cmd/demo-colors/demo.go
+
+## demo-list: Run the list demo
 demo-list:
 	go run cmd/demo-list/demo.go
 
+## demo-progress: Run the progress demo
 demo-progress:
 	go run cmd/demo-progress/demo.go
 
+## demo-table: Run the table demo
 demo-table:
 	go run cmd/demo-table/demo.go
 
-fmt:
-	go fmt ./...
-	gosimports -w .
+# ============================================================================
+# Utility targets
+# ============================================================================
 
+## help: Display help information for all available targets
+help:
+	@echo "\033[1mAvailable targets:\033[0m"
+	@awk '/^# [A-Z].*targets$$/ {gsub(/^# /, ""); print "\n\033[1;36m" $$0 "\033[0m"} /^##/ {gsub(/^##\s*/, ""); idx=match($$0, /: /); if(idx) {target=substr($$0,1,idx-1); desc=substr($$0,idx+2); printf "  \033[36mmake\033[0m \033[32m%-15s\033[0m \033[33m- %s\033[0m\n", target, desc}}' $(MAKEFILE_LIST)
+
+## profile: Run profiling script
 profile:
 	sh profile.sh
 
-test: fmt vet cyclo
-	go test -cover -coverprofile=.coverprofile ./...
-
-test-race:
-	go run -race ./cmd/demo-progress/demo.go
-
-vet:
-	go vet ./...
+## tools: Install required development tools
+tools:
+	go install github.com/fzipp/gocyclo/cmd/[email protected]
+	go install github.com/rinchsan/gosimports/cmd/[email protected]